Freigeben über

Microsoft.ApiManagement service/identityProviders 2023-05-01-preview

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp "service/identityProviders" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/identityProviders-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Bicep hinzu.

resource symbolicname 'Microsoft.ApiManagement/service/identityProviders@2023-05-01-preview' = {
  parent: resourceSymbolicName
  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'
  }
}

Eigenschaftswerte

IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Name Beschreibung Wert
allowedTenants Liste der zulässigen Mandanten beim Konfigurieren der Azure Active Directory-Anmeldung. string[]
Autorität OpenID Connect-Endpunkt-Hostname für AAD oder AAD B2C. Schnur
clientId Client-ID der Anwendung im externen Identitätsanbieter. Es ist App-ID für Facebook-Anmeldung, Client-ID für Google-Anmeldung, App-ID für Microsoft. Schnur

Zwänge:
Min. Länge = 1 (erforderlich)
clientLibrary Die Clientbibliothek, die im Entwicklerportal verwendet werden soll. Gilt nur für AAD und AAD B2C Identity Provider. Schnur

Zwänge:
Max. Länge =
clientSecret Der geheime Clientschlüssel der Anwendung im externen Identitätsanbieter, der zum Authentifizieren der Anmeldeanforderung verwendet wird. Beispielsweise ist es App Secret für Facebook-Anmeldung, API-Schlüssel für Google-Anmeldung, Öffentlicher Schlüssel für Microsoft. Diese Eigenschaft wird für 'GET'-Vorgänge nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
passwordResetPolicyName Name der Kennwortzurücksetzungsrichtlinie. Gilt nur für AAD B2C Identity Provider. Schnur

Zwänge:
Min. Länge = 1
profileEditingPolicyName Name der Profilbearbeitungsrichtlinie. Gilt nur für AAD B2C Identity Provider. Schnur

Zwänge:
Min. Länge = 1
signinPolicyName Anmelderichtlinienname. Gilt nur für AAD B2C Identity Provider. Schnur

Zwänge:
Min. Länge = 1
signinTenant Die TenantId, die bei der Anmeldung bei Active Directory anstelle von "Common" verwendet werden soll Schnur
signupPolicyName Name der Registrierungsrichtlinie. Gilt nur für AAD B2C Identity Provider. Schnur

Zwänge:
Min. Länge = 1
Art Id des Identitätsanbietertyps. "aad"
"aadB2C"
"facebook"
"google"
"microsoft"
"twitter"

Microsoft.ApiManagement/service/identityProviders

Name Beschreibung Wert
Name Der Ressourcenname "aad"
"aadB2C"
"facebook"
"google"
"microsoft"
"twitter" (erforderlich)
Elternteil In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.		 Symbolischer Name für Ressource des Typs: Dienst-
Eigenschaften Vertragseigenschaften des Identitätsanbieters. IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "service/identityProviders" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/identityProviders-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.ApiManagement/service/identityProviders",
  "apiVersion": "2023-05-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"
  }
}

Eigenschaftswerte

IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Name Beschreibung Wert
allowedTenants Liste der zulässigen Mandanten beim Konfigurieren der Azure Active Directory-Anmeldung. string[]
Autorität OpenID Connect-Endpunkt-Hostname für AAD oder AAD B2C. Schnur
clientId Client-ID der Anwendung im externen Identitätsanbieter. Es ist App-ID für Facebook-Anmeldung, Client-ID für Google-Anmeldung, App-ID für Microsoft. Schnur

Zwänge:
Min. Länge = 1 (erforderlich)
clientLibrary Die Clientbibliothek, die im Entwicklerportal verwendet werden soll. Gilt nur für AAD und AAD B2C Identity Provider. Schnur

Zwänge:
Max. Länge =
clientSecret Der geheime Clientschlüssel der Anwendung im externen Identitätsanbieter, der zum Authentifizieren der Anmeldeanforderung verwendet wird. Beispielsweise ist es App Secret für Facebook-Anmeldung, API-Schlüssel für Google-Anmeldung, Öffentlicher Schlüssel für Microsoft. Diese Eigenschaft wird für 'GET'-Vorgänge nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
passwordResetPolicyName Name der Kennwortzurücksetzungsrichtlinie. Gilt nur für AAD B2C Identity Provider. Schnur

