Delen via


Microsoft.ApiManagement-service/openidConnectProviders 2024-06-01-preview

Bicep-resourcedefinitie

Het resourcetype service/openidConnectProviders kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.ApiManagement/service/openidConnectProviders wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

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

Eigenschapswaarden

Microsoft.ApiManagement/service/openidConnectProviders

Naam Beschrijving Waarde
naam De resourcenaam snaar

Beperkingen:
Maximale lengte =
Patroon = ^[^*#&+:<>?]+$ (vereist)
ouder In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd.

Zie onderliggende resource buiten de bovenliggende resourcevoor meer informatie.
Symbolische naam voor resource van het type: service
Eigenschappen OpenId Connect Provider-contracteigenschappen. OpenidConnectProviderContractProperties-

OpenidConnectProviderContractProperties

Naam Beschrijving Waarde
clientId Client-id van de ontwikkelaarsconsole, de clienttoepassing. tekenreeks (vereist)
clientSecret Clientgeheim van de ontwikkelaarsconsole, de clienttoepassing. snaar

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
beschrijving Gebruiksvriendelijke beschrijving van OpenID Connect Provider. snaar
displayName Gebruiksvriendelijke OpenID Connect Provider-naam. snaar

Beperkingen:
Maximale lengte = (vereist)
metadataEndpoint Eindpunt-URI voor metagegevens. tekenreeks (vereist)
useInApiDocumentation Indien waar, wordt de Open ID Connect-provider gebruikt in de API-documentatie in de ontwikkelaarsportal. Standaard onwaar als er geen waarde is opgegeven. Bool
useInTestConsole Indien waar, kan de Open ID Connect-provider worden gebruikt in de testconsole van de ontwikkelaarsportal. True standaard als er geen waarde wordt opgegeven. Bool

Resourcedefinitie van ARM-sjabloon

Het resourcetype service/openidConnectProviders kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.ApiManagement/service/openidConnectProviders-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

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

Eigenschapswaarden

Microsoft.ApiManagement/service/openidConnectProviders

Naam Beschrijving Waarde
apiVersion De API-versie '2024-06-01-preview'
naam De resourcenaam snaar

Beperkingen:
Maximale lengte =
Patroon = ^[^*#&+:<>?]+$ (vereist)
Eigenschappen OpenId Connect Provider-contracteigenschappen. OpenidConnectProviderContractProperties-
type Het resourcetype 'Microsoft.ApiManagement/service/openidConnectProviders'

OpenidConnectProviderContractProperties

Naam Beschrijving Waarde
clientId Client-id van de ontwikkelaarsconsole, de clienttoepassing. tekenreeks (vereist)
clientSecret Clientgeheim van de ontwikkelaarsconsole, de clienttoepassing. snaar

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
beschrijving Gebruiksvriendelijke beschrijving van OpenID Connect Provider. snaar
displayName Gebruiksvriendelijke OpenID Connect Provider-naam. snaar

Beperkingen:
Maximale lengte = (vereist)
metadataEndpoint Eindpunt-URI voor metagegevens. tekenreeks (vereist)
useInApiDocumentation Indien waar, wordt de Open ID Connect-provider gebruikt in de API-documentatie in de ontwikkelaarsportal. Standaard onwaar als er geen waarde is opgegeven. Bool
useInTestConsole Indien waar, kan de Open ID Connect-provider worden gebruikt in de testconsole van de ontwikkelaarsportal. True standaard als er geen waarde wordt opgegeven. Bool

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype service/openidConnectProviders kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.ApiManagement/service/openidConnectProviders-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

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

Eigenschapswaarden

Microsoft.ApiManagement/service/openidConnectProviders

Naam Beschrijving Waarde
naam De resourcenaam snaar

Beperkingen:
Maximale lengte =
Patroon = ^[^*#&+:<>?]+$ (vereist)
parent_id De id van de resource die het bovenliggende item voor deze resource is. Id voor resource van het type: service-
Eigenschappen OpenId Connect Provider-contracteigenschappen. OpenidConnectProviderContractProperties-
type Het resourcetype "Microsoft.ApiManagement/service/openidConnectProviders@2024-06-01-preview"

OpenidConnectProviderContractProperties

Naam Beschrijving Waarde
clientId Client-id van de ontwikkelaarsconsole, de clienttoepassing. tekenreeks (vereist)
clientSecret Clientgeheim van de ontwikkelaarsconsole, de clienttoepassing. snaar

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
beschrijving Gebruiksvriendelijke beschrijving van OpenID Connect Provider. snaar
displayName Gebruiksvriendelijke OpenID Connect Provider-naam. snaar

Beperkingen:
Maximale lengte = (vereist)
metadataEndpoint Eindpunt-URI voor metagegevens. tekenreeks (vereist)
useInApiDocumentation Indien waar, wordt de Open ID Connect-provider gebruikt in de API-documentatie in de ontwikkelaarsportal. Standaard onwaar als er geen waarde is opgegeven. Bool
useInTestConsole Indien waar, kan de Open ID Connect-provider worden gebruikt in de testconsole van de ontwikkelaarsportal. True standaard als er geen waarde wordt opgegeven. Bool