Skip to content

Data types

Azure.ResourceManager

ArmAcceptedLroResponse

model Azure.ResourceManager.ArmAcceptedLroResponse<Description, LroHeaders>

Template Parameters

NameDescription
DescriptionThe description of the response status (defaults to Resource operation accepted)
LroHeadersOptional. The lro headers that appear in the Accepted response

Properties

NameTypeDescription
statusCode202The status code.

ArmAcceptedResponse

model Azure.ResourceManager.ArmAcceptedResponse<Message, ExtraHeaders>

Template Parameters

NameDescription
MessageThe description of the response status (defaults to Resource operation accepted)
ExtraHeadersAdditional headers in the response. Default includes Retry-After header

Properties

NameTypeDescription
statusCode202The status code.

ArmAsyncOperationHeader

The standard header for asynchronous operation polling

model Azure.ResourceManager.ArmAsyncOperationHeader<StatusMonitor, UrlValue, FinalResult>

Template Parameters

NameDescription
StatusMonitorThe status monitor type for lro polling
UrlValueThe value type of the Azure-AsyncOperation header
FinalResultThe logical final result of the operation

Properties

NameTypeDescription
azureAsyncOperation?UrlValueA link to the status monitor

ArmCombinedLroHeaders

Provide Both Azure-AsyncOperation and Location headers

model Azure.ResourceManager.ArmCombinedLroHeaders<StatusMonitor, FinalResult, PollingUrlValue, FinalUrlValue>

Template Parameters

NameDescription
StatusMonitorThe type of the polling StatusMonitor when following the Azure-AsyncOperation url
FinalResultThe type of the logical result when following the location header
PollingUrlValueThe value type of the link to the status monitor
FinalUrlValueThe value type fo the link to the final result

Properties

NameTypeDescription
azureAsyncOperation?PollingUrlValueA link to the status monitor
location?FinalUrlValueThe 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

NameDescription
ResponseBodyThe contents of the response body
ExtraHeadersAdditional headers in the response. Default includes Retry-After header

Properties

NameTypeDescription
statusCode201The status code.
bodyResponseBody

ArmDeleteAcceptedLroResponse

model Azure.ResourceManager.ArmDeleteAcceptedLroResponse<LroHeaders>

Template Parameters

NameDescription
LroHeadersOptional. Allows overriding the Lro headers returned in the response.

Properties

NameTypeDescription
statusCode202The status code.

ArmDeleteAcceptedResponse

model Azure.ResourceManager.ArmDeleteAcceptedResponse

Properties

NameTypeDescription
statusCode202The status code.
retryAfter?int32The Retry-After header can indicate how long the client should wait before polling the operation status.

ArmDeletedNoContentResponse

model Azure.ResourceManager.ArmDeletedNoContentResponse

Properties

NameTypeDescription
statusCode204The status code.

ArmDeletedResponse

The response for synchronous delete of a resource

model Azure.ResourceManager.ArmDeletedResponse

Properties

NameTypeDescription
statusCode200The status code.

ArmLocationResource

Template for ARM location resources. Use the parameter to specify

model Azure.ResourceManager.ArmLocationResource<BaseType>

Template Parameters

NameDescription
BaseType

Properties

NameTypeDescription
locationCore.azureLocationThe name of the Azure region.

ArmLroLocationHeader

The default header for lro PUT and DELETE polling

model Azure.ResourceManager.ArmLroLocationHeader<LroPollingOptions, FinalResult, UrlValue>

Template Parameters

NameDescription
LroPollingOptionsThe polling options when polling the url in the location header
FinalResultThe ultimate final result of the logical operation
UrlValueThe value type for the location header

Properties

NameTypeDescription
location?UrlValueThe 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

NameDescription
MessageThe description of the response status (defaults to Operation completed successfully)

Properties

NameTypeDescription
statusCode204The status code.

ArmOperationStatus

Standard Azure Resource Manager operation status response

model Azure.ResourceManager.ArmOperationStatus<Properties, StatusValues>

Template Parameters

NameDescription
PropertiesOptional resource-specific properties
StatusValuesThe set of allowed values for operation status

Properties

NameTypeDescription
properties?PropertiesRP-specific properties for the operationStatus resource, only appears when operation ended with Succeeded status
statusStatusValuesThe operation status
idstringThe unique identifier for the operationStatus resource
name?stringThe name of the operationStatus resource
startTime?utcDateTimeOperation start time
endTime?utcDateTimeOperation complete time
percentComplete?float64The progress made toward completing the operation
error?ErrorDetailErrors that occurred if the operation ended with Canceled or Failed status

ArmResourceCreatedResponse

model Azure.ResourceManager.ArmResourceCreatedResponse<Resource, LroHeaders>

Template Parameters

NameDescription
ResourceThe resource being updated
LroHeadersOptional. The lro headers returned with a Created response

Properties

NameTypeDescription
statusCode201The status code.
bodyResource

ArmResourceCreatedSyncResponse

model Azure.ResourceManager.ArmResourceCreatedSyncResponse<Resource>

Template Parameters

NameDescription
ResourceThe resource being updated

Properties

NameTypeDescription
statusCode201The status code.
bodyResource

