Microsoft.ApiManagement service/identityProviders 2022-04-01-preview
Definizione di risorsa Bicep
Il tipo di risorsa service/identityProviders può essere distribuito con operazioni destinate:
- Gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse
Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.
Formato di risorsa
Per creare una risorsa Microsoft.ApiManagement/service/identityProviders, aggiungere il modello Bicep seguente.
resource symbolicname 'Microsoft.ApiManagement/service/identityProviders@2022-04-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 |
---|---|---|
name | Nome della risorsa Vedere come impostare nomi e tipi per le risorse figlio in Bicep. |
stringa (obbligatoria) Limite di caratteri: 1-80 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico. |
padre | 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 esterna alla risorsa padre. |
Nome simbolico per la risorsa di tipo: servizio |
properties | Proprietà del contratto del provider di identità. | IdentityProviderCreateContractPropertiesOrIdentityPr... |
IdentityProviderCreateContractPropertiesOrIdentityPr...
Nome | Descrizione | Valore |
---|---|---|
consentitoTenants | Elenco dei tenant consentiti durante la configurazione dell'account di accesso di Azure Active Directory. | string[] |
authority | Nome host dell'endpoint di individuazione OpenID Connect per AAD o AAD B2C. | string |
clientId | ID client dell'applicazione nel provider di identità esterno. È ID app per Facebook account di accesso, ID client per Google login, ID app per Microsoft. | stringa (obbligatoria) |
clientLibrary | Libreria client da usare nel portale per sviluppatori. Si applica solo a AAD e AAD B2C Identity Provider. | string |
clientSecret | Segreto client dell'applicazione nel provider di identità esterno, usato per autenticare la richiesta di accesso. Ad esempio, è Segreto app per Facebook account di accesso, 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 (obbligatoria) |
passwordResetPolicyName | Nome criteri di reimpostazione della password. Si applica solo a AAD B2C Identity Provider. | string |
profileEditingPolicyName | Nome criteri di modifica del profilo. Si applica solo a AAD B2C Identity Provider. | string |
signinPolicyName | Nome criteri di accesso. Si applica solo a AAD B2C Identity Provider. | string |
signinTenant | TenantId da usare invece di Common quando si accede ad Active Directory | string |
signupPolicyName | Nome criteri di iscrizione. Si applica solo a AAD B2C Identity Provider. | string |
type | 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.
Modello | Descrizione |
---|---|
Creare un'istanza di Gestione API e tutte le relative risorse secondarie tramite un modello |
Questo modello illustra come creare un servizio di Gestione API e configurare le sottoentità |
Definizione della risorsa modello di Resource Manager
Il tipo di risorsa service/identityProviders può essere distribuito con operazioni destinate:
- Gruppi di risorse - Vedere i comandi di distribuzione dei gruppi di risorse
Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.
Formato di risorsa
Per creare una risorsa Microsoft.ApiManagement/service/identityProviders, aggiungere il codice JSON seguente al modello.
{
"type": "Microsoft.ApiManagement/service/identityProviders",
"apiVersion": "2022-04-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 |
---|---|---|
tipo | Tipo di risorsa | 'Microsoft.ApiManagement/service/identityProviders' |
apiVersion | Versione dell'API della risorsa | '2022-04-01-preview' |
name | Nome della risorsa Informazioni su come impostare nomi e tipi per le risorse figlio nei 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. |
properties | Proprietà del contratto del provider di identità. | IdentityProviderCreateContractPropertiesOrIdentityPr... |
IdentityProviderCreateContractPropertiesOrIdentityPr...
Nome | Descrizione | Valore |
---|---|---|
allowedTenants | Elenco dei tenant consentiti durante la configurazione dell'account di accesso di Azure Active Directory. | string[] |
authority | Nome host dell'endpoint di individuazione OpenID Connect per AAD o AAD B2C. | string |
clientId | ID client dell'applicazione nel provider di identità esterno. Si tratta dell'ID app per Facebook account di accesso, ID client per l'account di accesso Google, ID app per Microsoft. | stringa (obbligatorio) |
clientLibrary | Libreria client da usare nel portale per sviluppatori. Si applica solo al provider di identità AAD e AAD B2C. | string |
clientSecret | Segreto client dell'applicazione nel provider di identità esterno, usato per autenticare la richiesta di accesso. Ad esempio, è Segreto app per Facebook account di accesso, 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) |
passwordResetPolicyName | Nome del criterio di reimpostazione della password. Si applica solo al provider di identità AAD B2C. | string |
profileEditingPolicyName | Nome criterio di modifica del profilo. Si applica solo al provider di identità AAD B2C. | string |
signinPolicyName | Nome criteri di accesso. Si applica solo al provider di identità AAD B2C. | string |
signinTenant | TenantId da usare invece di Common durante l'accesso ad Active Directory | string |
signupPolicyName | Nome criteri di iscrizione. Si applica solo al provider di identità AAD B2C. | string |
type | 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.
Modello | Descrizione |
---|---|
Creare un'istanza di Gestione API e tutte le relative risorse secondarie tramite un modello |
Questo modello illustra come creare un servizio di Gestione API e configurare le sottoentità |
Definizione della 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 di 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@2022-04-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 |
---|---|---|
tipo | Tipo di risorsa | "Microsoft.ApiManagement/service/identityProviders@2022-04-01-preview" |
name | Nome della risorsa | stringa (obbligatoria) 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 |
properties | Proprietà del contratto del provider di identità. | IdentityProviderCreateContractPropertiesOrIdentityPr... |
IdentityProviderCreateContractPropertiesOrIdentityPr...
Nome | Descrizione | Valore |
---|---|---|
consentitoTenants | Elenco dei tenant consentiti durante la configurazione dell'account di accesso di Azure Active Directory. | string[] |
authority | Nome host dell'endpoint di individuazione OpenID Connect per AAD o AAD B2C. | string |
clientId | ID client dell'applicazione nel provider di identità esterno. È ID app per Facebook account di accesso, ID client per Google login, ID app per Microsoft. | stringa (obbligatoria) |
clientLibrary | Libreria client da usare nel portale per sviluppatori. Si applica solo a AAD e AAD B2C Identity Provider. | string |
clientSecret | Segreto client dell'applicazione nel provider di identità esterno, usato per autenticare la richiesta di accesso. Ad esempio, è Segreto app per Facebook account di accesso, 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 (obbligatoria) |
passwordResetPolicyName | Nome criteri di reimpostazione della password. Si applica solo a AAD B2C Identity Provider. | string |
profileEditingPolicyName | Nome criteri di modifica del profilo. Si applica solo a AAD B2C Identity Provider. | string |
signinPolicyName | Nome criteri di accesso. Si applica solo a AAD B2C Identity Provider. | string |
signinTenant | TenantId da usare invece di Common quando si accede ad Active Directory | string |
signupPolicyName | Nome criteri di iscrizione. Si applica solo a AAD B2C Identity Provider. | string |
type | Identificatore del tipo di provider di identità. | "aad" "aadB2C" "facebook" "google" "microsoft" "twitter" |