AuthorizationServerUpdateContract interface

Paket:

@azure/arm-apimanagement

Dış OAuth yetkilendirme sunucusu ayarları.

Extends

ProxyResource

Özellikler

authorizationEndpoint	OAuth yetkilendirme uç noktası. Bkz. http://tools.ietf.org/html/rfc6749#section-3.2.
authorizationMethods	Yetkilendirme uç noktası tarafından desteklenen HTTP fiilleri. GET her zaman mevcut olmalıdır. POST isteğe bağlıdır.
bearerTokenSendingMethods	Erişim belirtecinin API'ye geçirildiği mekanizmayı belirtir.
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.
clientId	Bu yetkilendirme sunucusuna kayıtlı istemci veya uygulama kimliği.
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.
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.
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.
description	Yetkilendirme sunucusunun açıklaması. HTML biçimlendirme etiketleri içerebilir.
displayName	Kullanıcı dostu yetkilendirme sunucusu adı.
grantTypes	İstemcinin erişim belirtecini istemek için kullandığı yetkilendirme verme biçimi.
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ı.
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ı.
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.
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"}.
tokenEndpoint	OAuth belirteci uç noktası. Başvurulmakta olan varlığa mutlak URI içerir.
useInApiDocumentation	Doğruysa, yetkilendirme sunucusu geliştirici portalındaki API belgelerinde kullanılır. Değer sağlanmazsa varsayılan olarak false olur.
useInTestConsole	Doğruysa, yetkilendirme sunucusu geliştirici portalı test konsolunda kullanılabilir. Değer sağlanmazsa varsayılan olarak True olur.

Devralınan Özellikler

id	Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.
name	Kaynağın adı NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.
type	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts" NOT: Bu özellik seri hale getirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.

Özellik Ayrıntıları

authorizationEndpoint

OAuth yetkilendirme uç noktası. Bkz. http://tools.ietf.org/html/rfc6749#section-3.2.

authorizationEndpoint?: string

Özellik Değeri

string

authorizationMethods

Yetkilendirme uç noktası tarafından desteklenen HTTP fiilleri. GET her zaman mevcut olmalıdır. POST isteğe bağlıdır.

authorizationMethods?: AuthorizationMethod[]

Özellik Değeri

AuthorizationMethod[]

bearerTokenSendingMethods

Erişim belirtecinin API'ye geçirildiği mekanizmayı belirtir.

bearerTokenSendingMethods?: string[]

Özellik Değeri

string[]

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.

clientAuthenticationMethod?: string[]

Özellik Değeri

string[]

clientId

Bu yetkilendirme sunucusuna kayıtlı istemci veya uygulama kimliği.

clientId?: string

Özellik Değeri

string

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.

clientRegistrationEndpoint?: string

Özellik Değeri

string

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.

clientSecret?: string

Özellik Değeri

string

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.

defaultScope?: string

Özellik Değeri

string

description

Yetkilendirme sunucusunun açıklaması. HTML biçimlendirme etiketleri içerebilir.

description?: string

Özellik Değeri

string

displayName

Kullanıcı dostu yetkilendirme sunucusu adı.

displayName?: string

Özellik Değeri

string

grantTypes

İstemcinin erişim belirtecini istemek için kullandığı yetkilendirme verme biçimi.

grantTypes?: string[]

Özellik Değeri

string[]

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ı.

resourceOwnerPassword?: string

Özellik Değeri

string

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ı.

resourceOwnerUsername?: string

Özellik Değeri

string

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.

supportState?: boolean

Özellik Değeri

boolean

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"}.

tokenBodyParameters?: TokenBodyParameterContract[]

Özellik Değeri

TokenBodyParameterContract[]

tokenEndpoint

OAuth belirteci uç noktası. Başvurulmakta olan varlığa mutlak URI içerir.

tokenEndpoint?: string

Özellik Değeri

string

useInApiDocumentation

Doğruysa, yetkilendirme sunucusu geliştirici portalındaki API belgelerinde kullanılır. Değer sağlanmazsa varsayılan olarak false olur.

useInApiDocumentation?: boolean

Özellik Değeri

boolean

useInTestConsole

Doğruysa, yetkilendirme sunucusu geliştirici portalı test konsolunda kullanılabilir. Değer sağlanmazsa varsayılan olarak True olur.

useInTestConsole?: boolean

Özellik Değeri

boolean

Devralınan Özellik Detayları

id

Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.

id?: string

Özellik Değeri

string

ProxyResource.id Devralındı

name

Kaynağın adı NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.

name?: string

Özellik Değeri

string

ProxyResource.name'dan Devralınan

type

Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts" NOT: Bu özellik seri hale getirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.

type?: string

Özellik Değeri

string

ProxyResource.typeDevralındı