Errors that occurred if the operation ended with Canceled or Failed status
ArmResourceCreatedResponse
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
Template Parameters
Name
Description
Resource
The resource being updated
Properties
Name
Type
Description
statusCode
201
The status code.
body
Resource
ArmResourceExistsResponse
Properties
Name
Type
Description
statusCode
204
The status code.
ArmResourceNotFoundResponse
Properties
Name
Type
Description
statusCode
404
The status code.
ArmResourceUpdatedResponse
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
Template Parameters
Name
Description
ResponseBody
The contents of the response body
Properties
Name
Type
Description
statusCode
200
The status code.
body
ResponseBody
AvailabilityZonesProperty
Model representing the standard zones envelope property for a resource.
Spread this model into a resource Model if the resource supports ARM zones.
Examples
Properties
Name
Type
Description
zones?
string[]
The availability zones.
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 used only to spread in the standard eTag envelope property for a resource
Examples
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
A model containing the provider-specific properties for this resource
PropertiesOptional
A boolean flag indicating whether the resource Properties field is marked as optional or required. Default true is optional and recommended.
Properties
Name
Type
Description
properties?
Properties
KeysOf
Extracts the key (path) parameters from a resource and its parents
Template Parameters
Name
Description
Resource
The resource to extract properties from
Properties
None
LocationParameter
DEPRECATED - DO NOT USE
The default location parameter type.
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.
Examples
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.
The managed service identities assigned to this resource.
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.
A model containing the provider-specific properties for this resource
PropertiesOptional
A boolean flag indicating whether the resource Properties field is marked as optional or required. Default true is optional and recommended.
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.
Properties
Name
Type
Description
location
Core.azureLocation
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
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.
Examples
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.
ResourceListCustomResult
Paged response containing results
Template Parameters
Name
Description
Result
The type of the values returned in the paged response
Properties
Name
Type
Description
value
Array<Element>
The items on this page
nextLink?
string
The link to the next page of items
ResourceListResult
Paged response containing resources
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
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
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 representing the standard sku envelope property for a resource.
Spread this model into a resource model if the resource supports standard ARM sku.
The SKU (Stock Keeping Unit) assigned to this resource.
ResourceUriParameter
The default resourceUri parameter type.
Properties
Name
Type
Description
resourceUri
string
The fully qualified Azure Resource manager identifier of the resource.
SubscriptionActionScope
Template used by ArmProviderAction templates.
Properties
Name
Type
Description
name
string
Symbolic name of scope
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.
Properties
Name
Type
Description
location
Core.azureLocation
The name of the Azure region.
TenantActionScope
Template used by ArmTenantAction templates.
Properties
Name
Type
Description
name
string
Symbolic name of scope
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.
Properties
Name
Type
Description
location
Core.azureLocation
The name of the Azure region.
TrackedResource
Concrete tracked resource types can be created by aliasing this type using a specific property type.
(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.
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
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.
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.
Properties
Name
Type
Description
location
string
The name of Azure region.
LocationResourceParameter
The default location parameter type.
Properties
Name
Type
Description
location
Core.azureLocation
The name of the Azure region.
ManagedOnBehalfOfConfiguration
Managed-On-Behalf-Of configuration properties. This configuration exists for the resources where a resource provider manages those resources on behalf of the resource owner.
Properties
Name
Type
Description
moboBrokerResources?
ResourceManager.CommonTypes.MoboBrokerResource[]
Managed-On-Behalf-Of broker resources
ManagedServiceIdentity
Managed service identity (system assigned and/or user assigned identities)
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.
Details of a REST API operation, returned from the Resource Provider Operations API
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.
Extensible enum. Indicates the action type. âInternalâ refers to actions that are for internal only APIs.
OperationDisplay
Localized display information for and operation.
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.
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.
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.
Details of a provisioning issue for a network security perimeter (NSP) configuration. Resource providers should generate separate provisioning issue elements for each separate issue detected, and include a meaningful and distinctive description, as well as any appropriate suggestedResourceIds and suggestedAccessRules
Fully qualified resource IDs of suggested resources that can be associated to the network security perimeter (NSP) to remediate the issue.
suggestedAccessRules?
ResourceManager.CommonTypes.AccessRule[]
Access rules that can be added to the network security profile (NSP) to remediate the issue.
ProxyResource
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Properties
None
Resource
Common fields that are returned in the response for all Azure Resource Manager resources
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â
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.
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.
The type of identity that last modified the resource.
lastModifiedAt?
utcDateTime
The timestamp of resource last modification (UTC)
TenantIdParameter
The default ManagementGroupName parameter type.
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â
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.
An internal enum to indicate the resource support for various path types
Name
Value
Description
Tenant
The resource is bound to a tenant
Subscription
The resource is bound to a subscription
Location
The resource is bound to a location
ResourceGroup
The resource is bound to a resource group
Extension
The resource is bound to an extension
Versions
The Azure Resource Manager common-types versions.
Name
Value
Description
v3
The Azure Resource Manager v3 common types.
v4
The Azure Resource Manager v4 common types.
v5
The Azure Resource Manager v5 common types.
AccessRuleDirection
Direction of Access Rule
ActionType
Extensible enum. Indicates the action type. âInternalâ refers to actions that are for internal only APIs.
CheckNameAvailabilityReason
Possible reasons for a name not being available.
createdByType
The kind of entity that created the resource.
EncryptionStatus
Indicates whether or not the encryption is enabled for container registry.
ExtendedLocationType
The supported ExtendedLocation types.
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.
IssueType
Type of issue
KeyEncryptionKeyIdentityType
The type of identity to use.
ManagedServiceIdentityType
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Provisioning state of a network security perimeter configuration that is being created or updated.
Origin
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is âuser,systemâ
PrivateEndpointConnectionProvisioningState
The current provisioning state.
PrivateEndpointServiceConnectionStatus
The private endpoint connection status.
PublicNetworkAccess
Allow, disallow, or let network security perimeter configuration control public network access to the protected resource. Value is optional but if passed in, it must be âEnabledâ, âDisabledâ or âSecuredByPerimeterâ.
ResourceAssociationAccessMode
Access mode of the resource association
ResourceIdentityType
Severity
Severity of the issue.
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.
SystemAssignedServiceIdentityType
Type of managed service identity (either system assigned, or none).
Azure.ResourceManager.Foundations
ArmTagsProperty
Standard type definition for Azure Resource Manager Tags property.
It is included in the TrackedResource template definition.
The Azure Resource Manager Resource tags.
Properties
Name
Type
Description
tags?
Record<string>
Resource tags.
DefaultBaseParameters
Base parameters for a resource.
Template Parameters
Name
Description
Resource
The type of the resource.
Properties
Name
Type
Description
apiVersion
string
The API version to use for this operation.
subscriptionId
Core.uuid
The ID of the target subscription. The value must be an UUID.
location
string
The location name.
resourceGroupName
string
The name of the resource group. The name is case insensitive.
resourceUri
string
The fully qualified Azure Resource manager identifier of the resource.
ExtensionBaseParameters
The static parameters for an extension resource
Properties
Name
Type
Description
apiVersion
string
The API version to use for this operation.
resourceUri
string
The fully qualified Azure Resource manager identifier of the resource.
ExtensionScope
Parameter model for listing an extension resource
Template Parameters
Name
Description
Resource
The type of the resource.
Properties
Name
Type
Description
apiVersion
string
The API version to use for this operation.
resourceUri
string
The fully qualified Azure Resource manager identifier of the resource.
provider
"Microsoft.ThisWillBeReplaced"
LocationBaseParameters
The static parameters for a location-based resource
Properties
Name
Type
Description
apiVersion
string
The API version to use for this operation.
subscriptionId
Core.uuid
The ID of the target subscription. The value must be an UUID.
location
string
The location name.
LocationScope
Parameter model for listing a resource at the location scope
Template Parameters
Name
Description
Resource
The type of the resource.
Properties
Name
Type
Description
apiVersion
string
The API version to use for this operation.
subscriptionId
Core.uuid
The ID of the target subscription. The value must be an UUID.
location
string
The location name.
provider
"Microsoft.ThisWillBeReplaced"
ProxyResourceUpdateModel
The type used for update operations of the resource.
The identities assigned to this resource by the user.
ManagedServiceIdentityV4Property
Model representing the standard ManagedServiceIdentity envelope property from V4 of common type.
Please note that this is only included for legacy specs with mixed v3 and v4 types, which would cause
breaking changes due to the ManagedServiceIdentityType.SystemAndUserAssigned value changes.
Do not use this if you are already on CommonTypes.Version.v4 or beyond.