Freigeben über

Microsoft.ApiManagement service/identityProviders 2022-08-01

  • 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 im Änderungsprotokoll.

Ressourcenformat

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

resource symbolicname 'Microsoft.ApiManagement/service/identityProviders@2022-08-01' = {
  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'
  }
}

Eigenschaftswerte

service/identityProviders

Name BESCHREIBUNG Wert
name Der Ressourcenname

Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in Bicep.		 Zeichenfolge (erforderlich)

Zeichenlimit: 1-80

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.

Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden.
parent 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 vom Typ: Dienst
properties Vertragseigenschaften des Identitätsanbieters. IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Name BESCHREIBUNG Wert
allowedTenants Liste der zulässigen Mandanten beim Konfigurieren der Azure Active Directory-Anmeldung. string[]
authority OpenID Connect-Endpunkthostname für AAD oder AAD B2C. Zeichenfolge
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. Zeichenfolge (erforderlich)
clientLibrary Die Clientbibliothek, die im Entwicklerportal verwendet werden soll. Gilt nur für den AAD- und AAD B2C-Identitätsanbieter. Zeichenfolge
clientSecret Geheimer 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 bei GET-Vorgängen nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen. Zeichenfolge (erforderlich)
passwordResetPolicyName Name der Richtlinie für die Kennwortzurücksetzung. Gilt nur für den AAD B2C-Identitätsanbieter. Zeichenfolge
profileEditingPolicyName Name der Profilbearbeitungsrichtlinie. Gilt nur für den AAD B2C-Identitätsanbieter. Zeichenfolge
signinPolicyName Anmelderichtlinienname. Gilt nur für den AAD B2C-Identitätsanbieter. Zeichenfolge
signinTenant Die TenantId, die bei der Anmeldung bei Active Directory anstelle von "Common" verwendet werden soll Zeichenfolge
signupPolicyName Name der Registrierungsrichtlinie. Gilt nur für den AAD B2C-Identitätsanbieter. Zeichenfolge
type Bezeichner des Identitätsanbietertyps. "aad"
'aadB2C'
"facebook"
"google"
"Microsoft"
"twittern"

Schnellstartvorlagen

In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.

Vorlage BESCHREIBUNG
Erstellen einer API Management-Instanz und aller Unterressourcen mithilfe einer Vorlage

Bereitstellen in Azure		 Diese Vorlage veranschaulicht, wie Sie einen API Management-Dienst erstellen und Untergeordnetetitäten konfigurieren.

Ressourcendefinition mit einer ARM-Vorlage

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 im Ä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": "2022-08-01",
  "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

service/identityProviders

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.ApiManagement/service/identityProviders"
apiVersion Die Version der Ressourcen-API '2022-08-01'
name Der Ressourcenname

Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen.		 Zeichenfolge (erforderlich)

Zeichenlimit: 1-80

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.

Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden.
properties Vertragseigenschaften des Identitätsanbieters. IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Name BESCHREIBUNG Wert
allowedTenants Liste der zulässigen Mandanten beim Konfigurieren der Azure Active Directory-Anmeldung. string[]
authority OpenID Connect-Endpunkthostname für AAD oder AAD B2C. Zeichenfolge
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. Zeichenfolge (erforderlich)
clientLibrary Die Clientbibliothek, die im Entwicklerportal verwendet werden soll. Gilt nur für den AAD- und AAD B2C-Identitätsanbieter. Zeichenfolge
clientSecret Geheimer 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 bei GET-Vorgängen nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen. Zeichenfolge (erforderlich)
passwordResetPolicyName Name der Richtlinie für die Kennwortzurücksetzung. Gilt nur für den AAD B2C-Identitätsanbieter. Zeichenfolge
profileEditingPolicyName Name der Profilbearbeitungsrichtlinie. Gilt nur für den AAD B2C-Identitätsanbieter. Zeichenfolge
signinPolicyName Anmelderichtlinienname. Gilt nur für den AAD B2C-Identitätsanbieter. Zeichenfolge
signinTenant Die TenantId, die bei der Anmeldung bei Active Directory anstelle von "Common" verwendet werden soll Zeichenfolge
signupPolicyName Name der Registrierungsrichtlinie. Gilt nur für den AAD B2C-Identitätsanbieter. Zeichenfolge
type Bezeichner des Identitätsanbietertyps. "aad"
'aadB2C'
"facebook"
"google"
"Microsoft"
"twittern"

Schnellstartvorlagen

In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.

Vorlage BESCHREIBUNG
Erstellen einer API Management-Instanz und aller Unterressourcen mithilfe einer Vorlage

Bereitstellen in Azure		 Diese Vorlage veranschaulicht, wie Sie einen API Management-Dienst erstellen und Untergeordnetetitäten konfigurieren.

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 im Änderungsprotokoll.

Ressourcenformat

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

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

Eigenschaftswerte

service/identityProviders

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.ApiManagement/service/identityProviders@2022-08-01"
name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 1-80

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.

Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden.
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource vom Typ: Dienst
properties Vertragseigenschaften des Identitätsanbieters. IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Name BESCHREIBUNG Wert
allowedTenants Liste der zulässigen Mandanten beim Konfigurieren der Azure Active Directory-Anmeldung. string[]
authority OpenID Connect-Endpunkthostname für AAD oder AAD B2C. Zeichenfolge
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. Zeichenfolge (erforderlich)
clientLibrary Die Clientbibliothek, die im Entwicklerportal verwendet werden soll. Gilt nur für den AAD- und AAD B2C-Identitätsanbieter. Zeichenfolge
clientSecret Geheimer 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 bei GET-Vorgängen nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen. Zeichenfolge (erforderlich)
passwordResetPolicyName Name der Richtlinie für die Kennwortzurücksetzung. Gilt nur für den AAD B2C-Identitätsanbieter. Zeichenfolge
profileEditingPolicyName Name der Profilbearbeitungsrichtlinie. Gilt nur für den AAD B2C-Identitätsanbieter. Zeichenfolge
signinPolicyName Anmelderichtlinienname. Gilt nur für den AAD B2C-Identitätsanbieter. Zeichenfolge
signinTenant Die TenantId, die bei der Anmeldung bei Active Directory anstelle von "Common" verwendet werden soll Zeichenfolge
signupPolicyName Name der Registrierungsrichtlinie. Gilt nur für den AAD B2C-Identitätsanbieter. Zeichenfolge
type Bezeichner des Identitätsanbietertyps. "aad"
"aadB2C"
"facebook"
"google"
"Microsoft"
"twitter"