Zwänge:
Min. Länge = 1
profileEditingPolicyName Name der Profilbearbeitungsrichtlinie. Gilt nur für AAD B2C Identity Provider. Schnur

Zwänge:
Min. Länge = 1
signinPolicyName Anmelderichtlinienname. Gilt nur für AAD B2C Identity Provider. Schnur

Zwänge:
Min. Länge = 1
signinTenant Die TenantId, die bei der Anmeldung bei Active Directory anstelle von "Common" verwendet werden soll Schnur
signupPolicyName Name der Registrierungsrichtlinie. Gilt nur für AAD B2C Identity Provider. Schnur

Zwänge:
Min. Länge = 1
Art Id des Identitätsanbietertyps. "aad"
"aadB2C"
"facebook"
"google"
"microsoft"
"twitter"

Microsoft.ApiManagement/service/identityProviders

Name Beschreibung Wert
apiVersion Die API-Version "2023-05-01-preview"
Name Der Ressourcenname "aad"
"aadB2C"
"facebook"
"google"
"microsoft"
"twitter" (erforderlich)
Eigenschaften Vertragseigenschaften des Identitätsanbieters. IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties
Art Der Ressourcentyp 'Microsoft.ApiManagement/service/identityProviders'

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "service/identityProviders" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/identityProviders-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/identityProviders@2023-05-01-preview"
  name = "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"
    }
  })
}

Eigenschaftswerte

IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Name Beschreibung Wert
allowedTenants Liste der zulässigen Mandanten beim Konfigurieren der Azure Active Directory-Anmeldung. string[]
Autorität OpenID Connect-Endpunkt-Hostname für AAD oder AAD B2C. Schnur
clientId Client-ID der Anwendung im externen Identitätsanbieter. Es ist App-ID für Facebook-Anmeldung, Client-ID für Google-Anmeldung, App-ID für Microsoft. Schnur

Zwänge:
Min. Länge = 1 (erforderlich)
clientLibrary Die Clientbibliothek, die im Entwicklerportal verwendet werden soll. Gilt nur für AAD und AAD B2C Identity Provider. Schnur

Zwänge:
Max. Länge =
clientSecret Der geheime Clientschlüssel der Anwendung im externen Identitätsanbieter, der zum Authentifizieren der Anmeldeanforderung verwendet wird. Beispielsweise ist es App Secret für Facebook-Anmeldung, API-Schlüssel für Google-Anmeldung, Öffentlicher Schlüssel für Microsoft. Diese Eigenschaft wird für 'GET'-Vorgänge nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
passwordResetPolicyName Name der Kennwortzurücksetzungsrichtlinie. Gilt nur für AAD B2C Identity Provider. Schnur

Zwänge:
Min. Länge = 1
profileEditingPolicyName Name der Profilbearbeitungsrichtlinie. Gilt nur für AAD B2C Identity Provider. Schnur

Zwänge:
Min. Länge = 1
signinPolicyName Anmelderichtlinienname. Gilt nur für AAD B2C Identity Provider. Schnur

Zwänge:
Min. Länge = 1
signinTenant Die TenantId, die bei der Anmeldung bei Active Directory anstelle von "Common" verwendet werden soll Schnur
signupPolicyName Name der Registrierungsrichtlinie. Gilt nur für AAD B2C Identity Provider. Schnur

Zwänge:
Min. Länge = 1
Art Id des Identitätsanbietertyps. "aad"
"aadB2C"
"facebook"
"google"
"microsoft"
"twitter"

Microsoft.ApiManagement/service/identityProviders

Name Beschreibung Wert
Name Der Ressourcenname "aad"
"aadB2C"
"facebook"
"google"
"microsoft"
"twitter" (erforderlich)
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource des Typs: Dienst-
Eigenschaften Vertragseigenschaften des Identitätsanbieters. IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties
Art Der Ressourcentyp "Microsoft.ApiManagement/service/identityProviders@2023-05-01-preview"