Microsoft.ApiManagement service/tenant 2022-04-01-preview

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.ApiManagement/service/tenant@2022-04-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    enabled: bool
    primaryKey: 'string'
    principalId: 'string'
    secondaryKey: 'string'
  }
}

Property values

service/tenant

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (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
properties Tenant access information update parameter properties. AccessInformationCreateParameterPropertiesOrAccessIn...

AccessInformationCreateParameterPropertiesOrAccessIn...

Name Description Value
enabled Determines whether direct access is enabled. bool
primaryKey Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. string
principalId Principal (User) Identifier. string
secondaryKey Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. string

ARM template resource definition

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

{
  "type": "Microsoft.ApiManagement/service/tenant",
  "apiVersion": "2022-04-01-preview",
  "name": "string",
  "properties": {
    "enabled": "bool",
    "primaryKey": "string",
    "principalId": "string",
    "secondaryKey": "string"
  }
}

Property values

service/tenant

Name Description Value
type The resource type 'Microsoft.ApiManagement/service/tenant'
apiVersion The resource api version '2022-04-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties Tenant access information update parameter properties. AccessInformationCreateParameterPropertiesOrAccessIn...

AccessInformationCreateParameterPropertiesOrAccessIn...

Name Description Value
enabled Determines whether direct access is enabled. bool
primaryKey Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. string
principalId Principal (User) Identifier. string
secondaryKey Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. string

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/tenant@2022-04-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      enabled = bool
      primaryKey = "string"
      principalId = "string"
      secondaryKey = "string"
    }
  })
}

Property values

service/tenant

Name Description Value
type The resource type "Microsoft.ApiManagement/service/tenant@2022-04-01-preview"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: service
properties Tenant access information update parameter properties. AccessInformationCreateParameterPropertiesOrAccessIn...

AccessInformationCreateParameterPropertiesOrAccessIn...

Name Description Value
enabled Determines whether direct access is enabled. bool
primaryKey Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. string
principalId Principal (User) Identifier. string
secondaryKey Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. string