Microsoft.ApiManagement service/authorizationServers 2021-04-01-preview

Статья
01/16/2024

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

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

Группы ресурсов — см. команды развертывания группы ресурсов.

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

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

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

resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2021-04-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    authorizationEndpoint: 'string'
    authorizationMethods: [
      'string'
    ]
    bearerTokenSendingMethods: [
      'string'
    ]
    clientAuthenticationMethod: [
      'string'
    ]
    clientId: 'string'
    clientRegistrationEndpoint: 'string'
    clientSecret: 'string'
    defaultScope: 'string'
    description: 'string'
    displayName: 'string'
    grantTypes: [
      'string'
    ]
    resourceOwnerPassword: 'string'
    resourceOwnerUsername: 'string'
    supportState: bool
    tokenBodyParameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    tokenEndpoint: 'string'
  }
}

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

service/authorizationServers

Имя	Описание	Значение
name	имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в Bicep.	строка (обязательно) Ограничение символов: 1–80 Допустимые символы: Буквенно-цифровые символы и дефисы. Начинается с буквы и заканчивается буквенно-цифровым символом.
родитель	В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен вне родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.	Символьное имя ресурса типа: service
properties	Свойства внешнего контракта сервера авторизации OAuth.	AuthorizationServerContractProperties

AuthorizationServerContractProperties

Имя	Описание	Значение
authorizationEndpoint	Конечная точка авторизации по протоколу OAuth. См. раздел `http://tools.ietf.org/html/rfc6749#section-3.2.`	строка (обязательно)
authorizationMethods	HTTP-команды, поддерживаемые на конечной точке авторизации. Get должен присутствовать всегда. POST является необязательным.	Массив строк, содержащий любой из: DELETE GET "HEAD" "ПАРАМЕТРЫ" "PATCH" "POST" PUT TRACE
bearerTokenSendingMethods	Определяет, с помощью какого механизма токен доступа передается API.	Массив строк, содержащий любой из: AuthorizationHeader "query"
clientAuthenticationMethod	Метод аутентификации, поддерживаемой конечной точкой токена этого сервера авторизации. Возможные значения: Basic и(или) Body. Если указан текст, учетные данные клиента и другие параметры передаются в тексте запроса в формате application/x-www-form-urlencoded.	Массив строк, содержащий любой из: "Базовый" "Body"
clientid	Идентификатор клиента или приложения, зарегистрированный для этого сервера авторизации.	строка (обязательно)
clientRegistrationEndpoint	Дополнительная ссылка на страницу, где выполняется регистрация клиента или приложения для этого сервера авторизации. Содержит абсолютный URL-адрес сущности, на которую имеется ссылка.	строка (обязательно)
clientSecret	Секрет клиента или приложения, зарегистрированный для этого сервера авторизации. Это свойство не будет заполнено при операциях GET! Используйте запрос POST /listSecrets, чтобы получить значение.	строка
defaultScope	Область маркера доступа , которая будет запрашиваться по умолчанию. Можно переопределить на уровне API. Необходимо предоставить в форме строки, содержащей разделенные пробелами значения.	строка
description	Описание сервера авторизации. Может содержать теги форматирования HTML.	строка
displayName	Понятное имя сервера авторизации.	строка (обязательно)
grantTypes	Форма предоставления авторизации, которую клиент использует для запроса маркера доступа.	Массив строк, содержащий любой из: authorizationCode clientCredentials "неявный" "resourceOwnerPassword" (обязательно)
resourceOwnerPassword	Можно указать при необходимости, если тип предоставления пароля владельца ресурса поддерживается этим сервером авторизации. Пароль владельца ресурса по умолчанию.	строка
resourceOwnerUsername	Можно указать при необходимости, если тип предоставления пароля владельца ресурса поддерживается этим сервером авторизации. Имя пользователя владельца ресурса по умолчанию.	строка
supportState	Если задано значение true, сервер авторизации будет включать параметр состояния из запроса авторизации в его ответ. Клиент может использовать параметр состояния для повышения безопасности протокола.	bool
tokenBodyParameters	Дополнительные параметры, необходимые для конечной точки маркера этого сервера авторизации, представленные в виде массива объектов JSON со свойствами строки name и value, т. е. {"name" : "name value", "value": "a value"}.	TokenBodyParameterContract[]
tokenEndpoint	Конечная точка токена OAuth. Содержит абсолютный URI сущности, на которую имеется ссылка.	строка

TokenBodyParameterContract

Имя	Описание	Значение
name	имя параметра body.	string (обязательно)
значение	значение параметра body.	string (обязательно)

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

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

Группы ресурсов — см. команды развертывания групп ресурсов.

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

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

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

