Microsoft.ApiManagement hizmeti/authorizationServers
Bicep kaynak tanımı
Service/authorizationServers kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:
- kaynak grupları
- Bkz. kaynak grubu dağıtım komutları
Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.
Kaynak biçimi
Microsoft.ApiManagement/service/authorizationServers kaynağı oluşturmak için, şablonunuza aşağıdaki Bicep'i ekleyin.
resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2023-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
}
}
Özellik değerleri
service/authorizationServers
Ad | Açıklama | Değer |
---|---|---|
ad | Kaynak adı Bicep'nde alt kaynaklar için adları ve türleri ayarlamayı öğrenin. |
dize (gerekli) Karakter sınırı: 1-80 Geçerli karakterler: Alfasayısallar ve kısa çizgiler. Harfle başlayın ve alfasayısal ile bitirin. |
ebeveyn | Bicep'te bir alt kaynak için üst kaynak belirtebilirsiniz. Bu özelliği yalnızca alt kaynak üst kaynağın dışında bildirildiğinde eklemeniz gerekir. Daha fazla bilgi için bkz. Alt kaynaküst kaynak dışında. |
Kaynak türü için sembolik ad: hizmet |
Özellikler | Dış OAuth yetkilendirme sunucusu Sözleşmesi'nin özellikleri. | AuthorizationServerContractProperties |
AuthorizationServerContractProperties
Ad | Açıklama | Değer |
---|---|---|
authorizationEndpoint | OAuth yetkilendirme uç noktası. Bkz. http://tools.ietf.org/html/rfc6749#section-3.2. |
dize (gerekli) |
authorizationMethods | Yetkilendirme uç noktası tarafından desteklenen HTTP fiilleri. GET her zaman mevcut olmalıdır. POST isteğe bağlıdır. | Herhangi birini içeren dize dizisi: 'DELETE' 'GET' 'HEAD' 'SEÇENEKLER' 'PATCH' 'POST' 'PUT' 'TRACE' |
bearerTokenSendingMethods | Erişim belirtecinin API'ye geçirildiği mekanizmayı belirtir. | Herhangi birini içeren dize dizisi: 'authorizationHeader' 'query' |
clientAuthenticationMethod | Bu yetkilendirme sunucusunun belirteç uç noktası tarafından desteklenen kimlik doğrulama yöntemi. Olası değerler Temel ve/veya Gövde'dir. Gövde belirtildiğinde, istemci kimlik bilgileri ve diğer parametreler istek gövdesi içinde application/x-www-form-urlencoded biçiminde geçirilir. | Herhangi birini içeren dize dizisi: 'Temel' 'Gövde' |
clientId | Bu yetkilendirme sunucusuna kayıtlı istemci veya uygulama kimliği. | dize (gerekli) |
clientRegistrationEndpoint | Bu yetkilendirme sunucusu için istemci veya uygulama kaydının gerçekleştirildiği bir sayfaya isteğe bağlı başvuru. Başvurulmakta olan varlığın mutlak URL'sini içerir. | dize (gerekli) |
clientSecret | Bu yetkilendirme sunucusuna kaydedilen istemci veya uygulama gizli dizisi. Bu özellik 'GET' işlemlerinde doldurulmayacak! Değeri almak için '/listSecrets' POST isteğini kullanın. | dizgi Kısıtlama -ları: Hassas değer. Güvenli parametre olarak geçirin. |
defaultScope | Varsayılan olarak istenecek erişim belirteci kapsamı. API düzeyinde geçersiz kılınabilir. Boşlukla ayrılmış değerler içeren bir dize biçiminde sağlanmalıdır. | dizgi |
Açıklama | Yetkilendirme sunucusunun açıklaması. HTML biçimlendirme etiketleri içerebilir. | dizgi |
displayName | Kullanıcı dostu yetkilendirme sunucusu adı. | dize (gerekli) Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 50 |
grantTypes | İstemcinin erişim belirtecini istemek için kullandığı yetkilendirme verme biçimi. | Herhangi birini içeren dize dizisi: 'authorizationCode' 'clientCredentials' 'örtük' 'resourceOwnerPassword' (gerekli) |
resourceOwnerPassword | Kaynak sahibi parola verme türü bu yetkilendirme sunucusu tarafından desteklendiğinde isteğe bağlı olarak belirtilebilir. Varsayılan kaynak sahibi parolası. | dizgi |
resourceOwnerUsername | Kaynak sahibi parola verme türü bu yetkilendirme sunucusu tarafından desteklendiğinde isteğe bağlı olarak belirtilebilir. Varsayılan kaynak sahibi kullanıcı adı. | dizgi |
supportState | Doğruysa, yetkilendirme sunucusu yetkilendirme isteğinden yanıtına durum parametresini ekler. İstemci, protokol güvenliğini artırmak için durum parametresini kullanabilir. | Bool |
tokenBodyParameters | Bu yetkilendirme sunucusunun belirteç uç noktası için gereken ek parametreler, ad ve değer dizesi özelliklerine sahip bir JSON nesneleri dizisi olarak temsil edilir, örneğin {"name" : "name value", "value": "a value"}. | TokenBodyParameterContract[] |
tokenEndpoint | OAuth belirteci uç noktası. Başvurulmakta olan varlığa mutlak URI içerir. | dizgi |
useInApiDocumentation | Doğruysa, yetkilendirme sunucusu geliştirici portalındaki API belgelerinde kullanılır. Değer sağlanmazsa varsayılan olarak false olur. | Bool |
useInTestConsole | Doğruysa, yetkilendirme sunucusu geliştirici portalı test konsolunda kullanılabilir. Değer sağlanmazsa varsayılan olarak True olur. | Bool |
TokenBodyParameterContract
Ad | Açıklama | Değer |
---|---|---|
ad | gövde parametresi adı. | dize (gerekli) |
değer | gövde parametresi değeri. | dize (gerekli) |
ARM şablonu kaynak tanımı
Service/authorizationServers kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:
- kaynak grupları
- Bkz. kaynak grubu dağıtım komutları
Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.
Kaynak biçimi
Microsoft.ApiManagement/service/authorizationServers kaynağı oluşturmak için şablonunuza aşağıdaki JSON'u ekleyin.
{
"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"
}
}
Özellik değerleri
service/authorizationServers
Ad | Açıklama | Değer |
---|---|---|
tür | Kaynak türü | 'Microsoft.ApiManagement/service/authorizationServers' |
apiVersion | Kaynak API'sinin sürümü | '2023-09-01-preview' |
ad | Kaynak adı |
dize (gerekli) Karakter sınırı: 1-80 Geçerli karakterler: Alfasayısallar ve kısa çizgiler. Harfle başlayın ve alfasayısal ile bitirin. |
Özellikler | Dış OAuth yetkilendirme sunucusu Sözleşmesi'nin özellikleri. | AuthorizationServerContractProperties |
AuthorizationServerContractProperties
Ad | Açıklama | Değer |
---|---|---|
authorizationEndpoint | OAuth yetkilendirme uç noktası. Bkz. http://tools.ietf.org/html/rfc6749#section-3.2. |
dize (gerekli) |
authorizationMethods | Yetkilendirme uç noktası tarafından desteklenen HTTP fiilleri. GET her zaman mevcut olmalıdır. POST isteğe bağlıdır. | Herhangi birini içeren dize dizisi: 'DELETE' 'GET' 'HEAD' 'SEÇENEKLER' 'PATCH' 'POST' 'PUT' 'TRACE' |
bearerTokenSendingMethods | Erişim belirtecinin API'ye geçirildiği mekanizmayı belirtir. | Herhangi birini içeren dize dizisi: 'authorizationHeader' 'query' |
clientAuthenticationMethod | Bu yetkilendirme sunucusunun belirteç uç noktası tarafından desteklenen kimlik doğrulama yöntemi. Olası değerler Temel ve/veya Gövde'dir. Gövde belirtildiğinde, istemci kimlik bilgileri ve diğer parametreler istek gövdesi içinde application/x-www-form-urlencoded biçiminde geçirilir. | Herhangi birini içeren dize dizisi: 'Temel' 'Gövde' |
clientId | Bu yetkilendirme sunucusuna kayıtlı istemci veya uygulama kimliği. | dize (gerekli) |
clientRegistrationEndpoint | Bu yetkilendirme sunucusu için istemci veya uygulama kaydının gerçekleştirildiği bir sayfaya isteğe bağlı başvuru. Başvurulmakta olan varlığın mutlak URL'sini içerir. | dize (gerekli) |
clientSecret | Bu yetkilendirme sunucusuna kaydedilen istemci veya uygulama gizli dizisi. Bu özellik 'GET' işlemlerinde doldurulmayacak! Değeri almak için '/listSecrets' POST isteğini kullanın. | dizgi Kısıtlama -ları: Hassas değer. Güvenli parametre olarak geçirin. |
defaultScope | Varsayılan olarak istenecek erişim belirteci kapsamı. API düzeyinde geçersiz kılınabilir. Boşlukla ayrılmış değerler içeren bir dize biçiminde sağlanmalıdır. | dizgi |
Açıklama | Yetkilendirme sunucusunun açıklaması. HTML biçimlendirme etiketleri içerebilir. | dizgi |
displayName | Kullanıcı dostu yetkilendirme sunucusu adı. | dize (gerekli) Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 50 |
grantTypes | İstemcinin erişim belirtecini istemek için kullandığı yetkilendirme verme biçimi. | Herhangi birini içeren dize dizisi: 'authorizationCode' 'clientCredentials' 'örtük' 'resourceOwnerPassword' (gerekli) |
resourceOwnerPassword | Kaynak sahibi parola verme türü bu yetkilendirme sunucusu tarafından desteklendiğinde isteğe bağlı olarak belirtilebilir. Varsayılan kaynak sahibi parolası. | dizgi |
resourceOwnerUsername | Kaynak sahibi parola verme türü bu yetkilendirme sunucusu tarafından desteklendiğinde isteğe bağlı olarak belirtilebilir. Varsayılan kaynak sahibi kullanıcı adı. | dizgi |
supportState | Doğruysa, yetkilendirme sunucusu yetkilendirme isteğinden yanıtına durum parametresini ekler. İstemci, protokol güvenliğini artırmak için durum parametresini kullanabilir. | Bool |
tokenBodyParameters | Bu yetkilendirme sunucusunun belirteç uç noktası için gereken ek parametreler, ad ve değer dizesi özelliklerine sahip bir JSON nesneleri dizisi olarak temsil edilir, örneğin {"name" : "name value", "value": "a value"}. | TokenBodyParameterContract[] |
tokenEndpoint | OAuth belirteci uç noktası. Başvurulmakta olan varlığa mutlak URI içerir. | dizgi |
useInApiDocumentation | Doğruysa, yetkilendirme sunucusu geliştirici portalındaki API belgelerinde kullanılır. Değer sağlanmazsa varsayılan olarak false olur. | Bool |
useInTestConsole | Doğruysa, yetkilendirme sunucusu geliştirici portalı test konsolunda kullanılabilir. Değer sağlanmazsa varsayılan olarak True olur. | Bool |
TokenBodyParameterContract
Ad | Açıklama | Değer |
---|---|---|
ad | gövde parametresi adı. | dize (gerekli) |
değer | gövde parametresi değeri. | dize (gerekli) |
Terraform (AzAPI sağlayıcısı) kaynak tanımı
Service/authorizationServers kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:
- Kaynak grupları
Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.
Kaynak biçimi
Microsoft.ApiManagement/service/authorizationServers kaynağı oluşturmak için şablonunuza aşağıdaki Terraform'u ekleyin.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/authorizationServers@2023-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
}
})
}
Özellik değerleri
service/authorizationServers
Ad | Açıklama | Değer |
---|---|---|
tür | Kaynak türü | "Microsoft.ApiManagement/service/authorizationServers@2023-09-01-preview" |
ad | Kaynak adı | dize (gerekli) Karakter sınırı: 1-80 Geçerli karakterler: Alfasayısallar ve kısa çizgiler. Harfle başlayın ve alfasayısal ile bitirin. |
parent_id | Bu kaynağın üst öğesi olan kaynağın kimliği. | Kaynak türü için kimlik: hizmet |
Özellikler | Dış OAuth yetkilendirme sunucusu Sözleşmesi'nin özellikleri. | AuthorizationServerContractProperties |
AuthorizationServerContractProperties
Ad | Açıklama | Değer |
---|---|---|
authorizationEndpoint | OAuth yetkilendirme uç noktası. Bkz. http://tools.ietf.org/html/rfc6749#section-3.2. |
dize (gerekli) |
authorizationMethods | Yetkilendirme uç noktası tarafından desteklenen HTTP fiilleri. GET her zaman mevcut olmalıdır. POST isteğe bağlıdır. | Herhangi birini içeren dize dizisi: "DELETE" "GET" "HEAD" "SEÇENEKLER" "PATCH" "POST" "PUT" "İZLEME" |
bearerTokenSendingMethods | Erişim belirtecinin API'ye geçirildiği mekanizmayı belirtir. | Herhangi birini içeren dize dizisi: "authorizationHeader" "query" |
clientAuthenticationMethod | Bu yetkilendirme sunucusunun belirteç uç noktası tarafından desteklenen kimlik doğrulama yöntemi. Olası değerler Temel ve/veya Gövde'dir. Gövde belirtildiğinde, istemci kimlik bilgileri ve diğer parametreler istek gövdesi içinde application/x-www-form-urlencoded biçiminde geçirilir. | Herhangi birini içeren dize dizisi: "Temel" "Gövde" |
clientId | Bu yetkilendirme sunucusuna kayıtlı istemci veya uygulama kimliği. | dize (gerekli) |
clientRegistrationEndpoint | Bu yetkilendirme sunucusu için istemci veya uygulama kaydının gerçekleştirildiği bir sayfaya isteğe bağlı başvuru. Başvurulmakta olan varlığın mutlak URL'sini içerir. | dize (gerekli) |
clientSecret | Bu yetkilendirme sunucusuna kaydedilen istemci veya uygulama gizli dizisi. Bu özellik 'GET' işlemlerinde doldurulmayacak! Değeri almak için '/listSecrets' POST isteğini kullanın. | dizgi Kısıtlama -ları: Hassas değer. Güvenli parametre olarak geçirin. |
defaultScope | Varsayılan olarak istenecek erişim belirteci kapsamı. API düzeyinde geçersiz kılınabilir. Boşlukla ayrılmış değerler içeren bir dize biçiminde sağlanmalıdır. | dizgi |
Açıklama | Yetkilendirme sunucusunun açıklaması. HTML biçimlendirme etiketleri içerebilir. | dizgi |
displayName | Kullanıcı dostu yetkilendirme sunucusu adı. | dize (gerekli) Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 50 |
grantTypes | İstemcinin erişim belirtecini istemek için kullandığı yetkilendirme verme biçimi. | Herhangi birini içeren dize dizisi: "authorizationCode" "clientCredentials" "örtük" "resourceOwnerPassword" (gerekli) |
resourceOwnerPassword | Kaynak sahibi parola verme türü bu yetkilendirme sunucusu tarafından desteklendiğinde isteğe bağlı olarak belirtilebilir. Varsayılan kaynak sahibi parolası. | dizgi |
resourceOwnerUsername | Kaynak sahibi parola verme türü bu yetkilendirme sunucusu tarafından desteklendiğinde isteğe bağlı olarak belirtilebilir. Varsayılan kaynak sahibi kullanıcı adı. | dizgi |
supportState | Doğruysa, yetkilendirme sunucusu yetkilendirme isteğinden yanıtına durum parametresini ekler. İstemci, protokol güvenliğini artırmak için durum parametresini kullanabilir. | Bool |
tokenBodyParameters | Bu yetkilendirme sunucusunun belirteç uç noktası için gereken ek parametreler, ad ve değer dizesi özelliklerine sahip bir JSON nesneleri dizisi olarak temsil edilir, örneğin {"name" : "name value", "value": "a value"}. | TokenBodyParameterContract[] |
tokenEndpoint | OAuth belirteci uç noktası. Başvurulmakta olan varlığa mutlak URI içerir. | dizgi |
useInApiDocumentation | Doğruysa, yetkilendirme sunucusu geliştirici portalındaki API belgelerinde kullanılır. Değer sağlanmazsa varsayılan olarak false olur. | Bool |
useInTestConsole | Doğruysa, yetkilendirme sunucusu geliştirici portalı test konsolunda kullanılabilir. Değer sağlanmazsa varsayılan olarak True olur. | Bool |
TokenBodyParameterContract
Ad | Açıklama | Değer |
---|---|---|
ad | gövde parametresi adı. | dize (gerekli) |
değer | gövde parametresi değeri. | dize (gerekli) |