Share via

Microsoft.ApiManagement service/identityProviders 2022-09-01-preview

  • Статья

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

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

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

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

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

resource symbolicname 'Microsoft.ApiManagement/service/identityProviders@2022-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    allowedTenants: [
      'string'
    ]
    authority: 'string'
    clientId: 'string'
    clientLibrary: 'string'
    clientSecret: 'string'
    passwordResetPolicyName: 'string'
    profileEditingPolicyName: 'string'
    signinPolicyName: 'string'
    signinTenant: 'string'
    signupPolicyName: 'string'
    type: 'string'
  }
}

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

service/identityProviders

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

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

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

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

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

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

IdentityProviderCreateContractPropertiesOrIdentityPr...

Имя Описание Значение
allowedTenants Список разрешенных клиентов при настройке входа в Azure Active Directory. string[]
authority Имя узла конечной точки обнаружения OpenID Connect для AAD или AAD B2C. строка
clientid Идентификатор клиента приложения во внешнем поставщике удостоверений. Это идентификатор приложения для входа Facebook, идентификатор клиента для входа в Google, идентификатор приложения для Майкрософт. string (обязательно)
clientLibrary Клиентская библиотека, используемая на портале разработчика. Применяется только к AAD и поставщику удостоверений AAD B2C. строка
clientSecret Секрет клиента приложения во внешнем поставщике удостоверений, используемый для проверки подлинности запроса на вход. Например, это секрет приложения для входа Facebook, ключ API для входа в Google, открытый ключ для Майкрософт. Это свойство не будет заполнено при операциях GET! Используйте запрос POST /listSecrets, чтобы получить значение. string (обязательно)
passwordResetPolicyName Имя политики сброса пароля. Применяется только к поставщику удостоверений AAD B2C. строка
profileEditingPolicyName Имя политики редактирования профиля. Применяется только к поставщику удостоверений AAD B2C. строка
signinPolicyName Имя политики входа. Применяется только к поставщику удостоверений AAD B2C. строка
signinTenant Идентификатор клиента, используемый вместо common при входе в Active Directory строка
signupPolicyName Имя политики регистрации. Применяется только к поставщику удостоверений AAD B2C. строка
type Идентификатор типа поставщика удостоверений. 'aad'
'aadB2C'
'facebook'
"Google"
"microsoft"
'twitter'

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
Create an API Management instance and all sub resources using template (Создание экземпляра службы "Управление API" и всех сопутствующих ресурсов с помощью шаблона)

Развертывание в Azure		 В этом шаблоне показано, как создать службу Управление API и настроить вложенные сущности.

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

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

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

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

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

{
  "type": "Microsoft.ApiManagement/service/identityProviders",
  "apiVersion": "2022-09-01-preview",
  "name": "string",
  "properties": {
    "allowedTenants": [ "string" ],
    "authority": "string",
    "clientId": "string",
    "clientLibrary": "string",
    "clientSecret": "string",
    "passwordResetPolicyName": "string",
    "profileEditingPolicyName": "string",
    "signinPolicyName": "string",
    "signinTenant": "string",
    "signupPolicyName": "string",
    "type": "string"
  }
}

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

service/identityProviders

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

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

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

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

Начинается с буквы и заканчивается буквенно-цифровым символом.
properties Свойства контракта поставщика удостоверений. IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Имя Описание Значение
allowedTenants Список разрешенных клиентов при настройке входа в Azure Active Directory. string[]
authority Имя узла конечной точки обнаружения OpenID Connect для AAD или AAD B2C. строка
clientid Идентификатор клиента приложения во внешнем поставщике удостоверений. Это идентификатор приложения для входа Facebook, идентификатор клиента для входа в Google, идентификатор приложения для Майкрософт. string (обязательно)
clientLibrary Клиентская библиотека, используемая на портале разработчика. Применяется только к AAD и поставщику удостоверений AAD B2C. строка
clientSecret Секрет клиента приложения во внешнем поставщике удостоверений, используемый для проверки подлинности запроса на вход. Например, это секрет приложения для входа Facebook, ключ API для входа в Google, открытый ключ для Майкрософт. Это свойство не будет заполнено при операциях GET! Используйте запрос POST /listSecrets, чтобы получить значение. string (обязательно)
passwordResetPolicyName Имя политики сброса пароля. Применяется только к поставщику удостоверений AAD B2C. строка
profileEditingPolicyName Имя политики редактирования профиля. Применяется только к поставщику удостоверений AAD B2C. строка
signinPolicyName Имя политики входа. Применяется только к поставщику удостоверений AAD B2C. строка
signinTenant Идентификатор клиента, используемый вместо common при входе в Active Directory строка
signupPolicyName Имя политики регистрации. Применяется только к поставщику удостоверений AAD B2C. строка
type Идентификатор типа поставщика удостоверений. 'aad'
'aadB2C'
'facebook'
"Google"
"microsoft"
'twitter'

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
Create an API Management instance and all sub resources using template (Создание экземпляра службы "Управление API" и всех сопутствующих ресурсов с помощью шаблона)

Развертывание в Azure		 В этом шаблоне показано, как создать службу Управление API и настроить вложенные сущности.

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/identityProviders@2022-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      allowedTenants = [
        "string"
      ]
      authority = "string"
      clientId = "string"
      clientLibrary = "string"
      clientSecret = "string"
      passwordResetPolicyName = "string"
      profileEditingPolicyName = "string"
      signinPolicyName = "string"
      signinTenant = "string"
      signupPolicyName = "string"
      type = "string"
    }
  })
}

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

service/identityProviders

Имя Описание Значение
тип Тип ресурса "Microsoft.ApiManagement/service/identityProviders@2022-09-01-preview"
name имя ресурса. строка (обязательно)

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

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

Начинается с буквы и заканчивается буквенно-цифровым символом.
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: service
properties Свойства контракта поставщика удостоверений. IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Имя Описание Значение
allowedTenants Список разрешенных клиентов при настройке входа в Azure Active Directory. string[]
authority Имя узла конечной точки обнаружения OpenID Connect для AAD или AAD B2C. строка
clientid Идентификатор клиента приложения во внешнем поставщике удостоверений. Это идентификатор приложения для входа Facebook, идентификатор клиента для входа Google, идентификатор приложения для Майкрософт. строка (обязательно)
clientLibrary Клиентская библиотека, используемая на портале разработчика. Применяется только к поставщику удостоверений AAD и AAD B2C. строка
clientSecret Секрет клиента приложения во внешнем поставщике удостоверений, используемый для проверки подлинности запроса на вход. Например, это секрет приложения для входа Facebook, ключ API для входа Google, открытый ключ для Майкрософт. Это свойство не будет заполнено при операциях GET! Используйте запрос POST /listSecrets, чтобы получить значение. строка (обязательно)
passwordResetPolicyName Имя политики сброса пароля. Применяется только к поставщику удостоверений AAD B2C. строка
profileEditingPolicyName Имя политики изменения профиля. Применяется только к поставщику удостоверений AAD B2C. строка
signinPolicyName Имя политики входа. Применяется только к поставщику удостоверений AAD B2C. строка
signinTenant Идентификатор клиента, используемый вместо Common при входе в Active Directory строка
signupPolicyName Имя политики регистрации. Применяется только к поставщику удостоверений AAD B2C. строка
type Идентификатор типа поставщика удостоверений. aad.
"aadB2C"
facebook;
google;
"microsoft"
twitter;