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


Служба Microsoft.ApiManagement/identityProviders 2024-06-01-preview

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

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

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

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

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

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

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

IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Имя Описание Ценность
разрешенныеtenants Список разрешенных клиентов при настройке имени входа Azure Active Directory. string[]
авторитет Имя узла конечной точки обнаружения OpenID Connect для AAD или AAD B2C. струна
certificateId Полный идентификатор ресурса сертификата, используемый во внешнем поставщике удостоверений струна
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/service/identityProviders

Имя Описание Ценность
имя Имя ресурса 'aad'
'aadB2C'
"facebook"
"Google"
Microsoft
"twitter" (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса.

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

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

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

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

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

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

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

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

IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Имя Описание Ценность
разрешенныеtenants Список разрешенных клиентов при настройке имени входа Azure Active Directory. string[]
авторитет Имя узла конечной точки обнаружения OpenID Connect для AAD или AAD B2C. струна
certificateId Полный идентификатор ресурса сертификата, используемый во внешнем поставщике удостоверений струна
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/service/identityProviders

Имя Описание Ценность
apiVersion Версия API '2024-06-01-preview'
имя Имя ресурса 'aad'
'aadB2C'
"facebook"
"Google"
Microsoft
"twitter" (обязательно)
свойства Свойства контракта поставщика удостоверений. IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties
тип Тип ресурса "Microsoft.ApiManagement/service/identityProviders"

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

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

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

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

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

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

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

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

IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Имя Описание Ценность
разрешенныеtenants Список разрешенных клиентов при настройке имени входа Azure Active Directory. string[]
авторитет Имя узла конечной точки обнаружения OpenID Connect для AAD или AAD B2C. струна
certificateId Полный идентификатор ресурса сертификата, используемый во внешнем поставщике удостоверений струна
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/service/identityProviders

Имя Описание Ценность
имя Имя ресурса 'aad'
'aadB2C'
"facebook"
"Google"
Microsoft
"twitter" (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: службы
свойства Свойства контракта поставщика удостоверений. IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties
тип Тип ресурса "Microsoft.ApiManagement/service/identityProviders@2024-06-01-preview"