Sdílet prostřednictvím

Služba Microsoft.ApiManagement /openidConnectProviders 2024-05-01

  • Článek

Definice prostředku Bicep

Typ prostředku service/openidConnectProviders je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/openidConnectProviders, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.ApiManagement/service/openidConnectProviders@2024-05-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    clientId: 'string'
    clientSecret: 'string'
    description: 'string'
    displayName: 'string'
    metadataEndpoint: 'string'
    useInApiDocumentation: bool
    useInTestConsole: bool
  }
}

Hodnoty vlastností

Microsoft.ApiManagement/service/openidConnectProviders

Jméno Popis Hodnota
Jméno Název prostředku řetězec

Omezení:
Maximální délka =
Model = ^[^*#&+:<>?]+$ (povinné)
rodič V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.		 Symbolický název prostředku typu: služby
vlastnosti Vlastnosti kontraktu zprostředkovatele OpenId Connect OpenidConnectProviderContractProperties

OpenidConnectProviderContractProperties

Jméno Popis Hodnota
clientId ID klienta konzoly pro vývojáře, což je klientská aplikace. string (povinné)
clientSecret Tajný klíč klienta konzoly pro vývojáře, což je klientská aplikace. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
popis Uživatelsky přívětivý popis zprostředkovatele OpenID Connect. řetězec
displayName Uživatelsky přívětivý název zprostředkovatele OpenID Connect řetězec

Omezení:
Maximální délka = (povinné)
metadataEndpoint Identifikátor URI koncového bodu metadat. string (povinné)
useInApiDocumentation Pokud je pravda, poskytovatel Open ID Connect se použije v dokumentaci k rozhraní API na portálu pro vývojáře. False ve výchozím nastavení, pokud není zadaná žádná hodnota. Bool
useInTestConsole Pokud je pravda, zprostředkovatel Open ID Connect se může použít v testovací konzole portálu pro vývojáře. Hodnota True ve výchozím nastavení platí, pokud není zadaná žádná hodnota. Bool

Definice prostředku šablony ARM

Typ prostředku service/openidConnectProviders je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/openidConnectProviders, přidejte do šablony následující JSON.

{
  "type": "Microsoft.ApiManagement/service/openidConnectProviders",
  "apiVersion": "2024-05-01",
  "name": "string",
  "properties": {
    "clientId": "string",
    "clientSecret": "string",
    "description": "string",
    "displayName": "string",
    "metadataEndpoint": "string",
    "useInApiDocumentation": "bool",
    "useInTestConsole": "bool"
  }
}

Hodnoty vlastností

Microsoft.ApiManagement/service/openidConnectProviders

Jméno Popis Hodnota
apiVersion Verze rozhraní API '2024-05-01'
Jméno Název prostředku řetězec

Omezení:
Maximální délka =
Model = ^[^*#&+:<>?]+$ (povinné)
vlastnosti Vlastnosti kontraktu zprostředkovatele OpenId Connect OpenidConnectProviderContractProperties
typ Typ prostředku Microsoft.ApiManagement/service/openidConnectProviders

OpenidConnectProviderContractProperties

Jméno Popis Hodnota
clientId ID klienta konzoly pro vývojáře, což je klientská aplikace. string (povinné)
clientSecret Tajný klíč klienta konzoly pro vývojáře, což je klientská aplikace. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
popis Uživatelsky přívětivý popis zprostředkovatele OpenID Connect. řetězec
displayName Uživatelsky přívětivý název zprostředkovatele OpenID Connect řetězec

Omezení:
Maximální délka = (povinné)
metadataEndpoint Identifikátor URI koncového bodu metadat. string (povinné)
useInApiDocumentation Pokud je pravda, poskytovatel Open ID Connect se použije v dokumentaci k rozhraní API na portálu pro vývojáře. False ve výchozím nastavení, pokud není zadaná žádná hodnota. Bool
useInTestConsole Pokud je pravda, zprostředkovatel Open ID Connect se může použít v testovací konzole portálu pro vývojáře. Hodnota True ve výchozím nastavení platí, pokud není zadaná žádná hodnota. Bool

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku service/openidConnectProviders je možné nasadit s operacemi, které cílí:

  • skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/openidConnectProviders, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/openidConnectProviders@2024-05-01"
  name = "string"
  body = jsonencode({
    properties = {
      clientId = "string"
      clientSecret = "string"
      description = "string"
      displayName = "string"
      metadataEndpoint = "string"
      useInApiDocumentation = bool
      useInTestConsole = bool
    }
  })
}

Hodnoty vlastností

Microsoft.ApiManagement/service/openidConnectProviders

Jméno Popis Hodnota
Jméno Název prostředku řetězec

Omezení:
Maximální délka =
Model = ^[^*#&+:<>?]+$ (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: služby
vlastnosti Vlastnosti kontraktu zprostředkovatele OpenId Connect OpenidConnectProviderContractProperties
typ Typ prostředku Microsoft.ApiManagement/service/openidConnectProviders@2024-05-01

OpenidConnectProviderContractProperties

Jméno Popis Hodnota
clientId ID klienta konzoly pro vývojáře, což je klientská aplikace. string (povinné)
clientSecret Tajný klíč klienta konzoly pro vývojáře, což je klientská aplikace. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
popis Uživatelsky přívětivý popis zprostředkovatele OpenID Connect. řetězec
displayName Uživatelsky přívětivý název zprostředkovatele OpenID Connect řetězec

Omezení:
Maximální délka = (povinné)
metadataEndpoint Identifikátor URI koncového bodu metadat. string (povinné)
useInApiDocumentation Pokud je pravda, poskytovatel Open ID Connect se použije v dokumentaci k rozhraní API na portálu pro vývojáře. False ve výchozím nastavení, pokud není zadaná žádná hodnota. Bool
useInTestConsole Pokud je pravda, zprostředkovatel Open ID Connect se může použít v testovací konzole portálu pro vývojáře. Hodnota True ve výchozím nastavení platí, pokud není zadaná žádná hodnota. Bool