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

op Azure.ResourceManager.ExtensionResourceCollectionOperations.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

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

ExtensionResourceInstanceOperations.createOrUpdate

op Azure.ResourceManager.ExtensionResourceInstanceOperations.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

op Azure.ResourceManager.ExtensionResourceInstanceOperations.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

op Azure.ResourceManager.ExtensionResourceInstanceOperations.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

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

ExtensionResourceOperations.createOrUpdate

op Azure.ResourceManager.ExtensionResourceOperations.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

op Azure.ResourceManager.ExtensionResourceOperations.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

op Azure.ResourceManager.ExtensionResourceOperations.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

op Azure.ResourceManager.ExtensionResourceOperations.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

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

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

ProxyResourceOperations.createOrUpdate

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

ProxyResourceOperations.delete

op Azure.ResourceManager.ProxyResourceOperations.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

op Azure.ResourceManager.ProxyResourceOperations.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

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

ResourceCollectionOperations.listBySubscription

op Azure.ResourceManager.ResourceCollectionOperations.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

op Azure.ResourceManager.ResourceCreateAsync.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

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

ResourceDeleteAsync

Caution

Deprecated: This should be deprecated in a future release

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

op Azure.ResourceManager.ResourceDeleteAsync.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

op Azure.ResourceManager.ResourceDeleteSync.delete(provider: "Microsoft.ThisWillBeReplaced"): Azure.ResourceManager.ArmDeletedResponse | Azure.ResourceManager.ArmDeletedNoContentResponse | Azure.ResourceManager.CommonTypes.ErrorResponse

ResourceDeleteWithoutOkAsync

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

op Azure.ResourceManager.ResourceDeleteWithoutOkAsync.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

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

ResourceInstanceOperations.createOrUpdate

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

ResourceInstanceOperations.update

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

ResourceInstanceOperations.delete

op Azure.ResourceManager.ResourceInstanceOperations.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

op Azure.ResourceManager.ResourceListByParent.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

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

ResourceOperations

Caution

Deprecated: Use Azure.ResourceManager.TrackedResourceOperations instead

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

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

ResourceOperations.createOrUpdate

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

ResourceOperations.update

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

ResourceOperations.delete

op Azure.ResourceManager.ResourceOperations.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

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

ResourceOperations.listBySubscription

op Azure.ResourceManager.ResourceOperations.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

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

ResourceUpdateAsync

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

op Azure.ResourceManager.ResourceUpdateAsync.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

op Azure.ResourceManager.ResourceUpdateSync.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

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

TenantResourceOperations.createOrUpdate

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

TenantResourceOperations.update

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

TenantResourceOperations.delete

op Azure.ResourceManager.TenantResourceOperations.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

op Azure.ResourceManager.TenantResourceOperations.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

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

TrackedResourceOperations.createOrUpdate

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

TrackedResourceOperations.update

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

TrackedResourceOperations.delete

op Azure.ResourceManager.TrackedResourceOperations.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

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

TrackedResourceOperations.listBySubscription

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

ArmCustomPatchAsync

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

op Azure.ResourceManager.ArmCustomPatchAsync(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.

ArmCustomPatchSync

A resource update using a custom PATCH payload (synchronous)

op Azure.ResourceManager.ArmCustomPatchSync(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.

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

ArmProviderActionAsync

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 | Azure.ResourceManager.CommonTypes.ErrorResponse

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 or TenantActionScope)
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.

ArmProviderActionSync

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

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 or TenantActionScope)
Parameters	Optional. Additional parameters after the path parameters (e.g. Location)
Error	Optional. The error response, if non-standard.

ArmResourceActionAsync

