Data types
Azure.Core​
AadOauth2Auth​
Azure Active Directory OAuth2 Flow
model Azure.Core.AadOauth2Auth<Scopes, AuthUrl, TokenUrl>
Template Parameters​
| Name | Description |
|---|---|
| Scopes | A list of scopes the token applies to. |
| AuthUrl | The authorization URL. |
| TokenUrl | The token URL. |
Properties​
| Name | Type | Description |
|---|---|---|
| type | TypeSpec.Http.AuthType.oauth2 | OAuth2 authentication |
| flows | [Core.AadTokenAuthFlow<Scopes, AuthUrl, TokenUrl>] | Supported OAuth2 flows |
| defaultScopes | [] | Oauth2 scopes of every flow. Overridden by scope definitions in specific flows |
AadTokenAuthFlow​
Azure Active Directory (AAD) Token Authentication Flow
model Azure.Core.AadTokenAuthFlow<Scopes, AuthUrl, TokenUrl>
Template Parameters​
| Name | Description |
|---|---|
| Scopes | A list of scopes the token applies to. |
| AuthUrl | The authorization URL. |
| TokenUrl | The token URL. |
Properties​
| Name | Type | Description |
|---|---|---|
| type | TypeSpec.Http.OAuth2FlowType.authorizationCode | |
| authorizationUrl | AuthUrl | |
| tokenUrl | TokenUrl | |
| scopes | Scopes |
ArmResourceIdentifierAllowedResource​
model Azure.Core.ArmResourceIdentifierAllowedResource
Properties​
| Name | Type | Description |
|---|---|---|
| type | string | The type of resource that is being referred to. For example Microsoft.Network/virtualNetworks or Microsoft.Network/virtualNetworks/subnets. See Example Types for more examples. |
| scopes? | Core.ArmResourceDeploymentScope[] | An array of scopes. If not specified, the default scope is ["ResourceGroup"]. See Allowed Scopes. |
AzureApiKeyAuthentication​
Azure API Key Authentication using the "Ocp-Apim-Subscription-Key" hea
model Azure.Core.AzureApiKeyAuthentication
Properties​
| Name | Type | Description |
|---|---|---|
| type | TypeSpec.Http.AuthType.apiKey | API key authentication |
| in | TypeSpec.Http.ApiKeyLocation.header | location of the API key |
| name | "Ocp-Apim-Subscription-Key" | name of the API key |
ClientRequestIdHeader​
Provides the 'x-ms-client-request-id' header to enable request correlation in requests and responses.
model Azure.Core.ClientRequestIdHeader
Properties​
| Name | Type | Description |
|---|---|---|
| clientRequestId? | uuid | An opaque, globally-unique, client-generated string identifier for the request. |
ConditionalRequestHeaders​
Provides the 'If-*' headers to enable conditional (cached) responses
model Azure.Core.ConditionalRequestHeaders
Properties​
| Name | Type | Description |
|---|---|---|
| ifMatch? | string | The request should only proceed if an entity matches this string. |
| ifNoneMatch? | string | The request should only proceed if no entity matches this string. |
| ifUnmodifiedSince? | utcDateTime | The request should only proceed if the entity was not modified after this time. |
| ifModifiedSince? | utcDateTime | The request should only proceed if the entity was modified after this time. |
EmbeddingVector​
A vector embedding frequently used in similarity search.
model Azure.Core.EmbeddingVector<Element>
Template Parameters​
| Name | Description |
|---|---|
| Element | The element type of the embedding vector. |
Properties​
None
EtagProperty​
Provides the 'ETag' field to enable conditional (cached) requests. This model can be spread into responses and item models to convey the ETag when it cannot simply conveyed in a header.
model Azure.Core.EtagProperty
Properties​
| Name | Type | Description |
|---|---|---|
| etag | eTag | The entity tag for this resource. |
EtagResponseEnvelope​
Provides the 'ETag' header to enable conditional (cached) requests
model Azure.Core.EtagResponseEnvelope
Properties​
| Name | Type | Description |
|---|---|---|
| etagHeader? | string | The entity tag for the response. |
ExpandQueryParameter​
Provides the standard 'expand' query parameter for list operations.
model Azure.Core.ExpandQueryParameter
Properties​
| Name | Type | Description |
|---|---|---|
| expand? | string[] | Expand the indicated resources into the response. |
FilterParameter​
Provides the standard 'filter' query parameter for list operations
model Azure.Core.FilterParameter
Properties​
| Name | Type | Description |
|---|---|---|
| filter? | string | The maximum number of result items per page. |
FilterQueryParameter​
Provides the standard 'filter' query parameter for list operations.
model Azure.Core.FilterQueryParameter
Properties​
| Name | Type | Description |
|---|---|---|
| filter? | string | Filter the result list using the given expression. |
MaxPageSizeQueryParameter​
Provides the standard 'maxpagesize' query parameter for list operations.
model Azure.Core.MaxPageSizeQueryParameter
Properties​
| Name | Type | Description |
|---|---|---|
| maxpagesize? | int32 | The maximum number of result items per page. |
OrderByQueryParameter​
Provides the standard 'orderby' query parameter for list operations.
model Azure.Core.OrderByQueryParameter
Properties​
| Name | Type | Description |
|---|---|---|
| orderby? | string[] | Expressions that specify the order of returned results. |
Page​
Describes a page of resource object.
model Azure.Core.Page<Resource>
Template Parameters​
| Name | Description |
|---|---|
| Resource | The resource type. |
Properties​
| Name | Type | Description |
|---|---|---|
| value | Array<Element> | |
| nextLink? | TypeSpec.Rest.ResourceLocation |
PollingOptions​
Generic polling options for LRO operations.
model Azure.Core.PollingOptions
Properties​
| Name | Type | Description |
|---|---|---|
| kind | PollingOptionKind | The kind of polling options |
| pollingModel? | Model | void | The model that is returned when polling should continue. |
| finalResult? | Model | void | The type that is returned when polling terminates successfully. |
RepeatabilityRequestHeaders​
Provides the 'Repeatability-*' headers to enable repeatable requests.
model Azure.Core.RepeatabilityRequestHeaders
Properties​
| Name | Type | Description |
|---|---|---|
| repeatabilityRequestId? | string | An opaque, globally-unique, client-generated string identifier for the request. |
| repeatabilityFirstSent? | utcDateTime | Specifies the date and time at which the request was first created. |
RepeatabilityResponseHeaders​
Provides the 'Repeatability-*' headers to enable repeatable requests.
model Azure.Core.RepeatabilityResponseHeaders
Properties​
| Name | Type | Description |
|---|---|---|
| repeatabilityResult? | RepeatabilityResult | Indicates whether the repeatable request was accepted or rejected. |
RequestIdResponseHeader​
Provides the 'x-ms-request-id' header to enable request correlation in responses.
model Azure.Core.RequestIdResponseHeader
Properties​
| Name | Type | Description |
|---|---|---|
| requestId? | uuid | An opaque, globally-unique, server-generated string identifier for the request. |
RequestParameter​
Defines a property as a request parameter.
model Azure.Core.RequestParameter<Name>
Template Parameters​
| Name | Description |
|---|---|
| Name | The parameter name. |
Properties​
None
ResourceOperationStatus​
model Azure.Core.ResourceOperationStatus<Resource, StatusResult, StatusError>
Template Parameters​
| Name | Description |
|---|---|
| Resource | The resource type. |
| StatusResult | Model describing the status result object. If not specified, the default is the resource type. |
| StatusError | Model describing the status error object. If not specified, the default is the Foundations.Error. |
Properties​
| Name | Type | Description |
|---|---|---|
| id | string | |
| status | OperationState | |
| error? | StatusError | |
| result? | StatusResult |
ResponseProperty​
Defines a property as a response header.
model Azure.Core.ResponseProperty<Name>
Template Parameters​
| Name | Description |
|---|---|
| Name | The header name. |
Properties​
None
SelectQueryParameter​
Provides the standard 'select' query parameter for list operations.
model Azure.Core.SelectQueryParameter
Properties​
| Name | Type | Description |
|---|---|---|
| select? | string[] | Select the specified fields to be included in the response. |
SkipQueryParameter​
Provides the standard 'skip' query parameter for list operations.
model Azure.Core.SkipQueryParameter
Properties​
| Name | Type | Description |
|---|---|---|
| skip? | int32 | The number of result items to skip. |
StandardListQueryParameters​
Provides the most common query parameters for list operations.
model Azure.Core.StandardListQueryParameters
Properties​
| Name | Type | Description |
|---|---|---|
| top? | int32 | The number of result items to return. |
| skip? | int32 | The number of result items to skip. |
| maxpagesize? | int32 | The maximum number of result items per page. |
StatusMonitorOptions​
Options for Lro status monitors.
model Azure.Core.StatusMonitorOptions
Properties​
| Name | Type | Description |
|---|---|---|
| kind | "statusMonitor" | The kind of polling options |
| finalProperty? | ModelProperty | string | A reference to or name of the property of the status monitor that contains the response |
StatusMonitorPollingOptions​
Options for overriding a polling endpoint that uses a StatusMonitor
model Azure.Core.StatusMonitorPollingOptions<PollingModel, FinalResult, FinalProperty>
Template Parameters​
| Name | Description |
|---|---|
| PollingModel | The model that is returned when polling should continue. |
| FinalResult | The model that is returned when polling terminates successfully. |
| FinalProperty | The property of the status monitor that contains results. |
Properties​
| Name | Type | Description |
|---|---|---|
| kind | "statusMonitor" | The kind of polling options |
| pollingModel | PollingModel | The model that is returned when polling should continue |
| finalResult | FinalResult | The model that is returned when polling terminates successfully |
| finalProperty | FinalProperty | The property of the status monitor that contains results |
TopQueryParameter​
Provides the standard 'top' query parameter for list operations.
model Azure.Core.TopQueryParameter
Properties​
| Name | Type | Description |
|---|---|---|
| top? | int32 | The number of result items to return. |
Versions​
Supported versions of Azure.Core TypeSpec building blocks.
enum Azure.Core.Versions
ArmResourceDeploymentScope​
union Azure.Core.ArmResourceDeploymentScope
PollingOptionKind​
The available kinds of polling options
union Azure.Core.PollingOptionKind
RepeatabilityResult​
Repeatability Result header options
union Azure.Core.RepeatabilityResult
armResourceIdentifier​
A type definition that refers the id to an Azure Resource Manager resource.
Sample usage: otherArmId: ResourceIdentifier; networkId: ResourceIdentifier<[{type:"\Microsoft.Network\vnet"}]> vmIds: ResourceIdentifier<[{type:"\Microsoft.Compute\vm", scopes["*"]}]>
scalar Azure.Core.armResourceIdentifier
azureLocation​
Represents an Azure geography region where supported resource providers live.
scalar Azure.Core.azureLocation
Examples​
WestUS
eTag​
The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource. It lets caches be more efficient and save bandwidth, as a web server does not need to resend a full response if the content was not changed.
It is a string of ASCII characters placed between double quotes, like "675af34563dc-tr34".
scalar Azure.Core.eTag
Examples​
In ETag header​
ETag: "675af34563dc-tr34"
ipV4Address​
Represent an IP V4 address serialized as a string.
It is formatted as four 8-bit fields separated by periods.
scalar Azure.Core.ipV4Address
Examples​
129.144.50.56
ipV6Address​
Represent an IP V6 address serialized as a string.
It is formatted as eight hex decimal values(16-bit) between 0 and FFFF separated by colon. (i.e. y:y:y:y:y:y:y:y)
scalar Azure.Core.ipV6Address
Examples​
2001:db8:3333:4444:CCCC:DDDD:EEEE:FFFF
uuid​
Universally Unique Identifier
scalar Azure.Core.uuid
Examples​
123e4567-e89b-12d3-a456-426614174000
Azure.Core.Foundations​
ApiVersionParameter​
The ApiVersion query parameter.
model Azure.Core.Foundations.ApiVersionParameter
Properties​
| Name | Type | Description |
|---|---|---|
| apiVersion | string | The API version to use for this operation. |
CollectionKeysOf​
A model containing the collection keys of the provided resource's parent resource.
model Azure.Core.Foundations.CollectionKeysOf<Resource>
Template Parameters​
| Name | Description |
|---|---|
| Resource | The type of the resource. |
Properties​
None
CreateableAndUpdateableProperties​
Collection of properties from a resource that are visible to create or update scopes.
model Azure.Core.Foundations.CreateableAndUpdateableProperties<Resource>
Template Parameters​
| Name | Description |
|---|---|
| Resource | The type of the resource. |
Properties​
None
CustomizationFields​
The expected shape of model types passed to the Custom parameter of operation signatures.
model Azure.Core.Foundations.CustomizationFields
Properties​
| Name | Type | Description |
|---|---|---|
| parameters? | {} | An object containing custom parameters that will be included in the operation. |
| response? | {} | An object containing custom properties that will be included in the response. |
CustomPage​
A model describing a customized page of resources.
model Azure.Core.Foundations.CustomPage<Resource, Traits>
Template Parameters​
| Name | Description |
|---|---|
| Resource | The type of the resource. |
| Traits | Traits which apply to the page. |
Properties​
| Name | Type | Description |
|---|---|---|
| value | Array<Element> | |
| nextLink? | TypeSpec.Rest.ResourceLocation |
CustomParameters​
A model describing a set of custom request parameters.
model Azure.Core.Foundations.CustomParameters<Custom>
Template Parameters​
| Name | Description |
|---|---|
| Custom | An object describing custom request parameters. |
Properties​
None
CustomResponseFields​
A model describing a set of custom response properties.
model Azure.Core.Foundations.CustomResponseFields<Custom>
Template Parameters​
| Name | Description |
|---|---|
| Custom | An object describing custom response properties. |
Properties​
None
Error​
The error object.
model Azure.Core.Foundations.Error
Properties​
| Name | Type | Description |
|---|---|---|
| code | string | One of a server-defined set of error codes. |
| message | string | A human-readable representation of the error. |
| target? | string | The target of the error. |
| details? | Core.Foundations.Error[] | An array of details about specific errors that led to this reported error. |
| innererror? | InnerError | An object containing more specific information than the current object about the error. |
ErrorResponse​
A response containing error details.
model Azure.Core.Foundations.ErrorResponse
Properties​
| Name | Type | Description |
|---|---|---|
| error | Error | The error object. |
| errorCode? | string | String error code indicating what went wrong. |
ErrorResponseBase​
A response containing error details.
model Azure.Core.Foundations.ErrorResponseBase<Error>
Template Parameters​
| Name | Description |
|---|---|
| Error | The type of the error object. |
Properties​
| Name | Type | Description |
|---|---|---|
| error | Error | |
| errorCode? | string |
InnerError​
An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
model Azure.Core.Foundations.InnerError
Properties​
| Name | Type | Description |
|---|---|---|
| code? | string | One of a server-defined set of error codes. |
| innererror? | InnerError | Inner error. |
ItemKeysOf​
A model containing the keys of the provided resource.
model Azure.Core.Foundations.ItemKeysOf<Resource>
Template Parameters​
| Name | Description |
|---|---|
| Resource | The type of the resource. |
Properties​
None
LocationOfCreatedResourceResponse​
Response describing the location of a created resource.
model Azure.Core.Foundations.LocationOfCreatedResourceResponse<Resource>
Template Parameters​
| Name | Description |
|---|---|
| Resource |
Properties​
| Name | Type | Description |
|---|---|---|
| statusCode | 201 | The status code. |
| location | TypeSpec.Rest.ResourceLocation |
LocationOfCreatedResourceWithServiceProvidedNameResponse​
Response describing the location of a resource created with a service-provided name.
model Azure.Core.Foundations.LocationOfCreatedResourceWithServiceProvidedNameResponse<Resource>
Template Parameters​
| Name | Description |
|---|---|
| Resource |
Properties​
| Name | Type | Description |
|---|---|---|
| statusCode | 202 | The status code. |
| location | TypeSpec.Rest.ResourceLocation |
LongRunningStatusLocation​
Metadata for long running operation status monitor locations.
model Azure.Core.Foundations.LongRunningStatusLocation<StatusResult>
Template Parameters​
| Name | Description |
|---|---|
| StatusResult | The type of the operation status result. |
Properties​
| Name | Type | Description |
|---|---|---|
| operationLocation | TypeSpec.Rest.ResourceLocation |
OperationStatus​
Provides status details for long running operations.
model Azure.Core.Foundations.OperationStatus<StatusResult, StatusError>
Template Parameters​
| Name | Description |
|---|---|
| StatusResult | The type of the operation status result. |
| StatusError | The type of the operation status error. If not provided, the default error is used. |
Properties​
| Name | Type | Description |
|---|---|---|
| id | string | |
| status | OperationState | |
| error? | StatusError | |
| result? | StatusResult |
ResourceBody​
Conveys the resource instance to an operation as a request body.
model Azure.Core.Foundations.ResourceBody<Resource>
Template Parameters​
| Name | Description |
|---|---|
| Resource | The type of the resource instance. |
Properties​
| Name | Type | Description |
|---|---|---|
| resource | Resource |
ResourceCreateOrReplaceModel​
Version of a model for a create or replace operation which only includes updateable properties.
model Azure.Core.Foundations.ResourceCreateOrReplaceModel<Resource>
Template Parameters​
| Name | Description |
|---|---|
| Resource | The type of the resource. |
Properties​
None
ResourceCreateOrUpdateModel​
Version of a model for a create or update operation which only includes updateable properties.
model Azure.Core.Foundations.ResourceCreateOrUpdateModel<Resource>
Template Parameters​
| Name | Description |
|---|---|
| Resource | The type of the resource. |
Properties​
None
ResourceUpdateModel​
Version of a model for an update operation which only includes updateable properties.
model Azure.Core.Foundations.ResourceUpdateModel<Resource>
Template Parameters​
| Name | Description |
|---|---|
| Resource | The type of the resource. |
Properties​
None
RetryAfterHeader​
The retry-after envelope.
model Azure.Core.Foundations.RetryAfterHeader
Properties​
| Name | Type | Description |
|---|---|---|
| retryAfter? | int32 | The Retry-After header can indicate how long the client should wait before polling the operation status. |
OperationState​
Enum describing allowed operation states.
union Azure.Core.Foundations.OperationState
Azure.Core.Traits​
ListQueryParametersTrait​
Declares a trait that is applied as a query parameter for list operations.
model Azure.Core.Traits.ListQueryParametersTrait<Parameters>
Template Parameters​
| Name | Description |
|---|---|
| Parameters | Object describing the query parameters. |
Properties​
| Name | Type | Description |
|---|---|---|
| queryParams | {...} | |
| queryParams.parameters | Parameters |
NoClientRequestId​
Indicates that the service or operation does not support clientRequestId headers.
model Azure.Core.Traits.NoClientRequestId
Properties​
| Name | Type | Description |
|---|---|---|
| clientRequestId | {} |
NoConditionalRequests​
Indicates that the service or operation does not support conditional requests.
model Azure.Core.Traits.NoConditionalRequests
Properties​
| Name | Type | Description |
|---|---|---|
| conditionalRequests | {} |
NoRepeatableRequests​
Indicates that the service or operation does not support repeatable requests.
model Azure.Core.Traits.NoRepeatableRequests
Properties​
| Name | Type | Description |
|---|---|---|
| repeatableRequests | {} |
QueryParametersTrait​
Declares a trait that is applied as a query parameter.
model Azure.Core.Traits.QueryParametersTrait<Parameters, Contexts>
Template Parameters​
| Name | Description |
|---|---|
| Parameters | The name of the query parameter. |
| Contexts | The contexts in which the trait is applicable. |
Properties​
| Name | Type | Description |
|---|---|---|
| queryParams | {...} | |
| queryParams.parameters | Parameters |
RequestHeadersTrait​
Declares a trait that is applied as a request header parameter.
model Azure.Core.Traits.RequestHeadersTrait<Headers, Contexts>
Template Parameters​
| Name | Description |
|---|---|
| Headers | Object describing the request header parameters. |
| Contexts | The contexts in which the trait is applicable. |
Properties​
| Name | Type | Description |
|---|---|---|
| requestHeaders | {...} | |
| requestHeaders.parameters | Headers |
ResponseHeadersTrait​
Declares a trait that is applied as a response header parameter.
model Azure.Core.Traits.ResponseHeadersTrait<Headers, Contexts>
Template Parameters​
| Name | Description |
|---|---|
| Headers | Object describing the response header parameters. |
| Contexts | The contexts in which the trait is applicable. |
Properties​
| Name | Type | Description |
|---|---|---|
| responseHeaders | {...} | |
| responseHeaders.parameters | Headers |
SupportsClientRequestId​
Provides clientRequestId headers for requests and responses.
model Azure.Core.Traits.SupportsClientRequestId<VersionAdded>
Template Parameters​
| Name | Description |
|---|---|
| VersionAdded | The version when the trait was added to the specification. Leave this empty if the trait is always supported. |
Properties​
| Name | Type | Description |
|---|---|---|
| clientRequestId | {...} | |
| clientRequestId.parameters | ClientRequestIdHeader | |
| clientRequestId.response | ClientRequestIdHeader |
SupportsConditionalRequests​
Provides conditional request headers for requests and ETag headers for responses.
model Azure.Core.Traits.SupportsConditionalRequests<VersionAdded>
Template Parameters​
| Name | Description |
|---|---|
| VersionAdded | The version when the trait was added to the specification. Leave this empty if the trait is always supported. |
Properties​
| Name | Type | Description |
|---|---|---|
| conditionalRequests | {...} | |
| conditionalRequests.parameters | ConditionalRequestHeaders | |
| conditionalRequests.response | EtagResponseEnvelope |
SupportsRepeatableRequests​
Provides repeatable request headers for requests and responses.
model Azure.Core.Traits.SupportsRepeatableRequests<VersionAdded>
Template Parameters​
| Name | Description |
|---|---|
| VersionAdded | The version when the trait was added to the specification. Leave this empty if the trait is always supported. |
Properties​
| Name | Type | Description |
|---|---|---|
| repeatableRequests | {...} | |
| repeatableRequests.parameters | RepeatabilityRequestHeaders | |
| repeatableRequests.response | RepeatabilityResponseHeaders |
TraitOverride​
Used to override a trait.
model Azure.Core.Traits.TraitOverride<Trait>
Template Parameters​
| Name | Description |
|---|---|
| Trait | The trait to override. |
Properties​
None
VersionParameterTrait​
Declares a version parameter trait.
model Azure.Core.Traits.VersionParameterTrait<VersionParameter>
Template Parameters​
| Name | Description |
|---|---|
| VersionParameter | The type of the version parameter. |
Properties​
| Name | Type | Description |
|---|---|---|
| versionParameter | {...} | |
| versionParameter.apiVersionParam | VersionParameter |
TraitContext​
Enumerates the standard trait contexts for Azure.Core operations.
enum Azure.Core.Traits.TraitContext
TraitLocation​
Enumerates the standard trait locations for Azure.Core operations.
enum Azure.Core.Traits.TraitLocation