Поделиться через

Служба Microsoft.ApiManagement/authorizationServers 2022-08-01

  • Статья

Определение ресурсов Bicep

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

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

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

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

resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2022-08-01' = {
  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'
    useInApiDocumentation: bool
    useInTestConsole: bool
  }
}

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

service/authorizationServers

Имя Описание Ценность
имя Имя ресурса

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

Ограничение символов: 1–80

Допустимые символы:
Буквенно-цифровые и дефисы.

Начните с буквы и заканчивается буквенно-цифровым.
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.		 Символьное имя ресурса типа: служба
свойства Свойства внешнего контракта сервера авторизации 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 Метод проверки подлинности, поддерживаемый конечной точкой маркера этого сервера авторизации. Возможные значения: "Базовый" и (или) "Текст". При указании текста учетные данные клиента и другие параметры передаются в тексте запроса в формате application/x-www-form-urlencoded. Массив строк, содержащий любой из:
"Базовый"
"Тело"
clientId Идентификатор клиента или приложения, зарегистрированный на этом сервере авторизации. строка (обязательно)
clientRegistrationEndpoint Необязательная ссылка на страницу, на которой выполняется регистрация клиента или приложения для этого сервера авторизации. Содержит абсолютный URL-адрес для ссылки на сущность. строка (обязательно)
clientSecret Секрет клиента или приложения, зарегистрированный на этом сервере авторизации. Это свойство не будет заполнено в операциях GET! Используйте запрос POST "/listSecrets", чтобы получить это значение. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
defaultScope Область маркера доступа, запрашиваемая по умолчанию. Можно переопределить на уровне API. Следует указать в виде строки, содержащей значения с разделителями пространства. струна
описание Описание сервера авторизации. Может содержать теги форматирования HTML. струна
displayName Понятное имя сервера авторизации. строка (обязательно)

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 50
grantTypes Форма предоставления авторизации, которую клиент использует для запроса маркера доступа. Массив строк, содержащий любой из:
"authorizationCode"
ClientCredentials
"неявное"
ResourceOwnerPassword (обязательный)
resourceOwnerPassword При необходимости можно указать, когда тип предоставления пароля владельца ресурса поддерживается этим сервером авторизации. Пароль владельца ресурса по умолчанию. струна
resourceOwnerUserName При необходимости можно указать, когда тип предоставления пароля владельца ресурса поддерживается этим сервером авторизации. Имя пользователя владельца ресурса по умолчанию. струна
supportState Если задано значение true, сервер авторизации будет включать параметр состояния из запроса авторизации в ответ. Клиент может использовать параметр состояния для повышения безопасности протокола. bool
tokenBodyParameters Дополнительные параметры, необходимые конечной точке маркера этого сервера авторизации, представленного в виде массива объектов JSON со свойствами строки имени и значения, т. е. {"name" : "name value", "value": "a value"}. TokenBodyParameterContract[]
tokenEndpoint Конечная точка маркера OAuth. Содержит абсолютный универсальный код ресурса (URI) для объекта, на который ссылается ссылка. струна
useInApiDocumentation Если значение true, сервер авторизации будет использоваться в документации по API на портале разработчика. Значение false по умолчанию, если значение не указано. bool
useInTestConsole Если задано значение true, сервер авторизации может использоваться в тестовой консоли портала разработчика. Значение true по умолчанию, если значение не указано. bool

TokenBodyParameterContract

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

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

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

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

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

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

{
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "apiVersion": "2022-08-01",
  "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",
    "useInApiDocumentation": "bool",
    "useInTestConsole": "bool"
  }
}

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

service/authorizationServers

Имя Описание Ценность
тип Тип ресурса "Microsoft.ApiManagement/service/authorizationServers"
apiVersion Версия API ресурсов '2022-08-01'
имя Имя ресурса

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

Ограничение символов: 1–80

Допустимые символы:
Буквенно-цифровые и дефисы.

