Dela via

Microsoft.ApiManagement service/authorizationServers 2016-07-07

  • Artikel

Bicep-resursdefinition

Resurstypen tjänst/authorizationServers 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/authorizationServers-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2016-07-07' = {
  parent: resourceSymbolicName
  authorizationEndpoint: 'string'
  authorizationMethods: [
    'string'
  ]
  bearerTokenSendingMethods: [
    'string'
  ]
  clientAuthenticationMethod: [
    'string'
  ]
  clientId: 'string'
  clientRegistrationEndpoint: 'string'
  clientSecret: 'string'
  defaultScope: 'string'
  description: 'string'
  grantTypes: [
    'string'
  ]
  name: 'string'
  resourceOwnerPassword: 'string'
  resourceOwnerUsername: 'string'
  supportState: bool
  tokenBodyParameters: [
    {
      name: 'string'
      value: 'string'
    }
  ]
  tokenEndpoint: 'string'
}

Egenskapsvärden

Microsoft.ApiManagement/service/authorizationServers

Namn Beskrivning Värde
authorizationEndpoint OAuth-auktoriseringsslutpunkt. Se http://tools.ietf.org/html/rfc6749#section-3.2. sträng (krävs)
authorizationMethods HTTP-verb som stöds av auktoriseringsslutpunkten. GET måste alltid vara närvarande. POST är valfritt. Strängmatris som innehåller något av:
"TA BORT"
"GET"
"HEAD"
ALTERNATIV
"PATCH"
"POST"
"PUT"
"TRACE"
bearerTokenSendingMethods Anger den mekanism med vilken åtkomsttoken skickas till API:et. Strängmatris som innehåller något av:
"authorizationHeader"
"fråga"
clientAuthenticationMethod Autentiseringsmetod som stöds av tokenslutpunkten för den här auktoriseringsservern. Möjliga värden är Grundläggande och/eller Brödtext. När Brödtext anges skickas klientautentiseringsuppgifter och andra parametrar i begärandetexten i formatet application/x-www-form-urlencoded. Strängmatris som innehåller något av:
"Grundläggande"
"Brödtext"
clientId Klient- eller app-ID som registrerats med den här auktoriseringsservern. sträng (krävs)
clientRegistrationEndpoint Valfri referens till en sida där klient- eller appregistrering för den här auktoriseringsservern utförs. Innehåller absolut URL till entitet som refereras till. sträng (krävs)
clientSecret Klient- eller apphemlighet registrerad hos den här auktoriseringsservern. sträng
defaultScope Åtkomsttokensomfång som ska begäras som standard. Kan åsidosättas på API-nivå. Ska anges i form av en sträng som innehåller blankstegsavgränsade värden. sträng
beskrivning Beskrivning av auktoriseringsservern. Kan innehålla HTML-formateringstaggar. sträng
grantTypes Form av ett auktoriseringsbidrag som klienten använder för att begära åtkomsttoken. Strängmatris som innehåller något av:
"authorizationCode"
"clientCredentials"
"implicit"
"resourceOwnerPassword" (krävs)
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
resourceOwnerPassword Du kan också ange när resursägarens lösenordsgivningstyp stöds av den här auktoriseringsservern. Standardlösenord för resursägare. sträng
resourceOwnerUsername Du kan också ange när resursägarens lösenordsgivningstyp stöds av den här auktoriseringsservern. Standardanvändaranvändarnamn för resursägare. sträng
supportState Om sant innehåller auktoriseringsservern tillståndsparametern från auktoriseringsbegäran till svaret. Klienten kan använda tillståndsparametern för att höja protokollsäkerheten. Bool
tokenBodyParameters Ytterligare parametrar som krävs av tokenslutpunkten för den här auktoriseringsservern som representeras som en matris med JSON-objekt med egenskaper för namn och värdesträng, d.v.s. {"name" : "name value", "value": "a value"}. TokenBodyParameterContract[]
tokenEndpoint OAuth-tokenslutpunkt. Innehåller absolut URI till entitet som refereras till. sträng

TokenBodyParameterContract

Namn Beskrivning Värde
Namn namn på brödtextparameter. sträng (krävs)
värde body-parametervärde. sträng (krävs)

