Microsoft.ApiManagement service/apis/resolvers 2023-05-01-preview

Bicep resource definition

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

resource symbolicname 'Microsoft.ApiManagement/service/apis/resolvers@2023-05-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    displayName: 'string'
    path: 'string'
  }
}

Property values

Microsoft.ApiManagement/service/apis/resolvers

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 1 (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: service/apis
properties Properties of the Resolver Contract. ResolverEntityBaseContract

ResolverEntityBaseContract

Name Description Value
description Description of the resolver. May include HTML formatting tags. string

Constraints:
Max length =
displayName Resolver Name. string

Constraints:
Min length = 1
Max length = 1
path Path is type/field being resolved. string

Constraints:
Min length = 1
Max length = 1

ARM template resource definition

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

{
  "type": "Microsoft.ApiManagement/service/apis/resolvers",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "path": "string"
  }
}

Property values

Microsoft.ApiManagement/service/apis/resolvers

Name Description Value
apiVersion The api version '2023-05-01-preview'
name The resource name string

Constraints:
Min length = 1
Max length = 1 (required)
properties Properties of the Resolver Contract. ResolverEntityBaseContract
type The resource type 'Microsoft.ApiManagement/service/apis/resolvers'

ResolverEntityBaseContract

Name Description Value
description Description of the resolver. May include HTML formatting tags. string

Constraints:
Max length =
displayName Resolver Name. string

Constraints:
Min length = 1
Max length = 1
path Path is type/field being resolved. string

Constraints:
Min length = 1
Max length = 1

Terraform (AzAPI provider) resource definition

The service/apis/resolvers resource type can be deployed with operations that target:

  • Resource groups

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

Resource format

To create a Microsoft.ApiManagement/service/apis/resolvers resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/resolvers@2023-05-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      path = "string"
    }
  })
}

Property values

Microsoft.ApiManagement/service/apis/resolvers

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 1 (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: service/apis
properties Properties of the Resolver Contract. ResolverEntityBaseContract
type The resource type "Microsoft.ApiManagement/service/apis/resolvers@2023-05-01-preview"

ResolverEntityBaseContract

Name Description Value
description Description of the resolver. May include HTML formatting tags. string

Constraints:
Max length =
displayName Resolver Name. string

Constraints:
Min length = 1
Max length = 1
path Path is type/field being resolved. string

Constraints:
Min length = 1
Max length = 1