Udostępnij za pośrednictwem

Microsoft.ApiManagement service/authorizationServers 2021-12-01-preview

  • Artykuł

Definicja zasobu Bicep

Typ zasobu service/authorizationServers można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/authorizationServers, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2021-12-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'
  }
}

Wartości właściwości

AuthorizationServerContractProperties

Nazwa Opis Wartość
authorizationEndpoint Punkt końcowy autoryzacji OAuth. Zobacz http://tools.ietf.org/html/rfc6749#section-3.2. ciąg (wymagany)
authorizationMethods Czasowniki HTTP obsługiwane przez punkt końcowy autoryzacji. Funkcja GET musi być zawsze obecna. Post jest opcjonalny. Tablica ciągów zawierająca dowolną z:
"DELETE"
"GET"
"HEAD"
"OPCJE"
"PATCH"
"POST"
"PUT"
"TRACE"
bearerTokenSendingMethods Określa mechanizm, za pomocą którego token dostępu jest przekazywany do interfejsu API. Tablica ciągów zawierająca dowolną z:
"authorizationHeader"
"zapytanie"
clientAuthenticationMethod Metoda uwierzytelniania obsługiwana przez punkt końcowy tokenu tego serwera autoryzacji. Możliwe wartości to Podstawowa i/lub Treść. Po określeniu treści poświadczenia klienta i inne parametry są przekazywane w treści żądania w formacie application/x-www-form-urlencoded. Tablica ciągów zawierająca dowolną z:
"Podstawowa"
"Treść"
clientId Identyfikator klienta lub aplikacji zarejestrowany na tym serwerze autoryzacji. ciąg (wymagany)
clientRegistrationEndpoint Opcjonalne odwołanie do strony, na której jest wykonywana rejestracja klienta lub aplikacji dla tego serwera autoryzacji. Zawiera bezwzględny adres URL do przywoływanej jednostki. ciąg (wymagany)
clientSecret Klucz tajny klienta lub aplikacji zarejestrowany na tym serwerze autoryzacji. Ta właściwość nie zostanie wypełniona na operacjach "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość. struna

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr.
defaultScope Zakres tokenu dostępu, który będzie domyślnie żądany. Można zastąpić na poziomie interfejsu API. Należy podać w postaci ciągu zawierającego wartości rozdzielane spacjami. struna
opis Opis serwera autoryzacji. Może zawierać tagi formatowania HTML. struna
displayName Przyjazna dla użytkownika nazwa serwera autoryzacji. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 50 (wymagane)
grantTypes Formularz udzielenia autoryzacji, którego klient używa do żądania tokenu dostępu. Tablica ciągów zawierająca dowolną z:
"authorizationCode"
"clientCredentials"
"niejawny"
"resourceOwnerPassword" (wymagane)
resourceOwnerPassword Opcjonalnie można określić, gdy typ udzielenia hasła właściciela zasobu jest obsługiwany przez ten serwer autoryzacji. Domyślne hasło właściciela zasobu. struna
resourceOwnerUsername Opcjonalnie można określić, gdy typ udzielenia hasła właściciela zasobu jest obsługiwany przez ten serwer autoryzacji. Domyślna nazwa użytkownika właściciela zasobu. struna
supportState Jeśli wartość true, serwer autoryzacji będzie zawierać parametr stanu z żądania autoryzacji do odpowiedzi. Klient może użyć parametru stanu w celu podniesienia zabezpieczeń protokołu. Bool
tokenBodyParameters Dodatkowe parametry wymagane przez punkt końcowy tokenu tego serwera autoryzacji reprezentowane jako tablica obiektów JSON z właściwościami nazwy i ciągu wartości, tj. {"name" : "name value", "value": "a value"}. TokenBodyParameterContract[]
tokenEndpoint Punkt końcowy tokenu OAuth. Zawiera bezwzględny identyfikator URI do przywoływanej jednostki. struna