Начните с буквы и заканчивается буквенно-цифровым.
свойства Свойства внешнего контракта сервера авторизации 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 Метод проверки подлинности, поддерживаемый конечной точкой маркера этого сервера авторизации. Возможные значения: "Базовый" и (или) "Текст". При указании текста учетные данные клиента и другие параметры передаются в тексте запроса в формате application/x-www-form-urlencoded. Массив строк, содержащий любой из:
"Базовый"
"Тело"
clientId Идентификатор клиента или приложения, зарегистрированный на этом сервере авторизации. строка (обязательно)
clientRegistrationEndpoint Необязательная ссылка на страницу, на которой выполняется регистрация клиента или приложения для этого сервера авторизации. Содержит абсолютный URL-адрес для ссылки на сущность. строка (обязательно)
clientSecret Секрет клиента или приложения, зарегистрированный на этом сервере авторизации. Это свойство не будет заполнено в операциях GET! Используйте запрос POST "/listSecrets", чтобы получить это значение. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
defaultScope Область маркера доступа, запрашиваемая по умолчанию. Можно переопределить на уровне API. Следует указать в виде строки, содержащей значения с разделителями пространства. струна
описание Описание сервера авторизации. Может содержать теги форматирования HTML. струна
displayName Понятное имя сервера авторизации. строка (обязательно)

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 50
grantTypes Форма предоставления авторизации, которую клиент использует для запроса маркера доступа. Массив строк, содержащий любой из:
"authorizationCode"
ClientCredentials
"неявное"
ResourceOwnerPassword (обязательный)
resourceOwnerPassword При необходимости можно указать, когда тип предоставления пароля владельца ресурса поддерживается этим сервером авторизации. Пароль владельца ресурса по умолчанию. струна
resourceOwnerUserName При необходимости можно указать, когда тип предоставления пароля владельца ресурса поддерживается этим сервером авторизации. Имя пользователя владельца ресурса по умолчанию. струна
supportState Если задано значение true, сервер авторизации будет включать параметр состояния из запроса авторизации в ответ. Клиент может использовать параметр состояния для повышения безопасности протокола. bool
tokenBodyParameters Дополнительные параметры, необходимые конечной точке маркера этого сервера авторизации, представленного в виде массива объектов JSON со свойствами строки имени и значения, т. е. {"name" : "name value", "value": "a value"}. TokenBodyParameterContract[]
tokenEndpoint Конечная точка маркера OAuth. Содержит абсолютный универсальный код ресурса (URI) для объекта, на который ссылается ссылка. струна
useInApiDocumentation Если значение true, сервер авторизации будет использоваться в документации по API на портале разработчика. Значение false по умолчанию, если значение не указано. bool
useInTestConsole Если задано значение true, сервер авторизации может использоваться в тестовой консоли портала разработчика. Значение true по умолчанию, если значение не указано. bool

TokenBodyParameterContract

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

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

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

  • групп ресурсов

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationServers@2022-08-01"
  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"
      useInApiDocumentation = bool
      useInTestConsole = bool
    }
  })
}

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

service/authorizationServers

Имя Описание Ценность
тип Тип ресурса "Microsoft.ApiManagement/service/authorizationServers@2022-08-01"
имя Имя ресурса строка (обязательно)

Ограничение символов: 1–80

Допустимые символы:
Буквенно-цифровые и дефисы.

Начните с буквы и заканчивается буквенно-цифровым.
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: службы
свойства Свойства внешнего контракта сервера авторизации 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 Метод проверки подлинности, поддерживаемый конечной точкой маркера этого сервера авторизации. Возможные значения: "Базовый" и (или) "Текст". При указании текста учетные данные клиента и другие параметры передаются в тексте запроса в формате application/x-www-form-urlencoded. Массив строк, содержащий любой из:
"Базовый"
"Тело"
clientId Идентификатор клиента или приложения, зарегистрированный на этом сервере авторизации. строка (обязательно)
clientRegistrationEndpoint Необязательная ссылка на страницу, на которой выполняется регистрация клиента или приложения для этого сервера авторизации. Содержит абсолютный URL-адрес для ссылки на сущность. строка (обязательно)
clientSecret Секрет клиента или приложения, зарегистрированный на этом сервере авторизации. Это свойство не будет заполнено в операциях GET! Используйте запрос POST "/listSecrets", чтобы получить это значение. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
defaultScope Область маркера доступа, запрашиваемая по умолчанию. Можно переопределить на уровне API. Следует указать в виде строки, содержащей значения с разделителями пространства. струна
описание Описание сервера авторизации. Может содержать теги форматирования HTML. струна
displayName Понятное имя сервера авторизации. строка (обязательно)

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 50
grantTypes Форма предоставления авторизации, которую клиент использует для запроса маркера доступа. Массив строк, содержащий любой из:
"authorizationCode"
"clientCredentials"
"неявное"
ResourceOwnerPassword (обязательный)
resourceOwnerPassword При необходимости можно указать, когда тип предоставления пароля владельца ресурса поддерживается этим сервером авторизации. Пароль владельца ресурса по умолчанию. струна
resourceOwnerUserName При необходимости можно указать, когда тип предоставления пароля владельца ресурса поддерживается этим сервером авторизации. Имя пользователя владельца ресурса по умолчанию. струна
supportState Если задано значение true, сервер авторизации будет включать параметр состояния из запроса авторизации в ответ. Клиент может использовать параметр состояния для повышения безопасности протокола. bool
tokenBodyParameters Дополнительные параметры, необходимые конечной точке маркера этого сервера авторизации, представленного в виде массива объектов JSON со свойствами строки имени и значения, т. е. {"name" : "name value", "value": "a value"}. TokenBodyParameterContract[]
tokenEndpoint Конечная точка маркера OAuth. Содержит абсолютный универсальный код ресурса (URI) для объекта, на который ссылается ссылка. струна
useInApiDocumentation Если значение true, сервер авторизации будет использоваться в документации по API на портале разработчика. Значение false по умолчанию, если значение не указано. bool
useInTestConsole Если задано значение true, сервер авторизации может использоваться в тестовой консоли портала разработчика. Значение true по умолчанию, если значение не указано. bool

TokenBodyParameterContract

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