Microsoft.ApiManagement service/authorizationServers 2022-09-01-preview
Bicep-resursdefinition
Resurstypen service/authorizationServers kan distribueras med åtgärder som mål:
- Resursgrupper – Se distributionskommandon för 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 Bicep i mallen.
resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2022-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
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
}
}
Egenskapsvärden
service/authorizationServers
Name | Beskrivning | Värde |
---|---|---|
name | Resursnamnet Se hur du anger namn och typer för underordnade resurser i Bicep. |
sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. |
parent | 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 överordnad resurs. |
Symboliskt namn för resurs av typen: tjänst |
properties | Egenskaper för det externa OAuth-auktoriseringsserverkontraktet. | AuthorizationServerContractProperties |
AuthorizationServerContractProperties
Name | 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 finnas. POST är valfritt. | Strängmatris som innehåller något av: "TA BORT" "GET" "HEAD" "ALTERNATIV" "PATCH" "POST" "PUT" "TRACE" |
bearerTokenSendingMethods | Anger vilken mekanism som å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 på den här auktoriseringsservern. Den här egenskapen fylls inte i för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet. | 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 |
displayName | Användarvänligt auktoriseringsservernamn. | sträng (krävs) |
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) |
resourceOwnerPassword | Du kan också ange när resursägarens lösenords beviljandetyp 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ösenords beviljandetyp stöds av den här auktoriseringsservern. Standardanvändaranvändarnamn för resursägare. | sträng |
supportState | Om det är 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. | boolesk |
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, dvs. {"name" : "name value", "value": "a value"}. | TokenBodyParameterContract[] |
tokenEndpoint | OAuth-tokenslutpunkt. Innehåller absolut URI till entitet som refereras till. | sträng |
useInApiDocumentation | Om det är sant används auktoriseringsservern i API-dokumentationen i utvecklarportalen. Falskt som standard om inget värde anges. | boolesk |
useInTestConsole | Om det är sant kan auktoriseringsservern användas i testkonsolen för utvecklarportalen. Sant som standard om inget värde anges. | boolesk |
TokenBodyParameterContract
Name | Beskrivning | Värde |
---|---|---|
name | body-parameternamn. | sträng (krävs) |
värde | body-parametervärde. | sträng (krävs) |
Resursdefinition för ARM-mall
Resurstypen service/authorizationServers kan distribueras med åtgärder som mål:
- Resursgrupper – Se kommandon för resursgruppsdistribution
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Resurs för Microsoft.ApiManagement/service/authorizationServers lägger du till följande JSON i mallen.
{
"type": "Microsoft.ApiManagement/service/authorizationServers",
"apiVersion": "2022-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"
}
}
Egenskapsvärden
service/authorizationServers
Name | Beskrivning | Värde |
---|---|---|
typ | Resurstypen | "Microsoft.ApiManagement/service/authorizationServers" |
apiVersion | Resurs-API-versionen | "2022-09-01-preview" |
name | Resursnamnet Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar. |
sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. |
properties | Egenskaper för det externa OAuth-auktoriseringsserverkontraktet. | AuthorizationServerContractProperties |
AuthorizationServerContractProperties
Name | 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 på den här auktoriseringsservern. Den här egenskapen fylls inte i vid GET-åtgärder! Använd POST-begäran "/listSecrets" för att hämta värdet. | 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 |
displayName | Användarvänligt namn på auktoriseringsservern. | sträng (krävs) |
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) |
resourceOwnerPassword | Du kan också ange när resursägarens lösenords beviljandetyp 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ösenords beviljandetyp stöds av den här auktoriseringsservern. Standardanvändaranvändarnamn för resursägare. | sträng |
supportState | Om det är 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. | boolesk |
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, dvs. {"name" : "name value", "value": "a value"}. | TokenBodyParameterContract[] |
tokenEndpoint | OAuth-tokenslutpunkt. Innehåller absolut URI till entitet som refereras till. | sträng |
useInApiDocumentation | Om det är sant används auktoriseringsservern i API-dokumentationen i utvecklarportalen. Falskt som standard om inget värde anges. | boolesk |
useInTestConsole | Om det är sant kan auktoriseringsservern användas i testkonsolen för utvecklarportalen. Sant som standard om inget värde anges. | boolesk |
TokenBodyParameterContract
Name | Beskrivning | Värde |
---|---|---|
name | body-parameternamn. | sträng (krävs) |
värde | body-parametervärde. | sträng (krävs) |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen service/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 Resurs för Microsoft.ApiManagement/service/authorizationServers lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/authorizationServers@2022-09-01-preview"
name = "string"
parent_id = "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
}
})
}
Egenskapsvärden
service/authorizationServers
Name | Beskrivning | Värde |
---|---|---|
typ | Resurstypen | "Microsoft.ApiManagement/service/authorizationServers@2022-09-01-preview" |
name | Resursnamnet | sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. |
parent_id | ID för resursen som är överordnad för den här resursen. | ID för resurs av typen: tjänst |
properties | Egenskaper för det externa OAuth-auktoriseringsserverkontraktet. | AuthorizationServerContractProperties |
AuthorizationServerContractProperties
Name | 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: "DELETE" "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" "query" |
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" "Body" |
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 på den här auktoriseringsservern. Den här egenskapen fylls inte i vid GET-åtgärder! Använd POST-begäran "/listSecrets" för att hämta värdet. | 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 |
displayName | Användarvänligt namn på auktoriseringsservern. | sträng (krävs) |
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) |
resourceOwnerPassword | Du kan också ange när resursägarens lösenords beviljandetyp 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ösenords beviljandetyp stöds av den här auktoriseringsservern. Standardanvändaranvändarnamn för resursägare. | sträng |
supportState | Om det är 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. | boolesk |
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, dvs. {"name" : "name value", "value": "a value"}. | TokenBodyParameterContract[] |
tokenEndpoint | OAuth-tokenslutpunkt. Innehåller absolut URI till entitet som refereras till. | sträng |
useInApiDocumentation | Om det är sant används auktoriseringsservern i API-dokumentationen i utvecklarportalen. Falskt som standard om inget värde anges. | boolesk |
useInTestConsole | Om det är sant kan auktoriseringsservern användas i testkonsolen för utvecklarportalen. Sant som standard om inget värde anges. | boolesk |
TokenBodyParameterContract
Name | Beskrivning | Värde |
---|---|---|
name | body-parameternamn. | sträng (krävs) |
värde | body-parametervärde. | sträng (krävs) |