Microsoft.ApiManagement/service/authorizationServers

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 80
Wzorzec = ^[^*#&+:<>?]+$ (wymagane)
rodzic W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.		 Nazwa symboliczna zasobu typu: usługi
Właściwości Właściwości zewnętrznego kontraktu serwera autoryzacji OAuth. AuthorizationServerContractProperties

TokenBodyParameterContract

Nazwa Opis Wartość
nazwa nazwa parametru body. ciąg (wymagany)
wartość wartość parametru body. ciąg (wymagany)

Definicja zasobu szablonu usługi ARM

Typ zasobu service/authorizationServers można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/authorizationServers, dodaj następujący kod JSON do szablonu.

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

Wartości właściwości

AuthorizationServerContractProperties

Nazwa Opis Wartość
authorizationEndpoint Punkt końcowy autoryzacji OAuth. Zobacz http://tools.ietf.org/html/rfc6749#section-3.2. ciąg (wymagany)
authorizationMethods Czasowniki HTTP obsługiwane przez punkt końcowy autoryzacji. Funkcja GET musi być zawsze obecna. Post jest opcjonalny. Tablica ciągów zawierająca dowolną z:
"DELETE"
"GET"
"HEAD"
"OPCJE"
"PATCH"
"POST"
"PUT"
"TRACE"
bearerTokenSendingMethods Określa mechanizm, za pomocą którego token dostępu jest przekazywany do interfejsu API. Tablica ciągów zawierająca dowolną z:
"authorizationHeader"
"zapytanie"
clientAuthenticationMethod Metoda uwierzytelniania obsługiwana przez punkt końcowy tokenu tego serwera autoryzacji. Możliwe wartości to Podstawowa i/lub Treść. Po określeniu treści poświadczenia klienta i inne parametry są przekazywane w treści żądania w formacie application/x-www-form-urlencoded. Tablica ciągów zawierająca dowolną z:
"Podstawowa"
"Treść"
clientId Identyfikator klienta lub aplikacji zarejestrowany na tym serwerze autoryzacji. ciąg (wymagany)
clientRegistrationEndpoint Opcjonalne odwołanie do strony, na której jest wykonywana rejestracja klienta lub aplikacji dla tego serwera autoryzacji. Zawiera bezwzględny adres URL do przywoływanej jednostki. ciąg (wymagany)
clientSecret Klucz tajny klienta lub aplikacji zarejestrowany na tym serwerze autoryzacji. Ta właściwość nie zostanie wypełniona na operacjach "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość. struna

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr.
defaultScope Zakres tokenu dostępu, który będzie domyślnie żądany. Można zastąpić na poziomie interfejsu API. Należy podać w postaci ciągu zawierającego wartości rozdzielane spacjami. struna
opis Opis serwera autoryzacji. Może zawierać tagi formatowania HTML. struna
displayName Przyjazna dla użytkownika nazwa serwera autoryzacji. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 50 (wymagane)
grantTypes Formularz udzielenia autoryzacji, którego klient używa do żądania tokenu dostępu. Tablica ciągów zawierająca dowolną z:
"authorizationCode"
"clientCredentials"
"niejawny"
"resourceOwnerPassword" (wymagane)
resourceOwnerPassword Opcjonalnie można określić, gdy typ udzielenia hasła właściciela zasobu jest obsługiwany przez ten serwer autoryzacji. Domyślne hasło właściciela zasobu. struna
resourceOwnerUsername Opcjonalnie można określić, gdy typ udzielenia hasła właściciela zasobu jest obsługiwany przez ten serwer autoryzacji. Domyślna nazwa użytkownika właściciela zasobu. struna
supportState Jeśli wartość true, serwer autoryzacji będzie zawierać parametr stanu z żądania autoryzacji do odpowiedzi. Klient może użyć parametru stanu w celu podniesienia zabezpieczeń protokołu. Bool
tokenBodyParameters Dodatkowe parametry wymagane przez punkt końcowy tokenu tego serwera autoryzacji reprezentowane jako tablica obiektów JSON z właściwościami nazwy i ciągu wartości, tj. {"name" : "name value", "value": "a value"}. TokenBodyParameterContract[]
tokenEndpoint Punkt końcowy tokenu OAuth. Zawiera bezwzględny identyfikator URI do przywoływanej jednostki. struna

Microsoft.ApiManagement/service/authorizationServers

Nazwa Opis Wartość
apiVersion Wersja interfejsu API "2021-12-01-preview"
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 80
Wzorzec = ^[^*#&+:<>?]+$ (wymagane)
Właściwości Właściwości zewnętrznego kontraktu serwera autoryzacji OAuth. AuthorizationServerContractProperties
typ Typ zasobu "Microsoft.ApiManagement/service/authorizationServers"

TokenBodyParameterContract

Nazwa Opis Wartość
nazwa nazwa parametru body. ciąg (wymagany)
wartość wartość parametru body. ciąg (wymagany)

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu service/authorizationServers można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/authorizationServers, dodaj następujący program Terraform do szablonu.

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

Wartości właściwości

AuthorizationServerContractProperties

Nazwa Opis Wartość
authorizationEndpoint Punkt końcowy autoryzacji OAuth. Zobacz http://tools.ietf.org/html/rfc6749#section-3.2. ciąg (wymagany)
authorizationMethods Czasowniki HTTP obsługiwane przez punkt końcowy autoryzacji. Funkcja GET musi być zawsze obecna. Post jest opcjonalny. Tablica ciągów zawierająca dowolną z:
"DELETE"
"GET"
"HEAD"
"OPCJE"
"PATCH"
"POST"
"PUT"
"TRACE"
bearerTokenSendingMethods Określa mechanizm, za pomocą którego token dostępu jest przekazywany do interfejsu API. Tablica ciągów zawierająca dowolną z:
"authorizationHeader"
"zapytanie"
clientAuthenticationMethod Metoda uwierzytelniania obsługiwana przez punkt końcowy tokenu tego serwera autoryzacji. Możliwe wartości to Podstawowa i/lub Treść. Po określeniu treści poświadczenia klienta i inne parametry są przekazywane w treści żądania w formacie application/x-www-form-urlencoded. Tablica ciągów zawierająca dowolną z:
"Podstawowa"
"Treść"
clientId Identyfikator klienta lub aplikacji zarejestrowany na tym serwerze autoryzacji. ciąg (wymagany)
clientRegistrationEndpoint Opcjonalne odwołanie do strony, na której jest wykonywana rejestracja klienta lub aplikacji dla tego serwera autoryzacji. Zawiera bezwzględny adres URL do przywoływanej jednostki. ciąg (wymagany)
clientSecret Klucz tajny klienta lub aplikacji zarejestrowany na tym serwerze autoryzacji. Ta właściwość nie zostanie wypełniona na operacjach "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość. struna

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr.
defaultScope Zakres tokenu dostępu, który będzie domyślnie żądany. Można zastąpić na poziomie interfejsu API. Należy podać w postaci ciągu zawierającego wartości rozdzielane spacjami. struna
opis Opis serwera autoryzacji. Może zawierać tagi formatowania HTML. struna
displayName Przyjazna dla użytkownika nazwa serwera autoryzacji. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 50 (wymagane)
grantTypes Formularz udzielenia autoryzacji, którego klient używa do żądania tokenu dostępu. Tablica ciągów zawierająca dowolną z:
"authorizationCode"
"clientCredentials"
"niejawny"
"resourceOwnerPassword" (wymagane)
resourceOwnerPassword Opcjonalnie można określić, gdy typ udzielenia hasła właściciela zasobu jest obsługiwany przez ten serwer autoryzacji. Domyślne hasło właściciela zasobu. struna
resourceOwnerUsername Opcjonalnie można określić, gdy typ udzielenia hasła właściciela zasobu jest obsługiwany przez ten serwer autoryzacji. Domyślna nazwa użytkownika właściciela zasobu. struna
supportState Jeśli wartość true, serwer autoryzacji będzie zawierać parametr stanu z żądania autoryzacji do odpowiedzi. Klient może użyć parametru stanu w celu podniesienia zabezpieczeń protokołu. Bool
tokenBodyParameters Dodatkowe parametry wymagane przez punkt końcowy tokenu tego serwera autoryzacji reprezentowane jako tablica obiektów JSON z właściwościami nazwy i ciągu wartości, tj. {"name" : "name value", "value": "a value"}. TokenBodyParameterContract[]
tokenEndpoint Punkt końcowy tokenu OAuth. Zawiera bezwzględny identyfikator URI do przywoływanej jednostki. struna

Microsoft.ApiManagement/service/authorizationServers

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 80
Wzorzec = ^[^*#&+:<>?]+$ (wymagane)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: usługi
Właściwości Właściwości zewnętrznego kontraktu serwera autoryzacji OAuth. AuthorizationServerContractProperties
typ Typ zasobu "Microsoft.ApiManagement/service/authorizationServers@2021-12-01-preview"

TokenBodyParameterContract

Nazwa Opis Wartość
nazwa nazwa parametru body. ciąg (wymagany)
wartość wartość parametru body. ciąg (wymagany)