Delen via

Microsoft.ApiManagement-service/authorizationServers 2023-09-01-preview

  • Artikel

Bicep-resourcedefinitie

Het resourcetype service/authorizationServers 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/authorizationServers wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2023-09-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    authorizationEndpoint: 'string'
    authorizationMethods: [
      'string'
    ]
    bearerTokenSendingMethods: [
      'string'
    ]
    clientAuthenticationMethod: [
      'string'
    ]
    clientId: 'string'
    clientRegistrationEndpoint: 'string'
    clientSecret: 'string'
    defaultScope: 'string'
    description: 'string'
    displayName: 'string'
    grantTypes: [
      'string'
    ]
    resourceOwnerPassword: 'string'
    resourceOwnerUsername: 'string'
    supportState: bool
    tokenBodyParameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    tokenEndpoint: 'string'
    useInApiDocumentation: bool
    useInTestConsole: bool
  }
}

Eigenschapswaarden

AuthorizationServerContractProperties

Naam Beschrijving Waarde
authorizationEndpoint OAuth-autorisatie-eindpunt. Zie http://tools.ietf.org/html/rfc6749#section-3.2. tekenreeks (vereist)
authorizationMethods HTTP-woorden die worden ondersteund door het autorisatie-eindpunt. GET moet altijd aanwezig zijn. POST is optioneel. Tekenreeksmatrix met een van de volgende waarden:
'VERWIJDEREN'
'GET'
'HEAD'
'OPTIES'
'PATCH'
'POST'
'PUT'
'TRACE'
bearerTokenSendingMethods Hiermee geeft u het mechanisme op waarmee het toegangstoken wordt doorgegeven aan de API. Tekenreeksmatrix met een van de volgende waarden:
'authorizationHeader'
'query'
clientAuthenticationMethod Verificatiemethode die wordt ondersteund door het tokeneindpunt van deze autorisatieserver. Mogelijke waarden zijn Basic en/of Hoofdtekst. Wanneer hoofdtekst is opgegeven, worden clientreferenties en andere parameters doorgegeven in de aanvraagbody in de indeling application/x-www-form-urlencoded. Tekenreeksmatrix met een van de volgende waarden:
'Basis'
'Hoofdtekst'
clientId Client- of app-id geregistreerd bij deze autorisatieserver. tekenreeks (vereist)
clientRegistrationEndpoint Optionele verwijzing naar een pagina waar client- of app-registratie voor deze autorisatieserver wordt uitgevoerd. Bevat de absolute URL naar de entiteit waarnaar wordt verwezen. tekenreeks (vereist)
clientSecret Client- of app-geheim dat is geregistreerd bij deze autorisatieserver. Deze eigenschap wordt niet ingevuld voor 'GET'-bewerkingen. Gebruik POST-aanvraag '/listSecrets' om de waarde op te halen. snaar

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
defaultScope Toegangstokenbereik dat standaard wordt aangevraagd. Kan worden overschreven op API-niveau. Moet worden opgegeven in de vorm van een tekenreeks die door spaties gescheiden waarden bevat. snaar
beschrijving Beschrijving van de autorisatieserver. Kan HTML-opmaaktags bevatten. snaar
displayName Gebruiksvriendelijke autorisatieservernaam. snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1 (vereist)
grantTypes Vorm van een autorisatietoekenning, die de client gebruikt om het toegangstoken aan te vragen. Tekenreeksmatrix met een van de volgende waarden:
'authorizationCode'
'clientCredentials'
'impliciet'
'resourceOwnerPassword' (vereist)
resourceOwnerPassword Kan eventueel worden opgegeven wanneer het type wachtwoordtoestemming van de resource-eigenaar wordt ondersteund door deze autorisatieserver. Standaardwachtwoord voor resource-eigenaar. snaar
resourceOwnerUsername Kan eventueel worden opgegeven wanneer het type wachtwoordtoestemming van de resource-eigenaar wordt ondersteund door deze autorisatieserver. Gebruikersnaam van standaardresource-eigenaar. snaar
supportState Indien waar, bevat de autorisatieserver de statusparameter van de autorisatieaanvraag tot het antwoord. Client kan de statusparameter gebruiken om protocolbeveiliging te verhogen. Bool
tokenBodyParameters Aanvullende parameters die zijn vereist voor het tokeneindpunt van deze autorisatieserver die worden weergegeven als een matrix van JSON-objecten met de eigenschappen van de naam- en waardetekenreeks, bijvoorbeeld {"name" : "name value", "value": "a value"}. TokenBodyParameterContract[]
tokenEndpoint OAuth-tokeneindpunt. Bevat de absolute URI naar de entiteit waarnaar wordt verwezen. snaar
useInApiDocumentation Indien waar, wordt de autorisatieserver gebruikt in de API-documentatie in de ontwikkelaarsportal. Standaard onwaar als er geen waarde is opgegeven. Bool
useInTestConsole Indien waar, kan de autorisatieserver worden gebruikt in de testconsole van de ontwikkelaarsportal. True standaard als er geen waarde wordt opgegeven. Bool

