Microsoft.ApiManagement service/tenant

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": "2023-05-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 '2023-05-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