ArmResourceExistsResponse

model Azure.ResourceManager.ArmResourceExistsResponse

Properties

NameTypeDescription
statusCode204The status code.

ArmResourceNotFoundResponse

model Azure.ResourceManager.ArmResourceNotFoundResponse

Properties

NameTypeDescription
statusCode404The status code.

ArmResourceUpdatedResponse

model Azure.ResourceManager.ArmResourceUpdatedResponse<Resource>

Template Parameters

NameDescription
ResourceThe resource being updated

Properties

NameTypeDescription
statusCode200The status code.
bodyResource

ArmResponse

The Azure Resource Manager synchronous OK response

model Azure.ResourceManager.ArmResponse<ResponseBody>

Template Parameters

NameDescription
ResponseBodyThe contents of the response body

Properties

NameTypeDescription
statusCode200The status code.
bodyResponseBody

AvailabilityZonesProperty

Model representing the standard zones envelope property for a resource. Spread this model into a resource Model if the resource supports ARM zones.

model Azure.ResourceManager.AvailabilityZonesProperty

Examples

model Foo is TrackedResource<FooProperties> {
...AvailabilityZonesProperty;
}

Properties

NameTypeDescription
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 Azure.ResourceManager.DefaultProvisioningStateProperty

Examples

model FooProperties {
// Only have standard Succeeded, Failed, Cancelled states
...DefaultProvisioningStateProperty;
}

Properties

NameTypeDescription
provisioningState?ResourceProvisioningStateThe provisioning state of the resource.

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

NameTypeDescription
encryptionEncryptionAll 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> {
// Only have standard Succeeded, Failed, Cancelled states
...EntityTagProperty;
}

Properties

NameTypeDescription
eTag?stringIf 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

NameTypeDescription
extendedLocation?ExtendedLocation

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, PropertiesOptional>

Template Parameters

NameDescription
PropertiesA model containing the provider-specific properties for this resource
PropertiesOptionalA boolean flag indicating whether the resource Properties field is marked as optional or required. Default true is optional and recommended.

Properties

NameTypeDescription
properties?Properties

KeysOf

Extracts the key (path) parameters from a resource and its parents

model Azure.ResourceManager.KeysOf<Resource>

Template Parameters

NameDescription
ResourceThe resource to extract properties from

Properties

None

LocationParameter

DEPRECATED - DO NOT USE The default location parameter type.

model Azure.ResourceManager.LocationParameter

Properties

NameTypeDescription
locationstringThe 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> {
// Only have standard Succeeded, Failed, Cancelled states
...ManagedByProperty;
}

Properties

NameTypeDescription
managedBy?stringThe 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

NameTypeDescription
identity?ManagedServiceIdentityThe 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.

model Azure.ResourceManager.ManagedSystemAssignedIdentityProperty

Examples

model Foo is TrackedResource<FooProperties> {
...ResourceNameParameter<Foo>;
...ManagedSystemAssignedIdentityProperty;
}

Properties

NameTypeDescription
identity?SystemAssignedServiceIdentityThe managed service identities assigned to this resource.

ParentKeysOf

Extracts the key (path) parameters from the parent(s) of the given resource

model Azure.ResourceManager.ParentKeysOf<Resource>

Template Parameters

NameDescription
ResourceThe resource to extract properties from

Properties

None

ProviderNamespace

Model describing the provider namespace.

model Azure.ResourceManager.ProviderNamespace<Resource>

Template Parameters

NameDescription
ResourceThe resource provided by the namespace.

Properties

NameTypeDescription
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, PropertiesOptional>

Template Parameters

NameDescription
PropertiesA model containing the provider-specific properties for this resource
PropertiesOptionalA boolean flag indicating whether the resource Properties field is marked as optional or required. Default true is optional and recommended.

Properties

NameTypeDescription
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

NameTypeDescription
locationCore.azureLocationThe 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

NameDescription
ResourceThe resource to get parameters for
BaseParametersThe parameters representing the base Uri of the resource

Properties

NameTypeDescription
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> {
// Only have standard Succeeded, Failed, Cancelled states
...ResourceKindProperty;
}

Properties

NameTypeDescription
kind?stringMetadata 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

model Azure.ResourceManager.ResourceListCustomResult<Result>

Template Parameters

NameDescription
ResultThe type of the values returned in the paged response

Properties

NameTypeDescription
valueArray<Element>The items on this page
nextLink?stringThe link to the next page of items

ResourceListResult

Paged response containing resources

model Azure.ResourceManager.ResourceListResult<Resource>

Template Parameters

NameDescription
ResourceThe type of the values returned in the paged response (must be a resource)

Properties

NameTypeDescription
valueArray<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

NameDescription
ResourceThe ARM resource this name parameter is applying to.
KeyNameOverride default key name of the resource.
SegmentNameOverride default segment name of the resource.
NamePatternThe RegEx pattern of the name. Default is ^[a-zA-Z0-9-]{3,24}$.
TypeThe type of the name property. Default type is string. However you can pass an union with string values.

Properties

NameTypeDescription
nameType

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

NameDescription
ResourceThe resource to get parameters for
BaseParametersThe parameters representing the base Uri of the resource

