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@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
ArmAcceptedLroResponseArmAcceptedResponseArmAsyncOperationHeaderArmCombinedLroHeadersArmCreatedResponseArmDeleteAcceptedLroResponseArmDeleteAcceptedResponseArmDeletedNoContentResponseArmDeletedResponseArmLocationResourceArmLroLocationHeaderArmNoContentResponseArmOperationStatusArmResourceCreatedResponseArmResourceCreatedSyncResponseArmResourceExistsResponseArmResourceNotFoundResponseArmResourceUpdatedResponseArmResponseAvailabilityZonesPropertyDefaultProvisioningStatePropertyEncryptionPropertyEntityTagPropertyExtendedLocationPropertyExtensionActionScopeExtensionResourceExtensionResourceActionScopeKeysOfLocationParameterLocationResourceParameterManagedByPropertyManagedServiceIdentityPropertyManagedSystemAssignedIdentityPropertyParentKeysOfPrivateEndpointConnectionResourcePrivateEndpointConnectionUpdatePrivateLinkProviderNamespaceProxyResourceResourceGroupLocationResourceResourceInstanceParametersResourceKindPropertyResourceListCustomResultResourceListResultResourceNameParameterResourceOperationOptionsResourceParentParametersResourcePlanPropertyResourceSkuPropertyResourceUriParameterSubscriptionActionScopeSubscriptionLocationResourceTenantActionScopeTenantLocationResourceTrackedResource
Azure.ResourceManager.CommonTypes
Section titled “Azure.ResourceManager.CommonTypes”AccessRuleAccessRulePropertiesApiVersionParameterAzureEntityResourceCheckNameAvailabilityRequestCheckNameAvailabilityResponseCustomerManagedKeyEncryptionDelegatedResourceDelegatedResourcesEncryptionEncryptionPropertiesErrorAdditionalInfoErrorDetailErrorResponseExtendedLocationExtensionResourceIdentityIfMatchHeaderIfNoneMatchHeaderKeyEncryptionKeyIdentityKeyVaultPropertiesLocationDataLocationParameterManagedOnBehalfOfConfigurationManagedServiceIdentityManagedServiceIdentityWithDelegationManagementGroupNameParameterMoboBrokerResourceNetworkSecurityPerimeterNetworkSecurityPerimeterConfigurationNetworkSecurityPerimeterConfigurationListResultNetworkSecurityPerimeterConfigurationNameParameterNetworkSecurityPerimeterConfigurationPropertiesNetworkSecurityProfileOperationOperationDisplayOperationIdParameterOperationListResultOperationStatusResultPlanPrivateEndpointPrivateEndpointConnectionPrivateEndpointConnectionListResultPrivateEndpointConnectionListResultV5PrivateEndpointConnectionParameterPrivateEndpointConnectionPropertiesPrivateLinkResourcePrivateLinkResourceListResultPrivateLinkResourceListResultV5PrivateLinkResourceParameterPrivateLinkResourcePropertiesPrivateLinkServiceConnectionStateProvisioningIssueProvisioningIssuePropertiesProxyResourceResourceResourceAssociationResourceGroupNameParameterResourceModelWithAllowedPropertySetScopeParameterSkuSubscriptionIdParameterSystemAssignedServiceIdentitySystemDataTenantIdParameterTrackedResourceUserAssignedIdentitiesUserAssignedIdentity
Azure.ResourceManager.Extension
Section titled “Azure.ResourceManager.Extension”Operations
Section titled “Operations”ActionAsyncActionAsyncBaseActionNoContentSyncActionNoResponseContentAsyncActionSyncCheckExistenceCreateOrReplaceAsyncCreateOrReplaceSyncCreateOrUpdateAsyncCustomPatchAsyncCustomPatchSyncDeleteAsyncDeleteAsyncBaseDeleteSyncDeleteWithoutOkAsyncListByTargetRead
ExtensionInstanceParametersExtensionParentParametersExtensionProviderNamespaceExternalChildResourceExternalResourceManagementGroupResourceGroupScopeParameterSubscriptionTargetBaseParametersTargetParametersTargetProviderNamespaceTenant
Azure.ResourceManager.Foundations
Section titled “Azure.ResourceManager.Foundations”Operations
Section titled “Operations”ArmTagsPropertyDefaultBaseParametersExtensionBaseParametersExtensionScopeLocationBaseParametersLocationScopeProxyResourceUpdateModelResourceGroupBaseParametersResourceGroupScopeResourceUpdateModelResourceUpdateModelPropertiesSimpleResourceSubscriptionBaseParametersSubscriptionScopeTagsUpdateModelTenantBaseParametersTenantScope
Azure.ResourceManager.Legacy
Section titled “Azure.ResourceManager.Legacy”Decorators
Section titled “Decorators”Interfaces
Section titled “Interfaces”Operations
Section titled “Operations”ArmListSinglePageByParentArmListSinglePageBySubscriptionCreateOperationCreateOrReplaceAsyncCreateOrReplaceSyncCustomPatchAsyncCustomPatchSyncUpdateOperation
ArmOperationOptionsCustomResourceOptionsDiscriminatedExtensionResourceDiscriminatedProxyResourceDiscriminatedTrackedResourceExtendedLocationOptionalExtendedLocationOptionalPropertyManagedServiceIdentityV4ManagedServiceIdentityV4PropertyProviderProviderParameterResourceWithPathParameterTrackedResourceWithOptionalLocation