Servizio Microsoft.ApiManagement/openidConnectProviders 2022-08-01
Definizione di risorsa Bicep
Il tipo di risorsa service/openidConnectProviders 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/openidConnectProviders, aggiungere il bicep seguente al modello.
resource symbolicname 'Microsoft.ApiManagement/service/openidConnectProviders@2022-08-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
clientId: 'string'
clientSecret: 'string'
description: 'string'
displayName: 'string'
metadataEndpoint: 'string'
useInApiDocumentation: bool
useInTestConsole: bool
}
}
Valori delle proprietà
service/openidConnectProviders
| 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 OpenId Connect. | OpenidConnectProviderContractProperties |
OpenidConnectProviderContractProperties
| Nome | Descrizione | Valore |
|---|---|---|
| clientId | ID client della console di sviluppo che è l'applicazione client. | stringa (obbligatoria) |
| clientSecret | Segreto client della console di sviluppo che è l'applicazione client. | string |
| description | Descrizione descrittiva del provider OpenID Connect. | string |
| displayName | Nome del provider OpenID Connect descrittivo. | stringa (obbligatoria) |
| metadataEndpoint | URI dell'endpoint dei metadati. | stringa (obbligatoria) |
| useInApiDocumentation | Se true, il provider Open ID Connect verrà usato nella documentazione dell'API nel portale per sviluppatori. False per impostazione predefinita se non viene fornito alcun valore. | bool |
| useInTestConsole | Se true, il provider Open ID Connect può essere usato nella console di test del portale per sviluppatori. True per impostazione predefinita se non viene fornito alcun valore. | bool |
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/openidConnectProviders 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/openidConnectProviders, aggiungere il codice JSON seguente al modello.
{
"type": "Microsoft.ApiManagement/service/openidConnectProviders",
"apiVersion": "2022-08-01",
"name": "string",
"properties": {
"clientId": "string",
"clientSecret": "string",
"description": "string",
"displayName": "string",
"metadataEndpoint": "string",
"useInApiDocumentation": "bool",
"useInTestConsole": "bool"
}
}
Valori delle proprietà
service/openidConnectProviders
| Nome | Descrizione | Valore |
|---|---|---|
| tipo | Tipo di risorsa | 'Microsoft.ApiManagement/service/openidConnectProviders' |
| apiVersion | Versione dell'API risorsa | '2022-08-01' |
| name | Nome della risorsa Vedere come impostare nomi e tipi per le risorse figlio nei modelli di RESOURCE JSON. |
stringa (obbligatoria) Limite di caratteri: 1-80 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico. |
| properties | Proprietà del contratto openId Connect Provider. | OpenidConnectProviderContractProperties |
OpenidConnectProviderContractProperties
| Nome | Descrizione | Valore |
|---|---|---|
| clientId | ID client della console per sviluppatori che è l'applicazione client. | stringa (obbligatorio) |
| clientSecret | Segreto client della console per sviluppatori che è l'applicazione client. | string |
| description | Descrizione intuitiva del provider OpenID Connect. | string |
| displayName | Nome del provider OpenID Connect descrittivo. | stringa (obbligatorio) |
| metadataEndpoint | URI dell'endpoint dei metadati. | stringa (obbligatorio) |
| useInApiDocumentation | Se true, il provider Open ID Connect verrà usato nella documentazione dell'API nel portale per sviluppatori. False per impostazione predefinita se non viene specificato alcun valore. | bool |
| useInTestConsole | Se true, il provider Open ID Connect può essere usato nella console di test del portale per sviluppatori. True per impostazione predefinita se non viene specificato alcun valore. | bool |
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/openidConnectProviders può essere distribuito con operazioni destinate:
- 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/openidConnectProviders, aggiungere il codice Terraform seguente al modello.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/openidConnectProviders@2022-08-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
clientId = "string"
clientSecret = "string"
description = "string"
displayName = "string"
metadataEndpoint = "string"
useInApiDocumentation = bool
useInTestConsole = bool
}
})
}
Valori delle proprietà
service/openidConnectProviders
| Nome | Descrizione | Valore |
|---|---|---|
| tipo | Tipo di risorsa | "Microsoft.ApiManagement/service/openidConnectProviders@2022-08-01" |
| name | 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 |
| properties | Proprietà del contratto openId Connect Provider. | OpenidConnectProviderContractProperties |
OpenidConnectProviderContractProperties
| Nome | Descrizione | Valore |
|---|---|---|
| clientId | ID client della console per sviluppatori che è l'applicazione client. | stringa (obbligatorio) |
| clientSecret | Segreto client della console per sviluppatori che è l'applicazione client. | string |
| description | Descrizione intuitiva del provider OpenID Connect. | string |
| displayName | Nome del provider OpenID Connect descrittivo. | stringa (obbligatorio) |
| metadataEndpoint | URI dell'endpoint dei metadati. | stringa (obbligatorio) |
| useInApiDocumentation | Se true, il provider Open ID Connect verrà usato nella documentazione dell'API nel portale per sviluppatori. False per impostazione predefinita se non viene specificato alcun valore. | bool |
| useInTestConsole | Se true, il provider Open ID Connect può essere usato nella console di test del portale per sviluppatori. True per impostazione predefinita se non viene specificato alcun valore. | bool |