Properties

NameTypeDescription
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> {
// Only have standard Succeeded, Failed, Cancelled states
...ResourcePlanProperty;
}

Properties

NameTypeDescription
plan?PlanDetails 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> {
// Only have standard Succeeded, Failed, Cancelled states
...ResourceSkuProperty;
}

Properties

NameTypeDescription
sku?SkuThe SKU (Stock Keeping Unit) assigned to this resource.

ResourceUriParameter

The default resourceUri parameter type.

model Azure.ResourceManager.ResourceUriParameter

Properties

NameTypeDescription
resourceUristringThe fully qualified Azure Resource manager identifier of the resource.

SubscriptionActionScope

Template used by ArmProviderAction templates.

model Azure.ResourceManager.SubscriptionActionScope

Properties

NameTypeDescription
namestringSymbolic 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.

model Azure.ResourceManager.SubscriptionLocationResource

Properties

NameTypeDescription
locationCore.azureLocationThe name of the Azure region.

TenantActionScope

Template used by ArmTenantAction templates.

model Azure.ResourceManager.TenantActionScope

Properties

NameTypeDescription
namestringSymbolic 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.

model Azure.ResourceManager.TenantLocationResource

Properties

NameTypeDescription
locationCore.azureLocationThe 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, PropertiesOptional>

Template Parameters

NameDescription
PropertiesA model containing the provider-specific properties for this resource
PropertiesOptionalA boolean flag indicating whether the resource Properties field is marked as optional or required. Default true is optional and recommended.

Properties

NameTypeDescription
properties?Properties

Versions

Supported versions of Azure.ResourceManager building blocks.

enum Azure.ResourceManager.Versions
NameValueDescription
v1_0_Preview_1"1.0-preview.1"Version 1.0-preview.1

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, // include standard provisioning states
starting: "starting",
started: "started",
stopping: "stopping",
stopped: "stopped",
}

Azure.ResourceManager.CommonTypes

AccessRule

Access rule in a network security perimeter configuration profile

model Azure.ResourceManager.CommonTypes.AccessRule

Properties

NameTypeDescription
name?stringName of the access rule
properties?AccessRuleProperties

AccessRuleProperties

Properties of Access Rule

model Azure.ResourceManager.CommonTypes.AccessRuleProperties

Properties

NameTypeDescription
direction?AccessRuleDirection
addressPrefixes?string[]Address prefixes in the CIDR format for inbound rules
subscriptions?ResourceManager.CommonTypes.{ id: Core.armResourceIdentifier }[]Subscriptions for inbound rules
networkSecurityPerimeters?ResourceManager.CommonTypes.NetworkSecurityPerimeter[]Network security perimeters for inbound rules
fullyQualifiedDomainNames?string[]Fully qualified domain names (FQDN) for outbound rules
emailAddresses?string[]Email addresses for outbound rules
phoneNumbers?string[]Phone numbers for outbound rules

ApiVersionParameter

The default api-version parameter type.

model Azure.ResourceManager.CommonTypes.ApiVersionParameter

Properties

NameTypeDescription
apiVersionstringThe 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

NameTypeDescription
etag?stringResource Etag.

CheckNameAvailabilityRequest

The check availability request body.

model Azure.ResourceManager.CommonTypes.CheckNameAvailabilityRequest

Properties

NameTypeDescription
name?stringThe name of the resource for which availability needs to be checked.
type?stringThe resource type.

CheckNameAvailabilityResponse

The check availability result.

model Azure.ResourceManager.CommonTypes.CheckNameAvailabilityResponse

Properties

NameTypeDescription
nameAvailable?booleanIndicates if the resource name is available.
reason?CheckNameAvailabilityReasonThe reason why the given name is not available.
message?stringDetailed reason why the given name is not available.

CustomerManagedKeyEncryption

Customer-managed key encryption properties for the resource.

model Azure.ResourceManager.CommonTypes.CustomerManagedKeyEncryption

Properties

NameTypeDescription
keyEncryptionKeyIdentity?KeyEncryptionKeyIdentityAll identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.
keyEncryptionKeyUrl?stringkey encryption key Url, versioned or non-versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek.

DelegatedResource

Delegated resource properties - internal use only.

model Azure.ResourceManager.CommonTypes.DelegatedResource

Properties

NameTypeDescription
resourceId?stringThe ARM resource id of the delegated resource - internal use only.
tenantId?Core.uuidThe tenant id of the delegated resource - internal use only.
referralResource?stringThe delegation id of the referral delegation (optional) - internal use only.
location?stringThe source resource location - internal use only.

DelegatedResources

The set of delegated resources. The delegated resources dictionary keys will be source resource internal ids - internal use only.

model Azure.ResourceManager.CommonTypes.DelegatedResources

Properties

NameTypeDescription
DelegatedResourceAdditional 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

NameTypeDescription
infrastructureEncryption?InfrastructureEncryptionValues are enabled and disabled.
customerManagedKeyEncryption?CustomerManagedKeyEncryptionAll Customer-managed key encryption properties for the resource.

EncryptionProperties

Configuration of key for data encryption

