Data types
Azure.ResourceManager​
ArmAcceptedLroResponse
​
model Azure.ResourceManager.ArmAcceptedLroResponse<Description, LroHeaders>
Template Parameters​
Name | Description |
---|
Description | The description of the response status (defaults to Resource operation accepted ) |
LroHeaders | Optional. The lro headers that appear in the Accepted response |
Properties​
Name | Type | Description |
---|
statusCode | 202 | The status code. |
ArmAcceptedResponse
​
model Azure.ResourceManager.ArmAcceptedResponse<Message, ExtraHeaders>
Template Parameters​
Name | Description |
---|
Message | The description of the response status (defaults to Resource operation accepted ) |
ExtraHeaders | Additional headers in the response. Default includes Retry-After header |
Properties​
Name | Type | Description |
---|
statusCode | 202 | The status code. |
The standard header for asynchronous operation polling
model Azure.ResourceManager.ArmAsyncOperationHeader<StatusMonitor, UrlValue, FinalResult>
Template Parameters​
Name | Description |
---|
StatusMonitor | The status monitor type for lro polling |
UrlValue | The value type of the Azure-AsyncOperation header |
FinalResult | The logical final result of the operation |
Properties​
Name | Type | Description |
---|
azureAsyncOperation? | UrlValue | A link to the status monitor |
Provide Both Azure-AsyncOperation and Location headers
model Azure.ResourceManager.ArmCombinedLroHeaders<StatusMonitor, FinalResult, PollingUrlValue, FinalUrlValue>
Template Parameters​
Name | Description |
---|
StatusMonitor | The type of the polling StatusMonitor when following the Azure-AsyncOperation url |
FinalResult | The type of the logical result when following the location header |
PollingUrlValue | The value type of the link to the status monitor |
FinalUrlValue | The value type fo the link to the final result |
Properties​
Name | Type | Description |
---|
azureAsyncOperation? | PollingUrlValue | A link to the status monitor |
location? | FinalUrlValue | The Location header contains the URL where the status of the long running operation can be checked. |
ArmCreatedResponse
​
The Azure Resource Manager 201 response for a resource
model Azure.ResourceManager.ArmCreatedResponse<ResponseBody, ExtraHeaders>
Template Parameters​
Name | Description |
---|
ResponseBody | The contents of the response body |
ExtraHeaders | Additional headers in the response. Default includes Retry-After header |
Properties​
Name | Type | Description |
---|
statusCode | 201 | The status code. |
body | ResponseBody | |
ArmDeleteAcceptedLroResponse
​
model Azure.ResourceManager.ArmDeleteAcceptedLroResponse<LroHeaders>
Template Parameters​
Name | Description |
---|
LroHeaders | Optional. Allows overriding the Lro headers returned in the response. |
Properties​
Name | Type | Description |
---|
statusCode | 202 | The status code. |
ArmDeleteAcceptedResponse
​
model Azure.ResourceManager.ArmDeleteAcceptedResponse
Properties​
Name | Type | Description |
---|
statusCode | 202 | The status code. |
retryAfter? | int32 | The Retry-After header can indicate how long the client should wait before polling the operation status. |
ArmDeletedNoContentResponse
​
model Azure.ResourceManager.ArmDeletedNoContentResponse
Properties​
Name | Type | Description |
---|
statusCode | 204 | The status code. |
ArmDeletedResponse
​
The response for synchronous delete of a resource
model Azure.ResourceManager.ArmDeletedResponse
Properties​
Name | Type | Description |
---|
statusCode | 200 | The status code. |
ArmLocationResource
​
Template for ARM location resources. Use the parameter to specify
model Azure.ResourceManager.ArmLocationResource<BaseType>
Template Parameters​
Properties​
Name | Type | Description |
---|
location | string | The name of the Azure region. |
The default header for lro PUT and DELETE polling
model Azure.ResourceManager.ArmLroLocationHeader<LroPollingOptions, FinalResult, UrlValue>
Template Parameters​
Name | Description |
---|
LroPollingOptions | The polling options when polling the url in the location header |
FinalResult | The ultimate final result of the logical operation |
UrlValue | The value type for the location header |
Properties​
Name | Type | Description |
---|
location? | UrlValue | The Location header contains the URL where the status of the long running operation can be checked. |
ArmNoContentResponse
​
Standard Azure Resource Manager NoContent (204) response
model Azure.ResourceManager.ArmNoContentResponse<Message>
Template Parameters​
Name | Description |
---|
Message | The description of the response status (defaults to Operation completed successfully ) |
Properties​
Name | Type | Description |
---|
statusCode | 204 | The status code. |
ArmOperationStatus
​
Standard Azure Resource Manager operation status response
model Azure.ResourceManager.ArmOperationStatus<Properties, StatusValues>
Template Parameters​
Name | Description |
---|
Properties | Optional resource-specific properties |
StatusValues | The set of allowed values for operation status |
Properties​
Name | Type | Description |
---|
properties? | Properties | RP-specific properties for the operationStatus resource, only appears when operation ended with Succeeded status |
status | StatusValues | The operation status |
id | Core.uuid | The unique identifier for the operationStatus resource |
name? | string | The name of the operationStatus resource |
startTime? | utcDateTime | Operation start time |
endTime? | utcDateTime | Operation complete time |
percentComplete? | float64 | The progress made toward completing the operation |
error? | ErrorDetail | Errors that occurred if the operation ended with Canceled or Failed status |
ArmResourceCreatedResponse
​
model Azure.ResourceManager.ArmResourceCreatedResponse<Resource, LroHeaders>
Template Parameters​
Name | Description |
---|
Resource | The resource being updated |
LroHeaders | Optional. The lro headers returned with a Created response |
Properties​
Name | Type | Description |
---|
statusCode | 201 | The status code. |
body | Resource | |
ArmResourceCreatedSyncResponse
​
model Azure.ResourceManager.ArmResourceCreatedSyncResponse<Resource>
Template Parameters​
Name | Description |
---|
Resource | The resource being updated |
Properties​
Name | Type | Description |
---|
statusCode | 201 | The status code. |
body | Resource | |
ArmResourceExistsResponse
​
model Azure.ResourceManager.ArmResourceExistsResponse
Properties​
Name | Type | Description |
---|
statusCode | 204 | The status code. |
ArmResourceNotFoundResponse
​
model Azure.ResourceManager.ArmResourceNotFoundResponse
Properties​
Name | Type | Description |
---|
statusCode | 404 | The status code. |
ArmResourceUpdatedResponse
​
model Azure.ResourceManager.ArmResourceUpdatedResponse<Resource>
Template Parameters​
Name | Description |
---|
Resource | The resource being updated |
Properties​
Name | Type | Description |
---|
statusCode | 200 | The status code. |
body | Resource | |
ArmResponse
​
The Azure Resource Manager synchronous OK response
model Azure.ResourceManager.ArmResponse<ResponseBody>
Template Parameters​
Name | Description |
---|
ResponseBody | The contents of the response body |
Properties​
Name | Type | Description |
---|
statusCode | 200 | The status code. |
body | ResponseBody | |
DefaultProvisioningStateProperty
​
Standard resource provisioning state model. If you do not have any custom provisioning state,
you can spread this model directly into your resource property model.
model Azure.ResourceManager.DefaultProvisioningStateProperty
Examples​
model FooProperties {
...DefaultProvisioningStateProperty;
}
Properties​
EncryptionProperty
​
Model used only to spread in the encryption
envelope property for a resource.
All encryption configuration for a resource.
model Azure.ResourceManager.EncryptionProperty
Examples​
model Foo is TrackedResource<FooProperties> {
...Encryption;
}
Properties​
Name | Type | Description |
---|
encryption | Encryption | All encryption configuration for a resource. |
EntityTagProperty
​
Model used only to spread in the standard eTag
envelope property for a resource
model Azure.ResourceManager.EntityTagProperty
Examples​
model Foo is TrackedResource<FooProperties> {
...EntityTagProperty;
}
Properties​
Name | Type | Description |
---|
eTag? | string | If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. |
ExtendedLocationProperty
​
Model representing the standard extendedLocation
envelope property for a resource.
Spread this model into a Resource Model, if the resource supports extended locations
model Azure.ResourceManager.ExtendedLocationProperty
Examples​
model Employee is TrackedResource<EmployeeProperties> {
...ResourceNameParameter<Employee>;
...ExtendedLocationProperty;
}
Properties​
ExtensionResource
​
Concrete extension resource types can be created by aliasing this type using a specific property type.
See more details on different Azure Resource Manager resource type here.
model Azure.ResourceManager.ExtensionResource<Properties>
Template Parameters​
Name | Description |
---|
Properties | A model containing the provider-specific properties for this resource |
Properties​
Name | Type | Description |
---|
properties? | Properties | |
Extracts the key (path) parameters from a resource and its parents
model Azure.ResourceManager.KeysOf<Resource>
Template Parameters​
Name | Description |
---|
Resource | The resource to extract properties from |
Properties​
None
LocationParameter
​
DEPRECATED - DO NOT USE
The default location parameter type.
model Azure.ResourceManager.LocationParameter
Properties​
Name | Type | Description |
---|
location | string | The location name. |
ManagedByProperty
​
Model representing the standard managedBy
envelope property for a resource.
Spread this model into a resource model if the resource is managed by another entity.
model Azure.ResourceManager.ManagedByProperty
Examples​
model Foo is TrackedResource<FooProperties> {
...ManagedByProperty;
}
Properties​
Name | Type | Description |
---|
managedBy? | string | The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource. |
ManagedServiceIdentityProperty
​
Model representing the standard ManagedServiceIdentity
envelope property for a resource.
Spread this model into a resource model if the resource supports both system-assigned and user-assigned managed identities.
model Azure.ResourceManager.ManagedServiceIdentityProperty
Examples​
model Foo is TrackedResource<FooProperties> {
...ResourceNameParameter<Foo>;
...ManagedServiceIdentityProperty;
}
Properties​
ManagedSystemAssignedIdentityProperty
​
Model representing the standard SystemAssignedServiceIdentity
envelope property for a resource.
Spread this model into a resource model if the resource supports system-assigned managed identities
but does not support user-assigned managed identities.
model Azure.ResourceManager.ManagedSystemAssignedIdentityProperty
Examples​
model Foo is TrackedResource<FooProperties> {
...ResourceNameParameter<Foo>;
...ManagedSystemAssignedIdentityProperty;
}
Properties​
ParentKeysOf
​
Extracts the key (path) parameters from the parent(s) of the given resource
model Azure.ResourceManager.ParentKeysOf<Resource>
Template Parameters​
Name | Description |
---|
Resource | The resource to extract properties from |
Properties​
None
ProviderNamespace
​
Model describing the provider namespace.
model Azure.ResourceManager.ProviderNamespace<Resource>
Template Parameters​
Name | Description |
---|
Resource | The resource provided by the namespace. |
Properties​
Name | Type | Description |
---|
provider | "Microsoft.ThisWillBeReplaced" | |
ProxyResource
​
Concrete proxy resource types can be created by aliasing this type using a specific property type.
See more details on different Azure Resource Manager resource type here.
model Azure.ResourceManager.ProxyResource<Properties>
Template Parameters​
Name | Description |
---|
Properties | A model containing the provider-specific properties for this resource |
Properties​
Name | Type | Description |
---|
properties? | Properties | |
ResourceGroupLocationResource
​
The location resource for resourceGroup-based locations. This can be used as a parent
resource for resource types that are homed in a resourceGroup-based location.
model Azure.ResourceManager.ResourceGroupLocationResource
Properties​
Name | Type | Description |
---|
location | string | The name of the Azure region. |
ResourceInstanceParameters
​
The dynamic parameters of a resource instance - pass in the proper base type to indicate
where the resource is based. The default is in a resource group
model Azure.ResourceManager.ResourceInstanceParameters<Resource, BaseParameters>
Template Parameters​
Name | Description |
---|
Resource | The resource to get parameters for |
BaseParameters | The parameters representing the base Uri of the resource |
Properties​
Name | Type | Description |
---|
provider | "Microsoft.ThisWillBeReplaced" | |
ResourceKindProperty
​
Model representing the standard kind
envelope property for a resource.
Spread this model into a resource model if the resource support ARM kind
.
model Azure.ResourceManager.ResourceKindProperty
Examples​
model Foo is TrackedResource<FooProperties> {
...ResourceKindProperty;
}
Properties​
Name | Type | Description |
---|
kind? | string | Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. |
ResourceListResult
​
Paged response containing resources
model Azure.ResourceManager.ResourceListResult<Resource>
Template Parameters​
Name | Description |
---|
Resource | The type of the values returned in the paged response (must be a resource) |
Properties​
Name | Type | Description |
---|
value | Array<Element> | |
nextLink? | TypeSpec.Rest.ResourceLocation | |
ResourceNameParameter
​
Spread this model into ARM resource models to specify resource name parameter for its operations. If Resource
parameter
is specified, the resource name will be properly camel cased and pluralized for @key
and @segment
automatically. You can also apply explicit override with KeyName
and SegmentName
template parameters.
For additional decorators such as
model Azure.ResourceManager.ResourceNameParameter<Resource, KeyName, SegmentName, NamePattern, Type>
Template Parameters​
Name | Description |
---|
Resource | The ARM resource this name parameter is applying to. |
KeyName | Override default key name of the resource. |
SegmentName | Override default segment name of the resource. |
NamePattern | The RegEx pattern of the name. Default is ^[a-zA-Z0-9-]{3,24}$ . |
Type | The type of the name property. Default type is string. However you can pass an union with string values. |
Properties​
Name | Type | Description |
---|
name | Type | |
ResourceParentParameters
​
The dynamic parameters of a list call for a resource instance - pass in the proper base type to indicate
where the list should take place. The default is in a resource group
model Azure.ResourceManager.ResourceParentParameters<Resource, BaseParameters>
Template Parameters​
Name | Description |
---|
Resource | The resource to get parameters for |
BaseParameters | The parameters representing the base Uri of the resource |
Properties​
Name | Type | Description |
---|
provider | "Microsoft.ThisWillBeReplaced" | |
ResourcePlanProperty
​
Model representing the standard plan
envelope property for a resource.
Spread this model into a resource Model if the resource supports ARM plan
.
model Azure.ResourceManager.ResourcePlanProperty
Examples​
model Foo is TrackedResource<FooProperties> {
...ResourcePlanProperty;
}
Properties​
Name | Type | Description |
---|
plan? | Plan | Details of the resource plan. |
ResourceSkuProperty
​
Model representing the standard sku
envelope property for a resource.
Spread this model into a resource model if the resource supports standard ARM sku
.
model Azure.ResourceManager.ResourceSkuProperty
Examples​
model Foo is TrackedResource<FooProperties> {
...ResourceSkuProperty;
}
Properties​
Name | Type | Description |
---|
sku? | Sku | The SKU (Stock Keeping Unit) assigned to this resource. |
ResourceUriParameter
​
The default resourceUri parameter type.
model Azure.ResourceManager.ResourceUriParameter
Properties​
Name | Type | Description |
---|
resourceUri | string | The fully qualified Azure Resource manager identifier of the resource. |
SubscriptionLocationResource
​
The location resource for subscription-based locations. This can be used as a parent
resource for resource types that are homed in a subscription-based location.
model Azure.ResourceManager.SubscriptionLocationResource
Properties​
Name | Type | Description |
---|
location | string | The name of the Azure region. |
TenantLocationResource
​
The location resource for tenant-based locations. This can be used as a parent
resource for resource types that are homed in a tenant-based location.
model Azure.ResourceManager.TenantLocationResource
Properties​
Name | Type | Description |
---|
location | string | The name of the Azure region. |
TrackedResource
​
Concrete tracked resource types can be created by aliasing this type using a specific property type.
See more details on different Azure Resource Manager resource type here.
model Azure.ResourceManager.TrackedResource<Properties>
Template Parameters​
Name | Description |
---|
Properties | A model containing the provider-specific properties for this resource |
Properties​
Name | Type | Description |
---|
properties? | Properties | |
Versions
​
Supported versions of Azure.ResourceManager building blocks.
enum Azure.ResourceManager.Versions
ResourceProvisioningState
​
Standard terminal provisioning state of resource type. You can include in your
custom provision state to avoid duplication and ensure consistency
union Azure.ResourceManager.ResourceProvisioningState
Examples​
union FooProvisioningState {
ResourceProvisioningState,
starting: "starting",
started: "started",
stopping: "stopping",
stopped: "stopped",
}
Azure.ResourceManager.CommonTypes​
ApiVersionParameter
​
The default api-version parameter type.
model Azure.ResourceManager.CommonTypes.ApiVersionParameter
Properties​
Name | Type | Description |
---|
apiVersion | string | The API version to use for this operation. |
AzureEntityResource
​
The resource model definition for an Azure Resource Manager resource with an etag.
model Azure.ResourceManager.CommonTypes.AzureEntityResource
Properties​
Name | Type | Description |
---|
etag? | string | Resource Etag. |
CheckNameAvailabilityRequest
​
The check availability request body.
model Azure.ResourceManager.CommonTypes.CheckNameAvailabilityRequest
Properties​
Name | Type | Description |
---|
name? | string | The name of the resource for which availability needs to be checked. |
type? | string | The resource type. |
CheckNameAvailabilityResponse
​
The check availability result.
model Azure.ResourceManager.CommonTypes.CheckNameAvailabilityResponse
Properties​
Name | Type | Description |
---|
nameAvailable? | boolean | Indicates if the resource name is available. |
reason? | CheckNameAvailabilityReason | The reason why the given name is not available. |
message? | string | Detailed reason why the given name is not available. |
CustomerManagedKeyEncryption
​
Customer-managed key encryption properties for the resource.
model Azure.ResourceManager.CommonTypes.CustomerManagedKeyEncryption
Properties​
Encryption
​
(Optional) Discouraged to include in resource definition. Only needed where it is possible to disable platform (AKA infrastructure) encryption. Azure SQL TDE is an example of this. Values are enabled and disabled.
model Azure.ResourceManager.CommonTypes.Encryption
Properties​
EncryptionProperties
​
Configuration of key for data encryption
model Azure.ResourceManager.CommonTypes.EncryptionProperties
Properties​
Name | Type | Description |
---|
status? | EncryptionStatus | Indicates whether or not the encryption is enabled for container registry. |
keyVaultProperties? | KeyVaultProperties | Key vault properties. |
ErrorAdditionalInfo
​
The resource management error additional info.
model Azure.ResourceManager.CommonTypes.ErrorAdditionalInfo
Properties​
Name | Type | Description |
---|
type? | string | The additional info type. |
info? | {} | The additional info. |
ErrorDetail
​
The error detail.
model Azure.ResourceManager.CommonTypes.ErrorDetail
Properties​
Name | Type | Description |
---|
code? | string | The error code. |
message? | string | The error message. |
target? | string | The error target. |
details? | ResourceManager.CommonTypes.ErrorDetail[] | The error details. |
additionalInfo? | ResourceManager.CommonTypes.ErrorAdditionalInfo[] | The error additional info. |
ErrorResponse
​
Common error response for all Azure Resource Manager APIs to return error details for failed operations.
model Azure.ResourceManager.CommonTypes.ErrorResponse
Properties​
ExtendedLocation
​
The complex type of the extended location.
model Azure.ResourceManager.CommonTypes.ExtendedLocation
Properties​
Name | Type | Description |
---|
name | string | The name of the extended location. |
type | ExtendedLocationType | The type of the extended location. |
ExtensionResource
​
The base extension resource.
model Azure.ResourceManager.CommonTypes.ExtensionResource
Properties​
None
Identity
​
Identity for the resource.
model Azure.ResourceManager.CommonTypes.Identity
Properties​
Name | Type | Description |
---|
principalId? | Core.uuid | The principal ID of resource identity. The value must be an UUID. |
tenantId? | Core.uuid | The tenant ID of resource. The value must be an UUID. |
type? | ResourceIdentityType | The identity type. |
The default ARM If-Match header type.
model Azure.ResourceManager.CommonTypes.IfMatchHeader
Properties​
Name | Type | Description |
---|
ifMatch | string | The If-Match header that makes a request conditional. |
The default ARM If-Match header type.
model Azure.ResourceManager.CommonTypes.IfNoneMatchHeader
Properties​
Name | Type | Description |
---|
ifNoneMatch | string | The If-None-Match header that makes a request conditional. |
KeyEncryptionKeyIdentity
​
All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.
model Azure.ResourceManager.CommonTypes.KeyEncryptionKeyIdentity
Properties​
Name | Type | Description |
---|
identityType? | KeyEncryptionKeyIdentityType | The type of identity to use. Values can be systemAssignedIdentity, userAssignedIdentity, or delegatedResourceIdentity. |
userAssignedIdentityResourceId? | Core.armResourceIdentifier | User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity. |
federatedClientId? | Core.uuid | application client identity to use for accessing key encryption key Url in a different tenant. Ex: f83c6b1b-4d34-47e4-bb34-9d83df58b540 |
delegatedIdentityClientId? | Core.uuid | delegated identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity and userAssignedIdentity - internal use only. |
KeyVaultProperties
​
model Azure.ResourceManager.CommonTypes.KeyVaultProperties
Properties​
Name | Type | Description |
---|
keyIdentifier? | string | Key vault uri to access the encryption key. |
identity? | string | The client ID of the identity which will be used to access key vault. |
LocationData
​
Metadata pertaining to the geographic location of the resource.
model Azure.ResourceManager.CommonTypes.LocationData
Properties​
Name | Type | Description |
---|
name | string | A canonical name for the geographic or physical location. |
city? | string | The city or locality where the resource is located. |
district? | string | The district, state, or province where the resource is located. |
countryOrRegion? | string | The country or region where the resource is located |
LocationParameter
​
The default location parameter type.
model Azure.ResourceManager.CommonTypes.LocationParameter
Properties​
Name | Type | Description |
---|
location | string | The name of Azure region. |
LocationResourceParameter
​
The default location parameter type.
model Azure.ResourceManager.CommonTypes.LocationResourceParameter
Properties​
Name | Type | Description |
---|
location | string | The name of the Azure region. |
ManagedServiceIdentity
​
Managed service identity (system assigned and/or user assigned identities)
model Azure.ResourceManager.CommonTypes.ManagedServiceIdentity
Properties​
Name | Type | Description |
---|
principalId? | Core.uuid | The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. |
tenantId? | Core.uuid | The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. |
type | ManagedServiceIdentityType | The type of managed identity assigned to this resource. |
userAssignedIdentities? | Record<ResourceManager.CommonTypes.UserAssignedIdentity> | null | The identities assigned to this resource by the user. |
ManagementGroupNameParameter
​
The default ManagementGroupName parameter type.
model Azure.ResourceManager.CommonTypes.ManagementGroupNameParameter
Properties​
Name | Type | Description |
---|
managementGroupName | string | The name of the management group. The name is case insensitive. |
Operation
​
Details of a REST API operation, returned from the Resource Provider Operations API
model Azure.ResourceManager.CommonTypes.Operation
Properties​
Name | Type | Description |
---|
name? | string | The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" |
isDataAction? | boolean | Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for Azure Resource Manager/control-plane operations. |
display? | OperationDisplay | Localized display information for this particular operation. |
origin? | Origin | The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" |
actionType? | ActionType | Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. |
OperationDisplay
​
Localized display information for and operation.
model Azure.ResourceManager.CommonTypes.OperationDisplay
Properties​
Name | Type | Description |
---|
provider? | string | The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". |
resource? | string | The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". |
operation? | string | The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". |
description? | string | The short, localized friendly description of the operation; suitable for tool tips and detailed views. |
OperationIdParameter
​
The default operationId parameter type.
model Azure.ResourceManager.CommonTypes.OperationIdParameter
Properties​
Name | Type | Description |
---|
operationId | string | The ID of an ongoing async operation. |
OperationListResult
​
A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
model Azure.ResourceManager.CommonTypes.OperationListResult
Properties​
Name | Type | Description |
---|
value | ResourceManager.CommonTypes.Operation[] | The Operation items on this page |
nextLink? | TypeSpec.Rest.ResourceLocation | The link to the next page of items |
OperationStatusResult
​
The current status of an async operation.
model Azure.ResourceManager.CommonTypes.OperationStatusResult
Properties​
Name | Type | Description |
---|
id? | string | Fully qualified ID for the async operation. |
name? | string | Name of the async operation. |
status | string | Operation status. |
percentComplete? | float64 | Percent of the operation that is complete. |
startTime? | utcDateTime | The start time of the operation. |
endTime? | utcDateTime | The end time of the operation. |
operations? | ResourceManager.CommonTypes.OperationStatusResult[] | The operations list. |
error? | ErrorDetail | If present, details of the operation error. |
Plan for the resource.
model Azure.ResourceManager.CommonTypes.Plan
Properties​
Name | Type | Description |
---|
name | string | A user defined name of the 3rd Party Artifact that is being procured. |
publisher | string | The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic |
product | string | The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. |
promotionCode? | string | A publisher provided promotion code as provisioned in Data Market for the said product/artifact. |
version? | string | The version of the desired product/artifact. |
PrivateEndpoint
​
The Private Endpoint resource.
model Azure.ResourceManager.CommonTypes.PrivateEndpoint
Properties​
Name | Type | Description |
---|
id? | Core.armResourceIdentifier | The resource identifier for private endpoint |
PrivateEndpointConnection
​
The private endpoint connection resource
model Azure.ResourceManager.CommonTypes.PrivateEndpointConnection
Properties​
PrivateEndpointConnectionListResult
​
List of private endpoint connections associated with the specified resource.
model Azure.ResourceManager.CommonTypes.PrivateEndpointConnectionListResult
Properties​
Name | Type | Description |
---|
value? | ResourceManager.CommonTypes.PrivateEndpointConnection[] | Array of private endpoint connections. |
PrivateEndpointConnectionParameter
​
The name of the private endpoint connection associated with the Azure resource.
model Azure.ResourceManager.CommonTypes.PrivateEndpointConnectionParameter<Segment>
Template Parameters​
Name | Description |
---|
Segment | The resource type name for private endpoint connections (default is privateEndpointConnections) |
Properties​
Name | Type | Description |
---|
name | string | The name of the private endpoint connection associated with the Azure resource. |
PrivateEndpointConnectionProperties
​
Properties of the private endpoint connection.
model Azure.ResourceManager.CommonTypes.PrivateEndpointConnectionProperties
Properties​
PrivateLinkResource
​
A private link resource.
model Azure.ResourceManager.CommonTypes.PrivateLinkResource
Properties​
PrivateLinkResourceListResult
​
A list of private link resources.
model Azure.ResourceManager.CommonTypes.PrivateLinkResourceListResult
Properties​
Name | Type | Description |
---|
value? | ResourceManager.CommonTypes.PrivateLinkResource[] | Array of private link resources |
PrivateLinkResourceParameter
​
The name of the private link associated with the Azure resource.
model Azure.ResourceManager.CommonTypes.PrivateLinkResourceParameter<Segment>
Template Parameters​
Name | Description |
---|
Segment | The resource type name for private links (default is privateLinkResources) |
Properties​
Name | Type | Description |
---|
name | string | The name of the private link associated with the Azure resource. |
PrivateLinkResourceProperties
​
Properties of a private link resource.
model Azure.ResourceManager.CommonTypes.PrivateLinkResourceProperties
Properties​
Name | Type | Description |
---|
groupId? | string | The private link resource group id. |
requiredMembers? | string[] | The private link resource required member names. |
requiredZoneNames? | string[] | The private link resource private link DNS zone name. |
PrivateLinkServiceConnectionState
​
A collection of information about the state of the connection between service consumer and provider.
model Azure.ResourceManager.CommonTypes.PrivateLinkServiceConnectionState
Properties​
Name | Type | Description |
---|
status? | PrivateEndpointServiceConnectionStatus | Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. |
description? | string | The reason for approval/rejection of the connection. |
actionsRequired? | string | A message indicating if changes on the service provider require any updates on the consumer. |
ProxyResource
​
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
model Azure.ResourceManager.CommonTypes.ProxyResource
Properties​
None
Resource
​
Common fields that are returned in the response for all Azure Resource Manager resources
model Azure.ResourceManager.CommonTypes.Resource
Properties​
Name | Type | Description |
---|
id? | Core.armResourceIdentifier | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name? | string | The name of the resource |
type? | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
systemData? | SystemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
ResourceGroupNameParameter
​
The default resource group parameter type.
model Azure.ResourceManager.CommonTypes.ResourceGroupNameParameter
Properties​
Name | Type | Description |
---|
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
ResourceModelWithAllowedPropertySet
​
The resource model definition containing the full set of allowed properties for a resource. Except properties bag, there cannot be a top level property outside of this set.
model Azure.ResourceManager.CommonTypes.ResourceModelWithAllowedPropertySet
Properties​
Name | Type | Description |
---|
managedBy? | string | The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource. |
kind? | string | Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. |
eTag? | string | The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. |
identity? | Identity | |
sku? | Sku | |
plan? | Plan | |
ScopeParameter
​
The default Scope parameter type.
model Azure.ResourceManager.CommonTypes.ScopeParameter
Properties​
Name | Type | Description |
---|
scope | string | The scope at which the operation is performed. |
The resource model definition representing SKU
model Azure.ResourceManager.CommonTypes.Sku
Properties​
Name | Type | Description |
---|
name | string | The name of the SKU. Ex - P3. It is typically a letter+number code |
tier? | SkuTier | This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. |
size? | string | The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. |
family? | string | If the service has different generations of hardware, for the same SKU, then that can be captured here. |
capacity? | int32 | If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. |
SubscriptionIdParameter
​
The default subscriptionId parameter type.
model Azure.ResourceManager.CommonTypes.SubscriptionIdParameter
Properties​
Name | Type | Description |
---|
subscriptionId | Core.uuid | The ID of the target subscription. The value must be an UUID. |
SystemAssignedServiceIdentity
​
Managed service identity (either system assigned, or none)
model Azure.ResourceManager.CommonTypes.SystemAssignedServiceIdentity
Properties​
Name | Type | Description |
---|
principalId? | Core.uuid | The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. |
tenantId? | Core.uuid | The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. |
type | SystemAssignedServiceIdentityType | The type of managed identity assigned to this resource. |
SystemData
​
Metadata pertaining to creation and last modification of the resource.
model Azure.ResourceManager.CommonTypes.SystemData
Properties​
Name | Type | Description |
---|
createdBy? | string | The identity that created the resource. |
createdByType? | createdByType | The type of identity that created the resource. |
createdAt? | utcDateTime | The timestamp of resource creation (UTC). |
lastModifiedBy? | string | The identity that last modified the resource. |
lastModifiedByType? | createdByType | The type of identity that last modified the resource. |
lastModifiedAt? | utcDateTime | The timestamp of resource last modification (UTC) |
TenantIdParameter
​
The default ManagementGroupName parameter type.
model Azure.ResourceManager.CommonTypes.TenantIdParameter
Properties​
Name | Type | Description |
---|
tenantId | Core.uuid | The Azure tenant ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) |
TrackedResource
​
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
model Azure.ResourceManager.CommonTypes.TrackedResource
Properties​
Name | Type | Description |
---|
tags? | Record<string> | Resource tags. |
location | string | The geo-location where the resource lives |
UserAssignedIdentities
​
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
model Azure.ResourceManager.CommonTypes.UserAssignedIdentities
Properties​
UserAssignedIdentity
​
User assigned identity properties
model Azure.ResourceManager.CommonTypes.UserAssignedIdentity
Properties​
Name | Type | Description |
---|
principalId? | Core.uuid | The principal ID of the assigned identity. |
clientId? | Core.uuid | The client ID of the assigned identity. |
ResourceHome
​
An internal enum to indicate the resource support for various path types
enum Azure.ResourceManager.CommonTypes.ResourceHome
Versions
​
The Azure Resource Manager common-types versions.
enum Azure.ResourceManager.CommonTypes.Versions
ActionType
​
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
union Azure.ResourceManager.CommonTypes.ActionType
CheckNameAvailabilityReason
​
Possible reasons for a name not being available.
union Azure.ResourceManager.CommonTypes.CheckNameAvailabilityReason
createdByType
​
The kind of entity that created the resource.
union Azure.ResourceManager.CommonTypes.createdByType
EncryptionStatus
​
Indicates whether or not the encryption is enabled for container registry.
union Azure.ResourceManager.CommonTypes.EncryptionStatus
ExtendedLocationType
​
The supported ExtendedLocation types.
union Azure.ResourceManager.CommonTypes.ExtendedLocationType
InfrastructureEncryption
​
(Optional) Discouraged to include in resource definition. Only needed where it is possible to disable platform (AKA infrastructure) encryption. Azure SQL TDE is an example of this. Values are enabled and disabled.
union Azure.ResourceManager.CommonTypes.InfrastructureEncryption
KeyEncryptionKeyIdentityType
​
The type of identity to use.
union Azure.ResourceManager.CommonTypes.KeyEncryptionKeyIdentityType
ManagedServiceIdentityType
​
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
union Azure.ResourceManager.CommonTypes.ManagedServiceIdentityType
Origin