Share via

Microsoft.Sql virtualClusters 2021-11-01

  • Article

Bicep resource definition

The virtualClusters resource type can exist at: Resource groups

Note

This resource type is read-only, which means it can't be deployed but an existing instance can be referenced. Typically, read-only resource types are automatically created by the service.

Use the existing keyword.

Resource format

To create a Microsoft.Sql/virtualClusters resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Sql/virtualClusters@2021-11-01' existing = {
  name: 'string'
}

Property values

virtualClusters

Name Description Value
name The name of the existing resource. string (required)

ARM template resource definition

The virtualClusters resource type can exist at: Resource groups

Note

This resource type is read-only, which means it can't be deployed but an existing instance can be referenced. Typically, read-only resource types are automatically created by the service.

Use the reference function.

Resource format

To create a Microsoft.Sql/virtualClusters resource, add the following JSON to your template.

[reference(resourceId('Microsoft.Sql/virtualClusters', '{name}'), '2021-11-01')]

Property values

virtualClusters

Name Description Value
name The name of the existing resource. string (required)

Terraform (AzAPI provider) resource definition

The virtualClusters resource type can exist at: Resource groups

Note

This resource type is read-only, which means it can't be deployed but an existing instance can be referenced. Typically, read-only resource types are automatically created by the service.

Use the data keyword.

Resource format

To create a Microsoft.Sql/virtualClusters resource, add the following Terraform to your template.

data "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/virtualClusters@2021-11-01"
  name = "string"
  parent_id = "string"
}

Property values

virtualClusters

Name Description Value
name The name of the existing resource. string (required)
parent_id To reference a resource group, use the ID of that resource group. string (required)