{
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "apiVersion": "2021-04-01-preview",
  "name": "string",
  "properties": {
    "authorizationEndpoint": "string",
    "authorizationMethods": [ "string" ],
    "bearerTokenSendingMethods": [ "string" ],
    "clientAuthenticationMethod": [ "string" ],
    "clientId": "string",
    "clientRegistrationEndpoint": "string",
    "clientSecret": "string",
    "defaultScope": "string",
    "description": "string",
    "displayName": "string",
    "grantTypes": [ "string" ],
    "resourceOwnerPassword": "string",
    "resourceOwnerUsername": "string",
    "supportState": "bool",
    "tokenBodyParameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "tokenEndpoint": "string"
  }
}

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

service/authorizationServers

Имя	Описание	Значение
тип	Тип ресурса	Microsoft.ApiManagement/service/authorizationServers
версия_API	Версия API ресурсов	'2021-04-01-preview'
name	имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.	string (обязательно) Ограничение символов: 1-80 Допустимые символы: Буквенно-цифровые символы и дефисы. Начинается с буквы и заканчивается буквенно-цифровым символом.
properties	Свойства внешнего сервера авторизации OAuth Contract.	AuthorizationServerContractProperties

AuthorizationServerContractProperties

Имя	Описание	Значение
authorizationEndpoint	Конечная точка авторизации по протоколу OAuth. См. раздел `http://tools.ietf.org/html/rfc6749#section-3.2.`	string (обязательно)
authorizationMethods	HTTP-команды, поддерживаемые на конечной точке авторизации. Get должен присутствовать всегда. POST является необязательным.	Массив строк, содержащий любой из: "DELETE" "GET" 'HEAD' "ПАРАМЕТРЫ" "PATCH" "POST" 'PUT' 'TRACE'
bearerTokenSendingMethods	Определяет, с помощью какого механизма токен доступа передается API.	Массив строк, содержащий любой из: authorizationHeader "запрос"
clientAuthenticationMethod	Метод аутентификации, поддерживаемой конечной точкой токена этого сервера авторизации. Возможные значения: Basic и (или) Body. Если указан текст , учетные данные клиента и другие параметры передаются в тексте запроса в формате application/x-www-form-urlencoded.	Массив строк, содержащий любой из: "Базовый" 'Body'
clientid	Идентификатор клиента или приложения, зарегистрированный для этого сервера авторизации.	string (обязательно)
clientRegistrationEndpoint	Дополнительная ссылка на страницу, где выполняется регистрация клиента или приложения для этого сервера авторизации. Содержит абсолютный URL-адрес сущности, на которую имеется ссылка.	string (обязательно)
clientSecret	Секрет клиента или приложения, зарегистрированный для этого сервера авторизации. Это свойство не будет заполнено при операциях GET! Используйте запрос POST /listSecrets, чтобы получить значение.	строка
defaultScope	Область маркера доступа , которая будет запрашиваться по умолчанию. Можно переопределить на уровне API. Необходимо предоставить в форме строки, содержащей разделенные пробелами значения.	строка
description	Описание сервера авторизации. Может содержать теги форматирования HTML.	строка
displayName	Понятное имя сервера авторизации.	string (обязательно)
grantTypes	Форма предоставления авторизации, которую клиент использует для запроса маркера доступа.	Массив строк, содержащий любой из: authorizationCode clientCredentials "неявный" "resourceOwnerPassword" (обязательно)
resourceOwnerPassword	Можно указать при необходимости, если тип предоставления пароля владельца ресурса поддерживается этим сервером авторизации. Пароль владельца ресурса по умолчанию.	строка
resourceOwnerUsername	Можно указать при необходимости, если тип предоставления пароля владельца ресурса поддерживается этим сервером авторизации. Имя пользователя владельца ресурса по умолчанию.	строка
supportState	Если задано значение true, сервер авторизации будет включать параметр состояния из запроса авторизации в его ответ. Клиент может использовать параметр состояния для повышения безопасности протокола.	bool
tokenBodyParameters	Дополнительные параметры, необходимые для конечной точки маркера этого сервера авторизации, представленные в виде массива объектов JSON со свойствами строки name и value, т. е. {"name" : "name value", "value": "a value"}.	TokenBodyParameterContract[]
tokenEndpoint	Конечная точка токена OAuth. Содержит абсолютный URI сущности, на которую имеется ссылка.	строка

TokenBodyParameterContract