model Azure.ResourceManager.CommonTypes.EncryptionProperties

Properties

NameTypeDescription
status?EncryptionStatusIndicates whether or not the encryption is enabled for container registry.
keyVaultProperties?KeyVaultPropertiesKey vault properties.

ErrorAdditionalInfo

The resource management error additional info.

model Azure.ResourceManager.CommonTypes.ErrorAdditionalInfo

Properties

NameTypeDescription
type?stringThe additional info type.
info?{}The additional info.

ErrorDetail

The error detail.

model Azure.ResourceManager.CommonTypes.ErrorDetail

Properties

NameTypeDescription
code?stringThe error code.
message?stringThe error message.
target?stringThe 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

NameTypeDescription
error?ErrorDetailThe error object.

ExtendedLocation

The complex type of the extended location.

model Azure.ResourceManager.CommonTypes.ExtendedLocation

Properties

NameTypeDescription
namestringThe name of the extended location.
typeExtendedLocationTypeThe 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

NameTypeDescription
principalId?Core.uuidThe principal ID of resource identity. The value must be an UUID.
tenantId?Core.uuidThe tenant ID of resource. The value must be an UUID.
type?ResourceIdentityTypeThe identity type.

IfMatchHeader

The default ARM If-Match header type.

model Azure.ResourceManager.CommonTypes.IfMatchHeader

Properties

NameTypeDescription
ifMatchstringThe If-Match header that makes a request conditional.

IfNoneMatchHeader

The default ARM If-Match header type.

model Azure.ResourceManager.CommonTypes.IfNoneMatchHeader

Properties

NameTypeDescription
ifNoneMatchstringThe 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

NameTypeDescription
identityType?KeyEncryptionKeyIdentityTypeThe type of identity to use. Values can be systemAssignedIdentity, userAssignedIdentity, or delegatedResourceIdentity.
userAssignedIdentityResourceId?Core.armResourceIdentifierUser 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.uuidapplication client identity to use for accessing key encryption key Url in a different tenant. Ex: f83c6b1b-4d34-47e4-bb34-9d83df58b540
delegatedIdentityClientId?Core.uuiddelegated 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

NameTypeDescription
keyIdentifier?stringKey vault uri to access the encryption key.
identity?stringThe 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

NameTypeDescription
namestringA canonical name for the geographic or physical location.
city?stringThe city or locality where the resource is located.
district?stringThe district, state, or province where the resource is located.
countryOrRegion?stringThe country or region where the resource is located

LocationParameter

The default location parameter type.

model Azure.ResourceManager.CommonTypes.LocationParameter

Properties

NameTypeDescription
locationstringThe name of Azure region.

LocationResourceParameter

The default location parameter type.

model Azure.ResourceManager.CommonTypes.LocationResourceParameter

Properties

NameTypeDescription
locationCore.azureLocationThe 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.

model Azure.ResourceManager.CommonTypes.ManagedOnBehalfOfConfiguration

Properties

NameTypeDescription
moboBrokerResources?ResourceManager.CommonTypes.MoboBrokerResource[]Managed-On-Behalf-Of broker resources

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)

model Azure.ResourceManager.CommonTypes.ManagedServiceIdentity

Properties

NameTypeDescription
principalId?Core.uuidThe service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId?Core.uuidThe tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
typeManagedServiceIdentityTypeThe type of managed identity assigned to this resource.
userAssignedIdentities?Record<ResourceManager.CommonTypes.UserAssignedIdentity | null>The identities assigned to this resource by the user.

ManagedServiceIdentityWithDelegation

Managed service identity (system assigned and/or user assigned identities and/or delegated identities) - internal use only.

model Azure.ResourceManager.CommonTypes.ManagedServiceIdentityWithDelegation

Properties

NameTypeDescription
delegatedResources?DelegatedResources

ManagementGroupNameParameter

The default ManagementGroupName parameter type.

model Azure.ResourceManager.CommonTypes.ManagementGroupNameParameter

Properties

NameTypeDescription
managementGroupNamestringThe name of the management group. The name is case insensitive.

MoboBrokerResource

Managed-On-Behalf-Of broker resource. This resource is created by the Resource Provider to manage some resources on behalf of the user.

model Azure.ResourceManager.CommonTypes.MoboBrokerResource

Properties

NameTypeDescription
id?Core.armResourceIdentifierResource identifier of a Managed-On-Behalf-Of broker resource

NetworkSecurityPerimeter

Information about a network security perimeter (NSP)

model Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeter

Properties

NameTypeDescription
id?Core.armResourceIdentifierFully qualified Azure resource ID of the NSP resource
perimeterGuid?Core.uuidUniversal unique ID (UUID) of the network security perimeter
location?stringLocation of the network security perimeter

NetworkSecurityPerimeterConfiguration

Network security perimeter (NSP) configuration resource

model Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeterConfiguration

Properties

NameTypeDescription
properties?NetworkSecurityPerimeterConfigurationProperties

NetworkSecurityPerimeterConfigurationListResult

Result of a list NSP (network security perimeter) configurations request.

model Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeterConfigurationListResult

Properties

