Microsoft.ApiManagement service/identityProviders 2023-03-01-preview
Bicep-Ressourcendefinition
Der Ressourcentyp service/identityProviders kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle
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 Bicep hinzu.
resource symbolicname 'Microsoft.ApiManagement/service/identityProviders@2023-03-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'
}
}
Eigenschaftswerte
service/identityProviders
Name | BESCHREIBUNG | Wert |
---|---|---|
name | Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep festlegen. |
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 | Eigenschaften des Identitätsanbietervertrags. | IdentityProviderCreateContractPropertiesOrIdentityPr... |
IdentityProviderCreateContractPropertiesOrIdentityPr...
Name | BESCHREIBUNG | Wert |
---|---|---|
allowedTenants | Liste der zulässigen Mandanten beim Konfigurieren der Azure Active Directory-Anmeldung. | string[] |
authority | Hostname des OpenID Connect-Ermittlungsendpunkts für AAD oder AAD B2C. | Zeichenfolge |
clientId | Client-ID der Anwendung im externen Identitätsanbieter. Dabei handelt es sich um die App-ID für Facebook Anmeldung, die Client-ID für die Google-Anmeldung, die App-ID für Microsoft. | Zeichenfolge (erforderlich) |
clientLibrary | Die Clientbibliothek, die im Entwicklerportal verwendet werden soll. Gilt nur für AAD und AAD B2C Identity Provider. | 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 die 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 Kennwortzurücksetzungsrichtlinie. Gilt nur für den AAD B2C-Identitätsanbieter. | Zeichenfolge |
profileBearbeitenPolicyName | Name der Richtlinie für die Profilbearbeitung. Gilt nur für den AAD B2C-Identitätsanbieter. | Zeichenfolge |
signinPolicyName | Anmelderichtlinienname. Gilt nur für den AAD B2C-Identitätsanbieter. | Zeichenfolge |
signinTenant | Die Mandanten-ID, die bei der Anmeldung bei Active Directory anstelle von "Common" verwendet werden soll | Zeichenfolge |
signupPolicyName | Name der Anmelderichtlinie. Gilt nur für den AAD B2C-Identitätsanbieter. | Zeichenfolge |
type | Identitätsanbietertypbezeichner. | 'aad' 'aadB2C' "Facebook" "google" "microsoft" "twittern" |
Schnellstartvorlagen
Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.
Vorlage | BESCHREIBUNG |
---|---|
Erstellen einer API Management-Instanz und aller Unterressourcen mithilfe einer Vorlage |
Diese Vorlage veranschaulicht, wie Sie einen API Management Dienst erstellen und Unterentitäten konfigurieren. |
Ressourcendefinition mit einer ARM-Vorlage
Der Ressourcentyp service/identityProviders kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle
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-03-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
service/identityProviders
Name | BESCHREIBUNG | Wert |
---|---|---|
type | Ressourcentyp | "Microsoft.ApiManagement/service/identityProviders" |
apiVersion | Die Ressourcen-API-Version | '2023-03-01-preview' |
name | Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen. |
Zeichenfolge (erforderlich) Zeichenlimit: 1-80 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden. |
properties | Eigenschaften des Identitätsanbietervertrags. | IdentityProviderCreateContractPropertiesOrIdentityPr... |
IdentityProviderCreateContractPropertiesOrIdentityPr...
Name | BESCHREIBUNG | Wert |
---|---|---|
allowedTenants | Liste der zulässigen Mandanten beim Konfigurieren der Azure Active Directory-Anmeldung. | string[] |
authority | Hostname des OpenID Connect-Ermittlungsendpunkts für AAD oder AAD B2C. | Zeichenfolge |
clientId | Client-ID der Anwendung im externen Identitätsanbieter. Dabei handelt es sich um die App-ID für Facebook Anmeldung, die Client-ID für die Google-Anmeldung, die App-ID für Microsoft. | Zeichenfolge (erforderlich) |
clientLibrary | Die Clientbibliothek, die im Entwicklerportal verwendet werden soll. Gilt nur für AAD und AAD B2C Identity Provider. | 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 die 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 Kennwortzurücksetzungsrichtlinie. Gilt nur für den AAD B2C-Identitätsanbieter. | Zeichenfolge |
profileBearbeitenPolicyName | Name der Richtlinie für die Profilbearbeitung. Gilt nur für den AAD B2C-Identitätsanbieter. | Zeichenfolge |
signinPolicyName | Anmelderichtlinienname. Gilt nur für den AAD B2C-Identitätsanbieter. | Zeichenfolge |
signinTenant | Die Mandanten-ID, die bei der Anmeldung bei Active Directory anstelle von "Common" verwendet werden soll | Zeichenfolge |
signupPolicyName | Name der Anmelderichtlinie. Gilt nur für den AAD B2C-Identitätsanbieter. | Zeichenfolge |
type | Identitätsanbietertypbezeichner. | 'aad' 'aadB2C' "Facebook" "google" "microsoft" "twittern" |
Schnellstartvorlagen
Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.
Vorlage | BESCHREIBUNG |
---|---|
Erstellen einer API Management-Instanz und aller Unterressourcen mithilfe einer Vorlage |
Diese Vorlage veranschaulicht, wie Sie einen API Management Dienst erstellen und Unterentitäten konfigurieren. |
Terraform (AzAPI-Anbieter) Ressourcendefinition
Der Ressourcentyp service/identityProviders kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- 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 der Vorlage die folgende Terraform-Ressource hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/identityProviders@2023-03-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"
}
})
}
Eigenschaftswerte
service/identityProviders
Name | BESCHREIBUNG | Wert |
---|---|---|
type | Ressourcentyp | "Microsoft.ApiManagement/service/identityProviders@2023-03-01-preview" |
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" |