Имя	Описание	Значение
name	имя параметра body.	string (обязательно)
значение	значение параметра body.	string (обязательно)

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationServers@2021-04-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      authorizationEndpoint = "string"
      authorizationMethods = [
        "string"
      ]
      bearerTokenSendingMethods = [
        "string"
      ]
      clientAuthenticationMethod = [
        "string"
      ]
      clientId = "string"
      clientRegistrationEndpoint = "string"
      clientSecret = "string"
      defaultScope = "string"
      description = "string"
      displayName = "string"
      grantTypes = [
        "string"
      ]
      resourceOwnerPassword = "string"
      resourceOwnerUsername = "string"
      supportState = bool
      tokenBodyParameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      tokenEndpoint = "string"
    }
  })
}

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

service/authorizationServers

Имя	Описание	Значение
тип	Тип ресурса	"Microsoft.ApiManagement/service/authorizationServers@2021-04-01-preview"
name	имя ресурса.	string (обязательно) Ограничение символов: 1-80 Допустимые символы: Буквенно-цифровые символы и дефисы. Начинается с буквы и заканчивается буквенно-цифровым символом.
parent_id	Идентификатор ресурса, который является родительским для этого ресурса.	Идентификатор ресурса типа: service
properties	Свойства внешнего сервера авторизации OAuth Contract.	AuthorizationServerContractProperties

AuthorizationServerContractProperties

Имя	Описание	Значение
authorizationEndpoint	Конечная точка авторизации по протоколу OAuth. См. раздел `http://tools.ietf.org/html/rfc6749#section-3.2.`	string (обязательно)
authorizationMethods	HTTP-команды, поддерживаемые на конечной точке авторизации. Get должен присутствовать всегда. POST является необязательным.	Массив строк, содержащий любой из: "DELETE" "GET" "HEAD" "ПАРАМЕТРЫ" "PATCH" POST "PUT" "TRACE"
bearerTokenSendingMethods	Определяет, с помощью какого механизма токен доступа передается API.	Массив строк, содержащий любой из: "authorizationHeader" "query"
clientAuthenticationMethod	Метод аутентификации, поддерживаемой конечной точкой токена этого сервера авторизации. Возможные значения: Basic и (или) Body. Если указан текст , учетные данные клиента и другие параметры передаются в тексте запроса в формате application/x-www-form-urlencoded.	Массив строк, содержащий любой из: "Basic" текст
clientid	Идентификатор клиента или приложения, зарегистрированный для этого сервера авторизации.	string (обязательно)
clientRegistrationEndpoint	Дополнительная ссылка на страницу, где выполняется регистрация клиента или приложения для этого сервера авторизации. Содержит абсолютный URL-адрес сущности, на которую имеется ссылка.	string (обязательно)
clientSecret	Секрет клиента или приложения, зарегистрированный для этого сервера авторизации. Это свойство не будет заполнено при операциях GET! Используйте запрос POST /listSecrets, чтобы получить значение.	строка
defaultScope	Область маркера доступа , которая будет запрашиваться по умолчанию. Можно переопределить на уровне API. Необходимо предоставить в форме строки, содержащей разделенные пробелами значения.	строка
description	Описание сервера авторизации. Может содержать теги форматирования HTML.	строка
displayName	Понятное имя сервера авторизации.	string (обязательно)
grantTypes	Форма предоставления авторизации, которую клиент использует для запроса маркера доступа.	Массив строк, содержащий любой из: "authorizationCode" "clientCredentials" "Неявное" "resourceOwnerPassword" (обязательно)
resourceOwnerPassword	Можно указать при необходимости, если тип предоставления пароля владельца ресурса поддерживается этим сервером авторизации. Пароль владельца ресурса по умолчанию.	строка
resourceOwnerUsername	Можно указать при необходимости, если тип предоставления пароля владельца ресурса поддерживается этим сервером авторизации. Имя пользователя владельца ресурса по умолчанию.	строка
supportState	Если задано значение true, сервер авторизации будет включать параметр состояния из запроса авторизации в его ответ. Клиент может использовать параметр состояния для повышения безопасности протокола.	bool
tokenBodyParameters	Дополнительные параметры, необходимые для конечной точки маркера этого сервера авторизации, представленные в виде массива объектов JSON со свойствами строки name и value, т. е. {"name" : "name value", "value": "a value"}.	TokenBodyParameterContract[]
tokenEndpoint	Конечная точка токена OAuth. Содержит абсолютный URI сущности, на которую имеется ссылка.	строка

TokenBodyParameterContract

Имя	Описание	Значение
name	имя параметра body.	string (обязательно)
значение	значение параметра body.	string (обязательно)

Share via

Microsoft.ApiManagement service/authorizationServers 2021-04-01-preview

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

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

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

service/authorizationServers

AuthorizationServerContractProperties

TokenBodyParameterContract

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

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

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

service/authorizationServers

AuthorizationServerContractProperties

TokenBodyParameterContract

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

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

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

service/authorizationServers

AuthorizationServerContractProperties

TokenBodyParameterContract

Дополнительные ресурсы