Sdílet prostřednictvím

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

  • Článek

Definice prostředku Bicep

Typ prostředku service/authorizationServers 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/authorizationServers, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2024-05-01' = {
  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
  }
}

Hodnoty vlastností

AuthorizationServerContractProperties

Jméno Popis Hodnota
authorizationEndpoint Koncový bod autorizace OAuth Viz http://tools.ietf.org/html/rfc6749#section-3.2. string (povinné)
authorizationMethods Příkazy HTTP podporované koncovým bodem autorizace Funkce GET musí být vždy k dispozici. POST je volitelné. Řetězcové pole obsahující některou z těchto možností:
DELETE
GET
"HEAD"
MOŽNOSTI
PATCH
POST
PUT
'TRACE'
bearerTokenSendingMethods Určuje mechanismus, pomocí kterého se přístupový token předává rozhraní API. Řetězcové pole obsahující některou z těchto možností:
AuthorizationHeader
Dotaz
clientAuthenticationMethod Metoda ověřování podporovaná koncovým bodem tokenu tohoto autorizačního serveru Možné hodnoty jsou Basic a/nebo Body. Při zadání textu se přihlašovací údaje klienta a další parametry předávají v textu požadavku ve formátu application/x-www-form-urlencoded. Řetězcové pole obsahující některou z těchto možností:
"Základní"
"Tělo"
clientId ID klienta nebo aplikace zaregistrované na tomto autorizačním serveru string (povinné)
clientRegistrationEndpoint Volitelný odkaz na stránku, na které se provádí registrace klienta nebo aplikace pro tento autorizační server. Obsahuje absolutní adresu URL odkazované na entitu. string (povinné)
clientSecret Tajný kód klienta nebo aplikace zaregistrovaný na tomto autorizačním serveru Tato vlastnost nebude vyplněna při operacích GET. K získání hodnoty použijte požadavek POST /listSecrets. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
defaultScope Obor přístupového tokenu, který se bude ve výchozím nastavení požadovat. Lze přepsat na úrovni rozhraní API. Měla by být poskytována ve formě řetězce obsahujícího hodnoty oddělené mezerami. řetězec
popis Popis autorizačního serveru Může obsahovat značky formátování HTML. řetězec
displayName Uživatelsky přívětivý název autorizačního serveru řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
grantTypes Forma udělení autorizace, kterou klient používá k vyžádání přístupového tokenu. Řetězcové pole obsahující některou z těchto možností:
AuthorizationCode
ClientCredentials
Implicitní
ResourceOwnerPassword (povinné)
resourceOwnerPassword Volitelně je možné zadat, pokud tento autorizační server podporuje typ udělení hesla vlastníka prostředku. Výchozí heslo vlastníka prostředku řetězec
resourceOwnerUsername Volitelně je možné zadat, pokud tento autorizační server podporuje typ udělení hesla vlastníka prostředku. Výchozí uživatelské jméno vlastníka prostředku řetězec
supportState Pokud je hodnota true, autorizační server do odpovědi zahrne parametr stavu z žádosti o autorizaci. Klient může ke zvýšení zabezpečení protokolu použít parametr stavu. Bool
tokenBodyParameters Další parametry vyžadované koncovým bodem tokenu tohoto autorizačního serveru reprezentované jako pole objektů JSON s vlastnostmi řetězce názvu a hodnoty, tj. {"name" : "name value", "value": "a value"}. TokenBodyParameterContract[]
tokenEndpoint Koncový bod tokenu OAuth Obsahuje absolutní identifikátor URI odkazované na entitu. řetězec
useInApiDocumentation Pokud ano, autorizační server 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, může být autorizační server použit v testovací konzole portálu pro vývojáře. Hodnota True ve výchozím nastavení platí, pokud není zadaná žádná hodnota. Bool

Microsoft.ApiManagement/service/authorizationServers

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

Omezení:
Minimální délka = 1
Maximální délka = 1
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 externího autorizačního serveru OAuth AuthorizationServerContractProperties

TokenBodyParameterContract

Jméno Popis Hodnota
Jméno název parametru body. string (povinné)
hodnota hodnota parametru body. string (povinné)

Definice prostředku šablony ARM

Typ prostředku service/authorizationServers 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/authorizationServers, přidejte do šablony následující JSON.