Microsoft.ApiManagement/service/authorizationServers

Naam Beschrijving Waarde
naam De resourcenaam snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1
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 Eigenschappen van het externe OAuth-autorisatieservercontract. AuthorizationServerContractProperties

TokenBodyParameterContract

Naam Beschrijving Waarde
naam naam van de hoofdparameter. tekenreeks (vereist)
waarde parameterwaarde van de hoofdtekst. tekenreeks (vereist)

Resourcedefinitie van ARM-sjabloon

Het resourcetype service/authorizationServers 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/authorizationServers-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "authorizationEndpoint": "string",
    "authorizationMethods": [ "string" ],
    "bearerTokenSendingMethods": [ "string" ],
    "clientAuthenticationMethod": [ "string" ],
    "clientId": "string",
    "clientRegistrationEndpoint": "string",
    "clientSecret": "string",
    "defaultScope": "string",
    "description": "string",
    "displayName": "string",
    "grantTypes": [ "string" ],
    "resourceOwnerPassword": "string",
    "resourceOwnerUsername": "string",
    "supportState": "bool",
    "tokenBodyParameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "tokenEndpoint": "string",
    "useInApiDocumentation": "bool",
    "useInTestConsole": "bool"
  }
}

Eigenschapswaarden

AuthorizationServerContractProperties

