Servizio Microsoft.ApiManagement/identityProviders 2023-09-01-preview
- più recenti
- 2023-09-01-preview
- 2022-08-01
- 2021-08-01
Definizione di risorsa Bicep
Il tipo di risorsa service/identityProviders può essere distribuito con operazioni destinate a:
Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.
Formato risorsa
Per creare una risorsa Microsoft.ApiManagement/service/identityProviders, aggiungere il bicep seguente al modello.
resource symbolicname 'Microsoft.ApiManagement/service/identityProviders@2023-09-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'
}
}
Valori delle proprietà
service/identityProviders
Nome | Descrizione | Valore |
---|---|---|
nome | Nome della risorsa Vedere come impostare nomi e tipi per le risorse figlio in Bicep. |
stringa (obbligatorio) Limite di caratteri: 1-80 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico. |
genitore | In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre. Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre. |
Nome simbolico per la risorsa di tipo: servizio |
proprietà | Proprietà del contratto del provider di identità. | IdentityProviderCreateContractPropertiesOrIdentityPr... |
IdentityProviderCreateContractPropertiesOrIdentityPr...
Nome | Descrizione | Valore |
---|---|---|
allowedTenants | Elenco di tenant consentiti durante la configurazione dell'account di accesso di Azure Active Directory. | string[] Vincoli: Lunghezza massima = 32 |
autorità | Nome host dell'endpoint di individuazione OpenID Connect per AAD o AAD B2C. | corda |
clientId | ID client dell'applicazione nel provider di identità esterno. Si tratta dell'ID app per l'account di accesso di Facebook, l'ID client per l'account di accesso google, l'ID app per Microsoft. | stringa (obbligatorio) Vincoli: Lunghezza minima = 1 |
clientLibrary | Libreria client da usare nel portale per sviluppatori. Si applica solo a AAD e al provider di identità AAD B2C. | corda Vincoli: Lunghezza massima = 16 |
clientSecret | Segreto client dell'applicazione nel provider di identità esterno, usato per autenticare la richiesta di accesso. Ad esempio, è Segreto app per l'account di accesso di Facebook, chiave API per l'account di accesso google, chiave pubblica per Microsoft. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore. | stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Valore sensibile. Passare come parametro sicuro. |
passwordResetPolicyName | Nome criterio di reimpostazione della password. Si applica solo al provider di identità AAD B2C. | corda Vincoli: Lunghezza minima = 1 |
profileEditingPolicyName | Nome criterio di modifica del profilo. Si applica solo al provider di identità AAD B2C. | corda Vincoli: Lunghezza minima = 1 |
signinPolicyName | Nome criterio di accesso. Si applica solo al provider di identità AAD B2C. | corda Vincoli: Lunghezza minima = 1 |
signinTenant | TenantId da usare invece di Common durante l'accesso ad Active Directory | corda |
signupPolicyName | Nome criterio di iscrizione. Si applica solo al provider di identità AAD B2C. | corda Vincoli: Lunghezza minima = 1 |
digitare | Identificatore del tipo di provider di identità. | 'aad' 'aadB2C' 'facebook' 'google' 'microsoft' 'twitter' |
Modelli di avvio rapido
I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.
Sagoma | Descrizione |
---|---|
Creare un'istanza di Gestione API e tutte le risorse secondarie usando modello |
Questo modello illustra come creare un servizio Gestione API e configurare le sottoentità |
Definizione di risorsa del modello di Resource Manager
Il tipo di risorsa service/identityProviders può essere distribuito con operazioni destinate a:
Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.
Formato risorsa
Per creare una risorsa Microsoft.ApiManagement/service/identityProviders, aggiungere il codice JSON seguente al modello.
{
"type": "Microsoft.ApiManagement/service/identityProviders",
"apiVersion": "2023-09-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"
}
}
Valori delle proprietà
service/identityProviders
Nome | Descrizione | Valore |
---|---|---|
digitare | Tipo di risorsa | 'Microsoft.ApiManagement/service/identityProviders' |
apiVersion | Versione dell'API della risorsa | '2023-09-01-preview' |
nome | Nome della risorsa Vedere come impostare nomi e tipi per le risorse figlio in modelli DI Resource Manager JSON. |
stringa (obbligatorio) Limite di caratteri: 1-80 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico. |
proprietà | Proprietà del contratto del provider di identità. | IdentityProviderCreateContractPropertiesOrIdentityPr... |
IdentityProviderCreateContractPropertiesOrIdentityPr...
Nome | Descrizione | Valore |
---|---|---|
allowedTenants | Elenco di tenant consentiti durante la configurazione dell'account di accesso di Azure Active Directory. | string[] Vincoli: Lunghezza massima = 32 |
autorità | Nome host dell'endpoint di individuazione OpenID Connect per AAD o AAD B2C. | corda |
clientId | ID client dell'applicazione nel provider di identità esterno. Si tratta dell'ID app per l'account di accesso di Facebook, l'ID client per l'account di accesso google, l'ID app per Microsoft. | stringa (obbligatorio) Vincoli: Lunghezza minima = 1 |
clientLibrary | Libreria client da usare nel portale per sviluppatori. Si applica solo a AAD e al provider di identità AAD B2C. | corda Vincoli: Lunghezza massima = 16 |
clientSecret | Segreto client dell'applicazione nel provider di identità esterno, usato per autenticare la richiesta di accesso. Ad esempio, è Segreto app per l'account di accesso di Facebook, chiave API per l'account di accesso google, chiave pubblica per Microsoft. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore. | stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Valore sensibile. Passare come parametro sicuro. |
passwordResetPolicyName | Nome criterio di reimpostazione della password. Si applica solo al provider di identità AAD B2C. | corda Vincoli: Lunghezza minima = 1 |
profileEditingPolicyName | Nome criterio di modifica del profilo. Si applica solo al provider di identità AAD B2C. | corda Vincoli: Lunghezza minima = 1 |
signinPolicyName | Nome criterio di accesso. Si applica solo al provider di identità AAD B2C. | corda Vincoli: Lunghezza minima = 1 |
signinTenant | TenantId da usare invece di Common durante l'accesso ad Active Directory | corda |
signupPolicyName | Nome criterio di iscrizione. Si applica solo al provider di identità AAD B2C. | corda Vincoli: Lunghezza minima = 1 |
digitare | Identificatore del tipo di provider di identità. | 'aad' 'aadB2C' 'facebook' 'google' 'microsoft' 'twitter' |
Modelli di avvio rapido
I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.
Sagoma | Descrizione |
---|---|
Creare un'istanza di Gestione API e tutte le risorse secondarie usando modello |
Questo modello illustra come creare un servizio Gestione API e configurare le sottoentità |
Definizione di risorsa Terraform (provider AzAPI)
Il tipo di risorsa service/identityProviders può essere distribuito con operazioni destinate a:
- gruppi di risorse
Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.
Formato risorsa
Per creare una risorsa Microsoft.ApiManagement/service/identityProviders, aggiungere il codice Terraform seguente al modello.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/identityProviders@2023-09-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"
}
})
}
Valori delle proprietà
service/identityProviders
Nome | Descrizione | Valore |
---|---|---|
digitare | Tipo di risorsa | "Microsoft.ApiManagement/service/identityProviders@2023-09-01-preview" |
nome | Nome della risorsa | stringa (obbligatorio) Limite di caratteri: 1-80 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico. |
parent_id | ID della risorsa padre per questa risorsa. | ID per la risorsa di tipo: servizio |
proprietà | Proprietà del contratto del provider di identità. | IdentityProviderCreateContractPropertiesOrIdentityPr... |
IdentityProviderCreateContractPropertiesOrIdentityPr...
Nome | Descrizione | Valore |
---|---|---|
allowedTenants | Elenco di tenant consentiti durante la configurazione dell'account di accesso di Azure Active Directory. | string[] Vincoli: Lunghezza massima = 32 |
autorità | Nome host dell'endpoint di individuazione OpenID Connect per AAD o AAD B2C. | corda |
clientId | ID client dell'applicazione nel provider di identità esterno. Si tratta dell'ID app per l'account di accesso di Facebook, l'ID client per l'account di accesso google, l'ID app per Microsoft. | stringa (obbligatorio) Vincoli: Lunghezza minima = 1 |
clientLibrary | Libreria client da usare nel portale per sviluppatori. Si applica solo a AAD e al provider di identità AAD B2C. | corda Vincoli: Lunghezza massima = 16 |
clientSecret | Segreto client dell'applicazione nel provider di identità esterno, usato per autenticare la richiesta di accesso. Ad esempio, è Segreto app per l'account di accesso di Facebook, chiave API per l'account di accesso google, chiave pubblica per Microsoft. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore. | stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Valore sensibile. Passare come parametro sicuro. |
passwordResetPolicyName | Nome criterio di reimpostazione della password. Si applica solo al provider di identità AAD B2C. | corda Vincoli: Lunghezza minima = 1 |
profileEditingPolicyName | Nome criterio di modifica del profilo. Si applica solo al provider di identità AAD B2C. | corda Vincoli: Lunghezza minima = 1 |
signinPolicyName | Nome criterio di accesso. Si applica solo al provider di identità AAD B2C. | corda Vincoli: Lunghezza minima = 1 |
signinTenant | TenantId da usare invece di Common durante l'accesso ad Active Directory | corda |
signupPolicyName | Nome criterio di iscrizione. Si applica solo al provider di identità AAD B2C. | corda Vincoli: Lunghezza minima = 1 |
digitare | Identificatore del tipo di provider di identità. | "aad" "aadB2C" "facebook" "google" "microsoft" "twitter" |