Skip to content
TypeSpec Azure
Docs
Playground
TypeSpec Core Docs
Can I Use (Azure Client)
Search...
Introduction
Get started
Installation
Creating a project
Versioning
Azure Data Plane Service
1. Writing Your First Service
2. Create the service namespace
3. Defining your first resource
4. Defining standard resource operations
5. Defining long-running resource operations
6. Defining child resources
7. Defining custom resource actions
8. Customizing operations with traits
9. Versioning
10. Complete Example
11. Advanced Topics
ARM Service
1. Installing Tools
2. Defining the Service
3. Defining the Resources
4. Defining Child Resource Types
5. Defining Custom Actions
6. Complete Example and Generate OpenApi 2.0 spec
Howtos & Examples
ARM
Adding Common Types to Azure Resource Manager (ARM)
ARM Rules, TypeSpec Linting, and Suppression
Change the provider namespace
ARM Resource Operations
ARM Resource Types
Versioning
Azure Core
Content Type Negotiation
Deep Dive: Long-running (Asynchronous) Operations
Azure Portal
Generating experiences in Azure Portal with TypeSpec
Generate client libraries
How to generate client libraries
Setup for SDK Customization
Common Behavior for Client Packages
Clients
Basic methods
Paging Operations
Long-Running Operations
Multipart Operations
Generated Types
Renaming Types
Versioning
Multi-Layer Discriminator Hierarchy Building
Client Options
Generate with tsp client
Usage
Quick Start
Repo setup
Versioning
How to define a preview version
ARM
Introduction
Adding a Preview Version when the Last Version was Preview
Adding a Stable Version when the Last Version was Preview
Adding a Preview Version when the Last Version was Stable
Adding a Stable Version when the Last Version was Stable
Uncommon scenarios
Converting Existing Specs to Single Active Preview
How to Manage a Single Active Preview When Some Features Always Remain In Preview
Rest api publish
Using Build Pipelines with TypeSpec
Checking in typespec and generated OpenAPI to azure-rest-api-specs repo
Azure TypeSpec Style Guide
Convert OpenAPI to TypeSpec
Getting started
TroubleShooting
Resolving OpenAPI Breaking Change Violations
Fixing Converted TypeSpec
Frequently Asked Questions
Understanding the OpenAPI Changes
Resolving Pipeline Failures
x-ms-examples example files
Checklists
Migrate ARM spec
Migrate data-plane specs
📚 Libraries
Azure.Core
Overview
Rules
auth-required
bad-record-type
casing-style
no-closed-literal-union
no-enum
no-generic-numeric
no-header-explode
no-legacy-usage
no-multiple-discriminator
no-nullable
no-openapi
no-private-usage
no-query-explode
no-string-discriminator
no-unnamed-union
non-breaking-versioning
operation-missing-api-version
prevent-format
require-versioned
spread-discriminated-model
use-standard-names
use-standard-operations
Data types
Decorators
Interfaces and Operations
Js api
Enumerations
[E] FinalStateValue
Functions
[F] $requestParameter
[F] $responseProperty
[F] extractLroStates
[F] filterModelProperties
[F] filterResponseModels
[F] getAllProperties
[F] getHttpMetadata
[F] getLroMetadata
[F] getOperationResponse
[F] getRequestParameter
[F] getResponseProperty
[F] getResultModelWithProperty
[F] getSourceTraitName
[F] getSuccessResponse
[F] getTraitContexts
[F] getTraitLocation
[F] getTraitName
[F] getUnionAsEnum
[F] hasUniqueItems
[F] isTraitModel
[P] JS API
Interfaces
[I] ArmResourceIdentifierConfig
[I] EmbeddingVectorMetadata
[I] FinalOperationLink
[I] FinalOperationReference
[I] HttpTerminationStatus
[I] LogicalOperationStep
[I] LroMetadata
[I] ModelPropertyTerminationStatus
[I] NextOperationLink
[I] NextOperationReference
[I] NoPollingSuccessProperty
[I] OperationLink
[I] OperationLinkMetadata
[I] OperationReference
[I] ParameterSource
[I] PollingOperationStep
[I] PollingSuccessNoResult
[I] PollingSuccessProperty
Type aliases
[T] FinalOperationStep
[T] OperationStep
[T] TerminationStatus
[T] UnionEnum
[T] nextOperationStep
Variables
[V] $addTraitProperties
[V] $applyTraitOverride
[V] $ensureAllHeaderParams
[V] $ensureAllQueryParams
[V] $ensureTraitsPresent
[V] $lib
[V] $linter
[V] $trait
[V] $traitAdded
[V] $traitContext
[V] $traitLocation
[V] $traitSource
[V] getArmResourceIdentifierConfig
[V] getAsEmbeddingVector
[V] getOperationLinks
[V] getParameterizedNextLinkArguments
[V] isPreviewVersion
[V] namespace
[V] preventRestLibraryInterfaces
[V] useStandardOperations
Linter usage
Azure.ResourceManager
Overview
Rules
arm-custom-resource-no-key
arm-no-record
arm-resource-invalid-action-verb
arm-resource-provisioning-state
delete-operation-response-codes
lro-location-header
missing-x-ms-identifiers
no-empty-model
no-resource-delete-operation
no-empty-model
post-operation-response-codes
put-operation-response-codes
resource-name-pattern
secret-prop
unsupported-types
Data types
Decorators
Interfaces and Operations
Js api
Enumerations
[E] ResourceBaseType
Functions
[F] addArmResourceOperation
[F] armRenameListByOperationInternal
[F] getArmCommonTypeOpenAPIRef
[F] getArmCommonTypesVersion
[F] getArmCommonTypesVersions
[F] getArmIdentifiers
[F] getArmKeyIdentifiers
[F] getArmProviderNamespace
[F] getArmResourceInfo
[F] getArmResourceKind
[F] getArmResourceOperationList
[F] getArmResourceOperations
[F] getArmResources
[F] getArmVirtualResourceDetails
[F] getDefaultLegacyExtensionResourceName
[F] getExternalTypeRef
[F] getFeature
[F] getFeatureOptions
[F] getPublicResourceKind
[F] getResourceBaseType
[F] getResourceNameForOperation
[F] getResourceOperation
[F] getResourcePathElements
[F] getRouteOptions
[F] getSingletonResourceKey
[F] getUnassociatedOperations
[F] getUsedLibraryNamespaces
[F] isArmCollectionAction
[F] isArmCommonType
[F] isArmLibraryNamespace
[F] isArmProviderNamespace
[F] isArmVirtualResource
[F] isAzureResource
[F] isCustomAzureResource
[F] isResourceOperationMatch
[F] isSingletonResource
[F] resolveArmResourceOperations
[F] resolveArmResources
[F] resolveProviderNamespace
[F] resolveResourceBaseType
[F] resolveResourceOperations
[F] setArmOperationIdentifier
[F] setResourceBaseType
[P] JS API
Interfaces
[I] ArmCommonTypeVersions
[I] ArmCommonTypesResolutionOptions
[I] ArmFeatureOptions
[I] ArmLifecycleOperationData
[I] ArmLifecycleOperations
[I] ArmOperationIdentifier
[I] ArmResolvedOperationsForResource
[I] ArmResourceDetails
[I] ArmResourceDetailsBase
[I] ArmResourceLifecycleOperations
[I] ArmResourceOperation
[I] ArmResourceOperations
[I] ArmResourceOperationsData
[I] ArmVirtualResourceDetails
[I] Provider
[I] ResolvedResource
[I] ResolvedResourceInfo
[I] ResourceModel
[I] ResourcePathInfo
[I] ResourceType
Type aliases
[T] ArmLifecycleOperationKind
[T] ArmOperationKind
[T] ArmResourceKind
Variables
[V] $armCommonTypesVersion
[V] $armExternalType
[V] $armLibraryNamespace
[V] $armOperationRoute
[V] $armProviderNameValue
[V] $armProviderNamespace
[V] $armResourceAction
[V] $armResourceCheckExistence
[V] $armResourceCollectionAction
[V] $armResourceCreateOrUpdate
[V] $armResourceDelete
[V] $armResourceList
[V] $armResourceOperations
[V] $armResourceRead
[V] $armResourceUpdate
[V] $armVirtualResource
[V] $customAzureResource
[V] $extensionResource
[V] $feature
[V] $featureOptions
[V] $features
[V] $identifiers
[V] $lib
[V] $linter
[V] $locationResource
[V] $renamePathParameter
[V] $resourceBaseType
[V] $resourceGroupResource
[V] $singleton
[V] $subscriptionResource
[V] $tenantResource
[V] $useLibraryNamespace
[V] getArmOperationList
[V] getArmResource
[V] getArmResourceOperationData
[V] getCustomResourceOptions
[V] getInlineAzureType
[V] getResolvedResources
[V] getResourceFeature
[V] getResourceFeatureOptions
[V] getResourceFeatureSet
[V] isArmExternalType
[V] namespace
[V] setArmExternalType
[V] setArmOperationList
[V] setArmResourceOperationData
[V] setResolvedResources
[V] setResourceFeature
[V] setResourceFeatureOptions
[V] setResourceFeatureSet
Linter usage
Azure.ClientGenerator.Core
Overview
Data types
Decorators
Emitter usage
Js api
Enumerations
[E] InitializedByFlags
[E] UsageFlags
Functions
[F] $clientLocation
[F] $onEmit
[F] $override
[F] addEncodeInfo
[F] createSdkContext
[F] createTCGCContext
[F] getAccess
[F] getAccessOverride
[F] getAllModels
[F] getAllModelsWithDiagnostics
[F] getAllReferencedTypes
[F] getAlternateType
[F] getClient
[F] getClientDefaultValue
[F] getClientDocExplicit
[F] getClientInitializationOptions
[F] getClientLocation
[F] getClientNameOverride
[F] getClientNamespace
[F] getClientOptions
[F] getClientType
[F] getClientTypeWithDiagnostics
[F] getCrossLanguageDefinitionId
[F] getCrossLanguagePackageId
[F] getDefaultApiVersion
[F] getDisablePageable
[F] getEffectivePayloadType
[F] getExplicitClientApiVersions
[F] getGeneratedName
[F] getHttpOperationExamples
[F] getHttpOperationParameter
[F] getHttpOperationParametersForClientParameter
[F] getHttpOperationWithCache
[F] getIsApiVersion
[F] getKnownScalars
[F] getLegacyHierarchyBuilding
[F] getLibraryName
[F] getMarkAsLro
[F] getMarkAsPageable
[F] getNamespaceFromType
[F] getNextLinkVerb
[F] getOperationGroup
[F] getOverriddenClientMethod
[F] getParamAlias
[F] getPropertyNames
[F] getResponseAsBool
[F] getSdkArrayOrDict
[F] getSdkArrayOrDictWithDiagnostics
[F] getSdkBuiltInType
[F] getSdkConstant
[F] getSdkCredentialParameter
[F] getSdkDurationType
[F] getSdkEnum
[F] getSdkEnumValue
[F] getSdkModel
[F] getSdkModelPropertyType
[F] getSdkModelPropertyTypeBase
[F] getSdkModelWithDiagnostics
[F] getSdkTuple
[F] getSdkTupleWithDiagnostics
[F] getSdkUnion
[F] getSdkUnionEnum
[F] getSdkUnionEnumWithDiagnostics
[F] getSdkUnionWithDiagnostics
[F] getTypeSpecBuiltInType
[F] getUsage
[F] getUsageOverride
[F] getWireName
[F] handleAllTypes
[F] isApiVersion
[F] isAzureCoreModel
[F] isHttpMetadata
[F] isInScope
[F] isOperationGroup
[F] isPagedResultModel
[F] isReadOnly
[F] isSdkBuiltInKind
[F] isSdkDateTimeEncodings
[F] isSdkFloatKind
[F] isSdkIntKind
[F] listAllServiceNamespaces
[F] listClients
[F] listOperationGroups
[F] listOperationsInOperationGroup
[F] resolveOperationId
[F] shouldFlattenProperty
[F] shouldGenerateConvenient
[F] shouldGenerateProtocol
[F] updateUsageOrAccess
[P] JS API
Interfaces
[I] BinarySerializationOptions
[I] ClientInitializationOptions
[I] CreateSdkContextOptions
[I] DecoratedType
[I] DecoratorInfo
[I] DiscriminatedOptions
[I] ExternalTypeInfo
[I] JsonSerializationOptions
[I] LicenseInfo
[I] MarkAsPageableInfo
[I] MultipartOptions
[I] SdkArrayExampleValue
[I] SdkArrayType
[I] SdkBasicServiceMethod
[I] SdkBodyParameter
[I] SdkBooleanExampleValue
[I] SdkBuiltInType
[I] SdkClient
[I] SdkClientInitializationType
[I] SdkClientType
[I] SdkConstantType
[I] SdkContext
[I] SdkCookieParameter
[I] SdkCredentialParameter
[I] SdkCredentialType
[I] SdkDictionaryExampleValue
[I] SdkDictionaryType
[I] SdkDurationType
[I] SdkEndpointParameter
[I] SdkEndpointType
[I] SdkEnumType
[I] SdkEnumValueType
[I] SdkHeaderParameter
[I] SdkHttpErrorResponse
[I] SdkHttpOperation
[I] SdkHttpOperationExample
[I] SdkHttpParameterExampleValue
[I] SdkHttpResponse
[I] SdkHttpResponseExampleValue
[I] SdkHttpResponseHeaderExampleValue
[I] SdkLroPagingServiceMethod
[I] SdkLroServiceFinalResponse
[I] SdkLroServiceMetadata
[I] SdkLroServiceMethod
[I] SdkLroServicePollingStep
[I] SdkMethodParameter
[I] SdkMethodResponse
[I] SdkModelExampleValue
[I] SdkModelPropertyType
[I] SdkModelPropertyTypeBase
[I] SdkModelType
[I] SdkNamespace
[I] SdkNextOperationLink
[I] SdkNextOperationReference
[I] SdkNullExampleValue
[I] SdkNullableType
[I] SdkNumberExampleValue
[I] SdkOperationGroup
[I] SdkOperationLink
[I] SdkOperationReference
[I] SdkPackage
[I] SdkPagingServiceMetadata
[I] SdkPagingServiceMethod
[I] SdkPathParameter
[I] SdkPollingOperationStep
[I] SdkPropertyMap
[I] SdkQueryParameter
[I] SdkServiceResponse
[I] SdkServiceResponseHeader
[I] SdkStreamMetadata
[I] SdkStringExampleValue
[I] SdkTupleType
[I] SdkUnionExampleValue
[I] SdkUnionType
[I] SdkUnknownExampleValue
[I] SerializationOptions
[I] TCGCContext
[I] XmlSerializationOptions
Type aliases
[T] AccessFlags
[T] ArrayKnownEncoding
[T] CollectionFormat
[T] LanguageScopes
[T] SdkBuiltInKinds
[T] SdkDateTimeType
[T] SdkExampleValue
[T] SdkHttpPackage
[T] SdkHttpParameter
[T] SdkLroServiceFinalStep
[T] SdkMethod
[T] SdkServiceMethod
[T] SdkServiceOperation
[T] SdkTerminationStatus
[T] SdkType
Variables
[V] $access
[V] $alternateType
[V] $apiVersion
[V] $client
[V] $clientApiVersions
[V] $clientDefaultValue
[V] $clientDoc
[V] $clientInitialization
[V] $clientName
[V] $clientNamespace
[V] $clientOption
[V] $convenientAPI
[V] $deserializeEmptyStringAsNull
[V] $disablePageable
[V] $flattenProperty
[V] $legacyHierarchyBuilding
[V] $lib
[V] $linter
[V] $markAsLro
[V] $markAsPageable
[V] $nextLinkVerb
[V] $operationGroup
[V] $paramAlias
[V] $protocolAPI
[V] $responseAsBool
[V] $scope
[V] $usage
[V] $useSystemTextJsonConverter
[V] BrandedSdkEmitterOptions
[V] UnbrandedSdkEmitterOptions
[V] clientOptionKey
[V] createDiagnostic
[V] createStateSymbol
[V] namespace
[V] reportDiagnostic
Linter usage
Guideline for Client Emitter
Azure.Portal
Overview
Data types
Decorators
Js api
Functions
[F] $about
[F] $browse
[F] $displayName
[F] $marketplaceOffer
[F] $onValidate
[F] $promotion
[F] checkIsArmResource
[F] checkIsArmTrackedResource
[F] checkIsValidApiVersion
[F] getAbout
[F] getAboutDisplayNames
[F] getAboutKeywords
[F] getAboutLearnMoreDocs
[F] getBrowse
[F] getBrowseArgQuery
[F] getDisplayName
[F] getMarketplaceOfferId
[F] getPromotion
[F] isFileExist
[P] JS API
Interfaces
[I] AboutOptions
[I] BrowseOptions
[I] DisplayNamesOptions
[I] FilePath
[I] LearnMoreDocsOptions
[I] MarketplaceOfferOptions
[I] PromotionOptions
Variables
[V] $lib
[V] PortalCoreKeys
[V] namespace
🖨️ Emitters
Autorest / Swagger
Overview
Decorators
Emitter usage
Js api
Functions
[F] $onEmit
[F] getAllServicesAtAllVersions
[F] getExamples
[F] getOpenAPIForService
[F] getRef
[F] resolveAutorestOptions
[F] sortOpenAPIDocument
[P] JS API
Interfaces
[I] AutorestDocumentEmitterOptions
[I] AutorestEmitterContext
[I] AutorestEmitterOptions
[I] Example
[I] OpenAPI2ApiKeySecurityScheme
[I] OpenAPI2BasicAuthenticationSecurityScheme
[I] OpenAPI2BodyParameter
[I] OpenAPI2Document
[I] OpenAPI2Example
[I] OpenAPI2ExternalDocs
[I] OpenAPI2FormDataParameter
[I] OpenAPI2HeaderDefinition
[I] OpenAPI2HeaderParameter
[I] OpenAPI2Info
[I] OpenAPI2OAuth2AccessCodeSecurityScheme
[I] OpenAPI2OAuth2ApplicationSecurityScheme
[I] OpenAPI2OAuth2ImplicitSecurityScheme
[I] OpenAPI2OAuth2PasswordSecurityScheme
[I] OpenAPI2OAuthSecurityBase
[I] OpenAPI2ParameterBase
[I] OpenAPI2PathParameter
[I] OpenAPI2QueryParameter
[I] OpenAPI2Response
[I] OpenAPI2SecuritySchemeBase
[I] OpenAPI2Tag
[I] PrimitiveItems
[I] Ref
[I] XMSParameterizedHost
[I] XmlObject
Type aliases
[T] Extensions
[T] HttpMethod
[T] JsonType
[T] OpenAPI2FileSchema
[T] OpenAPI2OAuth2FlowType
[T] OpenAPI2Operation
[T] OpenAPI2Parameter
[T] OpenAPI2ParameterType
[T] OpenAPI2PathItem
[T] OpenAPI2Responses
[T] OpenAPI2Schema
[T] OpenAPI2SchemaProperty
[T] OpenAPI2SchemaRefProperty
[T] OpenAPI2SecurityRequirement
[T] OpenAPI2SecurityScheme
[T] OpenAPI2StatusCode
[T] Refable
[T] XMSLongRunningFinalState
[T] XMSLongRunningOperationOptions
[T] XmsPageable
Variables
[V] $example
[V] $lib
[V] $useRef
[V] namespace
Clients
Java
Overview
Emitter usage
Go
Overview
Emitter usage
Python
Overview
Emitter usage
CSharp
Overview
Emitter usage
JavaScript
Overview
Emitter usage
🔎 Troubleshoot
Duplicate Body Error When Instantiating `ProxyResourceOperations`
My enums are not extensible anymore
OneBranch SDL
`ProvisioningStateMustBeReadOnly` lintdiff violation in TypeSpec for ARM Service
How to suppress warnings
How can I change the operation template of an operation in newer versions
🚀 Release Notes
0.64.0
0.64.0
0.63.0
0.62.0
0.61.0
0.60.0
0.59.0
0.58.0
0.57.0
0.56.0
0.55.0
0.54.0
0.53.0
0.52.0 March 2025
0.51.0 February 2025
0.50.0 January 2025
0.49.0 December 2024
0.48.0 November 2024
0.47.0 October 2024
0.46.0 September 2024
0.45.0 August 2024
0.44.0 July 2024
0.43.0 June 2024
0.42.0 May 2024
0.41.0 March 2024
March 2024
February 2024
January 2024
December 2023
November 2023
October 2023
September 2023
August 2023
July 2023
June 2023
May 2023
April 2023
March 2023
February 2023
January 2023
December 2022
November 2022
October 2022
September 2022
August 2022
July 2022
Cadl to TypeSpec rename completed in March 2023 release
GitHub
Select theme
Dark
Light
Auto
[I] MarkAsPageableInfo
Properties
Section titled “Properties”
Property
Type
itemsProperty
ModelProperty