Share via

Microsoft.ApiManagement service/settings

  • Article

Bicep resource definition

The service/settings 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.ApiManagement/service/settings resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ApiManagement/service/settings@2023-09-01-preview' existing = {
  name: 'string'
}

Property values

service/settings

Name Description Value
name The name of the existing resource.

See how to set names and types for child resources in Bicep.		 'public'

ARM template resource definition

The service/settings 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.ApiManagement/service/settings resource, add the following JSON to your template.

[reference(resourceId('Microsoft.ApiManagement/service/settings', '{name}'), '2023-09-01-preview')]

Property values

service/settings

Name Description Value
name The name of the existing resource.

See how to set names and types for child resources in JSON ARM templates.		 'public'

Terraform (AzAPI provider) resource definition

The service/settings 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.ApiManagement/service/settings resource, add the following Terraform to your template.

data "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/settings@2023-09-01-preview"
  name = "string"
  parent_id = "string"
}

Property values

service/settings

Name Description Value
name The name of the existing resource. "public"
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: service