Служба Microsoft.ApiManagement/identityProviders 2023-09-01-preview

Статья
07/24/2024

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

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

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

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

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

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

resource symbolicname 'Microsoft.ApiManagement/service/identityProviders@2023-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

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

IdentityProviderCreateContractPropertiesOrIdentityPr...

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

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

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

Шаблон	Описание
Создание экземпляра службы управления API и всех вложенных ресурсов с помощью шаблона развертывание	В этом шаблоне показано, как создать службу управления API и настроить вложенные сущности

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

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

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

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

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

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

{
  "type": "Microsoft.ApiManagement/service/identityProviders",
  "apiVersion": "2023-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"
apiVersion	Версия API ресурсов	'2023-09-01-preview'
имя	Имя ресурса Узнайте, как задать имена и типы дочерних ресурсов в шаблонах ARM JSON.	строка (обязательно) Ограничение символов: 1–80 Допустимые символы: Буквенно-цифровые и дефисы. Начните с буквы и заканчивается буквенно-цифровым.
свойства	Свойства контракта поставщика удостоверений.	IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

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

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

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

Шаблон	Описание
Создание экземпляра службы управления API и всех вложенных ресурсов с помощью шаблона развертывание	В этом шаблоне показано, как создать службу управления API и настроить вложенные сущности

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/identityProviders@2023-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@2023-09-01-preview"
имя	Имя ресурса	строка (обязательно) Ограничение символов: 1–80 Допустимые символы: Буквенно-цифровые и дефисы. Начните с буквы и заканчивается буквенно-цифровым.
parent_id	Идентификатор ресурса, который является родительским для этого ресурса.	Идентификатор ресурса типа: службы
свойства	Свойства контракта поставщика удостоверений.	IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

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

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

Служба Microsoft.ApiManagement/identityProviders 2023-09-01-preview

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

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

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

service/identityProviders

IdentityProviderCreateContractPropertiesOrIdentityPr...

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

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

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

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

service/identityProviders

IdentityProviderCreateContractPropertiesOrIdentityPr...

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

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

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

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

service/identityProviders

IdentityProviderCreateContractPropertiesOrIdentityPr...

Обратная связь

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