{
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "apiVersion": "2024-05-01",
  "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"
  }
}

Hodnoty vlastností

AuthorizationServerContractProperties

Jméno Popis Hodnota
authorizationEndpoint Koncový bod autorizace OAuth Viz http://tools.ietf.org/html/rfc6749#section-3.2. string (povinné)
authorizationMethods Příkazy HTTP podporované koncovým bodem autorizace Funkce GET musí být vždy k dispozici. POST je volitelné. Řetězcové pole obsahující některou z těchto možností:
DELETE
GET
"HEAD"
MOŽNOSTI
PATCH
POST
PUT
'TRACE'
bearerTokenSendingMethods Určuje mechanismus, pomocí kterého se přístupový token předává rozhraní API. Řetězcové pole obsahující některou z těchto možností:
AuthorizationHeader
Dotaz
clientAuthenticationMethod Metoda ověřování podporovaná koncovým bodem tokenu tohoto autorizačního serveru Možné hodnoty jsou Basic a/nebo Body. Při zadání textu se přihlašovací údaje klienta a další parametry předávají v textu požadavku ve formátu application/x-www-form-urlencoded. Řetězcové pole obsahující některou z těchto možností:
"Základní"
"Tělo"
clientId ID klienta nebo aplikace zaregistrované na tomto autorizačním serveru string (povinné)
clientRegistrationEndpoint Volitelný odkaz na stránku, na které se provádí registrace klienta nebo aplikace pro tento autorizační server. Obsahuje absolutní adresu URL odkazované na entitu. string (povinné)
clientSecret Tajný kód klienta nebo aplikace zaregistrovaný na tomto autorizačním serveru Tato vlastnost nebude vyplněna při operacích GET. K získání hodnoty použijte požadavek POST /listSecrets. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
defaultScope Obor přístupového tokenu, který se bude ve výchozím nastavení požadovat. Lze přepsat na úrovni rozhraní API. Měla by být poskytována ve formě řetězce obsahujícího hodnoty oddělené mezerami. řetězec
popis Popis autorizačního serveru Může obsahovat značky formátování HTML. řetězec
displayName Uživatelsky přívětivý název autorizačního serveru řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
grantTypes Forma udělení autorizace, kterou klient používá k vyžádání přístupového tokenu. Řetězcové pole obsahující některou z těchto možností:
AuthorizationCode
ClientCredentials
Implicitní
ResourceOwnerPassword (povinné)
resourceOwnerPassword Volitelně je možné zadat, pokud tento autorizační server podporuje typ udělení hesla vlastníka prostředku. Výchozí heslo vlastníka prostředku řetězec
resourceOwnerUsername Volitelně je možné zadat, pokud tento autorizační server podporuje typ udělení hesla vlastníka prostředku. Výchozí uživatelské jméno vlastníka prostředku řetězec
supportState Pokud je hodnota true, autorizační server do odpovědi zahrne parametr stavu z žádosti o autorizaci. Klient může ke zvýšení zabezpečení protokolu použít parametr stavu. Bool
tokenBodyParameters Další parametry vyžadované koncovým bodem tokenu tohoto autorizačního serveru reprezentované jako pole objektů JSON s vlastnostmi řetězce názvu a hodnoty, tj. {"name" : "name value", "value": "a value"}. TokenBodyParameterContract[]
tokenEndpoint Koncový bod tokenu OAuth Obsahuje absolutní identifikátor URI odkazované na entitu. řetězec
useInApiDocumentation Pokud ano, autorizační server 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, může být autorizační server použit v testovací konzole portálu pro vývojáře. Hodnota True ve výchozím nastavení platí, pokud není zadaná žádná hodnota. Bool

Microsoft.ApiManagement/service/authorizationServers

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

Omezení:
Minimální délka = 1
Maximální délka = 1
Model = ^[^*#&+:<>?]+$ (povinné)
vlastnosti Vlastnosti kontraktu externího autorizačního serveru OAuth AuthorizationServerContractProperties
typ Typ prostředku Microsoft.ApiManagement/service/authorizationServers

TokenBodyParameterContract

Jméno Popis Hodnota
Jméno název parametru body. string (povinné)
hodnota hodnota parametru body. string (povinné)

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku service/authorizationServers 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/authorizationServers, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationServers@2024-05-01"
  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
    }
  })
}

