AuthorizationServer interface

Balíček:

@azure/arm-apimanagement

Rozhraní představující autorizační server

Metody

createOrUpdate(string, string, string, AuthorizationServerContract, AuthorizationServerCreateOrUpdateOptionalParams)	Vytvoří nový autorizační server nebo aktualizuje existující autorizační server.
delete(string, string, string, string, AuthorizationServerDeleteOptionalParams)	Odstraní konkrétní instanci autorizačního serveru.
get(string, string, string, AuthorizationServerGetOptionalParams)	Získá podrobnosti autorizačního serveru určeného jeho identifikátorem.
getEntityTag(string, string, string, AuthorizationServerGetEntityTagOptionalParams)	Získá verzi stavu entity (Etag) autorizačního serveru určeného jeho identifikátorem.
listByService(string, string, AuthorizationServerListByServiceOptionalParams)	Zobrazí kolekci autorizačních serverů definovaných v instanci služby.
listSecrets(string, string, string, AuthorizationServerListSecretsOptionalParams)	Získá podrobnosti tajného klíče klienta autorizačního serveru.
update(string, string, string, string, AuthorizationServerUpdateContract, AuthorizationServerUpdateOptionalParams)	Aktualizuje podrobnosti autorizačního serveru určeného jeho identifikátorem.

Podrobnosti metody

createOrUpdate(string, string, string, AuthorizationServerContract, AuthorizationServerCreateOrUpdateOptionalParams)

Vytvoří nový autorizační server nebo aktualizuje existující autorizační server.

function createOrUpdate(resourceGroupName: string, serviceName: string, authsid: string, parameters: AuthorizationServerContract, options?: AuthorizationServerCreateOrUpdateOptionalParams): Promise<AuthorizationServerCreateOrUpdateResponse>

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

authsid

string

Identifikátor autorizačního serveru.

parameters

AuthorizationServerContract

Vytvoření nebo aktualizace parametrů

options

AuthorizationServerCreateOrUpdateOptionalParams

Parametry možností.

Návraty

Promise<AuthorizationServerCreateOrUpdateResponse>

delete(string, string, string, string, AuthorizationServerDeleteOptionalParams)

Odstraní konkrétní instanci autorizačního serveru.

function delete(resourceGroupName: string, serviceName: string, authsid: string, ifMatch: string, options?: AuthorizationServerDeleteOptionalParams): Promise<void>

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

authsid

string

Identifikátor autorizačního serveru.

ifMatch

string

ETag of the Entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET, nebo by měla být * pro nepodmíněnou aktualizaci.

options

AuthorizationServerDeleteOptionalParams

Parametry možností.

Návraty

Promise<void>

get(string, string, string, AuthorizationServerGetOptionalParams)

Získá podrobnosti autorizačního serveru určeného jeho identifikátorem.

function get(resourceGroupName: string, serviceName: string, authsid: string, options?: AuthorizationServerGetOptionalParams): Promise<AuthorizationServerGetResponse>

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

authsid

string

Identifikátor autorizačního serveru.

options

AuthorizationServerGetOptionalParams

Parametry možností.

Návraty

Promise<AuthorizationServerGetResponse>

getEntityTag(string, string, string, AuthorizationServerGetEntityTagOptionalParams)

Získá verzi stavu entity (Etag) autorizačního serveru určeného jeho identifikátorem.

function getEntityTag(resourceGroupName: string, serviceName: string, authsid: string, options?: AuthorizationServerGetEntityTagOptionalParams): Promise<AuthorizationServerGetEntityTagHeaders>

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

authsid

string

Identifikátor autorizačního serveru.

options

AuthorizationServerGetEntityTagOptionalParams

Parametry možností.

Návraty

Promise<AuthorizationServerGetEntityTagHeaders>

listByService(string, string, AuthorizationServerListByServiceOptionalParams)

Zobrazí kolekci autorizačních serverů definovaných v instanci služby.

function listByService(resourceGroupName: string, serviceName: string, options?: AuthorizationServerListByServiceOptionalParams): PagedAsyncIterableIterator<AuthorizationServerContract, AuthorizationServerContract[], PageSettings>

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

options

AuthorizationServerListByServiceOptionalParams

Parametry možností.

Návraty

PagedAsyncIterableIterator<AuthorizationServerContract, AuthorizationServerContract[], PageSettings>

listSecrets(string, string, string, AuthorizationServerListSecretsOptionalParams)

Získá podrobnosti tajného klíče klienta autorizačního serveru.

function listSecrets(resourceGroupName: string, serviceName: string, authsid: string, options?: AuthorizationServerListSecretsOptionalParams): Promise<AuthorizationServerListSecretsResponse>

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

authsid

string

Identifikátor autorizačního serveru.

options

AuthorizationServerListSecretsOptionalParams

Parametry možností.

Návraty

Promise<AuthorizationServerListSecretsResponse>

update(string, string, string, string, AuthorizationServerUpdateContract, AuthorizationServerUpdateOptionalParams)

Aktualizuje podrobnosti autorizačního serveru určeného jeho identifikátorem.

function update(resourceGroupName: string, serviceName: string, authsid: string, ifMatch: string, parameters: AuthorizationServerUpdateContract, options?: AuthorizationServerUpdateOptionalParams): Promise<AuthorizationServerUpdateResponse>

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

authsid

string

Identifikátor autorizačního serveru.

ifMatch

string

ETag of the Entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET, nebo by měla být * pro nepodmíněnou aktualizaci.

parameters

AuthorizationServerUpdateContract

Parametry aktualizace nastavení serveru OAuth2

options

AuthorizationServerUpdateOptionalParams

Parametry možností.

Návraty

Promise<AuthorizationServerUpdateResponse>