op Azure.ResourceManager.ArmResourceActionAsync(provider: "Microsoft.ThisWillBeReplaced", 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.

ArmResourceActionAsyncBase

A long-running resource action.

op Azure.ResourceManager.ArmResourceActionAsyncBase(provider: "Microsoft.ThisWillBeReplaced", 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.

ArmResourceActionNoContentAsync

op Azure.ResourceManager.ArmResourceActionNoContentAsync(provider: "Microsoft.ThisWillBeReplaced", 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.

ArmResourceActionNoContentSync

A synchronous resource action that returns no content.

op Azure.ResourceManager.ArmResourceActionNoContentSync(provider: "Microsoft.ThisWillBeReplaced", 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.

ArmResourceActionNoResponseContentAsync

op Azure.ResourceManager.ArmResourceActionNoResponseContentAsync(provider: "Microsoft.ThisWillBeReplaced", 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
Parameters	Optional. Additional parameters after the path parameters
Error	Optional. The error response, if non-standard.

ArmResourceActionSync

A synchronous resource action.

op Azure.ResourceManager.ArmResourceActionSync(provider: "Microsoft.ThisWillBeReplaced", 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.

ArmResourceCheckExistence

Check a resource’s existence via HEAD operation

op Azure.ResourceManager.ArmResourceCheckExistence(provider: "Microsoft.ThisWillBeReplaced"): 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.

ArmResourceCreateOrReplaceAsync

op Azure.ResourceManager.ArmResourceCreateOrReplaceAsync(provider: "Microsoft.ThisWillBeReplaced", 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.

ArmResourceCreateOrReplaceSync

Synchronous PUT operation for Azure Resource Manager resources

op Azure.ResourceManager.ArmResourceCreateOrReplaceSync(provider: "Microsoft.ThisWillBeReplaced", 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 createOrUpdate operation
Error	Optional. The error response, if non-standard.

ArmResourceCreateOrUpdateAsync

A long-running resource CreateOrUpdate (PUT)

op Azure.ResourceManager.ArmResourceCreateOrUpdateAsync(provider: "Microsoft.ThisWillBeReplaced", 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.

ArmResourceCreateOrUpdateSync

Caution

Deprecated: Please use ArmResourceCreateOrReplaceSync instead

DEPRECATED: Please use ArmResourceCreateOrReplaceSync instead

op Azure.ResourceManager.ArmResourceCreateOrUpdateSync(provider: "Microsoft.ThisWillBeReplaced", 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.

ArmResourceDeleteAsync

Caution

Deprecated: Use ‘ArmResourceDeleteWithoutOkAsync’ instead

op Azure.ResourceManager.ArmResourceDeleteAsync(provider: "Microsoft.ThisWillBeReplaced"): 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.

ArmResourceDeleteAsyncBase

op Azure.ResourceManager.ArmResourceDeleteAsyncBase(provider: "Microsoft.ThisWillBeReplaced"): 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.

ArmResourceDeleteSync

Delete a resource synchronously

op Azure.ResourceManager.ArmResourceDeleteSync(provider: "Microsoft.ThisWillBeReplaced"): 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.

ArmResourceDeleteWithoutOkAsync

op Azure.ResourceManager.ArmResourceDeleteWithoutOkAsync(provider: "Microsoft.ThisWillBeReplaced"): 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.

ArmResourceListAtScope

A resource list operation, with scope determined by BaseParameters

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

Template Parameters

Name	Description
Resource	the resource being patched
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.

ArmResourceListByParent

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

op Azure.ResourceManager.ArmResourceListByParent(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.

ArmResourcePatchAsync

op Azure.ResourceManager.ArmResourcePatchAsync(provider: "Microsoft.ThisWillBeReplaced", 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

ArmResourcePatchSync

op Azure.ResourceManager.ArmResourcePatchSync(provider: "Microsoft.ThisWillBeReplaced", 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

ArmResourceRead

A resource GET operation

op Azure.ResourceManager.ArmResourceRead(provider: "Microsoft.ThisWillBeReplaced"): 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.

ArmTagsPatchAsync

op Azure.ResourceManager.ArmTagsPatchAsync(provider: "Microsoft.ThisWillBeReplaced", 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
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

ArmTagsPatchSync

op Azure.ResourceManager.ArmTagsPatchSync(provider: "Microsoft.ThisWillBeReplaced", 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

checkGlobalNameAvailability

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

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

Azure.ResourceManager.Foundations

ArmCreateOperation

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

Template Parameters

Name	Description
HttpParameters
BodyParameter
Response
ErrorResponse

ArmReadOperation

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

Template Parameters

Name	Description
Parameters
Response
ErrorResponse

ArmUpdateOperation

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

Template Parameters

Name	Description
HttpParameters
BodyParameter
Response
ErrorResponse

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