Microsoft.ApiManagement service/tenant 2023-03-01-preview

Определение ресурса Bicep

Тип ресурса службы или клиента можно развернуть с помощью операций, предназначенных для:

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.ApiManagement/service/tenant, добавьте следующий Bicep в шаблон.

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

Значения свойств

служба или клиент

Имя Описание Значение
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в Bicep.
string (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен за пределами родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.
Символьное имя ресурса типа : service
properties Свойства параметра обновления сведений о доступе клиента. AccessInformationCreateParameterPropertiesOrAccessIn...

AccessInformationCreateParameterPropertiesOrAccessIn...

Имя Описание Значение
Включено Определяет, включен ли прямой доступ. bool
primaryKey Первичный ключ доступа. Это свойство не будет заполнено при операциях GET! Используйте запрос POST /listSecrets, чтобы получить значение. строка
principalId Идентификатор участника (пользователя). строка
secondaryKey Вторичный ключ доступа. Это свойство не будет заполнено при операциях GET! Используйте запрос POST /listSecrets, чтобы получить значение. строка

Определение ресурса шаблона ARM

Тип ресурса службы или клиента можно развернуть с помощью операций, предназначенных для:

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.ApiManagement/service/tenant, добавьте следующий код JSON в шаблон.

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

Значения свойств

служба или клиент

Имя Описание Значение
тип Тип ресурса Microsoft.ApiManagement/service/tenant
версия_API Версия API ресурсов '2023-03-01-preview'
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.
string (обязательно)
properties Свойства параметра обновления сведений о доступе клиента. AccessInformationCreateParameterPropertiesOrAccessIn...

AccessInformationCreateParameterPropertiesOrAccessIn...

Имя Описание Значение
Включено Определяет, включен ли прямой доступ. bool
primaryKey Первичный ключ доступа. Это свойство не будет заполнено при операциях GET! Используйте запрос POST /listSecrets, чтобы получить значение. строка
principalId Идентификатор участника (пользователя). строка
secondaryKey Вторичный ключ доступа. Это свойство не будет заполнено при операциях GET! Используйте запрос POST /listSecrets, чтобы получить значение. строка

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса службы или клиента можно развернуть с помощью операций, предназначенных для:

  • Группы ресурсов

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.ApiManagement/service/tenant, добавьте в шаблон следующую terraform.

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

Значения свойств

служба или клиент

Имя Описание Значение
тип Тип ресурса Microsoft.ApiManagement/service/tenant@2023-03-01-preview
name имя ресурса. строка (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: service
properties Свойства параметра обновления сведений о доступе клиента. AccessInformationCreateParameterPropertiesOrAccessIn...

AccessInformationCreateParameterPropertiesOrAccessIn...

Имя Описание Значение
Включено Определяет, включен ли прямой доступ. bool
primaryKey Первичный ключ доступа. Это свойство не будет заполнено при операциях GET! Используйте запрос POST /listSecrets, чтобы получить значение. строка
principalId Идентификатор участника (пользователя). строка
secondaryKey Вторичный ключ доступа. Это свойство не будет заполнено при операциях GET! Используйте запрос POST /listSecrets, чтобы получить значение. строка