Microsoft.CustomProviders (preview:2018-09-01)

2025/09/19 • 11 new, 11 deleted methods

Operations_List (new)
Description :  The list of operations provided by Microsoft CustomProviders.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CustomProviders/operations
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by this resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name, in format of {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: Display metadata associated with the operation. ,
Required: False ,
}
{
provider:
{
Description: Resource provider: Microsoft Custom Providers. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: Type of operation: get, read, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description of this operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
CustomResourceProvider_CreateOrUpdate (new)
Description :  Creates or updates the custom resource provider.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceProviderName:
{
Description: The name of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
resourceProvider:
{
Description: The parameters required to create or update a custom resource provider definition. ,
Required: True ,
}
{
properties:
{
Description: The manifest for the custom resource provider ,
Required: False ,
}
{
actions:
{
Description: A list of actions that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for action requests. ,
Enum:
{
Proxy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceTypes:
{
Description: A list of resource types that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for resource requests. ,
Enum:
{
Proxy: No description available. ,
Proxy,Cache: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validations:
{
Description: A list of validations to run on the custom resource provider's requests. ,
Required: False ,
}
[
{
validationType:
{
Description: The type of validation to run against a matching request. ,
Enum:
{
Swagger: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: A link to the validation specification. The specification must be hosted on raw.githubusercontent.com. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the resource provider. ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The manifest for the custom resource provider ,
Required: False ,
}
{
actions:
{
Description: A list of actions that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for action requests. ,
Enum:
{
Proxy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceTypes:
{
Description: A list of resource types that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for resource requests. ,
Enum:
{
Proxy: No description available. ,
Proxy,Cache: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validations:
{
Description: A list of validations to run on the custom resource provider's requests. ,
Required: False ,
}
[
{
validationType:
{
Description: The type of validation to run against a matching request. ,
Enum:
{
Swagger: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: A link to the validation specification. The specification must be hosted on raw.githubusercontent.com. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the resource provider. ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The manifest for the custom resource provider ,
Required: False ,
}
{
actions:
{
Description: A list of actions that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for action requests. ,
Enum:
{
Proxy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceTypes:
{
Description: A list of resource types that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for resource requests. ,
Enum:
{
Proxy: No description available. ,
Proxy,Cache: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validations:
{
Description: A list of validations to run on the custom resource provider's requests. ,
Required: False ,
}
[
{
validationType:
{
Description: The type of validation to run against a matching request. ,
Enum:
{
Swagger: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: A link to the validation specification. The specification must be hosted on raw.githubusercontent.com. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the resource provider. ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
CustomResourceProvider_Delete (new)
Description :  Deletes the custom resource provider.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceProviderName:
{
Description: The name of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
CustomResourceProvider_Get (new)
Description :  Gets the custom resource provider manifest.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceProviderName:
{
Description: The name of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The manifest for the custom resource provider ,
Required: False ,
}
{
actions:
{
Description: A list of actions that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for action requests. ,
Enum:
{
Proxy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceTypes:
{
Description: A list of resource types that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for resource requests. ,
Enum:
{
Proxy: No description available. ,
Proxy,Cache: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validations:
{
Description: A list of validations to run on the custom resource provider's requests. ,
Required: False ,
}
[
{
validationType:
{
Description: The type of validation to run against a matching request. ,
Enum:
{
Swagger: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: A link to the validation specification. The specification must be hosted on raw.githubusercontent.com. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the resource provider. ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
CustomResourceProvider_Update (new)
Description :  Updates an existing custom resource provider. The only value that can be updated via PATCH currently is the tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceProviderName:
{
Description: The name of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
patchableResource:
{
Description: The updatable fields of a custom resource provider. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The manifest for the custom resource provider ,
Required: False ,
}
{
actions:
{
Description: A list of actions that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for action requests. ,
Enum:
{
Proxy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceTypes:
{
Description: A list of resource types that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for resource requests. ,
Enum:
{
Proxy: No description available. ,
Proxy,Cache: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validations:
{
Description: A list of validations to run on the custom resource provider's requests. ,
Required: False ,
}
[
{
validationType:
{
Description: The type of validation to run against a matching request. ,
Enum:
{
Swagger: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: A link to the validation specification. The specification must be hosted on raw.githubusercontent.com. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the resource provider. ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
CustomResourceProvider_ListByResourceGroup (new)
Description :  Gets all the custom resource providers within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of custom resource provider manifests. ,
Required: False ,
}
[
{
properties:
{
Description: The manifest for the custom resource provider ,
Required: False ,
}
{
actions:
{
Description: A list of actions that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for action requests. ,
Enum:
{
Proxy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceTypes:
{
Description: A list of resource types that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for resource requests. ,
Enum:
{
Proxy: No description available. ,
Proxy,Cache: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validations:
{
Description: A list of validations to run on the custom resource provider's requests. ,
Required: False ,
}
[
{
validationType:
{
Description: The type of validation to run against a matching request. ,
Enum:
{
Swagger: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: A link to the validation specification. The specification must be hosted on raw.githubusercontent.com. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the resource provider. ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
CustomResourceProvider_ListBySubscription (new)
Description :  Gets all the custom resource providers within a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CustomProviders/resourceProviders
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of custom resource provider manifests. ,
Required: False ,
}
[
{
properties:
{
Description: The manifest for the custom resource provider ,
Required: False ,
}
{
actions:
{
Description: A list of actions that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for action requests. ,
Enum:
{
Proxy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceTypes:
{
Description: A list of resource types that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for resource requests. ,
Enum:
{
Proxy: No description available. ,
Proxy,Cache: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validations:
{
Description: A list of validations to run on the custom resource provider's requests. ,
Required: False ,
}
[
{
validationType:
{
Description: The type of validation to run against a matching request. ,
Enum:
{
Swagger: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: A link to the validation specification. The specification must be hosted on raw.githubusercontent.com. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the resource provider. ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Associations_CreateOrUpdate (new)
Description :  Create or update an association.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.CustomProviders/associations/{associationName}
{
scope:
{
Description: The scope of the association. The scope can be any valid REST resource instance. For example, use '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.Compute/virtualMachines/{vm-name}' for a virtual machine resource. ,
Required: True ,
}
string ,
associationName:
{
Description: The name of the association. ,
Required: True ,
}
string ,
association:
{
Description: The parameters required to create or update an association. ,
Required: True ,
}
{
id:
{
Description: The association id. ,
Required: False ,
}
string ,
name:
{
Description: The association name. ,
Required: False ,
}
string ,
type:
{
Description: The association type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the association. ,
Required: False ,
}
{
targetResourceId:
{
Description: The REST resource instance of the target resource for this association. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the association. ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The association id. ,
Required: False ,
}
string ,
name:
{
Description: The association name. ,
Required: False ,
}
string ,
type:
{
Description: The association type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the association. ,
Required: False ,
}
{
targetResourceId:
{
Description: The REST resource instance of the target resource for this association. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the association. ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
id:
{
Description: The association id. ,
Required: False ,
}
string ,
name:
{
Description: The association name. ,
Required: False ,
}
string ,
type:
{
Description: The association type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the association. ,
Required: False ,
}
{
targetResourceId:
{
Description: The REST resource instance of the target resource for this association. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the association. ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Associations_Delete (new)
Description :  Delete an association.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.CustomProviders/associations/{associationName}
{
scope:
{
Description: The scope of the association. ,
Required: True ,
}
string ,
associationName:
{
Description: The name of the association. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Associations_Get (new)
Description :  Get an association.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CustomProviders/associations/{associationName}
{
scope:
{
Description: The scope of the association. ,
Required: True ,
}
string ,
associationName:
{
Description: The name of the association. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The association id. ,
Required: False ,
}
string ,
name:
{
Description: The association name. ,
Required: False ,
}
string ,
type:
{
Description: The association type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the association. ,
Required: False ,
}
{
targetResourceId:
{
Description: The REST resource instance of the target resource for this association. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the association. ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Associations_ListAll (new)
Description :  Gets all association for the given scope.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CustomProviders/associations
{
scope:
{
Description: The scope of the association. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of associations. ,
Required: False ,
}
[
{
id:
{
Description: The association id. ,
Required: False ,
}
string ,
name:
{
Description: The association name. ,
Required: False ,
}
string ,
type:
{
Description: The association type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the association. ,
Required: False ,
}
{
targetResourceId:
{
Description: The REST resource instance of the target resource for this association. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the association. ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Operations_List (removed)
Description :  The list of operations provided by Microsoft CustomProviders.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CustomProviders/operations
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by this resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name, in format of {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: Display metadata associated with the operation. ,
Required: False ,
}
{
provider:
{
Description: Resource provider: Microsoft Custom Providers. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: Type of operation: get, read, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description of this operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
CustomResourceProvider_CreateOrUpdate (removed)
Description :  Creates or updates the custom resource provider.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceProviderName:
{
Description: The name of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
resourceProvider:
{
Description: The parameters required to create or update a custom resource provider definition. ,
Required: True ,
}
{
properties:
{
Description: The manifest for the custom resource provider ,
Required: False ,
}
{
actions:
{
Description: A list of actions that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for action requests. ,
Enum:
{
Proxy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceTypes:
{
Description: A list of resource types that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for resource requests. ,
Enum:
{
Proxy: No description available. ,
Proxy,Cache: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validations:
{
Description: A list of validations to run on the custom resource provider's requests. ,
Required: False ,
}
[
{
validationType:
{
Description: The type of validation to run against a matching request. ,
Enum:
{
Swagger: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: A link to the validation specification. The specification must be hosted on raw.githubusercontent.com. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the resource provider. ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The manifest for the custom resource provider ,
Required: False ,
}
{
actions:
{
Description: A list of actions that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for action requests. ,
Enum:
{
Proxy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceTypes:
{
Description: A list of resource types that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for resource requests. ,
Enum:
{
Proxy: No description available. ,
Proxy,Cache: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validations:
{
Description: A list of validations to run on the custom resource provider's requests. ,
Required: False ,
}
[
{
validationType:
{
Description: The type of validation to run against a matching request. ,
Enum:
{
Swagger: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: A link to the validation specification. The specification must be hosted on raw.githubusercontent.com. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the resource provider. ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The manifest for the custom resource provider ,
Required: False ,
}
{
actions:
{
Description: A list of actions that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for action requests. ,
Enum:
{
Proxy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceTypes:
{
Description: A list of resource types that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for resource requests. ,
Enum:
{
Proxy: No description available. ,
Proxy,Cache: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validations:
{
Description: A list of validations to run on the custom resource provider's requests. ,
Required: False ,
}
[
{
validationType:
{
Description: The type of validation to run against a matching request. ,
Enum:
{
Swagger: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: A link to the validation specification. The specification must be hosted on raw.githubusercontent.com. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the resource provider. ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
CustomResourceProvider_Delete (removed)
Description :  Deletes the custom resource provider.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceProviderName:
{
Description: The name of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
CustomResourceProvider_Get (removed)
Description :  Gets the custom resource provider manifest.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceProviderName:
{
Description: The name of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The manifest for the custom resource provider ,
Required: False ,
}
{
actions:
{
Description: A list of actions that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for action requests. ,
Enum:
{
Proxy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceTypes:
{
Description: A list of resource types that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for resource requests. ,
Enum:
{
Proxy: No description available. ,
Proxy,Cache: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validations:
{
Description: A list of validations to run on the custom resource provider's requests. ,
Required: False ,
}
[
{
validationType:
{
Description: The type of validation to run against a matching request. ,
Enum:
{
Swagger: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: A link to the validation specification. The specification must be hosted on raw.githubusercontent.com. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the resource provider. ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
CustomResourceProvider_Update (removed)
Description :  Updates an existing custom resource provider. The only value that can be updated via PATCH currently is the tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceProviderName:
{
Description: The name of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
patchableResource:
{
Description: The updatable fields of a custom resource provider. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The manifest for the custom resource provider ,
Required: False ,
}
{
actions:
{
Description: A list of actions that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for action requests. ,
Enum:
{
Proxy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceTypes:
{
Description: A list of resource types that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for resource requests. ,
Enum:
{
Proxy: No description available. ,
Proxy,Cache: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validations:
{
Description: A list of validations to run on the custom resource provider's requests. ,
Required: False ,
}
[
{
validationType:
{
Description: The type of validation to run against a matching request. ,
Enum:
{
Swagger: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: A link to the validation specification. The specification must be hosted on raw.githubusercontent.com. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the resource provider. ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
CustomResourceProvider_ListByResourceGroup (removed)
Description :  Gets all the custom resource providers within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of custom resource provider manifests. ,
Required: False ,
}
[
{
properties:
{
Description: The manifest for the custom resource provider ,
Required: False ,
}
{
actions:
{
Description: A list of actions that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for action requests. ,
Enum:
{
Proxy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceTypes:
{
Description: A list of resource types that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for resource requests. ,
Enum:
{
Proxy: No description available. ,
Proxy,Cache: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validations:
{
Description: A list of validations to run on the custom resource provider's requests. ,
Required: False ,
}
[
{
validationType:
{
Description: The type of validation to run against a matching request. ,
Enum:
{
Swagger: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: A link to the validation specification. The specification must be hosted on raw.githubusercontent.com. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the resource provider. ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
CustomResourceProvider_ListBySubscription (removed)
Description :  Gets all the custom resource providers within a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CustomProviders/resourceProviders
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of custom resource provider manifests. ,
Required: False ,
}
[
{
properties:
{
Description: The manifest for the custom resource provider ,
Required: False ,
}
{
actions:
{
Description: A list of actions that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for action requests. ,
Enum:
{
Proxy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceTypes:
{
Description: A list of resource types that the custom resource provider implements. ,
Required: False ,
}
[
{
routingType:
{
Description: The routing types that are supported for resource requests. ,
Enum:
{
Proxy: No description available. ,
Proxy,Cache: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validations:
{
Description: A list of validations to run on the custom resource provider's requests. ,
Required: False ,
}
[
{
validationType:
{
Description: The type of validation to run against a matching request. ,
Enum:
{
Swagger: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: A link to the validation specification. The specification must be hosted on raw.githubusercontent.com. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the resource provider. ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Associations_CreateOrUpdate (removed)
Description :  Create or update an association.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.CustomProviders/associations/{associationName}
{
scope:
{
Description: The scope of the association. The scope can be any valid REST resource instance. For example, use '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.Compute/virtualMachines/{vm-name}' for a virtual machine resource. ,
Required: True ,
}
string ,
associationName:
{
Description: The name of the association. ,
Required: True ,
}
string ,
association:
{
Description: The parameters required to create or update an association. ,
Required: True ,
}
{
id:
{
Description: The association id. ,
Required: False ,
}
string ,
name:
{
Description: The association name. ,
Required: False ,
}
string ,
type:
{
Description: The association type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the association. ,
Required: False ,
}
{
targetResourceId:
{
Description: The REST resource instance of the target resource for this association. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the association. ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The association id. ,
Required: False ,
}
string ,
name:
{
Description: The association name. ,
Required: False ,
}
string ,
type:
{
Description: The association type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the association. ,
Required: False ,
}
{
targetResourceId:
{
Description: The REST resource instance of the target resource for this association. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the association. ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
id:
{
Description: The association id. ,
Required: False ,
}
string ,
name:
{
Description: The association name. ,
Required: False ,
}
string ,
type:
{
Description: The association type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the association. ,
Required: False ,
}
{
targetResourceId:
{
Description: The REST resource instance of the target resource for this association. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the association. ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Associations_Delete (removed)
Description :  Delete an association.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.CustomProviders/associations/{associationName}
{
scope:
{
Description: The scope of the association. ,
Required: True ,
}
string ,
associationName:
{
Description: The name of the association. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Associations_Get (removed)
Description :  Get an association.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CustomProviders/associations/{associationName}
{
scope:
{
Description: The scope of the association. ,
Required: True ,
}
string ,
associationName:
{
Description: The name of the association. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The association id. ,
Required: False ,
}
string ,
name:
{
Description: The association name. ,
Required: False ,
}
string ,
type:
{
Description: The association type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the association. ,
Required: False ,
}
{
targetResourceId:
{
Description: The REST resource instance of the target resource for this association. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the association. ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Associations_ListAll (removed)
Description :  Gets all association for the given scope.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CustomProviders/associations
{
scope:
{
Description: The scope of the association. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of associations. ,
Required: False ,
}
[
{
id:
{
Description: The association id. ,
Required: False ,
}
string ,
name:
{
Description: The association name. ,
Required: False ,
}
string ,
type:
{
Description: The association type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the association. ,
Required: False ,
}
{
targetResourceId:
{
Description: The REST resource instance of the target resource for this association. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the association. ,
Enum:
{
Accepted: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}