Microsoft.ApiManagement service/tenant 2021-01-01-preview

The service/tenant resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.ApiManagement/service/tenant resource, add the following Bicep or JSON to your template.

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

Property values

service/tenant

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.ApiManagement/service/tenant'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2021-01-01-preview'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
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.
parentSymbolicName
properties Tenant access information update parameters of the API Management service AccessInformationCreateParameterProperties

AccessInformationCreateParameterProperties

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