Dela via

Microsoft.ApiManagement service/openidConnectProviders 2023-03-01-preview

  • Artikel

Bicep-resursdefinition

Resurstypen service/openidConnectProviders kan distribueras med åtgärder som mål:

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

Egenskapsvärden

Microsoft.ApiManagement/service/openidConnectProviders

Namn Beskrivning Värde
Namn Resursnamnet sträng

Begränsningar:
Max längd =
Mönster = ^[^*#&+:<>?]+$ (krävs)
förälder 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 den överordnade resursen.		 Symboliskt namn för resurs av typen: tjänst
Egenskaper OpenId Connect Provider-kontraktegenskaper. OpenidConnectProviderContractProperties

OpenidConnectProviderContractProperties

Namn 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

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
beskrivning Användarvänlig beskrivning av OpenID Connect-providern. sträng
displayName Användarvänligt OpenID Connect-providernamn. sträng

Begränsningar:
Maximal längd = (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. Bool
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. Bool

Resursdefinition för ARM-mall

Resurstypen service/openidConnectProviders kan distribueras med åtgärder som mål:

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

Microsoft.ApiManagement/service/openidConnectProviders

Namn Beskrivning Värde
apiVersion API-versionen "2023-03-01-preview"
Namn Resursnamnet sträng

Begränsningar:
Max längd =
Mönster = ^[^*#&+:<>?]+$ (krävs)
Egenskaper OpenId Connect Provider-kontraktegenskaper. OpenidConnectProviderContractProperties
typ Resurstypen "Microsoft.ApiManagement/service/openidConnectProviders"

OpenidConnectProviderContractProperties

Namn 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

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
beskrivning Användarvänlig beskrivning av OpenID Connect-providern. sträng
displayName Användarvänligt OpenID Connect-providernamn. sträng

Begränsningar:
Maximal längd = (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. Bool
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. Bool

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

Egenskapsvärden

Microsoft.ApiManagement/service/openidConnectProviders

Namn Beskrivning Värde
Namn Resursnamnet sträng

Begränsningar:
Max längd =
Mönster = ^[^*#&+:<>?]+$ (krävs)
parent_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: tjänst
Egenskaper OpenId Connect Provider-kontraktegenskaper. OpenidConnectProviderContractProperties
typ Resurstypen "Microsoft.ApiManagement/service/openidConnectProviders@2023-03-01-preview"

OpenidConnectProviderContractProperties

Namn 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

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
beskrivning Användarvänlig beskrivning av OpenID Connect-providern. sträng
displayName Användarvänligt OpenID Connect-providernamn. sträng

Begränsningar:
Maximal längd = (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. Bool
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. Bool