AuthorizationServer interface

Paket:

@azure/arm-apimanagement

Schnittstelle, die einen AuthorizationServer darstellt.

Methoden

createOrUpdate(string, string, string, AuthorizationServerContract, AuthorizationServerCreateOrUpdateOptionalParams)	Erstellt einen neuen Autorisierungsserver oder aktualisiert Details eines bereits vorhandenen Autorisierungsservers
delete(string, string, string, string, AuthorizationServerDeleteOptionalParams)	Löscht die angegebene Autorisierungsserverinstanz
get(string, string, string, AuthorizationServerGetOptionalParams)	Ruft die Details des Autorisierungsservers ab, der durch seinen Bezeichner angegeben wird.
getEntityTag(string, string, string, AuthorizationServerGetEntityTagOptionalParams)	Ruft die Etag-Version (Entity State) des authorizationServers ab, der durch den Bezeichner angegeben wird.
listByService(string, string, AuthorizationServerListByServiceOptionalParams)	Listet eine Auflistung der in einer Dienstinstanz definierten Autorisierungsserver auf
listSecrets(string, string, string, AuthorizationServerListSecretsOptionalParams)	Ruft die Details des geheimen Clientschlüssels des Autorisierungsservers ab.
update(string, string, string, string, AuthorizationServerUpdateContract, AuthorizationServerUpdateOptionalParams)	Updates die Details des Autorisierungsservers, der durch seinen Bezeichner angegeben wird.

Details zur Methode

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

Erstellt einen neuen Autorisierungsserver oder aktualisiert Details eines bereits vorhandenen Autorisierungsservers

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

authsid

string

Bezeichner des Autorisierungsservers.

parameters

AuthorizationServerContract

Erstellen oder Aktualisieren von Parametern

options

AuthorizationServerCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<AuthorizationServerCreateOrUpdateResponse>

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

Löscht die angegebene Autorisierungsserverinstanz

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

authsid

string

Bezeichner des Autorisierungsservers.

ifMatch

string

ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für die bedingungslose Aktualisierung sein.

options

AuthorizationServerDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

get(string, string, string, AuthorizationServerGetOptionalParams)

Ruft die Details des Autorisierungsservers ab, der durch seinen Bezeichner angegeben wird.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

authsid

string

Bezeichner des Autorisierungsservers.

options

AuthorizationServerGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<AuthorizationServerGetResponse>

getEntityTag(string, string, string, AuthorizationServerGetEntityTagOptionalParams)

Ruft die Etag-Version (Entity State) des authorizationServers ab, der durch den Bezeichner angegeben wird.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

authsid

string

Bezeichner des Autorisierungsservers.

options

AuthorizationServerGetEntityTagOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<AuthorizationServerGetEntityTagHeaders>

listByService(string, string, AuthorizationServerListByServiceOptionalParams)

Listet eine Auflistung der in einer Dienstinstanz definierten Autorisierungsserver auf

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

options

AuthorizationServerListByServiceOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<AuthorizationServerContract, AuthorizationServerContract[], PageSettings>

listSecrets(string, string, string, AuthorizationServerListSecretsOptionalParams)

Ruft die Details des geheimen Clientschlüssels des Autorisierungsservers ab.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

authsid

string

Bezeichner des Autorisierungsservers.

options

AuthorizationServerListSecretsOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<AuthorizationServerListSecretsResponse>

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

Updates die Details des Autorisierungsservers, der durch seinen Bezeichner angegeben wird.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

authsid

string

Bezeichner des Autorisierungsservers.

ifMatch

string

ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für die bedingungslose Aktualisierung sein.

parameters

AuthorizationServerUpdateContract

OAuth2-Servereinstellungen Updateparameter.

options

AuthorizationServerUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<AuthorizationServerUpdateResponse>