NameTypeDescription
value?ResourceManager.CommonTypes.NetworkSecurityPerimeterConfiguration[]Array of network security perimeter results.
nextLink?urlThe link used to get the next page of results.

NetworkSecurityPerimeterConfigurationNameParameter

The name for a network security perimeter configuration

model Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeterConfigurationNameParameter<Segment>

Template Parameters

NameDescription
SegmentThe resource type name for network security perimeter configuration (default is networkSecurityPerimeterConfigurations)

Properties

NameTypeDescription
namestringThe name for a network security perimeter configuration

NetworkSecurityPerimeterConfigurationProperties

Network security configuration properties.

model Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeterConfigurationProperties

Properties

NameTypeDescription
provisioningState?NetworkSecurityPerimeterConfigurationProvisioningState
provisioningIssues?ResourceManager.CommonTypes.ProvisioningIssue[]List of provisioning issues, if any
networkSecurityPerimeter?NetworkSecurityPerimeter
resourceAssociation?ResourceAssociation
profile?NetworkSecurityProfile

NetworkSecurityProfile

Network security perimeter configuration profile

model Azure.ResourceManager.CommonTypes.NetworkSecurityProfile

Properties

NameTypeDescription
name?stringName of the profile
accessRulesVersion?int32Current access rules version
accessRules?ResourceManager.CommonTypes.AccessRule[]List of Access Rules
diagnosticSettingsVersion?int32Current diagnostic settings version
enabledLogCategories?string[]List of log categories that are enabled

Operation

Details of a REST API operation, returned from the Resource Provider Operations API

model Azure.ResourceManager.CommonTypes.Operation

Properties

NameTypeDescription
name?stringThe name of the operation, as per Resource-Based Access Control (RBAC). Examples: “Microsoft.Compute/virtualMachines/write”, “Microsoft.Compute/virtualMachines/capture/action”
isDataAction?booleanWhether the operation applies to data-plane. This is “true” for data-plane operations and “false” for Azure Resource Manager/control-plane operations.
display?OperationDisplayLocalized display information for this particular operation.
origin?OriginThe intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”
actionType?ActionTypeExtensible 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

NameTypeDescription
provider?stringThe localized friendly form of the resource provider name, e.g. “Microsoft Monitoring Insights” or “Microsoft Compute”.
resource?stringThe localized friendly name of the resource type related to this operation. E.g. “Virtual Machines” or “Job Schedule Collections”.
operation?stringThe concise, localized friendly name for the operation; suitable for dropdowns. E.g. “Create or Update Virtual Machine”, “Restart Virtual Machine”.
description?stringThe 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

NameTypeDescription
operationIdstringThe 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

NameTypeDescription
valueResourceManager.CommonTypes.Operation[]The Operation items on this page
nextLink?TypeSpec.Rest.ResourceLocationThe link to the next page of items

OperationStatusResult

The current status of an async operation.

model Azure.ResourceManager.CommonTypes.OperationStatusResult

Properties

NameTypeDescription
id?stringFully qualified ID for the async operation.
name?stringName of the async operation.
statusstringOperation status.
percentComplete?float64Percent of the operation that is complete.
startTime?utcDateTimeThe start time of the operation.
endTime?utcDateTimeThe end time of the operation.
operations?ResourceManager.CommonTypes.OperationStatusResult[]The operations list.
error?ErrorDetailIf present, details of the operation error.

Plan

Plan for the resource.

model Azure.ResourceManager.CommonTypes.Plan

Properties

NameTypeDescription
namestringA user defined name of the 3rd Party Artifact that is being procured.
publisherstringThe publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
productstringThe 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?stringA publisher provided promotion code as provisioned in Data Market for the said product/artifact.
version?stringThe version of the desired product/artifact.

PrivateEndpoint

The Private Endpoint resource.

model Azure.ResourceManager.CommonTypes.PrivateEndpoint

Properties

NameTypeDescription
id?Core.armResourceIdentifierThe resource identifier for private endpoint

PrivateEndpointConnection

The private endpoint connection resource

model Azure.ResourceManager.CommonTypes.PrivateEndpointConnection

Properties

NameTypeDescription
properties?PrivateEndpointConnectionPropertiesThe private endpoint connection properties

PrivateEndpointConnectionListResult

List of private endpoint connections associated with the specified resource.

model Azure.ResourceManager.CommonTypes.PrivateEndpointConnectionListResult

Properties

NameTypeDescription
value?ResourceManager.CommonTypes.PrivateEndpointConnection[]Array of private endpoint connections.
nextLink?stringURL to get the next set of operation list results (if there are any).

PrivateEndpointConnectionListResultV5

List of private endpoint connections associated with the specified resource before version v6.

This model represents the standard PrivateEndpointConnectionResourceListResult envelope for versions v3, v4, and v5. It has been deprecated for v6 and beyond.

Note: This is only intended for use with versions before v6. Do not use this if you are already on CommonTypes.Version.v6 or beyond.

If you are migrating to v6 or above, use PrivateEndpointConnectionResourceListResult directly.

model Azure.ResourceManager.CommonTypes.PrivateEndpointConnectionListResultV5

Examples

Version: v3,v4,v5

