Microsoft.CustomProviders associations

• Latest
• 2018-09-01-preview

Bicep resource definition

The associations resource type is an extension resource, which means you can apply it to another resource.

Use the scope property on this resource to set the scope for this resource. See Set scope on extension resources in Bicep.

Valid deployment scopes for the associations resource are:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.CustomProviders/associations resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.CustomProviders/associations@2018-09-01-preview' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    targetResourceId: 'string'
  }
}

Property values

associations

Name	Description	Value
name	The resource name	string (required) Character limit: 1-180 Valid characters: Can't use: %&\\?/ or control characters Can't end with period or space.
scope	Use when creating an extension resource at a scope that is different than the deployment scope.	Target resource For Bicep, set this property to the symbolic name of the resource to apply the extension resource.
properties	The properties of the association.	AssociationProperties

AssociationProperties

Name	Description	Value
targetResourceId	The REST resource instance of the target resource for this association.	string

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Extend Existing Azure Resources with Custom Providers	This sample will go into detail on how to extend existing Azure resources and Resource Manager templates to add in custom workloads.

ARM template resource definition

The associations resource type is an extension resource, which means you can apply it to another resource.

Use the scope property on this resource to set the scope for this resource. See Set scope on extension resources in ARM templates.

Valid deployment scopes for the associations resource are:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.CustomProviders/associations resource, add the following JSON to your template.

{
  "type": "Microsoft.CustomProviders/associations",
  "apiVersion": "2018-09-01-preview",
  "name": "string",
  "scope": "string",
  "properties": {
    "targetResourceId": "string"
  }
}

Property values

associations

Name	Description	Value
type	The resource type	'Microsoft.CustomProviders/associations'
apiVersion	The resource api version	'2018-09-01-preview'
name	The resource name	string (required) Character limit: 1-180 Valid characters: Can't use: %&\\?/ or control characters Can't end with period or space.
scope	Use when creating an extension resource at a scope that is different than the deployment scope.	Target resource For JSON, set the value to the full name of the resource to apply the extension resource to.
properties	The properties of the association.	AssociationProperties

AssociationProperties

Name	Description	Value
targetResourceId	The REST resource instance of the target resource for this association.	string

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Extend Existing Azure Resources with Custom Providers	This sample will go into detail on how to extend existing Azure resources and Resource Manager templates to add in custom workloads.

Terraform (AzAPI provider) resource definition

The associations resource type is an extension resource, which means you can apply it to another resource.

Use the parent_id property on this resource to set the scope for this resource.

Valid deployment scopes for the associations resource are:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.CustomProviders/associations resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.CustomProviders/associations@2018-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      targetResourceId = "string"
    }
  })
}

Property values

associations

Name	Description	Value
type	The resource type	"Microsoft.CustomProviders/associations@2018-09-01-preview"
name	The resource name	string (required) Character limit: 1-180 Valid characters: Can't use: %&\\?/ or control characters Can't end with period or space.
parent_id	The ID of the resource to apply this extension resource to.	string (required)
properties	The properties of the association.	AssociationProperties

AssociationProperties

Name	Description	Value
targetResourceId	The REST resource instance of the target resource for this association.	string