AuthorizationServer interface

Pakiet:

@azure/arm-apimanagement

Interfejs reprezentujący serwer autoryzacji.

Metody

createOrUpdate(string, string, string, AuthorizationServerContract, AuthorizationServerCreateOrUpdateOptionalParams)	Tworzy nowy serwer autoryzacji lub aktualizuje istniejący serwer autoryzacji.
delete(string, string, string, string, AuthorizationServerDeleteOptionalParams)	Usuwa określone wystąpienie serwera autoryzacji.
get(string, string, string, AuthorizationServerGetOptionalParams)	Pobiera szczegóły serwera autoryzacji określonego przez jego identyfikator.
getEntityTag(string, string, string, AuthorizationServerGetEntityTagOptionalParams)	Pobiera wersję stanu jednostki (Etag) serwera autoryzacji określonego przez jego identyfikator.
listByService(string, string, AuthorizationServerListByServiceOptionalParams)	Wyświetla listę kolekcji serwerów autoryzacji zdefiniowanych w wystąpieniu usługi.
listSecrets(string, string, string, AuthorizationServerListSecretsOptionalParams)	Pobiera szczegóły wpisu tajnego klienta serwera autoryzacji.
update(string, string, string, string, AuthorizationServerUpdateContract, AuthorizationServerUpdateOptionalParams)	Aktualizuje szczegóły serwera autoryzacji określonego przez jego identyfikator.

Szczegóły metody

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

Tworzy nowy serwer autoryzacji lub aktualizuje istniejący serwer autoryzacji.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

authsid

string

Identyfikator serwera autoryzacji.

parameters

AuthorizationServerContract

Tworzenie lub aktualizowanie parametrów.

options

AuthorizationServerCreateOrUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<AuthorizationServerCreateOrUpdateResponse>

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

Usuwa określone wystąpienie serwera autoryzacji.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

authsid

string

Identyfikator serwera autoryzacji.

ifMatch

string

Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.

options

AuthorizationServerDeleteOptionalParams

Parametry opcji.

Zwraca

Promise<void>

get(string, string, string, AuthorizationServerGetOptionalParams)

Pobiera szczegóły serwera autoryzacji określonego przez jego identyfikator.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

authsid

string

Identyfikator serwera autoryzacji.

options

AuthorizationServerGetOptionalParams

Parametry opcji.

Zwraca

Promise<AuthorizationServerGetResponse>

getEntityTag(string, string, string, AuthorizationServerGetEntityTagOptionalParams)

Pobiera wersję stanu jednostki (Etag) serwera autoryzacji określonego przez jego identyfikator.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

authsid

string

Identyfikator serwera autoryzacji.

options

AuthorizationServerGetEntityTagOptionalParams

Parametry opcji.

Zwraca

Promise<AuthorizationServerGetEntityTagHeaders>

listByService(string, string, AuthorizationServerListByServiceOptionalParams)

Wyświetla listę kolekcji serwerów autoryzacji zdefiniowanych w wystąpieniu usługi.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

options

AuthorizationServerListByServiceOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<AuthorizationServerContract, AuthorizationServerContract[], PageSettings>

listSecrets(string, string, string, AuthorizationServerListSecretsOptionalParams)

Pobiera szczegóły wpisu tajnego klienta serwera autoryzacji.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

authsid

string

Identyfikator serwera autoryzacji.

options

AuthorizationServerListSecretsOptionalParams

Parametry opcji.

Zwraca

Promise<AuthorizationServerListSecretsResponse>

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

Aktualizuje szczegóły serwera autoryzacji określonego przez jego identyfikator.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

authsid

string

Identyfikator serwera autoryzacji.

ifMatch

string

Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.

parameters

AuthorizationServerUpdateContract

Ustawienia serwera OAuth2 Aktualizuj parametry.

options

AuthorizationServerUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<AuthorizationServerUpdateResponse>