Hodnoty vlastností

AuthorizationServerContractProperties

Jméno Popis Hodnota
authorizationEndpoint Koncový bod autorizace OAuth Viz http://tools.ietf.org/html/rfc6749#section-3.2. string (povinné)
authorizationMethods Příkazy HTTP podporované koncovým bodem autorizace Funkce GET musí být vždy k dispozici. POST je volitelné. Řetězcové pole obsahující některou z těchto možností:
DELETE
GET
"HEAD"
MOŽNOSTI
PATCH
POST
PUT
'TRACE'
bearerTokenSendingMethods Určuje mechanismus, pomocí kterého se přístupový token předává rozhraní API. Řetězcové pole obsahující některou z těchto možností:
AuthorizationHeader
Dotaz
clientAuthenticationMethod Metoda ověřování podporovaná koncovým bodem tokenu tohoto autorizačního serveru Možné hodnoty jsou Basic a/nebo Body. Při zadání textu se přihlašovací údaje klienta a další parametry předávají v textu požadavku ve formátu application/x-www-form-urlencoded. Řetězcové pole obsahující některou z těchto možností:
"Základní"
"Tělo"
clientId ID klienta nebo aplikace zaregistrované na tomto autorizačním serveru string (povinné)
clientRegistrationEndpoint Volitelný odkaz na stránku, na které se provádí registrace klienta nebo aplikace pro tento autorizační server. Obsahuje absolutní adresu URL odkazované na entitu. string (povinné)
clientSecret Tajný kód klienta nebo aplikace zaregistrovaný na tomto autorizačním serveru Tato vlastnost nebude vyplněna při operacích GET. K získání hodnoty použijte požadavek POST /listSecrets. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
defaultScope Obor přístupového tokenu, který se bude ve výchozím nastavení požadovat. Lze přepsat na úrovni rozhraní API. Měla by být poskytována ve formě řetězce obsahujícího hodnoty oddělené mezerami. řetězec
popis Popis autorizačního serveru Může obsahovat značky formátování HTML. řetězec
displayName Uživatelsky přívětivý název autorizačního serveru řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
grantTypes Forma udělení autorizace, kterou klient používá k vyžádání přístupového tokenu. Řetězcové pole obsahující některou z těchto možností:
AuthorizationCode
ClientCredentials
Implicitní
ResourceOwnerPassword (povinné)
resourceOwnerPassword Volitelně je možné zadat, pokud tento autorizační server podporuje typ udělení hesla vlastníka prostředku. Výchozí heslo vlastníka prostředku řetězec
resourceOwnerUsername Volitelně je možné zadat, pokud tento autorizační server podporuje typ udělení hesla vlastníka prostředku. Výchozí uživatelské jméno vlastníka prostředku řetězec
supportState Pokud je hodnota true, autorizační server do odpovědi zahrne parametr stavu z žádosti o autorizaci. Klient může ke zvýšení zabezpečení protokolu použít parametr stavu. Bool
tokenBodyParameters Další parametry vyžadované koncovým bodem tokenu tohoto autorizačního serveru reprezentované jako pole objektů JSON s vlastnostmi řetězce názvu a hodnoty, tj. {"name" : "name value", "value": "a value"}. TokenBodyParameterContract[]
tokenEndpoint Koncový bod tokenu OAuth Obsahuje absolutní identifikátor URI odkazované na entitu. řetězec
useInApiDocumentation Pokud ano, autorizační server 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, může být autorizační server použit v testovací konzole portálu pro vývojáře. Hodnota True ve výchozím nastavení platí, pokud není zadaná žádná hodnota. Bool

Microsoft.ApiManagement/service/authorizationServers

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

Omezení:
Minimální délka = 1
Maximální délka = 1
Model = ^[^*#&+:<>?]+$ (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: služby
vlastnosti Vlastnosti kontraktu externího autorizačního serveru OAuth AuthorizationServerContractProperties
typ Typ prostředku Microsoft.ApiManagement/service/authorizationServers@2024-05-01

TokenBodyParameterContract

Jméno Popis Hodnota
Jméno název parametru body. string (povinné)
hodnota hodnota parametru body. string (povinné)