Interfaces and Operations

Azure.ResourceManager

`ExtensionResourceCollectionOperations`

A composite interface for resource collections that include a paginated list operation.

interface Azure.ResourceManager.ExtensionResourceCollectionOperations<Resource>

Template Parameters

Name	Description
Resource	The ArmResource that provides these operations

`ExtensionResourceCollectionOperations.listByParent` {#Azure.ResourceManager.ExtensionResourceCollectionOperations.listByParent}

List resources by parent.

op Azure.ResourceManager.ExtensionResourceCollectionOperations<Resource>.listByParent(apiVersion: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse<Azure.ResourceManager.ResourceListResult<Resource>> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ExtensionResourceInstanceOperations`

A composite interface for resources that includes CRUD operations.

interface Azure.ResourceManager.ExtensionResourceInstanceOperations<Resource, Properties>

Template Parameters

Name	Description
Resource	The ArmResource that provides these operations
Properties	RP-specific property bag for the resource

`ExtensionResourceInstanceOperations.get`

Retrieve a resource.

op Azure.ResourceManager.ExtensionResourceInstanceOperations<Resource, Properties>.get(apiVersion: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse<ResponseBody> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ExtensionResourceInstanceOperations.createOrUpdate`

Create or update a resource using the asynchronous call pattern.

op Azure.ResourceManager.ExtensionResourceInstanceOperations<Resource, Properties>.createOrUpdate(apiVersion: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse<Resource> | Azure.ResourceManager.ArmResourceCreatedResponse<Resource, LroHeaders> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ExtensionResourceInstanceOperations.update`

Update a resource using the synchronous call pattern.

op Azure.ResourceManager.ExtensionResourceInstanceOperations<Resource, Properties>.update(apiVersion: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced", properties: Azure.ResourceManager.Foundations.ResourceUpdateModel<Resource, Properties>): Azure.ResourceManager.ArmResponse<ResponseBody> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ExtensionResourceInstanceOperations.delete`

Delete a resource using the asynchronous call pattern.

op Azure.ResourceManager.ExtensionResourceInstanceOperations<Resource, Properties>.delete(apiVersion: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse<Azure.ResourceManager.{ location: string, retryAfter: int32 }> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.CommonTypes.ErrorResponse

`ExtensionResourceOperations`

A composite interface for resources that include CRUD and list operations.

interface Azure.ResourceManager.ExtensionResourceOperations<Resource, Properties>

Template Parameters

Name	Description
Resource	The ArmResource that provides these operations
Properties	RP-specific property bag for the resource

`ExtensionResourceOperations.get`

Retrieve a resource.

op Azure.ResourceManager.ExtensionResourceOperations<Resource, Properties>.get(apiVersion: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse<ResponseBody> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ExtensionResourceOperations.createOrUpdate`

Create or update a resource using the asynchronous call pattern.

op Azure.ResourceManager.ExtensionResourceOperations<Resource, Properties>.createOrUpdate(apiVersion: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse<Resource> | Azure.ResourceManager.ArmResourceCreatedResponse<Resource, LroHeaders> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ExtensionResourceOperations.update`

Update a resource using the synchronous call pattern.

op Azure.ResourceManager.ExtensionResourceOperations<Resource, Properties>.update(apiVersion: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced", properties: Azure.ResourceManager.Foundations.ResourceUpdateModel<Resource, Properties>): Azure.ResourceManager.ArmResponse<ResponseBody> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ExtensionResourceOperations.delete`

Delete a resource using the asynchronous call pattern.

op Azure.ResourceManager.ExtensionResourceOperations<Resource, Properties>.delete(apiVersion: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse<Azure.ResourceManager.{ location: string, retryAfter: int32 }> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.CommonTypes.ErrorResponse

`ExtensionResourceOperations.listByParent`

List resources by parent.

op Azure.ResourceManager.ExtensionResourceOperations<Resource, Properties>.listByParent(apiVersion: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse<Azure.ResourceManager.ResourceListResult<Resource>> | Azure.ResourceManager.CommonTypes.ErrorResponse

`Operations`

This is the interface that implements the standard Azure Resource Manager operation that returns all supported RP operations. You should have exactly one declaration for each Azure Resource Manager service. It implements GET “/providers/Microsoft.ContosoProviderHub/operations”

interface Azure.ResourceManager.Operations<>

`Operations.list`

List the operations for the provider.

op Azure.ResourceManager.Operations.list(apiVersion: string, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse<Azure.ResourceManager.CommonTypes.OperationListResult> | Azure.ResourceManager.CommonTypes.ErrorResponse

`PrivateEndpoints`

Operations over private endpoint connection resources.

interface Azure.ResourceManager.PrivateEndpoints<PrivateEndpointResource, ResourceName, ResourceParameter>

Template Parameters

Name	Description
PrivateEndpointResource	The type of the private endpoint connection resource. You must declare a private endpoint connection resource type in your provider namespace.
ResourceName	Optional. The name of the private endpoint connection resource in this context, by default, this is `{targetResourceName}PrivateEndpointConnection`.
ResourceParameter	Optional. The name parameter model for the private endpoint connection resource. By default, this parameter has no constraints

`PrivateEndpoints.ListByParent`

List the private endpoint connections over a resource

op Azure.ResourceManager.PrivateEndpoints<PrivateEndpointResource, ResourceName, ResourceParameter>.ListByParent(provider: "Microsoft.ThisWillBeReplaced"): Response | Error

Template Parameters

Name	Description
ParentResource	the parent resource of the PrivateEndpointConnection
Resource	Optional. The PrivateEndpointConnection resource being listed
BaseParameters	Optional. Allows overriding the operation parameters
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the list operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. The name of the private endpoint connection resource being operated on.

`PrivateEndpoints.Read`

GET the a private endpoint connection for a particular resource

op Azure.ResourceManager.PrivateEndpoints<PrivateEndpointResource, ResourceName, ResourceParameter>.Read(provider: "Microsoft.ThisWillBeReplaced"): Response | Error

Template Parameters

Name	Description
ParentResource	the parent resource of the PrivateEndpointConnection
Resource	the PrivateEndpointConnection resource being read
BaseParameters	Optional. Allows overriding the operation parameters
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the read operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. The name of the private endpoint connection resource being operated on.

`PrivateEndpoints.CreateOrUpdateAsync`

A long-running resource CreateOrUpdate (PUT) for a PrivateEndpointConnection to a resource

op Azure.ResourceManager.PrivateEndpoints<PrivateEndpointResource, ResourceName, ResourceParameter>.CreateOrUpdateAsync(provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Response | Error

Template Parameters

Name	Description
ParentResource	the parent resource of the PrivateEndpointConnection
Resource	the PrivateEndpointConnection resource being created or updated
BaseParameters	Optional. Allows overriding the operation parameters
LroHeaders	Optional. Allows overriding the lro headers returned on resource create
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the createOrUpdate operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. The name of the private endpoint connection resource being operated on.

`PrivateEndpoints.CreateOrReplaceSync`

Synchronous PUT operation for a Private endpoint connection to a resource

op Azure.ResourceManager.PrivateEndpoints<PrivateEndpointResource, ResourceName, ResourceParameter>.CreateOrReplaceSync(provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Response | Error

Template Parameters

Name	Description
ParentResource	the parent resource of the PrivateEndpointConnection
Resource	the PrivateEndpointConnection resource being created or updated
BaseParameters	Optional. Allows overriding the operation parameters
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the createOrUpdate operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. The name of the private endpoint connection resource being operated on.

`PrivateEndpoints.CreateOrReplaceAsync`

A long-running resource CreateOrUpdate (PUT) for a PrivateEndpointConnection to a resource

op Azure.ResourceManager.PrivateEndpoints<PrivateEndpointResource, ResourceName, ResourceParameter>.CreateOrReplaceAsync(provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Response | Error

Template Parameters

Name	Description
ParentResource	the parent resource of the PrivateEndpointConnection
Resource	the PrivateEndpointConnection resource being created or updated
BaseParameters	Optional. Allows overriding the operation parameters
LroHeaders	Optional. Allows overriding the lro headers returned on resource create
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the createOrReplace operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. The name of the private endpoint connection resource being operated on.

`PrivateEndpoints.CustomPatchAsync`

A long-running resource update using a custom PATCH payload (Asynchronous) to update a PrivateEndpointConnection to a resource.

op Azure.ResourceManager.PrivateEndpoints<PrivateEndpointResource, ResourceName, ResourceParameter>.CustomPatchAsync(provider: "Microsoft.ThisWillBeReplaced", properties: PatchModel): Response | Error

Template Parameters

Name	Description
ParentResource	the parent resource of the PrivateEndpointConnection
Resource	the PrivateEndpointConnection resource being updated
PatchModel	The input model for the PATCH request
BaseParameters	Optional. Allows overriding the operation parameters
LroHeaders	Optional. Allows overriding the lro headers returned in the Accepted response
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the patch operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. The name of the private endpoint connection resource being operated on.

`PrivateEndpoints.CustomPatchSync`

A resource update using a custom PATCH payload (synchronous) to update a PrivateEndpointConnection to a resource

op Azure.ResourceManager.PrivateEndpoints<PrivateEndpointResource, ResourceName, ResourceParameter>.CustomPatchSync(provider: "Microsoft.ThisWillBeReplaced", properties: PatchModel): Response | Error

Template Parameters

Name	Description
ParentResource	The parent resource of the PrivateEndpointConnection
Resource	Optional. The PrivateEndpointConnection resource being patched
PatchModel	The input model for the PATCH request
BaseParameters	Optional. Allows overriding the operation parameters
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the patch operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. The name of the private endpoint connection resource being operated on.

`PrivateEndpoints.DeleteAsync`

Delete a PrivateEndpointConnection to a resource asynchronously

op Azure.ResourceManager.PrivateEndpoints<PrivateEndpointResource, ResourceName, ResourceParameter>.DeleteAsync(provider: "Microsoft.ThisWillBeReplaced"): Response | Error

Template Parameters

Name	Description
ParentResource	The parent resource of the PrivateEndpointConnection
Resource	Optional. The PrivateEndpointConnection resource being deleted
BaseParameters	Optional. Allows overriding the parameters for the operation
LroHeaders	Optional. Allows overriding the headers returned in the Accepted response
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response(s) for the delete operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. The name of the private endpoint connection resource being operated on.

`PrivateEndpoints.DeleteSync`

Delete a PrivateEndpointConnection to a resource synchronously

op Azure.ResourceManager.PrivateEndpoints<PrivateEndpointResource, ResourceName, ResourceParameter>.DeleteSync(provider: "Microsoft.ThisWillBeReplaced"): Response | Error

Template Parameters

Name	Description
ParentResource	The parent resource of the PrivateEndpointConnection
Resource	The PrivateEndpointConnection resource being deleted
BaseParameters	Optional. Allows overriding the parameters for the operation
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response(s) for the delete operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. The name of the private endpoint connection resource being operated on.

`PrivateEndpoints.DeleteAsyncBase`

Delete a PrivateEndpointConnection to a resource asynchronously

op Azure.ResourceManager.PrivateEndpoints<PrivateEndpointResource, ResourceName, ResourceParameter>.DeleteAsyncBase(provider: "Microsoft.ThisWillBeReplaced"): Response | Error

Template Parameters

Name	Description
ParentResource	The parent resource of the PrivateEndpointConnection
Response	The response type for the operation
Resource	Optional. The PrivateEndpointConnection resource being deleted
BaseParameters	Optional. Allows overriding the parameters for the operation
Parameters	Optional. Additional parameters after the path parameters
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. The name of the private endpoint connection resource being operated on.

Examples

namespace Microsoft.Contoso;
model PrivateEndpointConnection is PrivateEndpointConnectionResource {}
alias EmployeeConnectionOps is PrivateEndpoints<PrivateEndpointConnection>;
@armResourceOperations
interface Employees {
 @doc("get a private endpoint connection for resource employee")
 getPrivateEndpointConnection is EmployeeConnectionOps.Read<Employee>;
}

`PrivateLinks`

Operations over private link resources.

interface Azure.ResourceManager.PrivateLinks<PrivateLinkResourceModel, ResourceName, ResourceParameter>

Template Parameters

Name	Description
PrivateLinkResourceModel	The type of the private link resource. You must declare a private link resource type in your provider namespace.
ResourceName	Optional. The name of the private link resource in this context, by default, this is `{targetResourceName}PrivateLink`.
ResourceParameter	Optional. The name parameter model for the private link resource. By default, this is `PrivateLinkResourceParameter`, which has a required path parameter for the private link resource name. You can use this template parameter to specify a different parameter type if needed, but it must include at least a path parameter for the private link resource name.

`PrivateLinks.ListByParent`

List the private links to a resource

op Azure.ResourceManager.PrivateLinks<PrivateLinkResourceModel, ResourceName, ResourceParameter>.ListByParent(provider: "Microsoft.ThisWillBeReplaced"): Response | Error

Template Parameters

Name	Description
ParentResource	the parent resource of the PrivateLink
Resource	Optional. The PrivateLink resource being listed
BaseParameters	Optional. Allows overriding the operation parameters
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the list operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. The name of the private link resource being operated on.

`PrivateLinks.ListSinglePageByParent`

List the private links to a resource - this should only be used for legacy operations

op Azure.ResourceManager.PrivateLinks<PrivateLinkResourceModel, ResourceName, ResourceParameter>.ListSinglePageByParent(provider: "Microsoft.ThisWillBeReplaced"): Response | Error

Template Parameters

Name	Description
ParentResource	the parent resource of the PrivateLink
Resource	Optional. The PrivateLink resource being listed
BaseParameters	Optional. Allows overriding the operation parameters
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the list operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. The name of the private link resource being operated on.

`PrivateLinks.Read`

GET the a private link to a particular resource

op Azure.ResourceManager.PrivateLinks<PrivateLinkResourceModel, ResourceName, ResourceParameter>.Read(provider: "Microsoft.ThisWillBeReplaced"): Response | Error

Template Parameters

Name	Description
ParentResource	the parent resource of the PrivateLink
Resource	the PrivateLink resource being read
BaseParameters	Optional. Allows overriding the operation parameters
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the read operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. The name of the private link resource being operated on.

Examples

namespace Microsoft.Contoso;
model PrivateLink is PrivateLinkResource {}
alias EmployeeConnectionOps is PrivateLinks<PrivateLink>;
@armResourceOperations
interface Employees {
 @doc("get a private link for resource employee")
 getPrivateLink is EmployeeConnectionOps.Read<Employee>;
}

`ProxyResourceOperations`

A composite interface for Proxy resources that include ResourceInstanceOperations<Resource, Properties> and ResourceListByParent<Resource>. It includes: GET, PUT, PATCH, DELETE, ListByParent operations.

The actual route depends on the resource model but would have started with /subscriptions/{id}/resourcegroups/{rg}/providers/Microsoft.XXX/...

This is the most common API pattern for Proxy Resources to use.

interface Azure.ResourceManager.ProxyResourceOperations<Resource, BaseParameters>

Template Parameters

Name	Description
Resource	the ArmResource that provides these operations
BaseParameters	The http parameters that are part of the request

`ProxyResourceOperations.get`

Retrieve a resource.

op Azure.ResourceManager.ProxyResourceOperations<Resource, BaseParameters>.get(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse<ResponseBody> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ProxyResourceOperations.createOrUpdate`

Create or update a resource using the asynchronous call pattern.

op Azure.ResourceManager.ProxyResourceOperations<Resource, BaseParameters>.createOrUpdate(provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse<Resource> | Azure.ResourceManager.ArmResourceCreatedResponse<Resource, LroHeaders> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ProxyResourceOperations.delete`

Delete a resource using the asynchronous call pattern.

op Azure.ResourceManager.ProxyResourceOperations<Resource, BaseParameters>.delete(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse<Azure.ResourceManager.{ location: string, retryAfter: int32 }> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.CommonTypes.ErrorResponse

`ProxyResourceOperations.listByParent`

List resources by parent.

op Azure.ResourceManager.ProxyResourceOperations<Resource, BaseParameters>.listByParent(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse<Azure.ResourceManager.ResourceListResult<Resource>> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ResourceCollectionOperations`

A composite interface for resource collections.

interface Azure.ResourceManager.ResourceCollectionOperations<Resource, BaseParameters>

Template Parameters

Name	Description
Resource	The ArmResource that provides these operations
BaseParameters	The http parameters that are part of the request

`ResourceCollectionOperations.listByParent`

List resources by parent.

op Azure.ResourceManager.ResourceCollectionOperations<Resource, BaseParameters>.listByParent(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse<Azure.ResourceManager.ResourceListResult<Resource>> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ResourceCollectionOperations.listBySubscription`

List resources by subscription.

op Azure.ResourceManager.ResourceCollectionOperations<Resource, BaseParameters>.listBySubscription(apiVersion: string, subscriptionId: Azure.Core.uuid, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse<Azure.ResourceManager.ResourceListResult<Resource>> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ResourceCreateAsync`

A composite interface for resources that include a long-running create or update operation.

interface Azure.ResourceManager.ResourceCreateAsync<Resource, BaseParameters>

Template Parameters

Name	Description
Resource	The ArmResource that provides these operations
BaseParameters	The http parameters that are part of the request

`ResourceCreateAsync.createOrUpdate`

Create or update a resource using the asynchronous call pattern.

op Azure.ResourceManager.ResourceCreateAsync<Resource, BaseParameters>.createOrUpdate(provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse<Resource> | Azure.ResourceManager.ArmResourceCreatedResponse<Resource, LroHeaders> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ResourceCreateSync`

A composite interface for resources that include a synchronous create or update operation.

interface Azure.ResourceManager.ResourceCreateSync<Resource, BaseParameters>

Template Parameters

Name	Description
Resource	The ArmResource that provides these operations
BaseParameters	The http parameters that are part of the request

`ResourceCreateSync.createOrUpdate`

Create or update a resource using the synchronous call pattern.

op Azure.ResourceManager.ResourceCreateSync<Resource, BaseParameters>.createOrUpdate(provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse<Resource> | Azure.ResourceManager.ArmResourceCreatedSyncResponse<Resource> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ResourceDeleteAsync`

A composite interface for resources that include a long-running delete operation. DEPRECATED: Use ResourceDeleteWithoutOkAsync instead

interface Azure.ResourceManager.ResourceDeleteAsync<Resource, BaseParameters>

Template Parameters

Name	Description
Resource	The ArmResource that provides these operations
BaseParameters	The http parameters that are part of the request

`ResourceDeleteAsync.delete`

Delete a resource using the asynchronous call pattern.

op Azure.ResourceManager.ResourceDeleteAsync<Resource, BaseParameters>.delete(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse<Azure.ResourceManager.{ location: string, retryAfter: int32 }> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.CommonTypes.ErrorResponse

`ResourceDeleteSync`

A composite interface for resources that include a synchronous delete operation.

interface Azure.ResourceManager.ResourceDeleteSync<Resource, BaseParameters>

Template Parameters

Name	Description
Resource	The ArmResource that provides these operations
BaseParameters	The http parameters that are part of the request

`ResourceDeleteSync.delete`

Delete a resource using the synchronous call pattern.

op Azure.ResourceManager.ResourceDeleteSync<Resource, BaseParameters>.delete(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.CommonTypes.ErrorResponse

`ResourceDeleteWithoutOkAsync`

A composite interface for resources that include a long-running delete operation without returning a final OK response.

interface Azure.ResourceManager.ResourceDeleteWithoutOkAsync<Resource, BaseParameters>

Template Parameters

Name	Description
Resource	The ArmResource that provides these operations
BaseParameters	The http parameters that are part of the request

`ResourceDeleteWithoutOkAsync.delete`

Delete a resource using the asynchronous call pattern.

op Azure.ResourceManager.ResourceDeleteWithoutOkAsync<Resource, BaseParameters>.delete(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmDeleteAcceptedLroResponse<Azure.ResourceManager.{ location: string, retryAfter: int32 }> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.CommonTypes.ErrorResponse

`ResourceInstanceOperations`

A composite interface for resources that have CRUD operations.

interface Azure.ResourceManager.ResourceInstanceOperations<Resource, Properties, BaseParameters, PatchModel>

Template Parameters

Name	Description
Resource	The ArmResource that provides these operations
Properties	RP-specific property bag for the resource
BaseParameters	The http parameters that are part of the request
PatchModel	The model used for PATCH operations

`ResourceInstanceOperations.get`

Retrieve a resource.

op Azure.ResourceManager.ResourceInstanceOperations<Resource, Properties, BaseParameters, PatchModel>.get(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse<ResponseBody> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ResourceInstanceOperations.createOrUpdate`

Create or update a resource using the asynchronous call pattern.

op Azure.ResourceManager.ResourceInstanceOperations<Resource, Properties, BaseParameters, PatchModel>.createOrUpdate(provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse<Resource> | Azure.ResourceManager.ArmResourceCreatedResponse<Resource, LroHeaders> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ResourceInstanceOperations.update`

Update a resource using the synchronous call pattern.

op Azure.ResourceManager.ResourceInstanceOperations<Resource, Properties, BaseParameters, PatchModel>.update(provider: "Microsoft.ThisWillBeReplaced", properties: Azure.ResourceManager.Foundations.ResourceUpdateModel<Resource, Properties>): Azure.ResourceManager.ArmResponse<ResponseBody> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ResourceInstanceOperations.delete`

Delete a resource using the asynchronous call pattern.

op Azure.ResourceManager.ResourceInstanceOperations<Resource, Properties, BaseParameters, PatchModel>.delete(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse<Azure.ResourceManager.{ location: string, retryAfter: int32 }> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.CommonTypes.ErrorResponse

`ResourceListByParent`

An interface for resources which can be listed by parent.

interface Azure.ResourceManager.ResourceListByParent<Resource, BaseParameters, ParentName, ParentFriendlyName>

Template Parameters

Name	Description
Resource	The ArmResource that provides these operations
BaseParameters	The http parameters that are part of the request
ParentName	The name of the parent resource
ParentFriendlyName	The friendly name of the parent resource

`ResourceListByParent.listByParent`

List resources by parent.

op Azure.ResourceManager.ResourceListByParent<Resource, BaseParameters, ParentName, ParentFriendlyName>.listByParent(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse<Azure.ResourceManager.ResourceListResult<Resource>> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ResourceListBySubscription`

An interface for resources with can be listed by subscription.

interface Azure.ResourceManager.ResourceListBySubscription<Resource>

Template Parameters

Name	Description
Resource	The ArmResource that provides these operations

`ResourceListBySubscription.listBySubscription` {#Azure.ResourceManager.ResourceListBySubscription.listBySubscription}

List resources by subscription.

op Azure.ResourceManager.ResourceListBySubscription<Resource>.listBySubscription(apiVersion: string, subscriptionId: Azure.Core.uuid, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse<Azure.ResourceManager.ResourceListResult<Resource>> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ResourceOperations`

interface Azure.ResourceManager.ResourceOperations<Resource, Properties, BaseParameters>

Template Parameters

Name	Description
Resource	the ArmResource that provides these operations
Properties	RP-specific property bag for the resource
BaseParameters	The http parameters that are part of the request

`ResourceOperations.get`

Retrieve a resource.

op Azure.ResourceManager.ResourceOperations<Resource, Properties, BaseParameters>.get(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse<ResponseBody> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ResourceOperations.createOrUpdate`

Create or update a resource using the asynchronous call pattern.

op Azure.ResourceManager.ResourceOperations<Resource, Properties, BaseParameters>.createOrUpdate(provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse<Resource> | Azure.ResourceManager.ArmResourceCreatedResponse<Resource, LroHeaders> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ResourceOperations.update`

Update a resource using the synchronous call pattern.

op Azure.ResourceManager.ResourceOperations<Resource, Properties, BaseParameters>.update(provider: "Microsoft.ThisWillBeReplaced", properties: Azure.ResourceManager.Foundations.ResourceUpdateModel<Resource, Properties>): Azure.ResourceManager.ArmResponse<ResponseBody> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ResourceOperations.delete`

Delete a resource using the asynchronous call pattern.

op Azure.ResourceManager.ResourceOperations<Resource, Properties, BaseParameters>.delete(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse<Azure.ResourceManager.{ location: string, retryAfter: int32 }> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.CommonTypes.ErrorResponse

`ResourceOperations.listByParent`

List resources by parent.

op Azure.ResourceManager.ResourceOperations<Resource, Properties, BaseParameters>.listByParent(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse<Azure.ResourceManager.ResourceListResult<Resource>> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ResourceOperations.listBySubscription`

List resources by subscription.

op Azure.ResourceManager.ResourceOperations<Resource, Properties, BaseParameters>.listBySubscription(apiVersion: string, subscriptionId: Azure.Core.uuid, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse<Azure.ResourceManager.ResourceListResult<Resource>> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ResourceRead`

A composite interface for resources that include a GET operation.

interface Azure.ResourceManager.ResourceRead<Resource, BaseParameters>

Template Parameters

Name	Description
Resource	The ArmResource that provides these operations
BaseParameters	The http parameters that are part of the request

`ResourceRead.get`

Retrieve a resource.

op Azure.ResourceManager.ResourceRead<Resource, BaseParameters>.get(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse<ResponseBody> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ResourceUpdateAsync`

A composite interface for resources that include a long-running update operation.

interface Azure.ResourceManager.ResourceUpdateAsync<Resource, Properties, BaseParameters>

Template Parameters

Name	Description
Resource	The ArmResource that provides these operations
Properties	RP-specific property bag for the resource
BaseParameters	The http parameters that are part of the request

`ResourceUpdateAsync.update`

Update a resource using the asynchronous call pattern.

op Azure.ResourceManager.ResourceUpdateAsync<Resource, Properties, BaseParameters>.update(provider: "Microsoft.ThisWillBeReplaced", properties: Azure.ResourceManager.Foundations.ResourceUpdateModel<Resource, Properties>): Azure.ResourceManager.ArmResponse<ResponseBody> | Azure.ResourceManager.ArmAcceptedLroResponse<"Resource update request accepted.", Azure.ResourceManager.{ location: string, retryAfter: int32 }> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ResourceUpdateSync`

A composite interface for resources that include a synchronous update operation.

interface Azure.ResourceManager.ResourceUpdateSync<Resource, Properties, BaseParameters>

Template Parameters

Name	Description
Resource	The ArmResource that provides these operations
Properties	RP-specific property bag for the resource
BaseParameters	The http parameters that are part of the request

`ResourceUpdateSync.update`

Update a resource using the synchronous call pattern.

op Azure.ResourceManager.ResourceUpdateSync<Resource, Properties, BaseParameters>.update(provider: "Microsoft.ThisWillBeReplaced", properties: Azure.ResourceManager.Foundations.ResourceUpdateModel<Resource, Properties>): Azure.ResourceManager.ArmResponse<ResponseBody> | Azure.ResourceManager.CommonTypes.ErrorResponse

`TenantResourceOperations`

A composite interface for Tenant resources that include ResourceInstanceOperations<Resource, Properties> and ResourceListByParent<Resource>. It includes: GET, PUT, PATCH, DELETE, ListByParent operations.

The routes are always start at root level: /providers/Microsoft.XXX/...

This is the most common API pattern for Tenant Resources to use.

interface Azure.ResourceManager.TenantResourceOperations<Resource, Properties>

Template Parameters

Name	Description
Resource	the ArmResource that provides these operations
Properties	RP-specific property bag for the resource

`TenantResourceOperations.get`

Retrieve a resource.

op Azure.ResourceManager.TenantResourceOperations<Resource, Properties>.get(apiVersion: string, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse<ResponseBody> | Azure.ResourceManager.CommonTypes.ErrorResponse

`TenantResourceOperations.createOrUpdate`

Create or update a resource using the asynchronous call pattern.

op Azure.ResourceManager.TenantResourceOperations<Resource, Properties>.createOrUpdate(apiVersion: string, provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse<Resource> | Azure.ResourceManager.ArmResourceCreatedResponse<Resource, LroHeaders> | Azure.ResourceManager.CommonTypes.ErrorResponse

`TenantResourceOperations.update`

Update a resource using the synchronous call pattern.

op Azure.ResourceManager.TenantResourceOperations<Resource, Properties>.update(apiVersion: string, provider: "Microsoft.ThisWillBeReplaced", properties: Azure.ResourceManager.Foundations.ResourceUpdateModel<Resource, Properties>): Azure.ResourceManager.ArmResponse<ResponseBody> | Azure.ResourceManager.CommonTypes.ErrorResponse

`TenantResourceOperations.delete`

Delete a resource using the asynchronous call pattern.

op Azure.ResourceManager.TenantResourceOperations<Resource, Properties>.delete(apiVersion: string, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse<Azure.ResourceManager.{ location: string, retryAfter: int32 }> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.CommonTypes.ErrorResponse

`TenantResourceOperations.listByParent`

List resources by parent.

op Azure.ResourceManager.TenantResourceOperations<Resource, Properties>.listByParent(apiVersion: string, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse<Azure.ResourceManager.ResourceListResult<Resource>> | Azure.ResourceManager.CommonTypes.ErrorResponse

`TrackedResourceOperations`

A composite interface for resources that include ResourceInstanceOperations<Resource, Properties> and ResourceCollectionOperations<Resource>. It includes: GET, PUT, PATCH, DELETE, ListByParent, ListBySubscription operations. The actual route depends on the resource model. This is the most common API pattern for Tracked Resources to use.

interface Azure.ResourceManager.TrackedResourceOperations<Resource, Properties, BaseParameters>

Template Parameters

Name	Description
Resource	the ArmResource that provides these operations
Properties	RP-specific property bag for the resource
BaseParameters	The http parameters that are part of the request

`TrackedResourceOperations.get`

Retrieve a resource.

op Azure.ResourceManager.TrackedResourceOperations<Resource, Properties, BaseParameters>.get(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse<ResponseBody> | Azure.ResourceManager.CommonTypes.ErrorResponse

`TrackedResourceOperations.createOrUpdate`

Create or update a resource using the asynchronous call pattern.

op Azure.ResourceManager.TrackedResourceOperations<Resource, Properties, BaseParameters>.createOrUpdate(provider: "Microsoft.ThisWillBeReplaced", resource: Resource): Azure.ResourceManager.ArmResourceUpdatedResponse<Resource> | Azure.ResourceManager.ArmResourceCreatedResponse<Resource, LroHeaders> | Azure.ResourceManager.CommonTypes.ErrorResponse

`TrackedResourceOperations.update`

Update a resource using the synchronous call pattern.

op Azure.ResourceManager.TrackedResourceOperations<Resource, Properties, BaseParameters>.update(provider: "Microsoft.ThisWillBeReplaced", properties: Azure.ResourceManager.Foundations.ResourceUpdateModel<Resource, Properties>): Azure.ResourceManager.ArmResponse<ResponseBody> | Azure.ResourceManager.CommonTypes.ErrorResponse

`TrackedResourceOperations.delete`

Delete a resource using the asynchronous call pattern.

op Azure.ResourceManager.TrackedResourceOperations<Resource, Properties, BaseParameters>.delete(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeleteAcceptedLroResponse<Azure.ResourceManager.{ location: string, retryAfter: int32 }> | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.CommonTypes.ErrorResponse

`TrackedResourceOperations.listByParent`

List resources by parent.

op Azure.ResourceManager.TrackedResourceOperations<Resource, Properties, BaseParameters>.listByParent(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse<Azure.ResourceManager.ResourceListResult<Resource>> | Azure.ResourceManager.CommonTypes.ErrorResponse

`TrackedResourceOperations.listBySubscription`

List resources by subscription.

op Azure.ResourceManager.TrackedResourceOperations<Resource, Properties, BaseParameters>.listBySubscription(apiVersion: string, subscriptionId: Azure.Core.uuid, provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmResponse<Azure.ResourceManager.ResourceListResult<Resource>> | Azure.ResourceManager.CommonTypes.ErrorResponse

`ActionAsync`

The standard long-running resource action.

op Azure.ResourceManager.ActionAsync(body: Request): Azure.ResourceManager.ArmAcceptedLroResponse<Description, LroHeaders> | Error

Template Parameters

Name	Description
Resource	The resource being acted upon
Request	The request model for the action
Response	The response model for the action, returned after polling the long-running operation
BaseParameters	Optional. Allows overriding the parameters for the operation
LroHeaders	Optional. Allows overriding the headers returned in the Accepted response
Parameters	Optional. Additional parameters after the path parameters
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. Indicates whether the body parameter is optional.
Provider	Optional. The provider namespace model for the resource.

`ArmCustomPatchAsync`

A long-running resource update using a custom PATCH payload (Asynchronous)

op Azure.ResourceManager.ArmCustomPatchAsync(properties: PatchModel): Response | Error

Template Parameters

Name	Description
Resource	the resource being patched
PatchModel	The input model for the PATCH request
BaseParameters	Optional. Allows overriding the operation parameters
LroHeaders	Optional. Allows overriding the lro headers returned in the Accepted response
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the patch operation
Error	Optional. The error response, if non-standard.
Provider	Optional. The provider namespace model for the resource.

`ArmCustomPatchSync`

A resource update using a custom PATCH payload (synchronous)

op Azure.ResourceManager.ArmCustomPatchSync(properties: PatchModel): Response | Error

Template Parameters

Name	Description
Resource	the resource being patched
PatchModel	The input model for the PATCH request
BaseParameters	Optional. Allows overriding the operation parameters
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the patch operation
Error	Optional. The error response, if non-standard.
Provider	Optional. The provider namespace model for the resource.

`ArmListBySubscription`

A resource list operation, at the subscription scope

op Azure.ResourceManager.ArmListBySubscription(apiVersion: string, subscriptionId: Azure.Core.uuid, provider: "Microsoft.ThisWillBeReplaced"): Response | Error

Template Parameters

Name	Description
Resource	the resource being listed
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the list operation
Error	Optional. The error response, if non-standard.

`ArmListBySubscriptionScope`

A resource list operation, at the subscription scope, for any resource. This template generates a standard resource list operation at the subscription level,

op Azure.ResourceManager.ArmListBySubscriptionScope(apiVersion: string, subscriptionId: Azure.Core.uuid, provider: "Microsoft.ThisWillBeReplaced"): Response | Error

Template Parameters

Name	Description
Resource	the resource being listed
Parameters	Optional. Additional query or header parameters
Response	Optional. The success response for the list operation
Error	Optional. The error response, if non-standard.

`ArmProviderActionAsync`

A long-running provider action.

op Azure.ResourceManager.ArmProviderActionAsync(apiVersion: string, subscriptionId: Azure.Core.uuid, location: string, resourceGroupName: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced", body: Request): Azure.ResourceManager.ArmAcceptedLroResponse<Description, LroHeaders> | Response | Error

Template Parameters

Name	Description
Request	The request model for the action
Response	The response type for the action
Scope	The scope of the action (SubscriptionActionScope, TenantActionScope, or ExtensionResourceActionScope)
Parameters	Optional. Additional parameters after the path parameters (e.g. Location)
LroHeaders	Optional. Allows overriding the lro headers returned in the Accepted response
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. Indicates whether the request body is optional.

`ArmProviderActionSync`

A provider action performed over a tenant

op Azure.ResourceManager.ArmProviderActionSync(apiVersion: string, subscriptionId: Azure.Core.uuid, location: string, resourceGroupName: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced", body: Request): Response | Error

Template Parameters

Name	Description
Request	The request model for the action
Response	The response type for the action
Scope	The scope of the action (SubscriptionActionScope, TenantActionScope, or ExtensionResourceActionScope)
Parameters	Optional. Additional parameters after the path parameters (e.g. Location)
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. Indicates whether the request body is optional.

`ArmResourceActionAsync`

A long-running resource action.

op Azure.ResourceManager.ArmResourceActionAsync(body: Request): Azure.ResourceManager.ArmAcceptedLroResponse<Description, LroHeaders> | Response | Error

Template Parameters

Name	Description
Resource	The resource being acted upon
Request	The request model for the action
Response	The response model for the action
BaseParameters	Optional. Allows overriding the parameters for the operation
LroHeaders	Optional. Allows overriding the headers returned in the Accepted response
Parameters	Optional. Additional parameters after the path parameters
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. Indicates whether the body parameter is optional.
Provider	Optional. The provider namespace model for the resource.

`ArmResourceActionAsyncBase`

A long-running resource action.

op Azure.ResourceManager.ArmResourceActionAsyncBase(body: Request): Response | Error

Template Parameters

Name	Description
Resource	The resource being acted upon
Request	The request model for the action
Response	The response type for the action
BaseParameters	Optional. Allows overriding the parameters for the operation
Parameters	Optional. Additional parameters after the path parameters
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. Indicates whether the request body is optional.
Provider	Optional. The provider namespace model for the resource.

`ArmResourceActionNoContentAsync`

A long-running resource action that returns no content. DEPRECATED: Use ‘ArmResourceActionNoResponseContentAsync’ instead

op Azure.ResourceManager.ArmResourceActionNoContentAsync(body: Request): Azure.ResourceManager.ArmAcceptedLroResponse<Description, LroHeaders> | Azure.ResourceManager.ArmNoContentResponse<"Action completed successfully."> | Error

Template Parameters

Name	Description
Resource	The resource being acted upon
Request	The request model for the action
BaseParameters	Optional. Allows overriding the parameters for the operation
LroHeaders	Optional. Allows overriding the headers returned in the Accepted response
Parameters	Optional. Additional parameters after the path parameters
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. Indicates whether the body parameter is optional.
Provider	Optional. The provider namespace model for the resource.

`ArmResourceActionNoContentSync`

A synchronous resource action that returns no content.

op Azure.ResourceManager.ArmResourceActionNoContentSync(body: Request): Azure.ResourceManager.ArmNoContentResponse<"Action completed successfully."> | Error

Template Parameters

Name	Description
Resource	The resource being acted upon
Request	The request model for the action
BaseParameters	Optional. Allows overriding the parameters for the operation
Parameters	Optional. Additional parameters after the path parameters
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. Indicates whether the request body is optional.
Provider	Optional. The provider namespace model for the resource.

`ArmResourceActionNoResponseContentAsync`

A long-running resource action that returns no content.

op Azure.ResourceManager.ArmResourceActionNoResponseContentAsync(body: Request): Azure.ResourceManager.ArmAcceptedLroResponse<Description, LroHeaders> | Error

Template Parameters

Name	Description
Resource	The resource being acted upon
Request	The request model for the action
BaseParameters	Optional. Allows overriding the parameters for the operation
LroHeaders	Optional. Allows overriding the headers returned in the Accepted response
Parameters	Optional. Additional parameters after the path parameters
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. Indicates whether the body parameter is optional.
Provider	Optional. The provider namespace model for the resource.

`ArmResourceActionSync`

A synchronous resource action.

op Azure.ResourceManager.ArmResourceActionSync(body: Request): Response | Error

Template Parameters

Name	Description
Resource	The resource being acted upon
Request	The request model for the action
Response	The response model for the action
BaseParameters	Optional. Allows overriding the parameters for the operation
Parameters	Optional. Additional parameters after the path parameters
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. Indicates whether the body parameter is optional.
Provider	Optional. The provider namespace model for the resource.

`ArmResourceCheckExistence`

Check a resource’s existence via HEAD operation

op Azure.ResourceManager.ArmResourceCheckExistence(): Response | Error

Template Parameters

Name	Description
Resource	the resource being checked
BaseParameters	Optional. Allows overriding the operation parameters
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the read operation
Error	Optional. The error response, if non-standard.
Provider	Optional. The provider namespace model for the resource.

`ArmResourceCreateOrReplaceAsync`

A long-running resource CreateOrUpdate (PUT)

op Azure.ResourceManager.ArmResourceCreateOrReplaceAsync(resource: Resource): Response | Error

Template Parameters

Name	Description
Resource	the resource being created or replaced
BaseParameters	Optional. Allows overriding the operation parameters
LroHeaders	Optional. Allows overriding the lro headers returned on resource create
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the createOrReplace operation
Error	Optional. The error response, if non-standard.
Provider	Optional. The provider namespace model for the resource.

`ArmResourceCreateOrReplaceSync`

Synchronous PUT operation for Azure Resource Manager resources

op Azure.ResourceManager.ArmResourceCreateOrReplaceSync(resource: Resource): Response | Error

Template Parameters

Name	Description
Resource	the resource being created or replaced
BaseParameters	Optional. Allows overriding the operation parameters
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the createOrReplace operation
Error	Optional. The error response, if non-standard.
Provider	Optional. The provider namespace model for the resource.

`ArmResourceCreateOrUpdateAsync`

A long-running resource CreateOrUpdate (PUT)

op Azure.ResourceManager.ArmResourceCreateOrUpdateAsync(resource: Resource): Response | Error

Template Parameters

Name	Description
Resource	the resource being created or updated
BaseParameters	Optional. Allows overriding the operation parameters
LroHeaders	Optional. Allows overriding the lro headers returned on resource create
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the createOrUpdate operation
Error	Optional. The error response, if non-standard.
Provider	Optional. The provider namespace model for the resource.

`ArmResourceCreateOrUpdateSync`

DEPRECATED: Please use ArmResourceCreateOrReplaceSync instead

op Azure.ResourceManager.ArmResourceCreateOrUpdateSync(resource: Resource): Response | Error

Template Parameters

Name	Description
Resource	the resource being created or updated
BaseParameters	Optional. Allows overriding the operation parameters
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the createOrUpdate operation
Error	Optional. The error response, if non-standard.
Provider	Optional. The provider namespace model for the resource.

`ArmResourceDeleteAsync`

Delete a resource asynchronously. DEPRECATED: Use ArmResourceDeleteWithoutOkAsync instead

op Azure.ResourceManager.ArmResourceDeleteAsync(): Response | Error

Template Parameters

Name	Description
Resource	The resource being deleted
BaseParameters	Optional. Allows overriding the parameters for the operation
LroHeaders	Optional. Allows overriding the headers in the Accepted response
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response(s) for the delete operation
Error	Optional. The error response, if non-standard.
Provider	Optional. The provider namespace model for the resource.

`ArmResourceDeleteAsyncBase`

Delete a resource asynchronously

op Azure.ResourceManager.ArmResourceDeleteAsyncBase(): Response | Error

Template Parameters

Name	Description
Resource	The resource being deleted
Response	The response type for the operation
BaseParameters	Optional. Allows overriding the parameters for the operation
Parameters	Optional. Additional parameters after the path parameters
Error	Optional. The error response, if non-standard.
Provider	Optional. The provider namespace model for the resource.

`ArmResourceDeleteSync`

Delete a resource synchronously

op Azure.ResourceManager.ArmResourceDeleteSync(): Response | Error

Template Parameters

Name	Description
Resource	The resource being deleted
BaseParameters	Optional. Allows overriding the parameters for the operation
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response(s) for the delete operation
Error	Optional. The error response, if non-standard.
Provider	Optional. The provider namespace model for the resource.

`ArmResourceDeleteWithoutOkAsync`

Delete a resource asynchronously

op Azure.ResourceManager.ArmResourceDeleteWithoutOkAsync(): Response | Error

Template Parameters

Name	Description
Resource	The resource being deleted
BaseParameters	Optional. Allows overriding the parameters for the operation
LroHeaders	Optional. Allows overriding the headers returned in the Accepted response
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response(s) for the delete operation
Error	Optional. The error response, if non-standard.
Provider	Optional. The provider namespace model for the resource.

`ArmResourceListAtScope`

A resource list operation, with scope determined by BaseParameters

op Azure.ResourceManager.ArmResourceListAtScope(): Response | Error

Template Parameters

Name	Description
Resource	the resource being listed
BaseParameters	Optional. Allows overriding the operation parameters
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the list operation
Error	Optional. The error response, if non-standard.
Provider	Optional. The provider namespace model for the resource.

`ArmResourceListByParent`

A resource list operation, at the scope of the resource’s parent

op Azure.ResourceManager.ArmResourceListByParent(): Response | Error

Template Parameters

Name	Description
Resource	the resource being listed
BaseParameters	Optional. Allows overriding the operation parameters
ParentName	Optional. The name of the parent resource
ParentFriendlyName	Optional. The friendly name of the parent resource
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the list operation
Error	Optional. The error response, if non-standard.
Provider	Optional. The provider namespace model for the resource.

`ArmResourcePatchAsync`

A long-running resource update using the items from the resource marked with Lifecycle.Update visibility

op Azure.ResourceManager.ArmResourcePatchAsync(properties: Resource): Azure.ResourceManager.ArmResponse<ResponseBody> | Azure.ResourceManager.ArmAcceptedLroResponse<Description, LroHeaders> | Azure.ResourceManager.CommonTypes.ErrorResponse

Template Parameters

Name	Description
Resource	the resource being patched
Properties	The model type of the resource properties
BaseParameters	Optional. Allows overriding the operation parameters
LroHeaders	Optional. Allows overriding the lro headers returned in the Accepted response
Parameters	Optional. Additional parameters after the path parameters
Provider	Optional. The provider namespace model for the resource.

`ArmResourcePatchSync`

A resource update using the items from the resource marked with Lifecycle.Update visibility

op Azure.ResourceManager.ArmResourcePatchSync(properties: Resource): Azure.ResourceManager.ArmResponse<ResponseBody> | Azure.ResourceManager.CommonTypes.ErrorResponse

Template Parameters

Name	Description
Resource	the resource being patched
Properties	The model type of the resource properties
BaseParameters	Optional. Allows overriding the operation parameters
Parameters	Optional. Additional parameters after the path parameters
Provider	Optional. The provider namespace model for the resource.

`ArmResourceRead`

A resource GET operation

op Azure.ResourceManager.ArmResourceRead(): Response | Error

Template Parameters

Name	Description
Resource	the resource being read
BaseParameters	Optional. Allows overriding the operation parameters
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the read operation
Error	Optional. The error response, if non-standard.
Provider	Optional. The provider namespace model for the resource.

`ArmTagsPatchAsync`

A long-running resource update that only allows updating resource tags (the minimum)

op Azure.ResourceManager.ArmTagsPatchAsync(properties: Azure.ResourceManager.Foundations.TagsUpdateModel<Resource>): Azure.ResourceManager.ArmResponse<ResponseBody> | Azure.ResourceManager.ArmAcceptedLroResponse<Description, LroHeaders> | Azure.ResourceManager.CommonTypes.ErrorResponse

Template Parameters

Name	Description
Resource	the resource being patched
Properties	Optional. Exists for parallelism with ArmResourcePatch.
BaseParameters	Optional. Allows overriding the operation parameters
LroHeaders	Optional. Allows overriding the lro headers that appear in the Accepted response
Parameters	Optional. Additional parameters after the path parameters
Provider	Optional. The provider namespace model for the resource.

`ArmTagsPatchSync`

A resource update that only allows updating resource tags (the minimum)

op Azure.ResourceManager.ArmTagsPatchSync(properties: Azure.ResourceManager.Foundations.TagsUpdateModel<Resource>): Azure.ResourceManager.ArmResponse<ResponseBody> | Azure.ResourceManager.CommonTypes.ErrorResponse

Template Parameters

Name	Description
Resource	the resource being patched
BaseParameters	Optional. Allows overriding the operation parameters
Parameters	Optional. Additional parameters after the path parameters
Provider	Optional. The provider namespace model for the resource.

`checkGlobalNameAvailability`

Adds check global name availability operation, normally used if a resource name must be globally unique (for example, if the resource exposes and endpoint that uses the resource name in the url)

op Azure.ResourceManager.checkGlobalNameAvailability(apiVersion: string, subscriptionId: Azure.Core.uuid, provider: "Microsoft.ThisWillBeReplaced", body: Request): Response | Azure.ResourceManager.CommonTypes.ErrorResponse

Template Parameters

Name	Description
Request	the availability request, defaults to the standard request, containing name and resource type
Response	the availability response, default to the standard response
AdditionalParams	A model specifying additional non-path parameters to the availability request

`checkLocalNameAvailability`

Adds check location-specific name availability operation, normally used if a resource name must be globally unique (for example, if the resource exposes and endpoint that uses the resource name in the url)

op Azure.ResourceManager.checkLocalNameAvailability(apiVersion: string, subscriptionId: Azure.Core.uuid, provider: "Microsoft.ThisWillBeReplaced", location: Azure.Core.azureLocation, body: Request): Response | Azure.ResourceManager.CommonTypes.ErrorResponse

Template Parameters

Name	Description
Request	the availability request, defaults to the standard request, containing name and resource type
Response	the availability response, default to the standard response
AdditionalParams	A model specifying additional non-path parameters to the availability request

`GetResourceOperationStatus`

A resource GET operation template for an Azure Resource Manager Operation Status endpoint. The path is determined by the Scope parameter. Use one of the four standard scope models:

TenantActionScope (default): GET /providers/{providerNamespace}/operationStatuses/{operationId}
SubscriptionActionScope: GET /subscriptions/{subscriptionId}/providers/{providerNamespace}/operationStatuses/{operationId}
TenantLocationActionScope: GET /providers/{providerNamespace}/locations/{location}/operationStatuses/{operationId}
SubscriptionLocationActionScope: GET /subscriptions/{subscriptionId}/providers/{providerNamespace}/locations/{location}/operationStatuses/{operationId}

op Azure.ResourceManager.GetResourceOperationStatus(apiVersion: string, subscriptionId: Azure.Core.uuid, location: string, resourceGroupName: string, resourceUri: string, provider: "Microsoft.ThisWillBeReplaced", operationId: string): Azure.ResourceManager.ArmResponse<ResponseBody> | Error

Template Parameters

Name	Description
Response	The type of the response body. Defaults to ArmOperationStatus.
Scope	The scope of the operation. Defaults to TenantActionScope.
Parameters	Optional. Additional non-path parameters (e.g. query or header parameters).
Error	Optional. The error response, if non-standard.

Azure.ResourceManager.CommonTypes

`NspConfigurationOperations`

Operations over network security perimeter resources.

interface Azure.ResourceManager.CommonTypes.NspConfigurationOperations<NspConfigurationResourceModel, NspConfigurationKeyName, ResourceName, ResourceParameter>

Template Parameters

Name	Description
NspConfigurationResourceModel	The type of the network security perimeter configuration resource. You must declare a network security perimeter configuration resource type in your provider namespace.
NspConfigurationKeyName	Optional. The NSP configuration resource name parameter. By default, this is `networkSecurityPerimeterConfigurationName`.
ResourceName	Optional. The name of the network security perimeter configuration resource in this context, by default, this is `{targetResourceName}NetworkSecurityPerimeterConfiguration`.
ResourceParameter	Optional. The name parameter model for the network security perimeter configuration resource. By default, this is `NspConfigurationNameParameter`, which has a required path parameter for the network security perimeter configuration resource name. You can use this template parameter to specify a different parameter type if needed, but it must include at least a path parameter for the network security perimeter configuration resource name.

`NspConfigurationOperations.ListByParent`

List the network security perimeter configurations to a resource

op Azure.ResourceManager.CommonTypes.NspConfigurationOperations<NspConfigurationResourceModel, NspConfigurationKeyName, ResourceName, ResourceParameter>.ListByParent(provider: "Microsoft.ThisWillBeReplaced"): Response | Error

Template Parameters

Name	Description
ParentResource	the parent resource of the NspConfiguration
Resource	Optional. The NspConfiguration resource being listed
BaseParameters	Optional. Allows overriding the operation parameters
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the list operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. The name of the network security perimeter configuration resource being operated on.

`NspConfigurationOperations.ListSinglePageByParent`

List the network security parameter configuration for a resource without pagination - this should only be used for legacy operations

op Azure.ResourceManager.CommonTypes.NspConfigurationOperations<NspConfigurationResourceModel, NspConfigurationKeyName, ResourceName, ResourceParameter>.ListSinglePageByParent(provider: "Microsoft.ThisWillBeReplaced"): Response | Error

Template Parameters

Name	Description
ParentResource	the parent resource of the NspConfiguration
Resource	Optional. The NspConfiguration resource being listed
BaseParameters	Optional. Allows overriding the operation parameters
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the list operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. The name of the network security perimeter configuration resource being operated on.

`NspConfigurationOperations.Read`

GET a network security perimeter configuration for a particular resource

op Azure.ResourceManager.CommonTypes.NspConfigurationOperations<NspConfigurationResourceModel, NspConfigurationKeyName, ResourceName, ResourceParameter>.Read(provider: "Microsoft.ThisWillBeReplaced"): Response | Error

Template Parameters

Name	Description
ParentResource	the parent resource of the NspConfiguration
Resource	the NspConfiguration resource being read
BaseParameters	Optional. Allows overriding the operation parameters
KeyName	Optional. The NSP configuration resource name parameter. By default, this is `networkSecurityPerimeterConfigurationName`
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the read operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. The name of the network security perimeter configuration resource being operated on.

`NspConfigurationOperations.Action`

Perform an action on a network security perimeter configuration for a particular resource

op Azure.ResourceManager.CommonTypes.NspConfigurationOperations<NspConfigurationResourceModel, NspConfigurationKeyName, ResourceName, ResourceParameter>.Action(provider: "Microsoft.ThisWillBeReplaced", body: Request): Response | Error

Template Parameters

Name	Description
ParentResource	the parent resource of the NspConfiguration
Request	The request body type
Response	The success response for the read operation
Resource	the NspConfiguration resource being read
BaseParameters	Optional. Allows overriding the operation parameters
KeyName	Optional. The NSP configuration resource name parameter. By default, this is `networkSecurityPerimeterConfigurationName`
Parameters	Optional. Additional parameters after the path parameters
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. The name of the network security perimeter configuration resource being operated on.
OptionalRequestBody	Optional. Indicates if the request body is optional.

`NspConfigurationOperations.ActionAsync`

Perform an action on a network security perimeter configuration for a particular resource

op Azure.ResourceManager.CommonTypes.NspConfigurationOperations<NspConfigurationResourceModel, NspConfigurationKeyName, ResourceName, ResourceParameter>.ActionAsync(provider: "Microsoft.ThisWillBeReplaced", body: Request): Azure.ResourceManager.ArmAcceptedLroResponse<Description, LroHeaders> | Response | Error

Template Parameters

Name	Description
ParentResource	the parent resource of the NspConfiguration
Request	The request body type
Response	The success response for the read operation
Resource	the NspConfiguration resource being read
BaseParameters	Optional. Allows overriding the operation parameters
KeyName	Optional. The NSP configuration resource name parameter. By default, this is `networkSecurityPerimeterConfigurationName`
Parameters	Optional. Additional parameters after the path parameters
LroHeaders	Optional. The LRO headers for the accepted response
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. The name of the network security perimeter configuration resource being operated on.
OptionalRequestBody	Optional. Indicates if the request body is optional.

Examples

namespace Microsoft.Contoso;
model NspConfiguration is NspConfigurationResource {}
alias EmployeeNspConfigurationOps is NspConfigurations<NspConfiguration>;
@armResourceOperations
interface Employees {
 @doc("get a network security perimeter configuration for resource employee")
 getNspConfiguration is EmployeeNspConfigurationOps.Read<Employee>;
}

Azure.ResourceManager.Extension

`ActionAsync`

A long-running resource action.

op Azure.ResourceManager.Extension.ActionAsync(apiVersion: string, subscriptionId: Azure.Core.uuid, resourceGroupName: string, provider: "Microsoft.TargetProviderNamespace", extensionProvider: "Microsoft.ExtensionProviderNamespace", body: Request): Azure.ResourceManager.ArmAcceptedLroResponse<Description, LroHeaders> | Response | Error

Template Parameters

Name	Description
TargetResource	The target resource, e.g. Extension.Subscription or Extension.ManagementGroup or Extension.ResourceGroup
ExtensionResource	The resource being acted upon
Request	The request model for the action
Response	The response model for the action
LroHeaders	Optional. Allows overriding the headers returned in the Accepted response
Parameters	Optional. Additional parameters after the path parameters
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. Indicates whether the body parameter is optional.
OverrideResourceName	Optional. Allows overriding the resource name for this scope in generated clients.

`ActionAsyncBase`

A long-running resource action.

op Azure.ResourceManager.Extension.ActionAsyncBase(apiVersion: string, subscriptionId: Azure.Core.uuid, resourceGroupName: string, provider: "Microsoft.TargetProviderNamespace", extensionProvider: "Microsoft.ExtensionProviderNamespace", body: Request): Response | Error

Template Parameters

Name	Description
TargetResource	The target resource, e.g. Extension.Subscription or Extension.ManagementGroup or Extension.ResourceGroup
ExtensionResource	The resource being acted upon
Request	The request model for the action
Response	The response type for the action
Parameters	Optional. Additional parameters after the path parameters
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. Indicates whether the request body is optional.
OverrideResourceName	Optional. Allows overriding the resource name for this scope in generated clients.

`ActionNoContentSync`

A synchronous resource action that returns no content.

op Azure.ResourceManager.Extension.ActionNoContentSync(apiVersion: string, subscriptionId: Azure.Core.uuid, resourceGroupName: string, provider: "Microsoft.TargetProviderNamespace", extensionProvider: "Microsoft.ExtensionProviderNamespace", body: Request): Azure.ResourceManager.ArmNoContentResponse<"Action completed successfully."> | Error

Template Parameters

Name	Description
TargetResource	The target resource, e.g. Extension.Subscription or Extension.ManagementGroup or Extension.ResourceGroup
ExtensionResource	The resource being acted upon
Request	The request model for the action
Parameters	Optional. Additional parameters after the path parameters
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. Indicates whether the request body is optional.
OverrideResourceName	Optional. Allows overriding the resource name for this scope in generated clients.

`ActionNoResponseContentAsync`

A long-running resource action that returns no content.

op Azure.ResourceManager.Extension.ActionNoResponseContentAsync(apiVersion: string, subscriptionId: Azure.Core.uuid, resourceGroupName: string, provider: "Microsoft.TargetProviderNamespace", extensionProvider: "Microsoft.ExtensionProviderNamespace", body: Request): Azure.ResourceManager.ArmAcceptedLroResponse<Description, LroHeaders> | Error

Template Parameters

Name	Description
TargetResource	The target resource, e.g. Extension.Subscription or Extension.ManagementGroup or Extension.ResourceGroup
ExtensionResource	The resource being acted upon
Request	The request model for the action
LroHeaders	Optional. Allows overriding the headers returned in the Accepted response
Parameters	Optional. Additional parameters after the path parameters
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. Indicates whether the body parameter is optional.
OverrideResourceName	Optional. Allows overriding the resource name for this scope in generated clients.

`ActionSync`

A synchronous resource action.

op Azure.ResourceManager.Extension.ActionSync(apiVersion: string, subscriptionId: Azure.Core.uuid, resourceGroupName: string, provider: "Microsoft.TargetProviderNamespace", extensionProvider: "Microsoft.ExtensionProviderNamespace", body: Request): Response | Error

Template Parameters

Name	Description
TargetResource	The target resource, e.g. Extension.Subscription or Extension.ManagementGroup or Extension.ResourceGroup
ExtensionResource	The resource being acted upon
Request	The request model for the action
Response	The response model for the action
Parameters	Optional. Additional parameters after the path parameters
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. Indicates whether the body parameter is optional.
OverrideResourceName	Optional. Allows overriding the resource name for this scope in generated clients.

`CheckExistence`

Check a resource’s existence via HEAD operation

op Azure.ResourceManager.Extension.CheckExistence(apiVersion: string, subscriptionId: Azure.Core.uuid, resourceGroupName: string, provider: "Microsoft.TargetProviderNamespace", extensionProvider: "Microsoft.ExtensionProviderNamespace"): Response | Error

Template Parameters

Name	Description
TargetResource	The target resource, e.g. Extension.Subscription or Extension.ManagementGroup or Extension.ResourceGroup
ExtensionResource	the extension resource being checked
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the read operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. Allows overriding the resource name for this scope in generated clients.

`CreateOrReplaceAsync`

A long-running resource CreateOrUpdate (PUT)

op Azure.ResourceManager.Extension.CreateOrReplaceAsync(apiVersion: string, subscriptionId: Azure.Core.uuid, resourceGroupName: string, provider: "Microsoft.TargetProviderNamespace", extensionProvider: "Microsoft.ExtensionProviderNamespace", resource: ExtensionResource): Response | Error

Template Parameters

Name	Description
TargetResource	the target resource, e.g. Extension.Subscription or Extension.ManagementGroup or Extension.ResourceGroup
ExtensionResource	the resource being created or replaced
LroHeaders	Optional. Allows overriding the lro headers returned on resource create
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the createOrReplace operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. Allows overriding the resource name for this scope in generated clients

`CreateOrReplaceSync`

Synchronous PUT operation for Azure Resource Manager resources

op Azure.ResourceManager.Extension.CreateOrReplaceSync(apiVersion: string, subscriptionId: Azure.Core.uuid, resourceGroupName: string, provider: "Microsoft.TargetProviderNamespace", extensionProvider: "Microsoft.ExtensionProviderNamespace", resource: ExtensionResource): Response | Error

Template Parameters

Name	Description
TargetResource	the target resource, e.g. Extension.Subscription or Extension.ManagementGroup or Extension.ResourceGroup
ExtensionResource	the resource being created or replaced
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the createOrReplace operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. Allows overriding the resource name for this scope in generated clients.

`CreateOrUpdateAsync`

A long-running resource CreateOrUpdate (PUT)

op Azure.ResourceManager.Extension.CreateOrUpdateAsync(apiVersion: string, subscriptionId: Azure.Core.uuid, resourceGroupName: string, provider: "Microsoft.TargetProviderNamespace", extensionProvider: "Microsoft.ExtensionProviderNamespace", resource: ExtensionResource): Response | Error

Template Parameters

Name	Description
TargetResource	the target resource, e.g. Extension.Subscription or Extension.ManagementGroup or Extension.ResourceGroup
ExtensionResource	the resource being created or updated
LroHeaders	Optional. Allows overriding the lro headers returned on resource create
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the createOrUpdate operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. Allows overriding the resource name for this scope in generated clients

`CustomPatchAsync`

A long-running resource update using a custom PATCH payload (Asynchronous)

op Azure.ResourceManager.Extension.CustomPatchAsync(apiVersion: string, subscriptionId: Azure.Core.uuid, resourceGroupName: string, provider: "Microsoft.TargetProviderNamespace", extensionProvider: "Microsoft.ExtensionProviderNamespace", properties: PatchModel): Response | Error

Template Parameters

Name	Description
TargetResource	the target resource, e.g. Extension.Subscription or Extension.ManagementGroup or Extension.ResourceGroup
ExtensionResource	the resource being patched
PatchModel	The input model for the PATCH request
LroHeaders	Optional. Allows overriding the lro headers returned in the Accepted response
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the patch operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. Allows overriding the resource name for this scope in generated clients

`CustomPatchSync`

A resource update using a custom PATCH payload (synchronous)

op Azure.ResourceManager.Extension.CustomPatchSync(apiVersion: string, subscriptionId: Azure.Core.uuid, resourceGroupName: string, provider: "Microsoft.TargetProviderNamespace", extensionProvider: "Microsoft.ExtensionProviderNamespace", properties: PatchModel): Response | Error

Template Parameters

Name	Description
TargetResource	the target resource, e.g. Extension.Subscription or Extension.ManagementGroup or Extension.ResourceGroup
ExtensionResource	the resource being patched
PatchModel	The input model for the PATCH request
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the patch operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. Allows overriding the resource name for this scope in generated clients.

`DeleteAsync`

Delete a resource asynchronously.

op Azure.ResourceManager.Extension.DeleteAsync(apiVersion: string, subscriptionId: Azure.Core.uuid, resourceGroupName: string, provider: "Microsoft.TargetProviderNamespace", extensionProvider: "Microsoft.ExtensionProviderNamespace"): Response | Error

Template Parameters

Name	Description
TargetResource	The target resource, e.g. Extension.Subscription or Extension.ManagementGroup or Extension.ResourceGroup
ExtensionResource	The resource being deleted
LroHeaders	Optional. Allows overriding the headers in the Accepted response
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response(s) for the delete operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. Allows overriding the resource name for this scope in generated clients.

`DeleteAsyncBase`

Delete a resource asynchronously

op Azure.ResourceManager.Extension.DeleteAsyncBase(apiVersion: string, subscriptionId: Azure.Core.uuid, resourceGroupName: string, provider: "Microsoft.TargetProviderNamespace", extensionProvider: "Microsoft.ExtensionProviderNamespace"): Response | Error

Template Parameters

Name	Description
TargetResource	The target resource, e.g. Extension.Subscription or Extension.ManagementGroup or Extension.ResourceGroup
ExtensionResource	The resource being deleted
Response	The response type for the operation
Parameters	Optional. Additional parameters after the path parameters
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. Allows overriding the resource name for this scope in generated clients.

`DeleteSync`

Delete a resource synchronously

op Azure.ResourceManager.Extension.DeleteSync(apiVersion: string, subscriptionId: Azure.Core.uuid, resourceGroupName: string, provider: "Microsoft.TargetProviderNamespace", extensionProvider: "Microsoft.ExtensionProviderNamespace"): Response | Error

Template Parameters

Name	Description
TargetResource	The target resource, e.g. Extension.Subscription or Extension.ManagementGroup or Extension.ResourceGroup
ExtensionResource	The resource being deleted
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response(s) for the delete operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. Allows overriding the resource name for this scope in generated clients.

`DeleteWithoutOkAsync`

Delete a resource asynchronously

op Azure.ResourceManager.Extension.DeleteWithoutOkAsync(apiVersion: string, subscriptionId: Azure.Core.uuid, resourceGroupName: string, provider: "Microsoft.TargetProviderNamespace", extensionProvider: "Microsoft.ExtensionProviderNamespace"): Response | Error

Template Parameters

Name	Description
TargetResource	The target resource, e.g. Extension.Subscription or Extension.ManagementGroup or Extension.ResourceGroup
ExtensionResource	The resource being deleted
LroHeaders	Optional. Allows overriding the headers returned in the Accepted response
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response(s) for the delete operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. Allows overriding the resource name for this scope in generated clients.

`ListByTarget`

List an extension resource at the given target scope

op Azure.ResourceManager.Extension.ListByTarget(apiVersion: string, subscriptionId: Azure.Core.uuid, resourceGroupName: string, provider: "Microsoft.TargetProviderNamespace", extensionProvider: "Microsoft.ExtensionProviderNamespace"): Response | Error

Template Parameters

Name	Description
TargetResource	The target to list at, e.g. Extension.Subscription or Extension.ManagementGroup or Extension.ResourceGroup
ExtensionResource	the resource being listed
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the list operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. Allows overriding the resource name for this scope in generated clients.

`Read`

A resource GET operation

op Azure.ResourceManager.Extension.Read(apiVersion: string, subscriptionId: Azure.Core.uuid, resourceGroupName: string, provider: "Microsoft.TargetProviderNamespace", extensionProvider: "Microsoft.ExtensionProviderNamespace"): Response | Error

Template Parameters

Name	Description
TargetResource	The target resource, e.g. Extension.Subscription or Extension.ManagementGroup or Extension.ResourceGroup
ExtensionResource	the resource being read
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the read operation
Error	Optional. The error response, if non-standard.
OverrideResourceName	Optional. Allows overriding the resource name for this scope in generated clients.

Azure.ResourceManager.Foundations

`ArmCreateOperation`

The base template for Azure Resource Manager PUT Operations.

op Azure.ResourceManager.Foundations.ArmCreateOperation(resource: BodyParameter): Response | ErrorResponse

Template Parameters

Name	Description
HttpParameters	The parameter object for the operation.
BodyParameter	The body parameter
Response	The response or union of responses for success.
ErrorResponse	The error response.

`ArmReadOperation`

The base template for Azure Resource Manager GET and HEAD Operations.

op Azure.ResourceManager.Foundations.ArmReadOperation(): Response | ErrorResponse

Template Parameters

Name	Description
Parameters	The parameter object for the operation.
Response	The response or union of responses for success.
ErrorResponse	The error response.

`ArmUpdateOperation`

The base template for Azure Resource Manager PATCH Operations.

op Azure.ResourceManager.Foundations.ArmUpdateOperation(properties: BodyParameter): Response | ErrorResponse

Template Parameters

Name	Description
HttpParameters	The parameter object for the operation.
BodyParameter	The body parameter
Response	The response or union of responses for success.
ErrorResponse	The error response.

`checkNameAvailability`

Adds check name availability operation, normally used if a resource name must be globally unique (for example, if the resource exposes an endpoint that uses the resource name in the url)

op Azure.ResourceManager.Foundations.checkNameAvailability(apiVersion: string, body: Request): Response | Azure.ResourceManager.CommonTypes.ErrorResponse

Template Parameters

Name	Description
ScopeParameters	A parameter model with properties representing the scope of the resource
Request	The operation request body
Response	The operation response
AdditionalParams	A parameter model with properties representing non-path parameters

Azure.ResourceManager.Legacy

`ExtensionOperations`

An operation template used to build extension resource operations using non-standard paths.

interface Azure.ResourceManager.Legacy.ExtensionOperations<TargetParameters, ExtensionParentParameters, ExtensionInstanceParameters, ResourceName>

Template Parameters

Name	Description
TargetParameters	The path parameters for the target resource
ExtensionParentParameters	Parent parameters of the extension resource
ExtensionInstanceParameters	The instance parameters of the extension resource
ResourceName	Optional. The name of the resource type at this scope in clients.

`ExtensionOperations.CreateOrUpdateAsync`

A long-running resource CreateOrUpdate (PUT)

op Azure.ResourceManager.Legacy.ExtensionOperations<TargetParameters, ExtensionParentParameters, ExtensionInstanceParameters, ResourceName>.CreateOrUpdateAsync(resource: Request): Response | ErrorType

Template Parameters

Name	Description
Resource	the resource being created or updated
LroHeaders	Optional. Allows overriding the lro headers returned on resource create
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response(s) for the PUT operation
OptionalRequestBody	Optional. Indicates whether the request body is optional
ErrorType	Optional. The error response, if non-standard.
OperationOptions	Optional. The route options for the operation.
Request	Optional. The request body for the createOrUpdate operation.
OverrideResourceName	Optional. The name of the resource type at this scope in clients.

`ExtensionOperations.CreateOrUpdateSync`

A synchronous resource CreateOrUpdate (PUT)

op Azure.ResourceManager.Legacy.ExtensionOperations<TargetParameters, ExtensionParentParameters, ExtensionInstanceParameters, ResourceName>.CreateOrUpdateSync(resource: Request): Response | ErrorType

Template Parameters

Name	Description
Resource	the resource being created or updated
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response(s) for the PUT operation
OptionalRequestBody	Optional. Indicates whether the request body is optional
ErrorType	Optional. The error response, if non-standard.
OperationOptions	Optional. The route options for the operation.
Request	Optional. The request body for the createOrUpdate operation.
OverrideResourceName	Optional. The name of the resource type at this scope in clients.

`ExtensionOperations.CustomPatchAsync`

A long-running resource Update (PATCH)

op Azure.ResourceManager.Legacy.ExtensionOperations<TargetParameters, ExtensionParentParameters, ExtensionInstanceParameters, ResourceName>.CustomPatchAsync(properties: PatchModel): Response | ErrorType

Template Parameters

Name	Description
Resource	the resource being created or updated
PatchModel	the PATCH request model
LroHeaders	Optional. Allows overriding the lro headers returned on resource create
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response(s) for the PATCH operation
OptionalRequestBody	Optional. Indicates whether the request body is optional
ErrorType	Optional. The error response, if non-standard.
OperationOptions	Optional. The route options for the operation.
OverrideResourceName	Optional. The name of the resource type at this scope in clients.

`ExtensionOperations.CustomPatchSync`

A synchronous resource Update (PATCH)

op Azure.ResourceManager.Legacy.ExtensionOperations<TargetParameters, ExtensionParentParameters, ExtensionInstanceParameters, ResourceName>.CustomPatchSync(properties: PatchModel): Response | ErrorType

Template Parameters

Name	Description
Resource	the resource being created or updated
PatchModel	the PATCH request model
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response(s) for the PATCH operation
OptionalRequestBody	Optional. Indicates whether the request body is optional
ErrorType	Optional. The error response, if non-standard.
OperationOptions	Optional. The route options for the operation.
OverrideResourceName	Optional. The name of the resource type at this scope in clients.

`ExtensionOperations.DeleteWithoutOkAsync`

Delete a resource asynchronously

op Azure.ResourceManager.Legacy.ExtensionOperations<TargetParameters, ExtensionParentParameters, ExtensionInstanceParameters, ResourceName>.DeleteWithoutOkAsync(): Response | ErrorType

Template Parameters

Name	Description
Resource	The resource being deleted
LroHeaders	The lro headers for the operation
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response(s) for the delete operation
ErrorType	Optional. The error response, if non-standard.
OperationOptions	Optional. The route options for the operation.
OverrideResourceName	Optional. The name of the resource type at this scope in clients.

`ExtensionOperations.DeleteSync`

Delete a resource synchronously

op Azure.ResourceManager.Legacy.ExtensionOperations<TargetParameters, ExtensionParentParameters, ExtensionInstanceParameters, ResourceName>.DeleteSync(): Response | ErrorType

Template Parameters

Name	Description
Resource	The resource being deleted
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response(s) for the delete operation
ErrorType	Optional. The error response, if non-standard.
OperationOptions	Optional. The route options for the operation.
OverrideResourceName	Optional. The name of the resource type at this scope in clients.

`ExtensionOperations.Read`

Get a resource

op Azure.ResourceManager.Legacy.ExtensionOperations<TargetParameters, ExtensionParentParameters, ExtensionInstanceParameters, ResourceName>.Read(): Response | ErrorType

Template Parameters

Name	Description
Resource	The resource being read
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for a get operation.
ErrorType	Optional. The error response, if non-standard.
OperationOptions	Optional. The route options for the operation.
OverrideResourceName	Optional. The name of the resource type at this scope in clients.

`ExtensionOperations.CheckExistence`

Check a resource’s existence via HEAD operation

op Azure.ResourceManager.Legacy.ExtensionOperations<TargetParameters, ExtensionParentParameters, ExtensionInstanceParameters, ResourceName>.CheckExistence(): Response | ErrorType

Template Parameters

Name	Description
Resource	The resource being checked
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for a head operation (by default NoContent or NotFound response).
ErrorType	Optional. The error response, if non-standard.
OperationOptions	Optional. The route options for the operation.
OverrideResourceName	Optional. The name of the resource type at this scope in clients.

`ExtensionOperations.List`

List a resource

op Azure.ResourceManager.Legacy.ExtensionOperations<TargetParameters, ExtensionParentParameters, ExtensionInstanceParameters, ResourceName>.List(): Response | ErrorType

Template Parameters

Name	Description
Resource	The resource being listed
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The response returned by the list
ErrorType	Optional. The error response, if non-standard.
OperationOptions	Optional. The route options for the operation.
OverrideResourceName	Optional. The name of the resource type at this scope in clients.

`ExtensionOperations.ListSinglePage`

List a resource, without pagination

op Azure.ResourceManager.Legacy.ExtensionOperations<TargetParameters, ExtensionParentParameters, ExtensionInstanceParameters, ResourceName>.ListSinglePage(): Response | ErrorType

Template Parameters

Name	Description
Resource	The resource being listed
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The response returned by the list
ErrorType	Optional. The error response, if non-standard.
OperationOptions	Optional. The route options for the operation.
OverrideResourceName	Optional. The name of the resource type at this scope in clients.

`ExtensionOperations.ActionSync`

A synchronous resource action.

op Azure.ResourceManager.Legacy.ExtensionOperations<TargetParameters, ExtensionParentParameters, ExtensionInstanceParameters, ResourceName>.ActionSync(body: Request): Response | ErrorType

Template Parameters

Name	Description
Resource	The resource being acted upon
Request	The request model for the action
Response	The response model for the action
Parameters	Optional. Additional parameters after the path parameters
OptionalRequestBody	Optional. Indicates whether the request body is optional
ErrorType	Optional. The error response, if non-standard.
OperationOptions	Optional. The route options for the operation.
OverrideResourceName	Optional. The name of the resource type at this scope in clients.

`ExtensionOperations.ActionAsync`

A long-running resource action.

op Azure.ResourceManager.Legacy.ExtensionOperations<TargetParameters, ExtensionParentParameters, ExtensionInstanceParameters, ResourceName>.ActionAsync(body: Request): Response | ErrorType

Template Parameters

Name	Description
Resource	The resource being acted upon
Request	The request model for the action
Result	The result model for the action
LroHeaders	Optional. Allows overriding the headers returned in the Accepted response
Parameters	Optional. Additional parameters after the path parameters
Response	The full response union of the action
OptionalRequestBody	Optional. Indicates whether the request body is optional
ErrorType	Optional. The error response, if non-standard.
OperationOptions	Optional. The route options for the operation.
OverrideResourceName	Optional. The name of the resource type at this scope in clients.

`LegacyOperations`

An operation template used to build resource operations in which the same resource type is accessible at multiple, fixed resource paths.

interface Azure.ResourceManager.Legacy.LegacyOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceName>

Template Parameters

Name	Description
ParentParameters	The path parameters for the resource parent
ResourceTypeParameter	The path parameter for the resource name
ErrorType	Optional. The type of error models used in operations created form this template
ResourceName	Optional. The name of the resource type described in this template

`LegacyOperations.CreateOrUpdateAsync`

A long-running resource CreateOrUpdate (PUT)

op Azure.ResourceManager.Legacy.LegacyOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceName>.CreateOrUpdateAsync(resource: Request): Response | OverrideErrorType

`LegacyOperations.CreateOrUpdateSync`

A synchronous resource CreateOrUpdate (PUT)

op Azure.ResourceManager.Legacy.LegacyOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceName>.CreateOrUpdateSync(resource: Request): Response | OverrideErrorType

`LegacyOperations.CustomPatchAsync`

A long-running resource Update (PATCH)

op Azure.ResourceManager.Legacy.LegacyOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceName>.CustomPatchAsync(properties: PatchModel): Response | OverrideErrorType

`LegacyOperations.CustomPatchSync`

A synchronous resource Update (PATCH)

op Azure.ResourceManager.Legacy.LegacyOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceName>.CustomPatchSync(properties: PatchModel): Response | OverrideErrorType

`LegacyOperations.DeleteWithoutOkAsync`

Delete a resource asynchronously

op Azure.ResourceManager.Legacy.LegacyOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceName>.DeleteWithoutOkAsync(): Response | OverrideErrorType

`LegacyOperations.DeleteSync`

Delete a resource synchronously

op Azure.ResourceManager.Legacy.LegacyOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceName>.DeleteSync(): Response | OverrideErrorType

`LegacyOperations.Read`

Get a resource

op Azure.ResourceManager.Legacy.LegacyOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceName>.Read(): Response | OverrideErrorType

`LegacyOperations.CheckExistence`

Check a resource’s existence via HEAD operation

op Azure.ResourceManager.Legacy.LegacyOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceName>.CheckExistence(): Response | OverrideErrorType

`LegacyOperations.List`

List a resource

op Azure.ResourceManager.Legacy.LegacyOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceName>.List(): Response | OverrideErrorType

`LegacyOperations.ListSinglePage`

List a single page of the resource

op Azure.ResourceManager.Legacy.LegacyOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceName>.ListSinglePage(): Response | OverrideErrorType

`LegacyOperations.ActionSync`

A synchronous resource action.

op Azure.ResourceManager.Legacy.LegacyOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceName>.ActionSync(body: Request): Response | OverrideErrorType

`LegacyOperations.ActionAsync`

A long-running resource action.

op Azure.ResourceManager.Legacy.LegacyOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceName>.ActionAsync(body: Request): Response | OverrideErrorType

`Operations`

interface Azure.ResourceManager.Legacy.Operations<Response, Error, Parameters>

Template Parameters

Name	Description
Response	The response returned by the operation list.
Error	the error response returned by the operation list.
Parameters	Additional request parameters for the list operation.

`Operations.list`

op Azure.ResourceManager.Legacy.Operations<Response, Error, Parameters>.list(apiVersion: string, provider: "Microsoft.ThisWillBeReplaced"): Response | Error

`RoutedOperations`

An operation template used to build resource operations in which the same resource type is accessible at multiple, fixed resource paths. Can be used with static routes.

interface Azure.ResourceManager.Legacy.RoutedOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceRoute, RoutedResourceName>

Template Parameters

Name	Description
ParentParameters	The path parameters for the resource parent
ResourceTypeParameter	The path parameter for the resource name
ErrorType	Optional. The type of error models used in operations created form this template
ResourceRoute	Optional. The resource route to use for operations in the interface.
RoutedResourceName	Optional. The name of the resource type described in this template

`RoutedOperations.CreateOrUpdateAsync`

A long-running resource CreateOrUpdate (PUT)

op Azure.ResourceManager.Legacy.RoutedOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceRoute, RoutedResourceName>.CreateOrUpdateAsync(resource: Request): Response | OverrideErrorType

Template Parameters

Name	Description
Resource	the resource being created or updated
LroHeaders	Optional. Allows overriding the lro headers returned on resource create
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response(s) for the PUT operation
OptionalRequestBody	Optional. Indicates whether the request body is optional
OverrideErrorType	Optional. The error response, if non-standard.
OverrideRouteOptions	Optional. The route options for the operation.
Request	Optional. The request body for the createOrUpdate operation.
OverrideResourceName	Optional. The name of the resource type being acted upon.

`RoutedOperations.CreateOrUpdateSync`

A synchronous resource CreateOrUpdate (PUT)

op Azure.ResourceManager.Legacy.RoutedOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceRoute, RoutedResourceName>.CreateOrUpdateSync(resource: Request): Response | OverrideErrorType

Template Parameters

Name	Description
Resource	the resource being created or updated
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response(s) for the PUT operation
OptionalRequestBody	Optional. Indicates whether the request body is optional
OverrideErrorType	Optional. The error response, if non-standard.
OverrideRouteOptions	Optional. The route options for the operation.
Request	Optional. The request body for the createOrUpdate operation.
OverrideResourceName	Optional. The name of the resource type being acted upon.

`RoutedOperations.CustomPatchAsync`

A long-running resource Update (PATCH)

op Azure.ResourceManager.Legacy.RoutedOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceRoute, RoutedResourceName>.CustomPatchAsync(properties: PatchModel): Response | OverrideErrorType

Template Parameters

Name	Description
Resource	the resource being updated
PatchModel	the PATCH request model
LroHeaders	Optional. Allows overriding the lro headers returned on resource create
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response(s) for the PATCH operation
OptionalRequestBody	Optional. Indicates whether the request body is optional
OverrideErrorType	Optional. The error response, if non-standard.
OverrideRouteOptions	Optional. The route options for the operation.
OverrideResourceName	Optional. The name of the resource type being acted upon.

`RoutedOperations.CustomPatchSync`

A synchronous resource Update (PATCH)

op Azure.ResourceManager.Legacy.RoutedOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceRoute, RoutedResourceName>.CustomPatchSync(properties: PatchModel): Response | OverrideErrorType

Template Parameters

Name	Description
Resource	the resource being created or updated
PatchModel	the PATCH request model
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response(s) for the PATCH operation
OptionalRequestBody	Optional. Indicates whether the request body is optional
OverrideErrorType	Optional. The error response, if non-standard.
OverrideRouteOptions	Optional. The route options for the operation.
OverrideResourceName	Optional. The name of the resource type being acted upon.

`RoutedOperations.DeleteWithoutOkAsync`

Delete a resource asynchronously

op Azure.ResourceManager.Legacy.RoutedOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceRoute, RoutedResourceName>.DeleteWithoutOkAsync(): Response | OverrideErrorType

Template Parameters

Name	Description
Resource	The resource being deleted
LroHeaders	The lro headers for the operation
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response(s) for the delete operation
OverrideErrorType	Optional. The error response, if non-standard.
OverrideRouteOptions	Optional. The route options for the operation.
OverrideResourceName	Optional. The name of the resource type being acted upon.

`RoutedOperations.DeleteSync`

Delete a resource synchronously

op Azure.ResourceManager.Legacy.RoutedOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceRoute, RoutedResourceName>.DeleteSync(): Response | OverrideErrorType

Template Parameters

Name	Description
Resource	The resource being deleted
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response(s) for the delete operation
OverrideErrorType	Optional. The error response, if non-standard.
OverrideRouteOptions	Optional. The route options for the operation.
OverrideResourceName	Optional. The name of the resource type being acted upon.

`RoutedOperations.Read`

Get a resource

op Azure.ResourceManager.Legacy.RoutedOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceRoute, RoutedResourceName>.Read(): Response | OverrideErrorType

Template Parameters

Name	Description
Resource	The resource being read
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for a get operation.
OverrideErrorType	Optional. The error response, if non-standard.
OverrideRouteOptions	Optional. The route options for the operation.
OverrideResourceName	Optional. The name of the resource type being acted upon.

`RoutedOperations.CheckExistence`

Check a resource’s existence via HEAD operation

op Azure.ResourceManager.Legacy.RoutedOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceRoute, RoutedResourceName>.CheckExistence(): Response | OverrideErrorType

Template Parameters

Name	Description
Resource	The resource being checked
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for a head operation (by default NoContent or NotFound response).
OverrideErrorType	Optional. The error response, if non-standard.
OverrideRouteOptions	Optional. The route options for the operation.
OverrideResourceName	Optional. The name of the resource type being acted upon.

`RoutedOperations.List`

List a resource

op Azure.ResourceManager.Legacy.RoutedOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceRoute, RoutedResourceName>.List(): Response | OverrideErrorType

Template Parameters

Name	Description
Resource	The resource being listed
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The response returned by the list
OverrideErrorType	Optional. The error response, if non-standard.
OverrideRouteOptions	Optional. The route options for the operation.
OverrideResourceName	Optional. The name of the resource type being acted upon.

`RoutedOperations.ListSinglePage`

List a single page of the resource

op Azure.ResourceManager.Legacy.RoutedOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceRoute, RoutedResourceName>.ListSinglePage(): Response | OverrideErrorType

Template Parameters

Name	Description
Resource	The resource being listed
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The response returned by the list
OverrideErrorType	Optional. The error response, if non-standard.
OverrideRouteOptions	Optional. The route options for the operation.
OverrideResourceName	Optional. The name of the resource type being acted upon.

`RoutedOperations.ActionSync`

A synchronous resource action.

op Azure.ResourceManager.Legacy.RoutedOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceRoute, RoutedResourceName>.ActionSync(body: Request): Response | OverrideErrorType

Template Parameters

Name	Description
Resource	The resource being acted upon
Request	The request model for the action
Response	The response model for the action
Parameters	Optional. Additional parameters after the path parameters
OptionalRequestBody	Optional. Indicates whether the request body is optional
OverrideErrorType	Optional. The error response, if non-standard.
OverrideRouteOptions	Optional. The route options for the operation.
OverrideResourceName	Optional. The name of the resource type being acted upon.

`RoutedOperations.ActionAsync`

A long-running resource action.

op Azure.ResourceManager.Legacy.RoutedOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceRoute, RoutedResourceName>.ActionAsync(body: Request): Response | OverrideErrorType

Template Parameters

Name	Description
Resource	The resource being acted upon
Request	The request model for the action
Result	The result model for the action when the operation is successful
LroHeaders	Optional. Allows overriding the headers returned in the Accepted response
Parameters	Optional. Additional parameters after the path parameters
Response	The union of successful responses for the action
OptionalRequestBody	Optional. Indicates whether the request body is optional
OverrideErrorType	Optional. The error response, if non-standard.
OverrideRouteOptions	Optional. The route options for the operation.
OverrideResourceName	Optional. The name of the resource type being acted upon.

`ArmListSinglePageByParent`

A resource list operation, at the scope of the resource’s parent that lists only a single page.

op Azure.ResourceManager.Legacy.ArmListSinglePageByParent(provider: "Microsoft.ThisWillBeReplaced"): Response | Error

Template Parameters

Name	Description
Resource	the resource being patched
BaseParameters	Optional. Allows overriding the operation parameters
ParentName	Optional. The name of the parent resource
ParentFriendlyName	Optional. The friendly name of the parent resource
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the list operation
Error	Optional. The error response, if non-standard.

`ArmListSinglePageBySubscription`

A resource list operation, at the subscription scope, that lists only a single page

op Azure.ResourceManager.Legacy.ArmListSinglePageBySubscription(apiVersion: string, subscriptionId: Azure.Core.uuid, provider: "Microsoft.ThisWillBeReplaced"): Response | Error

Template Parameters

Name	Description
Resource	the resource being patched
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the list operation
Error	Optional. The error response, if non-standard.

`CreateOperation`

The base template for Azure Resource Manager PUT Operations.

op Azure.ResourceManager.Legacy.CreateOperation(resource: BodyParameter): Response | ErrorResponse

Template Parameters

Name	Description
HttpParameters	The parameter object for the operation.
BodyParameter	The body parameter
Response	The response or union of responses for success.
ErrorResponse	The error response.
OptionalRequestBody	Optional. Indicates whether the request body is optional

`CreateOrReplaceAsync`

A long-running resource CreateOrUpdate (PUT)

op Azure.ResourceManager.Legacy.CreateOrReplaceAsync(provider: "Microsoft.ThisWillBeReplaced", resource: Request): Response | Error

Template Parameters

Name	Description
Resource	the resource being created or updated
Request	The request body for the operation
BaseParameters	Optional. Allows overriding the operation parameters
LroHeaders	Optional. Allows overriding the lro headers returned on resource create
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the createOrUpdate operation
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. Indicates whether the request body is optional

`CreateOrReplaceSync`

Synchronous PUT operation for Azure Resource Manager resources

op Azure.ResourceManager.Legacy.CreateOrReplaceSync(provider: "Microsoft.ThisWillBeReplaced", resource: Request): Response | Error

Template Parameters

Name	Description
Resource	the resource being created or replaced
Request	The request body for the operation
BaseParameters	Optional. Allows overriding the operation parameters
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the createOrUpdate operation
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. Indicates whether the request body is optional

`CustomPatchAsync`

A long-running resource update using a custom PATCH payload (Asynchronous)

op Azure.ResourceManager.Legacy.CustomPatchAsync(provider: "Microsoft.ThisWillBeReplaced", properties: PatchModel): Response | Error

Template Parameters

Name	Description
Resource	the resource being patched
PatchModel	The input model for the PATCH request
BaseParameters	Optional. Allows overriding the operation parameters
LroHeaders	Optional. Allows overriding the lro headers returned in the Accepted response
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the patch operation
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. Indicates whether the request body is optional

`CustomPatchSync`

A resource update using a custom PATCH payload (synchronous)

op Azure.ResourceManager.Legacy.CustomPatchSync(provider: "Microsoft.ThisWillBeReplaced", properties: PatchModel): Response | Error

Template Parameters

Name	Description
Resource	the resource being patched
PatchModel	The input model for the PATCH request
BaseParameters	Optional. Allows overriding the operation parameters
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the patch operation
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. Indicates whether the request body is optional

`UpdateOperation`

The base template for Legacy Azure Resource Manager PATCH Operations.

op Azure.ResourceManager.Legacy.UpdateOperation(properties: BodyParameter): Response | ErrorResponse

Template Parameters

Name	Description
HttpParameters	The parameter object for the operation.
BodyParameter	The body parameter
Response	The response or union of responses for success.
ErrorResponse	The error response.
OptionalRequestBody	Optional. Indicates whether the request body is optional

Azure.ResourceManager.Legacy.Extension

`CreateOrReplaceAsync`

A long-running resource CreateOrUpdate (PUT)

op Azure.ResourceManager.Legacy.Extension.CreateOrReplaceAsync(apiVersion: string, subscriptionId: Azure.Core.uuid, resourceGroupName: string, provider: "Microsoft.TargetProviderNamespace", extensionProvider: "Microsoft.ExtensionProviderNamespace", resource: Request): Response | Error

Template Parameters

Name	Description
TargetResource	the target resource, e.g. Extension.Subscription or Extension.ManagementGroup or Extension.ResourceGroup
ExtensionResource	the resource being created or updated
Request	Optional. The request body for the createOrUpdate operation
LroHeaders	Optional. Allows overriding the lro headers returned on resource create
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the createOrUpdate operation
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. If true, the request body is optional
OverrideResourceName	Optional. The name of the resource type at this scope in clients.

`CreateOrReplaceSync`

Synchronous PUT operation for Azure Resource Manager resources

op Azure.ResourceManager.Legacy.Extension.CreateOrReplaceSync(apiVersion: string, subscriptionId: Azure.Core.uuid, resourceGroupName: string, provider: "Microsoft.TargetProviderNamespace", extensionProvider: "Microsoft.ExtensionProviderNamespace", resource: Request): Response | Error

Template Parameters

Name	Description
TargetResource	the target resource, e.g. Extension.Subscription or Extension.ManagementGroup or Extension.ResourceGroup
ExtensionResource	the resource being created or replaced
Request	Optional. The request body for the createOrUpdate operation
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the createOrUpdate operation
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. If true, the request body is optional
OverrideResourceName	Optional. The name of the resource type at this scope in clients.

`CustomPatchAsync`

A long-running resource update using a custom PATCH payload (Asynchronous)

op Azure.ResourceManager.Legacy.Extension.CustomPatchAsync(apiVersion: string, subscriptionId: Azure.Core.uuid, resourceGroupName: string, provider: "Microsoft.TargetProviderNamespace", extensionProvider: "Microsoft.ExtensionProviderNamespace", properties: PatchModel): Response | Error

Template Parameters

Name	Description
TargetResource	the target resource, e.g. Extension.Subscription or Extension.ManagementGroup or Extension.ResourceGroup
ExtensionResource	the resource being patched
PatchModel	The input model for the PATCH request
LroHeaders	Optional. Allows overriding the lro headers returned in the Accepted response
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the patch operation
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. Whether the request body is optional.
OverrideResourceName	Optional. The name of the resource type at this scope in clients.

`CustomPatchSync`

A resource update using a custom PATCH payload (synchronous)

op Azure.ResourceManager.Legacy.Extension.CustomPatchSync(apiVersion: string, subscriptionId: Azure.Core.uuid, resourceGroupName: string, provider: "Microsoft.TargetProviderNamespace", extensionProvider: "Microsoft.ExtensionProviderNamespace", properties: PatchModel): Response | Error

Template Parameters

Name	Description
TargetResource	the target resource, e.g. Extension.Subscription or Extension.ManagementGroup or Extension.ResourceGroup
ExtensionResource	the resource being patched
PatchModel	The input model for the PATCH request
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the patch operation
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. Whether the request body is optional.
OverrideResourceName	Optional. The name of the resource type at this scope in clients.

Azure.ResourceManager.Legacy.PrivateEndpoints

`CreateOrReplaceAsync`

A long-running resource CreateOrUpdate (PUT) for a PrivateEndpointConnection to a resource

op Azure.ResourceManager.Legacy.PrivateEndpoints.CreateOrReplaceAsync(provider: "Microsoft.ThisWillBeReplaced", privateEndpointConnectionName: string, resource: Request): Response | Error

Template Parameters

Name	Description
ParentResource	the parent resource of the PrivateEndpointConnection
Resource	the PrivateEndpointConnection resource being created or updated
BaseParameters	Optional. Allows overriding the operation parameters
LroHeaders	Optional. Allows overriding the lro headers returned on resource create
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the createOrReplace operation
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. Indicates whether the request body is optional.
Request	Optional. The request body for the operation.

`CreateOrReplaceSync`

Synchronous PUT operation for a Private endpoint connection to a resource

op Azure.ResourceManager.Legacy.PrivateEndpoints.CreateOrReplaceSync(provider: "Microsoft.ThisWillBeReplaced", privateEndpointConnectionName: string, resource: Request): Response | Error

Template Parameters

Name	Description
ParentResource	the parent resource of the PrivateEndpointConnection
Resource	the PrivateEndpointConnection resource being created or updated
BaseParameters	Optional. Allows overriding the operation parameters
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the createOrUpdate operation
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. Indicates whether the request body is optional.
Request	Optional. The request body for the operation.

`CustomPatchAsync`

A long-running resource update using a custom PATCH payload (Asynchronous) to update a PrivateEndpointConnection to a resource.

op Azure.ResourceManager.Legacy.PrivateEndpoints.CustomPatchAsync(provider: "Microsoft.ThisWillBeReplaced", privateEndpointConnectionName: string, properties: PatchModel): Response | Error

Template Parameters

Name	Description
ParentResource	the parent resource of the PrivateEndpointConnection
Resource	the PrivateEndpointConnection resource being updated
PatchModel	The input model for the PATCH request
BaseParameters	Optional. Allows overriding the operation parameters
LroHeaders	Optional. Allows overriding the lro headers returned in the Accepted response
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the patch operation
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. Indicates whether the request body is optional.

`CustomPatchSync`

A resource update using a custom PATCH payload (synchronous) to update a PrivateEndpointConnection to a resource

op Azure.ResourceManager.Legacy.PrivateEndpoints.CustomPatchSync(provider: "Microsoft.ThisWillBeReplaced", privateEndpointConnectionName: string, properties: PatchModel): Response | Error

Template Parameters

Name	Description
ParentResource	The parent resource of the PrivateEndpointConnection
Resource	Optional. The PrivateEndpointConnection resource being patched
PatchModel	The input model for the PATCH request
BaseParameters	Optional. Allows overriding the operation parameters
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the patch operation
Error	Optional. The error response, if non-standard.
OptionalRequestBody	Optional. Indicates whether the request body is optional.

`ListSinglePageByParent`

List the private endpoint connections over a resource

op Azure.ResourceManager.Legacy.PrivateEndpoints.ListSinglePageByParent(provider: "Microsoft.ThisWillBeReplaced"): Response | Error

Template Parameters

Name	Description
ParentResource	the parent resource of the PrivateEndpointConnection
Resource	Optional. The PrivateEndpointConnection resource being listed
BaseParameters	Optional. Allows overriding the operation parameters
Parameters	Optional. Additional parameters after the path parameters
Response	Optional. The success response for the list operation
Error	Optional. The error response, if non-standard.

Interfaces and Operations

Azure.ResourceManager

ExtensionResourceCollectionOperations

Template Parameters

ExtensionResourceCollectionOperations.listByParent {#Azure.ResourceManager.ExtensionResourceCollectionOperations.listByParent}

ExtensionResourceInstanceOperations

Template Parameters

ExtensionResourceInstanceOperations.get

ExtensionResourceInstanceOperations.createOrUpdate

ExtensionResourceInstanceOperations.update

ExtensionResourceInstanceOperations.delete

ExtensionResourceOperations

Template Parameters

ExtensionResourceOperations.get

ExtensionResourceOperations.createOrUpdate

ExtensionResourceOperations.update

ExtensionResourceOperations.delete

ExtensionResourceOperations.listByParent

Operations

Operations.list

PrivateEndpoints

Template Parameters

PrivateEndpoints.ListByParent

Template Parameters

PrivateEndpoints.Read

Template Parameters

PrivateEndpoints.CreateOrUpdateAsync

Template Parameters

PrivateEndpoints.CreateOrReplaceSync

Template Parameters

PrivateEndpoints.CreateOrReplaceAsync

Template Parameters

PrivateEndpoints.CustomPatchAsync

Template Parameters

PrivateEndpoints.CustomPatchSync

Template Parameters

PrivateEndpoints.DeleteAsync

Template Parameters

PrivateEndpoints.DeleteSync

Template Parameters

PrivateEndpoints.DeleteAsyncBase

Template Parameters

Examples

PrivateLinks

Template Parameters

PrivateLinks.ListByParent

Template Parameters

PrivateLinks.ListSinglePageByParent

Template Parameters

PrivateLinks.Read

Template Parameters

Examples

ProxyResourceOperations

Template Parameters

ProxyResourceOperations.get

ProxyResourceOperations.createOrUpdate

ProxyResourceOperations.delete

ProxyResourceOperations.listByParent

ResourceCollectionOperations

Template Parameters

ResourceCollectionOperations.listByParent

ResourceCollectionOperations.listBySubscription

ResourceCreateAsync

Template Parameters

ResourceCreateAsync.createOrUpdate

ResourceCreateSync

Template Parameters

ResourceCreateSync.createOrUpdate

ResourceDeleteAsync

Template Parameters

ResourceDeleteAsync.delete

ResourceDeleteSync

Template Parameters

ResourceDeleteSync.delete

ResourceDeleteWithoutOkAsync

Template Parameters

ResourceDeleteWithoutOkAsync.delete

ResourceInstanceOperations

Template Parameters

ResourceInstanceOperations.get

`ExtensionResourceCollectionOperations`

`ExtensionResourceCollectionOperations.listByParent` {#Azure.ResourceManager.ExtensionResourceCollectionOperations.listByParent}

`ExtensionResourceInstanceOperations`

`ExtensionResourceInstanceOperations.get`

`ExtensionResourceInstanceOperations.createOrUpdate`

`ExtensionResourceInstanceOperations.update`

`ExtensionResourceInstanceOperations.delete`

`ExtensionResourceOperations`

`ExtensionResourceOperations.get`

`ExtensionResourceOperations.createOrUpdate`

`ExtensionResourceOperations.update`

`ExtensionResourceOperations.delete`

`ExtensionResourceOperations.listByParent`

`Operations`

`Operations.list`

`PrivateEndpoints`

`PrivateEndpoints.ListByParent`

`PrivateEndpoints.Read`

`PrivateEndpoints.CreateOrUpdateAsync`

`PrivateEndpoints.CreateOrReplaceSync`

`PrivateEndpoints.CreateOrReplaceAsync`

`PrivateEndpoints.CustomPatchAsync`

`PrivateEndpoints.CustomPatchSync`

`PrivateEndpoints.DeleteAsync`

`PrivateEndpoints.DeleteSync`

`PrivateEndpoints.DeleteAsyncBase`

`PrivateLinks`

`PrivateLinks.ListByParent`

`PrivateLinks.ListSinglePageByParent`

`PrivateLinks.Read`

`ProxyResourceOperations`

`ProxyResourceOperations.get`

`ProxyResourceOperations.createOrUpdate`

`ProxyResourceOperations.delete`

`ProxyResourceOperations.listByParent`

`ResourceCollectionOperations`

`ResourceCollectionOperations.listByParent`

`ResourceCollectionOperations.listBySubscription`

`ResourceCreateAsync`

`ResourceCreateAsync.createOrUpdate`

`ResourceCreateSync`

`ResourceCreateSync.createOrUpdate`

`ResourceDeleteAsync`

`ResourceDeleteAsync.delete`

`ResourceDeleteSync`

`ResourceDeleteSync.delete`

`ResourceDeleteWithoutOkAsync`

`ResourceDeleteWithoutOkAsync.delete`

`ResourceInstanceOperations`

`ResourceInstanceOperations.get`

`ResourceInstanceOperations.createOrUpdate`

`ResourceInstanceOperations.update`

`ResourceInstanceOperations.delete`

`ResourceListByParent`

`ResourceListByParent.listByParent`

`ResourceListBySubscription`

`ResourceListBySubscription.listBySubscription` {#Azure.ResourceManager.ResourceListBySubscription.listBySubscription}

`ResourceOperations`

`ResourceOperations.get`

`ResourceOperations.createOrUpdate`

`ResourceOperations.update`

`ResourceOperations.delete`

`ResourceOperations.listByParent`

`ResourceOperations.listBySubscription`

`ResourceRead`

`ResourceRead.get`

`ResourceUpdateAsync`

`ResourceUpdateAsync.update`

`ResourceUpdateSync`

`ResourceUpdateSync.update`

`TenantResourceOperations`

`TenantResourceOperations.get`

`TenantResourceOperations.createOrUpdate`

`TenantResourceOperations.update`

`TenantResourceOperations.delete`

`TenantResourceOperations.listByParent`

`TrackedResourceOperations`

`TrackedResourceOperations.get`

`TrackedResourceOperations.createOrUpdate`

`TrackedResourceOperations.update`