Condividi tramite


Servizio Microsoft.ApiManagement/openidConnectProviders 2022-04-01-preview

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@2022-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    clientId: 'string'
    clientSecret: 'string'
    description: 'string'
    displayName: 'string'
    metadataEndpoint: 'string'
    useInApiDocumentation: bool
    useInTestConsole: bool
  }
}

Valori delle proprietà

Microsoft.ApiManagement/service/openidConnectProviders

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Lunghezza massima =
Pattern = ^[^*#&+:<>?]+$ (obbligatorio)
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. corda

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

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": "2022-04-01-preview",
  "name": "string",
  "properties": {
    "clientId": "string",
    "clientSecret": "string",
    "description": "string",
    "displayName": "string",
    "metadataEndpoint": "string",
    "useInApiDocumentation": "bool",
    "useInTestConsole": "bool"
  }
}

Valori delle proprietà

Microsoft.ApiManagement/service/openidConnectProviders

Nome Descrizione Valore
apiVersion Versione dell'API '2022-04-01-preview'
nome Nome della risorsa corda

Vincoli:
Lunghezza massima =
Pattern = ^[^*#&+:<>?]+$ (obbligatorio)
proprietà Proprietà del contratto del provider OpenId Connect. OpenidConnectProviderContractProperties
digitare Tipo di risorsa 'Microsoft.ApiManagement/service/openidConnectProviders'

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. corda

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

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@2022-04-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      clientId = "string"
      clientSecret = "string"
      description = "string"
      displayName = "string"
      metadataEndpoint = "string"
      useInApiDocumentation = bool
      useInTestConsole = bool
    }
  })
}

Valori delle proprietà

Microsoft.ApiManagement/service/openidConnectProviders

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Lunghezza massima =
Pattern = ^[^*#&+:<>?]+$ (obbligatorio)
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
digitare Tipo di risorsa "Microsoft.ApiManagement/service/openidConnectProviders@2022-04-01-preview"

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. corda

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