Naam Beschrijving Waarde
authorizationEndpoint OAuth-autorisatie-eindpunt. Zie http://tools.ietf.org/html/rfc6749#section-3.2. tekenreeks (vereist)
authorizationMethods HTTP-woorden die worden ondersteund door het autorisatie-eindpunt. GET moet altijd aanwezig zijn. POST is optioneel. Tekenreeksmatrix met een van de volgende waarden:
'VERWIJDEREN'
'GET'
'HEAD'
'OPTIES'
'PATCH'
'POST'
'PUT'
'TRACE'
bearerTokenSendingMethods Hiermee geeft u het mechanisme op waarmee het toegangstoken wordt doorgegeven aan de API. Tekenreeksmatrix met een van de volgende waarden:
'authorizationHeader'
'query'
clientAuthenticationMethod Verificatiemethode die wordt ondersteund door het tokeneindpunt van deze autorisatieserver. Mogelijke waarden zijn Basic en/of Hoofdtekst. Wanneer hoofdtekst is opgegeven, worden clientreferenties en andere parameters doorgegeven in de aanvraagbody in de indeling application/x-www-form-urlencoded. Tekenreeksmatrix met een van de volgende waarden:
'Basis'
'Hoofdtekst'
clientId Client- of app-id geregistreerd bij deze autorisatieserver. tekenreeks (vereist)
clientRegistrationEndpoint Optionele verwijzing naar een pagina waar client- of app-registratie voor deze autorisatieserver wordt uitgevoerd. Bevat de absolute URL naar de entiteit waarnaar wordt verwezen. tekenreeks (vereist)
clientSecret Client- of app-geheim dat is geregistreerd bij deze autorisatieserver. Deze eigenschap wordt niet ingevuld voor 'GET'-bewerkingen. Gebruik POST-aanvraag '/listSecrets' om de waarde op te halen. snaar

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
defaultScope Toegangstokenbereik dat standaard wordt aangevraagd. Kan worden overschreven op API-niveau. Moet worden opgegeven in de vorm van een tekenreeks die door spaties gescheiden waarden bevat. snaar
beschrijving Beschrijving van de autorisatieserver. Kan HTML-opmaaktags bevatten. snaar
displayName Gebruiksvriendelijke autorisatieservernaam. snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1 (vereist)
grantTypes Vorm van een autorisatietoekenning, die de client gebruikt om het toegangstoken aan te vragen. Tekenreeksmatrix met een van de volgende waarden:
'authorizationCode'
'clientCredentials'
'impliciet'
'resourceOwnerPassword' (vereist)
resourceOwnerPassword Kan eventueel worden opgegeven wanneer het type wachtwoordtoestemming van de resource-eigenaar wordt ondersteund door deze autorisatieserver. Standaardwachtwoord voor resource-eigenaar. snaar
resourceOwnerUsername Kan eventueel worden opgegeven wanneer het type wachtwoordtoestemming van de resource-eigenaar wordt ondersteund door deze autorisatieserver. Gebruikersnaam van standaardresource-eigenaar. snaar
supportState Indien waar, bevat de autorisatieserver de statusparameter van de autorisatieaanvraag tot het antwoord. Client kan de statusparameter gebruiken om protocolbeveiliging te verhogen. Bool
tokenBodyParameters Aanvullende parameters die zijn vereist voor het tokeneindpunt van deze autorisatieserver die worden weergegeven als een matrix van JSON-objecten met de eigenschappen van de naam- en waardetekenreeks, bijvoorbeeld {"name" : "name value", "value": "a value"}. TokenBodyParameterContract[]
tokenEndpoint OAuth-tokeneindpunt. Bevat de absolute URI naar de entiteit waarnaar wordt verwezen. snaar
useInApiDocumentation Indien waar, wordt de autorisatieserver gebruikt in de API-documentatie in de ontwikkelaarsportal. Standaard onwaar als er geen waarde is opgegeven. Bool
useInTestConsole Indien waar, kan de autorisatieserver worden gebruikt in de testconsole van de ontwikkelaarsportal. True standaard als er geen waarde wordt opgegeven. Bool

Microsoft.ApiManagement/service/authorizationServers

Naam Beschrijving Waarde
apiVersion De API-versie '2023-09-01-preview'
naam De resourcenaam snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1
Patroon = ^[^*#&+:<>?]+$ (vereist)
Eigenschappen Eigenschappen van het externe OAuth-autorisatieservercontract. AuthorizationServerContractProperties
type Het resourcetype 'Microsoft.ApiManagement/service/authorizationServers'

TokenBodyParameterContract

Naam Beschrijving Waarde
naam naam van de hoofdparameter. tekenreeks (vereist)
waarde parameterwaarde van de hoofdtekst. tekenreeks (vereist)

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype service/authorizationServers 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/authorizationServers-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationServers@2023-09-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      authorizationEndpoint = "string"
      authorizationMethods = [
        "string"
      ]
      bearerTokenSendingMethods = [
        "string"
      ]
      clientAuthenticationMethod = [
        "string"
      ]
      clientId = "string"
      clientRegistrationEndpoint = "string"
      clientSecret = "string"
      defaultScope = "string"
      description = "string"
      displayName = "string"
      grantTypes = [
        "string"
      ]
      resourceOwnerPassword = "string"
      resourceOwnerUsername = "string"
      supportState = bool
      tokenBodyParameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      tokenEndpoint = "string"
      useInApiDocumentation = bool
      useInTestConsole = bool
    }
  })
}

Eigenschapswaarden

AuthorizationServerContractProperties

