Microsoft.ApiManagement service/identityProviders 2019-12-01-preview
- senaste
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Bicep-resursdefinition
Resurstypen service/identityProviders kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/identityProviders-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.ApiManagement/service/identityProviders@2019-12-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
allowedTenants: [
'string'
]
authority: 'string'
clientId: 'string'
clientSecret: 'string'
passwordResetPolicyName: 'string'
profileEditingPolicyName: 'string'
signinPolicyName: 'string'
signinTenant: 'string'
signupPolicyName: 'string'
type: 'string'
}
}
Egenskapsvärden
IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| allowedTenants | Lista över tillåtna klienter när du konfigurerar Azure Active Directory-inloggning. | string[] |
| auktoritet | OpenID Connect-värdnamnet för identifieringsslutpunkten för AAD eller AAD B2C. | sträng |
| clientId | Klient-ID för programmet i den externa identitetsprovidern. Det är app-ID för Facebook-inloggning, klient-ID för Google-inloggning, app-ID för Microsoft. | sträng Begränsningar: Minsta längd = 1 (krävs) |
| clientSecret | Klienthemlighet för programmet i den externa identitetsprovidern som används för att autentisera inloggningsbegäran. Det är till exempel apphemlighet för Facebook-inloggning, API-nyckel för Google-inloggning, offentlig nyckel för Microsoft. Den här egenskapen fylls inte i för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet. | sträng Begränsningar: Min längd = 1 Känsligt värde. Skicka in som en säker parameter. (krävs) |
| passwordResetPolicyName | Namn på lösenordsåterställningsprincip. Gäller endast för AAD B2C-identitetsprovider. | sträng Begränsningar: Min längd = 1 |
| profileEditingPolicyName | Namn på profilredigeringsprincip. Gäller endast för AAD B2C-identitetsprovider. | sträng Begränsningar: Min längd = 1 |
| signinPolicyName | Namn på inloggningsprincip. Gäller endast för AAD B2C-identitetsprovider. | sträng Begränsningar: Min längd = 1 |
| signinTenant | TenantId som ska användas i stället för Common när du loggar in på Active Directory | sträng |
| signupPolicyName | Namn på registreringsprincip. Gäller endast för AAD B2C-identitetsprovider. | sträng Begränsningar: Min längd = 1 |
| typ | Identitetsproviderns typidentifierare. | "aad" "aadB2C" "facebook" "google" "microsoft" "twitter" |
Microsoft.ApiManagement/service/identityProviders
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Resursnamnet | "aad" "aadB2C" "facebook" "google" "microsoft" "twitter" (krävs) |
| förälder | I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen. Mer information finns i Underordnad resurs utanför den överordnade resursen. |
Symboliskt namn för resurs av typen: tjänst |
| Egenskaper | Egenskaper för identitetsproviderkontrakt. | IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties |
Resursdefinition för ARM-mall
Resurstypen service/identityProviders kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/identityProviders-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.ApiManagement/service/identityProviders",
"apiVersion": "2019-12-01-preview",
"name": "string",
"properties": {
"allowedTenants": [ "string" ],
"authority": "string",
"clientId": "string",
"clientSecret": "string",
"passwordResetPolicyName": "string",
"profileEditingPolicyName": "string",
"signinPolicyName": "string",
"signinTenant": "string",
"signupPolicyName": "string",
"type": "string"
}
}
Egenskapsvärden
IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| allowedTenants | Lista över tillåtna klienter när du konfigurerar Azure Active Directory-inloggning. | string[] |
| auktoritet | OpenID Connect-värdnamnet för identifieringsslutpunkten för AAD eller AAD B2C. | sträng |
| clientId | Klient-ID för programmet i den externa identitetsprovidern. Det är app-ID för Facebook-inloggning, klient-ID för Google-inloggning, app-ID för Microsoft. | sträng Begränsningar: Minsta längd = 1 (krävs) |
| clientSecret | Klienthemlighet för programmet i den externa identitetsprovidern som används för att autentisera inloggningsbegäran. Det är till exempel apphemlighet för Facebook-inloggning, API-nyckel för Google-inloggning, offentlig nyckel för Microsoft. Den här egenskapen fylls inte i för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet. | sträng Begränsningar: Min längd = 1 Känsligt värde. Skicka in som en säker parameter. (krävs) |
| passwordResetPolicyName | Namn på lösenordsåterställningsprincip. Gäller endast för AAD B2C-identitetsprovider. | sträng Begränsningar: Min längd = 1 |
| profileEditingPolicyName | Namn på profilredigeringsprincip. Gäller endast för AAD B2C-identitetsprovider. | sträng Begränsningar: Min längd = 1 |
| signinPolicyName | Namn på inloggningsprincip. Gäller endast för AAD B2C-identitetsprovider. | sträng Begränsningar: Min längd = 1 |
| signinTenant | TenantId som ska användas i stället för Common när du loggar in på Active Directory | sträng |
| signupPolicyName | Namn på registreringsprincip. Gäller endast för AAD B2C-identitetsprovider. | sträng Begränsningar: Min längd = 1 |
| typ | Identitetsproviderns typidentifierare. | "aad" "aadB2C" "facebook" "google" "microsoft" "twitter" |
Microsoft.ApiManagement/service/identityProviders
| Namn | Beskrivning | Värde |
|---|---|---|
| apiVersion | API-versionen | "2019-12-01-preview" |
| Namn | Resursnamnet | "aad" "aadB2C" "facebook" "google" "microsoft" "twitter" (krävs) |
| Egenskaper | Egenskaper för identitetsproviderkontrakt. | IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties |
| typ | Resurstypen | "Microsoft.ApiManagement/service/identityProviders" |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen service/identityProviders kan distribueras med åtgärder som mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/identityProviders-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/identityProviders@2019-12-01-preview"
name = "string"
body = jsonencode({
properties = {
allowedTenants = [
"string"
]
authority = "string"
clientId = "string"
clientSecret = "string"
passwordResetPolicyName = "string"
profileEditingPolicyName = "string"
signinPolicyName = "string"
signinTenant = "string"
signupPolicyName = "string"
type = "string"
}
})
}
Egenskapsvärden
IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| allowedTenants | Lista över tillåtna klienter när du konfigurerar Azure Active Directory-inloggning. | string[] |
| auktoritet | OpenID Connect-värdnamnet för identifieringsslutpunkten för AAD eller AAD B2C. | sträng |
| clientId | Klient-ID för programmet i den externa identitetsprovidern. Det är app-ID för Facebook-inloggning, klient-ID för Google-inloggning, app-ID för Microsoft. | sträng Begränsningar: Minsta längd = 1 (krävs) |
| clientSecret | Klienthemlighet för programmet i den externa identitetsprovidern som används för att autentisera inloggningsbegäran. Det är till exempel apphemlighet för Facebook-inloggning, API-nyckel för Google-inloggning, offentlig nyckel för Microsoft. Den här egenskapen fylls inte i för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet. | sträng Begränsningar: Min längd = 1 Känsligt värde. Skicka in som en säker parameter. (krävs) |
| passwordResetPolicyName | Namn på lösenordsåterställningsprincip. Gäller endast för AAD B2C-identitetsprovider. | sträng Begränsningar: Min längd = 1 |
| profileEditingPolicyName | Namn på profilredigeringsprincip. Gäller endast för AAD B2C-identitetsprovider. | sträng Begränsningar: Min längd = 1 |
| signinPolicyName | Namn på inloggningsprincip. Gäller endast för AAD B2C-identitetsprovider. | sträng Begränsningar: Min längd = 1 |
| signinTenant | TenantId som ska användas i stället för Common när du loggar in på Active Directory | sträng |
| signupPolicyName | Namn på registreringsprincip. Gäller endast för AAD B2C-identitetsprovider. | sträng Begränsningar: Min längd = 1 |
| typ | Identitetsproviderns typidentifierare. | "aad" "aadB2C" "facebook" "google" "microsoft" "twitter" |
Microsoft.ApiManagement/service/identityProviders
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Resursnamnet | "aad" "aadB2C" "facebook" "google" "microsoft" "twitter" (krävs) |
| parent_id | ID för resursen som är överordnad för den här resursen. | ID för resurs av typen: tjänst |
| Egenskaper | Egenskaper för identitetsproviderkontrakt. | IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties |
| typ | Resurstypen | "Microsoft.ApiManagement/service/identityProviders@2019-12-01-preview" |