Condividi tramite


Servizio Microsoft.ApiManagement/openidConnectProviders

Definizione di risorsa Bicep

Il tipo di risorsa service/openidConnectProviders può essere distribuito con operazioni destinate a:

  • 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 risorsa

Per creare una risorsa Microsoft.ApiManagement/service/openidConnectProviders, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.ApiManagement/service/openidConnectProviders@2023-09-01-preview' = {
  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
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 OpenId Connect. OpenidConnectProviderContractProperties

OpenidConnectProviderContractProperties

Nome Descrizione Valore
clientId ID client della console per sviluppatori che è l'applicazione client. stringa (obbligatorio)
clientSecret Segreto client della console di sviluppo che è l'applicazione client. corda

Vincoli:
Valore sensibile. Passare come parametro sicuro.
descrizione Descrizione intuitiva del provider OpenID Connect. corda
displayName Nome del provider OpenID Connect descrittivo. stringa (obbligatorio)

Vincoli:
Lunghezza massima = 50
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.

Sagoma Descrizione
Creare un'istanza di Gestione API e tutte le risorse secondarie usando modello

Distribuire in Azure
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/openidConnectProviders può essere distribuito con operazioni destinate a:

  • 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 risorsa

Per creare una risorsa Microsoft.ApiManagement/service/openidConnectProviders, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.ApiManagement/service/openidConnectProviders",
  "apiVersion": "2023-09-01-preview",
  "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
digitare Tipo di risorsa 'Microsoft.ApiManagement/service/openidConnectProviders'
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 OpenId Connect. OpenidConnectProviderContractProperties

OpenidConnectProviderContractProperties

Nome Descrizione Valore
clientId ID client della console per sviluppatori che è l'applicazione client. stringa (obbligatorio)
clientSecret Segreto client della console di sviluppo che è l'applicazione client. corda

Vincoli:
Valore sensibile. Passare come parametro sicuro.
descrizione Descrizione intuitiva del provider OpenID Connect. corda
displayName Nome del provider OpenID Connect descrittivo. stringa (obbligatorio)

Vincoli:
Lunghezza massima = 50
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.

Sagoma Descrizione
Creare un'istanza di Gestione API e tutte le risorse secondarie usando modello

Distribuire in Azure
Questo modello illustra come creare un servizio Gestione API e configurare le sottoentità

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa service/openidConnectProviders 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/openidConnectProviders, aggiungere il codice Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/openidConnectProviders@2023-09-01-preview"
  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
digitare Tipo di risorsa "Microsoft.ApiManagement/service/openidConnectProviders@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 OpenId Connect. OpenidConnectProviderContractProperties

OpenidConnectProviderContractProperties

Nome Descrizione Valore
clientId ID client della console per sviluppatori che è l'applicazione client. stringa (obbligatorio)
clientSecret Segreto client della console di sviluppo che è l'applicazione client. corda

Vincoli:
Valore sensibile. Passare come parametro sicuro.
descrizione Descrizione intuitiva del provider OpenID Connect. corda
displayName Nome del provider OpenID Connect descrittivo. stringa (obbligatorio)

Vincoli:
Lunghezza massima = 50
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