Share via

Microsoft.CustomProviders associations 2018-09-01-preview

  • Article

Bicep resource definition

The associations resource type can be deployed with operations that target:

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' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    targetResourceId: 'string'
  }
}

Property values

AssociationProperties

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

Microsoft.CustomProviders/associations

Name Description Value
name The resource name string (required)
properties The properties of the association. AssociationProperties
scope Use when creating a resource at a scope that is different than the deployment scope. Set this property to the symbolic name of a resource to apply the extension resource.

ARM template resource definition

The associations resource type can be deployed with operations that target:

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",
  "properties": {
    "targetResourceId": "string"
  }
}

Property values

AssociationProperties

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

Microsoft.CustomProviders/associations

Name Description Value
apiVersion The api version '2018-09-01-preview'
name The resource name string (required)
properties The properties of the association. AssociationProperties
type The resource type 'Microsoft.CustomProviders/associations'

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Extend Existing Azure Resources with Custom Providers

Deploy to Azure		 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 can be deployed with operations that target:

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

AssociationProperties

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

Microsoft.CustomProviders/associations

Name Description Value
name The resource name string (required)
parent_id The ID of the resource to apply this extension resource to. string (required)
properties The properties of the association. AssociationProperties
type The resource type "Microsoft.CustomProviders/associations@2018-09-01-preview"