Resursdefinition för ARM-mall

Resurstypen tjänst/authorizationServers 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/authorizationServers-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "apiVersion": "2016-07-07",
  "name": "string",
  "authorizationEndpoint": "string",
  "authorizationMethods": [ "string" ],
  "bearerTokenSendingMethods": [ "string" ],
  "clientAuthenticationMethod": [ "string" ],
  "clientId": "string",
  "clientRegistrationEndpoint": "string",
  "clientSecret": "string",
  "defaultScope": "string",
  "description": "string",
  "grantTypes": [ "string" ],
  "resourceOwnerPassword": "string",
  "resourceOwnerUsername": "string",
  "supportState": "bool",
  "tokenBodyParameters": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "tokenEndpoint": "string"
}

Egenskapsvärden

Microsoft.ApiManagement/service/authorizationServers

Namn Beskrivning Värde
apiVersion API-versionen '2016-07-07'
authorizationEndpoint OAuth-auktoriseringsslutpunkt. Se http://tools.ietf.org/html/rfc6749#section-3.2. sträng (krävs)
authorizationMethods HTTP-verb som stöds av auktoriseringsslutpunkten. GET måste alltid vara närvarande. POST är valfritt. Strängmatris som innehåller något av:
"TA BORT"
"GET"
"HEAD"
ALTERNATIV
"PATCH"
"POST"
"PUT"
"TRACE"
bearerTokenSendingMethods Anger den mekanism med vilken åtkomsttoken skickas till API:et. Strängmatris som innehåller något av:
"authorizationHeader"
"fråga"
clientAuthenticationMethod Autentiseringsmetod som stöds av tokenslutpunkten för den här auktoriseringsservern. Möjliga värden är Grundläggande och/eller Brödtext. När Brödtext anges skickas klientautentiseringsuppgifter och andra parametrar i begärandetexten i formatet application/x-www-form-urlencoded. Strängmatris som innehåller något av:
"Grundläggande"
"Brödtext"
clientId Klient- eller app-ID som registrerats med den här auktoriseringsservern. sträng (krävs)
clientRegistrationEndpoint Valfri referens till en sida där klient- eller appregistrering för den här auktoriseringsservern utförs. Innehåller absolut URL till entitet som refereras till. sträng (krävs)
clientSecret Klient- eller apphemlighet registrerad hos den här auktoriseringsservern. sträng
defaultScope Åtkomsttokensomfång som ska begäras som standard. Kan åsidosättas på API-nivå. Ska anges i form av en sträng som innehåller blankstegsavgränsade värden. sträng
beskrivning Beskrivning av auktoriseringsservern. Kan innehålla HTML-formateringstaggar. sträng
grantTypes Form av ett auktoriseringsbidrag som klienten använder för att begära åtkomsttoken. Strängmatris som innehåller något av:
"authorizationCode"
"clientCredentials"
"implicit"
"resourceOwnerPassword" (krävs)
Namn Resursnamnet sträng

Begränsningar:
Max längd =
Mönster = ^[^*#&+:<>?]+$ (krävs)
resourceOwnerPassword Du kan också ange när resursägarens lösenordsgivningstyp stöds av den här auktoriseringsservern. Standardlösenord för resursägare. sträng
resourceOwnerUsername Du kan också ange när resursägarens lösenordsgivningstyp stöds av den här auktoriseringsservern. Standardanvändaranvändarnamn för resursägare. sträng
supportState Om sant innehåller auktoriseringsservern tillståndsparametern från auktoriseringsbegäran till svaret. Klienten kan använda tillståndsparametern för att höja protokollsäkerheten. Bool
tokenBodyParameters Ytterligare parametrar som krävs av tokenslutpunkten för den här auktoriseringsservern som representeras som en matris med JSON-objekt med egenskaper för namn och värdesträng, d.v.s. {"name" : "name value", "value": "a value"}. TokenBodyParameterContract[]
tokenEndpoint OAuth-tokenslutpunkt. Innehåller absolut URI till entitet som refereras till. sträng
typ Resurstypen "Microsoft.ApiManagement/service/authorizationServers"

TokenBodyParameterContract

Namn Beskrivning Värde
Namn namn på brödtextparameter. sträng (krävs)
värde body-parametervärde. sträng (krävs)

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen tjänst/authorizationServers 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/authorizationServers-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationServers@2016-07-07"
  name = "string"
  authorizationEndpoint = "string"
  authorizationMethods = [
    "string"
  ]
  bearerTokenSendingMethods = [
    "string"
  ]
  clientAuthenticationMethod = [
    "string"
  ]
  clientId = "string"
  clientRegistrationEndpoint = "string"
  clientSecret = "string"
  defaultScope = "string"
  description = "string"
  grantTypes = [
    "string"
  ]
  resourceOwnerPassword = "string"
  resourceOwnerUsername = "string"
  supportState = bool
  tokenBodyParameters = [
    {
      name = "string"
      value = "string"
    }
  ]
  tokenEndpoint = "string"
}