@armResourceOperations
interface Employees {
createConnection is ArmResourceActionAsync<
Employee,
PrivateEndpointConnection,
PrivateEndpointConnectionResourceListResultV5
>;
}

Version: v6

@armResourceOperations
interface Employees {
createConnection is ArmResourceActionAsync<
Employee,
PrivateEndpointConnection,
PrivateEndpointConnectionResourceListResult
>;
}

Properties

NameTypeDescription
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

NameDescription
SegmentThe resource type name for private endpoint connections (default is privateEndpointConnections)

Properties

NameTypeDescription
namestringThe name of the private endpoint connection associated with the Azure resource.

PrivateEndpointConnectionProperties

Properties of the private endpoint connection.

model Azure.ResourceManager.CommonTypes.PrivateEndpointConnectionProperties

Properties

NameTypeDescription
groupIds?string[]The group ids for the private endpoint resource.
privateEndpoint?PrivateEndpointThe private endpoint resource.
privateLinkServiceConnectionStatePrivateLinkServiceConnectionStateA collection of information about the state of the connection between service consumer and provider.
provisioningState?PrivateEndpointConnectionProvisioningStateThe provisioning state of the private endpoint connection resource.

PrivateLinkResource

A private link resource.

model Azure.ResourceManager.CommonTypes.PrivateLinkResource

Properties

NameTypeDescription
properties?PrivateLinkResourcePropertiesResource properties.

PrivateLinkResourceListResult

A list of private link resources.

model Azure.ResourceManager.CommonTypes.PrivateLinkResourceListResult

Properties

NameTypeDescription
value?ResourceManager.CommonTypes.PrivateLinkResource[]Array of private link resources
nextLink?stringURL to get the next set of operation list results (if there are any).

PrivateLinkResourceListResultV5

A list of private link resources for versions before v6.

This model represents the standard PrivateLinkResourceListResult envelope for versions v3, v4, and v5. It has been deprecated for v6 and beyond.

Note: This is only intended for use with versions before v6. Do not use this if you are already on CommonTypes.Version.v6 or beyond.

If you are migrating to v6 or above, use PrivateLinkResourceListResult directly.

model Azure.ResourceManager.CommonTypes.PrivateLinkResourceListResultV5

Examples

Version: v3,v4,v5

@armResourceOperations
interface Employees {
listConnections is ArmResourceActionAsync<Employee, {}, PrivateLinkResourceListResultV5>;
}

Version: v6

@armResourceOperations
interface Employees {
listConnections is ArmResourceActionAsync<Employee, {}, PrivateLinkResourceListResult>;
}

Properties

NameTypeDescription
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

NameDescription
SegmentThe resource type name for private links (default is privateLinkResources)

Properties

NameTypeDescription
namestringThe name of the private link associated with the Azure resource.

PrivateLinkResourceProperties

Properties of a private link resource.

model Azure.ResourceManager.CommonTypes.PrivateLinkResourceProperties

Properties

NameTypeDescription
groupId?stringThe 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

NameTypeDescription
status?PrivateEndpointServiceConnectionStatusIndicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
description?stringThe reason for approval/rejection of the connection.
actionsRequired?stringA message indicating if changes on the service provider require any updates on the consumer.

ProvisioningIssue

Describes a provisioning issue for a network security perimeter configuration

model Azure.ResourceManager.CommonTypes.ProvisioningIssue

Properties

NameTypeDescription
name?stringName of the issue
properties?ProvisioningIssueProperties

ProvisioningIssueProperties

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

model Azure.ResourceManager.CommonTypes.ProvisioningIssueProperties

Properties

NameTypeDescription
issueType?IssueTypeType of issue
severity?SeveritySeverity of the issue.
description?stringDescription of the issue
suggestedResourceIds?Core.armResourceIdentifier[]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

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

NameTypeDescription
id?Core.armResourceIdentifierFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name?stringThe name of the resource
type?stringThe type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
systemData?SystemDataAzure Resource Manager metadata containing createdBy and modifiedBy information.

ResourceAssociation

Information about resource association

model Azure.ResourceManager.CommonTypes.ResourceAssociation

Properties

NameTypeDescription
name?stringName of the resource association
accessMode?ResourceAssociationAccessMode

ResourceGroupNameParameter

The default resource group parameter type.

model Azure.ResourceManager.CommonTypes.ResourceGroupNameParameter

Properties

NameTypeDescription
resourceGroupNamestringThe 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

NameTypeDescription
managedBy?stringThe 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?stringMetadata 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?stringThe 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?ManagedServiceIdentity
sku?Sku
plan?Plan

ScopeParameter

The default Scope parameter type.

model Azure.ResourceManager.CommonTypes.ScopeParameter

Properties

NameTypeDescription
scopestringThe scope at which the operation is performed.

Sku

The resource model definition representing SKU

model Azure.ResourceManager.CommonTypes.Sku

Properties

NameTypeDescription
namestringThe name of the SKU. Ex - P3. It is typically a letter+number code
tier?SkuTierThis 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?stringThe SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
family?stringIf the service has different generations of hardware, for the same SKU, then that can be captured here.
capacity?int32If 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

NameTypeDescription
subscriptionIdCore.uuidThe 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

