Overview
TypeSpec Azure Resource Manager library
Install
Section titled “Install”npm install @azure-tools/typespec-azure-resource-managernpm install --save-peer @azure-tools/typespec-azure-resource-managerAzure.ResourceManager
Section titled “Azure.ResourceManager”Decorators
Section titled “Decorators”@armCommonTypesVersion@armLibraryNamespace@armProviderNamespace@armProviderNameValue@armResourceAction@armResourceCheckExistence@armResourceCollectionAction@armResourceCreateOrUpdate@armResourceDelete@armResourceList@armResourceOperations@armResourceRead@armResourceUpdate@armVirtualResource@extensionResource@identifiers@locationResource@resourceBaseType@resourceGroupResource@singleton@subscriptionResource@tenantResource@useLibraryNamespace
Interfaces
Section titled “Interfaces”ExtensionResourceCollectionOperationsExtensionResourceInstanceOperationsExtensionResourceOperationsOperationsPrivateEndpointsPrivateLinksProxyResourceOperationsResourceCollectionOperationsResourceCreateAsyncResourceCreateSyncResourceDeleteAsyncResourceDeleteSyncResourceDeleteWithoutOkAsyncResourceInstanceOperationsResourceListByParentResourceListBySubscriptionResourceOperationsResourceReadResourceUpdateAsyncResourceUpdateSyncTenantResourceOperationsTrackedResourceOperations
Operations
Section titled “Operations”ArmCustomPatchAsyncArmCustomPatchSyncArmListBySubscriptionArmProviderActionAsyncArmProviderActionSyncArmResourceActionAsyncArmResourceActionAsyncBaseArmResourceActionNoContentAsyncArmResourceActionNoContentSyncArmResourceActionNoResponseContentAsyncArmResourceActionSyncArmResourceCheckExistenceArmResourceCreateOrReplaceAsyncArmResourceCreateOrReplaceSyncArmResourceCreateOrUpdateAsyncArmResourceCreateOrUpdateSyncArmResourceDeleteAsyncArmResourceDeleteAsyncBaseArmResourceDeleteSyncArmResourceDeleteWithoutOkAsyncArmResourceListAtScopeArmResourceListByParentArmResourcePatchAsyncArmResourcePatchSyncArmResourceReadArmTagsPatchAsyncArmTagsPatchSynccheckGlobalNameAvailabilitycheckLocalNameAvailability
Models
Section titled “Models”ArmAcceptedLroResponseArmAcceptedResponseArmAsyncOperationHeaderArmCombinedLroHeadersArmCreatedResponseArmDeleteAcceptedLroResponseArmDeleteAcceptedResponseArmDeletedNoContentResponseArmDeletedResponseArmLocationResourceArmLroLocationHeaderArmNoContentResponseArmOperationStatusArmResourceCreatedResponseArmResourceCreatedSyncResponseArmResourceExistsResponseArmResourceNotFoundResponseArmResourceUpdatedResponseArmResponseAvailabilityZonesPropertyDefaultProvisioningStatePropertyEncryptionPropertyEntityTagPropertyExtendedLocationPropertyExtensionActionScopeExtensionResourceExtensionResourceActionScopeKeysOfLocationParameterLocationResourceParameterManagedByPropertyManagedServiceIdentityPropertyManagedSystemAssignedIdentityPropertyParentKeysOfPrivateEndpointConnectionResourcePrivateEndpointConnectionUpdatePrivateLinkProviderNamespaceProxyResourceResourceGroupLocationResourceResourceInstanceParametersResourceKindPropertyResourceListCustomResultResourceListResultResourceNameParameterResourceOperationOptionsResourceParentParametersResourcePlanPropertyResourceSkuPropertyResourceUriParameterSubscriptionActionScopeSubscriptionLocationResourceTenantActionScopeTenantLocationResourceTrackedResource
Azure.ResourceManager.CommonTypes
Section titled “Azure.ResourceManager.CommonTypes”Interfaces
Section titled “Interfaces”Models
Section titled “Models”AccessRuleAccessRulePropertiesApiVersionParameterAzureEntityResourceCheckNameAvailabilityRequestCheckNameAvailabilityResponseCustomerManagedKeyEncryptionDelegatedResourceDelegatedResourcesEncryptionEncryptionPropertiesErrorAdditionalInfoErrorDetailErrorResponseExtendedLocationExtensionResourceIdentityIfMatchHeaderIfNoneMatchHeaderKeyEncryptionKeyIdentityKeyVaultPropertiesLocationDataLocationParameterManagedOnBehalfOfConfigurationManagedServiceIdentityManagedServiceIdentityWithDelegationManagementGroupNameParameterMoboBrokerResourceNetworkSecurityPerimeterNetworkSecurityPerimeterConfigurationNetworkSecurityPerimeterConfigurationListResultNetworkSecurityPerimeterConfigurationNameParameterNetworkSecurityPerimeterConfigurationPropertiesNetworkSecurityProfileNspConfigurationNameParameterNspConfigurationResourceOperationOperationDisplayOperationIdParameterOperationListResultOperationStatusResultPlanPrivateEndpointPrivateEndpointConnectionPrivateEndpointConnectionListResultPrivateEndpointConnectionListResultV5PrivateEndpointConnectionParameterPrivateEndpointConnectionPropertiesPrivateLinkResourcePrivateLinkResourceListResultPrivateLinkResourceListResultV5PrivateLinkResourceParameterPrivateLinkResourcePropertiesPrivateLinkServiceConnectionStateProvisioningIssueProvisioningIssuePropertiesProxyResourceResourceResourceAssociationResourceGroupNameParameterResourceModelWithAllowedPropertySetScopeParameterSkuSubscriptionIdParameterSystemAssignedServiceIdentitySystemDataTenantIdParameterTrackedResourceUserAssignedIdentitiesUserAssignedIdentity
Azure.ResourceManager.Extension
Section titled “Azure.ResourceManager.Extension”Operations
Section titled “Operations”ActionAsyncActionAsyncBaseActionNoContentSyncActionNoResponseContentAsyncActionSyncCheckExistenceCreateOrReplaceAsyncCreateOrReplaceSyncCreateOrUpdateAsyncCustomPatchAsyncCustomPatchSyncDeleteAsyncDeleteAsyncBaseDeleteSyncDeleteWithoutOkAsyncListByTargetRead
Models
Section titled “Models”ExtensionInstanceParametersExtensionParentParametersExtensionProviderNamespaceExternalChildResourceExternalResourceManagementGroupResourceGroupScopeParameterSubscriptionTargetBaseParametersTargetParametersTargetProviderNamespaceTenant
Azure.ResourceManager.Foundations
Section titled “Azure.ResourceManager.Foundations”Operations
Section titled “Operations”Models
Section titled “Models”ArmTagsPropertyDefaultBaseParametersExtensionBaseParametersExtensionScopeLocationBaseParametersLocationScopeProxyResourceUpdateModelResourceGroupBaseParametersResourceGroupScopeResourceUpdateModelResourceUpdateModelPropertiesSimpleResourceSubscriptionBaseParametersSubscriptionScopeTagsUpdateModelTenantBaseParametersTenantScope
Azure.ResourceManager.Legacy
Section titled “Azure.ResourceManager.Legacy”Decorators
Section titled “Decorators”@armExternalType@armOperationRoute@customAzureResource@externalTypeRef@feature@featureOptions@features@renamePathParameter
Interfaces
Section titled “Interfaces”Operations
Section titled “Operations”ArmListSinglePageByParentArmListSinglePageBySubscriptionCreateOperationCreateOrReplaceAsyncCreateOrReplaceSyncCustomPatchAsyncCustomPatchSyncUpdateOperation
Models
Section titled “Models”ArmFeatureOptionsArmOperationOptionsCustomAzureResourceCustomResourceOptionsDiscriminatedExtensionResourceDiscriminatedProxyResourceDiscriminatedTrackedResourceExtendedLocationOptionalExtendedLocationOptionalPropertyManagedServiceIdentityV4ManagedServiceIdentityV4PropertyPolymorphicResourceKindPropertyProviderProviderParameterResourceWithPathParameterTrackedResourceWithOptionalLocation