Microsoft.ApiManagement service/openidConnectProviders 2023-03-01-preview
Bicep-resursdefinition
Resurstypen service/openidConnectProviders kan distribueras med åtgärder som mål:
- Resursgrupper – Se distributionskommandon för resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/openidConnectProviders-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.ApiManagement/service/openidConnectProviders@2023-03-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
clientId: 'string'
clientSecret: 'string'
description: 'string'
displayName: 'string'
metadataEndpoint: 'string'
useInApiDocumentation: bool
useInTestConsole: bool
}
}
Egenskapsvärden
service/openidConnectProviders
Name | Beskrivning | Värde |
---|---|---|
name | Resursnamnet Se hur du anger namn och typer för underordnade resurser i Bicep. |
sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. |
parent | I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen. Mer information finns i Underordnad resurs utanför överordnad resurs. |
Symboliskt namn för resurs av typen: tjänst |
properties | OpenId Connect Provider kontraktegenskaper. | OpenidConnectProviderContractProperties |
OpenidConnectProviderContractProperties
Name | Beskrivning | Värde |
---|---|---|
ClientID | Klient-ID för utvecklarkonsolen som är klientprogrammet. | sträng (krävs) |
clientSecret | Klienthemlighet för utvecklarkonsolen som är klientprogrammet. | sträng |
beskrivning | Användarvänlig beskrivning av OpenID Connect-providern. | sträng |
displayName | Användarvänligt OpenID Connect-providernamn. | sträng (krävs) |
metadataEndpoint | URI för metadataslutpunkt. | sträng (krävs) |
useInApiDocumentation | Om det är sant används Open ID Connect-providern i API-dokumentationen i utvecklarportalen. Falskt som standard om inget värde anges. | boolesk |
useInTestConsole | Om det är sant kan Open ID Connect-providern användas i testkonsolen för utvecklarportalen. Sant som standard om inget värde anges. | boolesk |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
Mall | Description |
---|---|
Skapa en API Management-instans och alla underresurser med hjälp av mallen |
Den här mallen visar hur du skapar en API Management-tjänst och konfigurerar underentiteter |
Resursdefinition för ARM-mall
Resurstypen service/openidConnectProviders kan distribueras med åtgärder som mål:
- Resursgrupper – Se distributionskommandon för resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/openidConnectProviders-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.ApiManagement/service/openidConnectProviders",
"apiVersion": "2023-03-01-preview",
"name": "string",
"properties": {
"clientId": "string",
"clientSecret": "string",
"description": "string",
"displayName": "string",
"metadataEndpoint": "string",
"useInApiDocumentation": "bool",
"useInTestConsole": "bool"
}
}
Egenskapsvärden
service/openidConnectProviders
Name | Beskrivning | Värde |
---|---|---|
typ | Resurstypen | "Microsoft.ApiManagement/service/openidConnectProviders" |
apiVersion | Resurs-API-versionen | "2023-03-01-preview" |
name | Resursnamnet Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar. |
sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. |
properties | OpenId Connect Provider kontraktegenskaper. | OpenidConnectProviderContractProperties |
OpenidConnectProviderContractProperties
Name | Beskrivning | Värde |
---|---|---|
ClientID | Klient-ID för utvecklarkonsolen som är klientprogrammet. | sträng (krävs) |
clientSecret | Klienthemlighet för utvecklarkonsolen som är klientprogrammet. | sträng |
beskrivning | Användarvänlig beskrivning av OpenID Connect-providern. | sträng |
displayName | Användarvänligt OpenID Connect-providernamn. | sträng (krävs) |
metadataEndpoint | URI för metadataslutpunkt. | sträng (krävs) |
useInApiDocumentation | Om det är sant används Open ID Connect-providern i API-dokumentationen i utvecklarportalen. Falskt som standard om inget värde anges. | boolesk |
useInTestConsole | Om det är sant kan Open ID Connect-providern användas i testkonsolen för utvecklarportalen. Sant som standard om inget värde anges. | boolesk |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
Mall | Description |
---|---|
Skapa en API Management-instans och alla underresurser med hjälp av mallen |
Den här mallen visar hur du skapar en API Management-tjänst och konfigurerar underentiteter |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen service/openidConnectProviders kan distribueras med åtgärder som mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/openidConnectProviders-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/openidConnectProviders@2023-03-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
clientId = "string"
clientSecret = "string"
description = "string"
displayName = "string"
metadataEndpoint = "string"
useInApiDocumentation = bool
useInTestConsole = bool
}
})
}
Egenskapsvärden
service/openidConnectProviders
Name | Beskrivning | Värde |
---|---|---|
typ | Resurstypen | "Microsoft.ApiManagement/service/openidConnectProviders@2023-03-01-preview" |
name | Resursnamnet | sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. |
parent_id | ID:t för resursen som är överordnad för den här resursen. | ID för resurs av typen: tjänst |
properties | OpenId Connect Provider kontraktegenskaper. | OpenidConnectProviderContractProperties |
OpenidConnectProviderContractProperties
Name | Beskrivning | Värde |
---|---|---|
ClientID | Klient-ID för utvecklarkonsolen som är klientprogrammet. | sträng (krävs) |
clientSecret | Klienthemlighet för utvecklarkonsolen som är klientprogrammet. | sträng |
beskrivning | Användarvänlig beskrivning av OpenID Connect-providern. | sträng |
displayName | Användarvänligt OpenID Connect-providernamn. | sträng (krävs) |
metadataEndpoint | URI för metadataslutpunkt. | sträng (krävs) |
useInApiDocumentation | Om det är sant används Open ID Connect-providern i API-dokumentationen i utvecklarportalen. Falskt som standard om inget värde anges. | boolesk |
useInTestConsole | Om det är sant kan Open ID Connect-providern användas i testkonsolen för utvecklarportalen. Sant som standard om inget värde anges. | boolesk |