NameTypeDescription
principalId?Core.uuidThe service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId?Core.uuidThe tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
typeSystemAssignedServiceIdentityTypeThe 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

NameTypeDescription
createdBy?stringThe identity that created the resource.
createdByType?createdByTypeThe type of identity that created the resource.
createdAt?utcDateTimeThe timestamp of resource creation (UTC).
lastModifiedBy?stringThe identity that last modified the resource.
lastModifiedByType?createdByTypeThe type of identity that last modified the resource.
lastModifiedAt?utcDateTimeThe timestamp of resource last modification (UTC)

TenantIdParameter

The default ManagementGroupName parameter type.

model Azure.ResourceManager.CommonTypes.TenantIdParameter

Properties

NameTypeDescription
tenantIdCore.uuidThe 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

NameTypeDescription
tags?Record<string>Resource tags.
locationstringThe 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

NameTypeDescription
ResourceManager.CommonTypes.UserAssignedIdentity | nullAdditional properties

UserAssignedIdentity

User assigned identity properties

model Azure.ResourceManager.CommonTypes.UserAssignedIdentity

Properties

NameTypeDescription
principalId?Core.uuidThe principal ID of the assigned identity.
clientId?Core.uuidThe client ID of the assigned identity.

ResourceHome

An internal enum to indicate the resource support for various path types

enum Azure.ResourceManager.CommonTypes.ResourceHome
NameValueDescription
TenantThe resource is bound to a tenant
SubscriptionThe resource is bound to a subscription
LocationThe resource is bound to a location
ResourceGroupThe resource is bound to a resource group
ExtensionThe resource is bound to an extension

Versions

The Azure Resource Manager common-types versions.

enum Azure.ResourceManager.CommonTypes.Versions
NameValueDescription
v3The Azure Resource Manager v3 common types.
v4The Azure Resource Manager v4 common types.
v5The Azure Resource Manager v5 common types.
v6The Azure Resource Manager v6 common types.

AccessRuleDirection

Direction of Access Rule

union Azure.ResourceManager.CommonTypes.AccessRuleDirection

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

IssueType

Type of issue

union Azure.ResourceManager.CommonTypes.IssueType

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

NetworkSecurityPerimeterConfigurationProvisioningState

Provisioning state of a network security perimeter configuration that is being created or updated.

union Azure.ResourceManager.CommonTypes.NetworkSecurityPerimeterConfigurationProvisioningState

Origin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”

union Azure.ResourceManager.CommonTypes.Origin

PrivateEndpointConnectionProvisioningState

The current provisioning state.

union Azure.ResourceManager.CommonTypes.PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

The private endpoint connection status.

union Azure.ResourceManager.CommonTypes.PrivateEndpointServiceConnectionStatus

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’.

union Azure.ResourceManager.CommonTypes.PublicNetworkAccess

ResourceAssociationAccessMode

Access mode of the resource association

union Azure.ResourceManager.CommonTypes.ResourceAssociationAccessMode

ResourceIdentityType

union Azure.ResourceManager.CommonTypes.ResourceIdentityType

Severity

Severity of the issue.

union Azure.ResourceManager.CommonTypes.Severity

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.

union Azure.ResourceManager.CommonTypes.SkuTier

SystemAssignedServiceIdentityType

Type of managed service identity (either system assigned, or none).

union Azure.ResourceManager.CommonTypes.SystemAssignedServiceIdentityType

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.

model Azure.ResourceManager.Foundations.ArmTagsProperty

Properties

NameTypeDescription
tags?Record<string>Resource tags.

DefaultBaseParameters

Base parameters for a resource.

model Azure.ResourceManager.Foundations.DefaultBaseParameters<Resource>

Template Parameters

NameDescription
ResourceThe type of the resource.

Properties

NameTypeDescription
apiVersionstringThe API version to use for this operation.
subscriptionIdCore.uuidThe ID of the target subscription. The value must be an UUID.
locationstringThe location name.
resourceGroupNamestringThe name of the resource group. The name is case insensitive.
resourceUristringThe fully qualified Azure Resource manager identifier of the resource.

ExtensionBaseParameters

The static parameters for an extension resource

model Azure.ResourceManager.Foundations.ExtensionBaseParameters

Properties

NameTypeDescription
apiVersionstringThe API version to use for this operation.
resourceUristringThe fully qualified Azure Resource manager identifier of the resource.

ExtensionScope

Parameter model for listing an extension resource

model Azure.ResourceManager.Foundations.ExtensionScope<Resource>

Template Parameters

NameDescription
ResourceThe type of the resource.

Properties

NameTypeDescription
apiVersionstringThe API version to use for this operation.
resourceUristringThe fully qualified Azure Resource manager identifier of the resource.
provider"Microsoft.ThisWillBeReplaced"

LocationBaseParameters

The static parameters for a location-based resource

model Azure.ResourceManager.Foundations.LocationBaseParameters

Properties

NameTypeDescription
apiVersionstringThe API version to use for this operation.
subscriptionIdCore.uuidThe ID of the target subscription. The value must be an UUID.
locationstringThe location name.

LocationScope

Parameter model for listing a resource at the location scope