Naam Beschrijving Waarde
authorizationEndpoint OAuth-autorisatie-eindpunt. Zie http://tools.ietf.org/html/rfc6749#section-3.2. tekenreeks (vereist)
authorizationMethods HTTP-woorden die worden ondersteund door het autorisatie-eindpunt. GET moet altijd aanwezig zijn. POST is optioneel. Tekenreeksmatrix met een van de volgende waarden:
'VERWIJDEREN'
'GET'
'HEAD'
'OPTIES'
'PATCH'
'POST'
'PUT'
'TRACE'
bearerTokenSendingMethods Hiermee geeft u het mechanisme op waarmee het toegangstoken wordt doorgegeven aan de API. Tekenreeksmatrix met een van de volgende waarden:
'authorizationHeader'
'query'
clientAuthenticationMethod Verificatiemethode die wordt ondersteund door het tokeneindpunt van deze autorisatieserver. Mogelijke waarden zijn Basic en/of Hoofdtekst. Wanneer hoofdtekst is opgegeven, worden clientreferenties en andere parameters doorgegeven in de aanvraagbody in de indeling application/x-www-form-urlencoded. Tekenreeksmatrix met een van de volgende waarden:
'Basis'
'Hoofdtekst'
clientId Client- of app-id geregistreerd bij deze autorisatieserver. tekenreeks (vereist)
clientRegistrationEndpoint Optionele verwijzing naar een pagina waar client- of app-registratie voor deze autorisatieserver wordt uitgevoerd. Bevat de absolute URL naar de entiteit waarnaar wordt verwezen. tekenreeks (vereist)
clientSecret Client- of app-geheim dat is geregistreerd bij deze autorisatieserver. Deze eigenschap wordt niet ingevuld voor 'GET'-bewerkingen. Gebruik POST-aanvraag '/listSecrets' om de waarde op te halen. snaar

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
defaultScope Toegangstokenbereik dat standaard wordt aangevraagd. Kan worden overschreven op API-niveau. Moet worden opgegeven in de vorm van een tekenreeks die door spaties gescheiden waarden bevat. snaar
beschrijving Beschrijving van de autorisatieserver. Kan HTML-opmaaktags bevatten. snaar
displayName Gebruiksvriendelijke autorisatieservernaam. snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1 (vereist)
grantTypes Vorm van een autorisatietoekenning, die de client gebruikt om het toegangstoken aan te vragen. Tekenreeksmatrix met een van de volgende waarden:
'authorizationCode'
'clientCredentials'
'impliciet'
'resourceOwnerPassword' (vereist)
resourceOwnerPassword Kan eventueel worden opgegeven wanneer het type wachtwoordtoestemming van de resource-eigenaar wordt ondersteund door deze autorisatieserver. Standaardwachtwoord voor resource-eigenaar. snaar
resourceOwnerUsername Kan eventueel worden opgegeven wanneer het type wachtwoordtoestemming van de resource-eigenaar wordt ondersteund door deze autorisatieserver. Gebruikersnaam van standaardresource-eigenaar. snaar
supportState Indien waar, bevat de autorisatieserver de statusparameter van de autorisatieaanvraag tot het antwoord. Client kan de statusparameter gebruiken om protocolbeveiliging te verhogen. Bool
tokenBodyParameters Aanvullende parameters die zijn vereist voor het tokeneindpunt van deze autorisatieserver die worden weergegeven als een matrix van JSON-objecten met de eigenschappen van de naam- en waardetekenreeks, bijvoorbeeld {"name" : "name value", "value": "a value"}. TokenBodyParameterContract[]
tokenEndpoint OAuth-tokeneindpunt. Bevat de absolute URI naar de entiteit waarnaar wordt verwezen. snaar
useInApiDocumentation Indien waar, wordt de autorisatieserver gebruikt in de API-documentatie in de ontwikkelaarsportal. Standaard onwaar als er geen waarde is opgegeven. Bool
useInTestConsole Indien waar, kan de autorisatieserver worden gebruikt in de testconsole van de ontwikkelaarsportal. True standaard als er geen waarde wordt opgegeven. Bool

Microsoft.ApiManagement/service/authorizationServers

Naam Beschrijving Waarde
naam De resourcenaam snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1
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 Eigenschappen van het externe OAuth-autorisatieservercontract. AuthorizationServerContractProperties
type Het resourcetype "Microsoft.ApiManagement/service/authorizationServers@2023-09-01-preview"

TokenBodyParameterContract

Naam Beschrijving Waarde
naam naam van de hoofdparameter. tekenreeks (vereist)
waarde parameterwaarde van de hoofdtekst. tekenreeks (vereist)