Egenskapsvärden

Microsoft.ApiManagement/service/authorizationServers

Namn Beskrivning Värde
authorizationEndpoint OAuth-auktoriseringsslutpunkt. Se http://tools.ietf.org/html/rfc6749#section-3.2. sträng (krävs)
authorizationMethods HTTP-verb som stöds av auktoriseringsslutpunkten. GET måste alltid vara närvarande. POST är valfritt. Strängmatris som innehåller något av:
"TA BORT"
"GET"
"HEAD"
ALTERNATIV
"PATCH"
"POST"
"PUT"
"TRACE"
bearerTokenSendingMethods Anger den mekanism med vilken åtkomsttoken skickas till API:et. Strängmatris som innehåller något av:
"authorizationHeader"
"fråga"
clientAuthenticationMethod Autentiseringsmetod som stöds av tokenslutpunkten för den här auktoriseringsservern. Möjliga värden är Grundläggande och/eller Brödtext. När Brödtext anges skickas klientautentiseringsuppgifter och andra parametrar i begärandetexten i formatet application/x-www-form-urlencoded. Strängmatris som innehåller något av:
"Grundläggande"
"Brödtext"
clientId Klient- eller app-ID som registrerats med den här auktoriseringsservern. sträng (krävs)
clientRegistrationEndpoint Valfri referens till en sida där klient- eller appregistrering för den här auktoriseringsservern utförs. Innehåller absolut URL till entitet som refereras till. sträng (krävs)
clientSecret Klient- eller apphemlighet registrerad hos den här auktoriseringsservern. sträng
defaultScope Åtkomsttokensomfång som ska begäras som standard. Kan åsidosättas på API-nivå. Ska anges i form av en sträng som innehåller blankstegsavgränsade värden. sträng
beskrivning Beskrivning av auktoriseringsservern. Kan innehålla HTML-formateringstaggar. sträng
grantTypes Form av ett auktoriseringsbidrag som klienten använder för att begära åtkomsttoken. Strängmatris som innehåller något av:
"authorizationCode"
"clientCredentials"
"implicit"
"resourceOwnerPassword" (krävs)
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
resourceOwnerPassword Du kan också ange när resursägarens lösenordsgivningstyp stöds av den här auktoriseringsservern. Standardlösenord för resursägare. sträng
resourceOwnerUsername Du kan också ange när resursägarens lösenordsgivningstyp stöds av den här auktoriseringsservern. Standardanvändaranvändarnamn för resursägare. sträng
supportState Om sant innehåller auktoriseringsservern tillståndsparametern från auktoriseringsbegäran till svaret. Klienten kan använda tillståndsparametern för att höja protokollsäkerheten. Bool
tokenBodyParameters Ytterligare parametrar som krävs av tokenslutpunkten för den här auktoriseringsservern som representeras som en matris med JSON-objekt med egenskaper för namn och värdesträng, d.v.s. {"name" : "name value", "value": "a value"}. TokenBodyParameterContract[]
tokenEndpoint OAuth-tokenslutpunkt. Innehåller absolut URI till entitet som refereras till. sträng
typ Resurstypen "Microsoft.ApiManagement/service/authorizationServers@2016-07-07"

TokenBodyParameterContract

Namn Beskrivning Värde
Namn namn på brödtextparameter. sträng (krävs)
värde body-parametervärde. sträng (krävs)