model Azure.ResourceManager.Foundations.LocationScope<Resource>

Template Parameters

NameDescription
ResourceThe type of the resource.

Properties

NameTypeDescription
apiVersionstringThe API version to use for this operation.
subscriptionIdCore.uuidThe ID of the target subscription. The value must be an UUID.
locationstringThe location name.
provider"Microsoft.ThisWillBeReplaced"

ProxyResourceUpdateModel

The type used for update operations of the resource.

model Azure.ResourceManager.Foundations.ProxyResourceUpdateModel<Resource, Properties>

Template Parameters

NameDescription
ResourceThe type of the resource.
PropertiesThe type of the properties.

Properties

NameTypeDescription
properties?ResourceManager.Foundations.ResourceUpdateModelProperties<Resource, Properties>

ResourceGroupBaseParameters

The static parameters for a resource-group based resource

model Azure.ResourceManager.Foundations.ResourceGroupBaseParameters

Properties

NameTypeDescription
apiVersionstringThe API version to use for this operation.
subscriptionIdCore.uuidThe ID of the target subscription. The value must be an UUID.
resourceGroupNamestringThe name of the resource group. The name is case insensitive.

ResourceGroupScope

Parameter model for listing a resource at the resource group scope

model Azure.ResourceManager.Foundations.ResourceGroupScope<Resource>

Template Parameters

NameDescription
ResourceThe type of the resource.

Properties

NameTypeDescription
apiVersionstringThe API version to use for this operation.
subscriptionIdCore.uuidThe ID of the target subscription. The value must be an UUID.
locationstringThe location name.
resourceGroupNamestringThe name of the resource group. The name is case insensitive.
resourceUristringThe fully qualified Azure Resource manager identifier of the resource.
provider"Microsoft.ThisWillBeReplaced"

ResourceUpdateModel

Defines a model type used to create named resource update models e.g. model MyResourceUpdate is ResourceUpdate<MyResourceProperties> {}

model Azure.ResourceManager.Foundations.ResourceUpdateModel<Resource, Properties>

Template Parameters

NameDescription
ResourceThe type of the resource.
PropertiesThe type of the properties.

Properties

NameTypeDescription
properties?ResourceManager.Foundations.ResourceUpdateModelProperties<Resource, Properties>The resource-specific properties for this resource.

ResourceUpdateModelProperties

Defines a properties type used to create named resource update models. This type is not used directly, it is referenced by ResourceUpdateModel.

model Azure.ResourceManager.Foundations.ResourceUpdateModelProperties<Resource, Properties>

Template Parameters

NameDescription
ResourceThe type of the resource.
PropertiesThe type of the properties.

Properties

None

SubscriptionBaseParameters

The static parameters for a subscription based resource

model Azure.ResourceManager.Foundations.SubscriptionBaseParameters

Properties

NameTypeDescription
apiVersionstringThe API version to use for this operation.
subscriptionIdCore.uuidThe ID of the target subscription. The value must be an UUID.

SubscriptionScope

Parameter model for listing a resource at the subscription scope

model Azure.ResourceManager.Foundations.SubscriptionScope<Resource>

Template Parameters

NameDescription
ResourceThe type of the resource.

Properties

NameTypeDescription
apiVersionstringThe API version to use for this operation.
subscriptionIdCore.uuidThe ID of the target subscription. The value must be an UUID.
provider"Microsoft.ThisWillBeReplaced"

TagsUpdateModel

The type used for updating tags in resources.

model Azure.ResourceManager.Foundations.TagsUpdateModel<Resource>

Template Parameters

NameDescription
ResourceThe type of the resource.

Properties

NameTypeDescription
tags?Record<string>Resource tags.

TenantBaseParameters

The static parameters for a tenant-based resource

model Azure.ResourceManager.Foundations.TenantBaseParameters

Properties

NameTypeDescription
apiVersionstringThe API version to use for this operation.

TenantScope

Parameter model for listing a resource at the tenant scope

model Azure.ResourceManager.Foundations.TenantScope<Resource>

Template Parameters

NameDescription
ResourceThe type of the resource.

Properties

NameTypeDescription
apiVersionstringThe API version to use for this operation.
provider"Microsoft.ThisWillBeReplaced"

Azure.ResourceManager.Legacy

ManagedServiceIdentityV4

Managed service identity (system assigned and/or user assigned identities)

model Azure.ResourceManager.Legacy.ManagedServiceIdentityV4

Properties

NameTypeDescription
principalId?Core.uuidThe service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId?Core.uuidThe tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
typeManagedServiceIdentityTypeThe type of managed identity assigned to this resource.
userAssignedIdentities?Record<ResourceManager.CommonTypes.UserAssignedIdentity>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.

model Azure.ResourceManager.Legacy.ManagedServiceIdentityV4Property

Examples

model Foo is TrackedResource<FooProperties> {
...ResourceNameParameter<Foo>;
...Legacy.ManagedServiceIdentityV4Property;
}

Properties

NameTypeDescription
identity?ManagedServiceIdentityV4The managed service identities assigned to this resource.

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

union Azure.ResourceManager.Legacy.ManagedServiceIdentityType