IdentityProvider interface

Pakiet:

@azure/arm-apimanagement

Interfejs reprezentujący dostawcę tożsamości.

Metody

createOrUpdate(string, string, string, IdentityProviderCreateContract, IdentityProviderCreateOrUpdateOptionalParams)	Tworzy lub Aktualizacje konfiguracji IdentityProvider.
delete(string, string, string, string, IdentityProviderDeleteOptionalParams)	Usuwa określoną konfigurację dostawcy tożsamości.
get(string, string, string, IdentityProviderGetOptionalParams)	Pobiera szczegóły konfiguracji dostawcy tożsamości skonfigurowanego w określonym wystąpieniu usługi.
getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)	Pobiera wersję stanu jednostki (Etag) elementu identityProvider określonego przez jego identyfikator.
listByService(string, string, IdentityProviderListByServiceOptionalParams)	Wyświetla kolekcję dostawcy tożsamości skonfigurowaną w określonym wystąpieniu usługi.
listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)	Pobiera szczegóły wpisu tajnego klienta dostawcy tożsamości.
update(string, string, string, string, IdentityProviderUpdateParameters, IdentityProviderUpdateOptionalParams)	Aktualizacje istniejącej konfiguracji IdentityProvider.

Szczegóły metody

createOrUpdate(string, string, string, IdentityProviderCreateContract, IdentityProviderCreateOrUpdateOptionalParams)

Tworzy lub Aktualizacje konfiguracji IdentityProvider.

function createOrUpdate(resourceGroupName: string, serviceName: string, identityProviderName: string, parameters: IdentityProviderCreateContract, options?: IdentityProviderCreateOrUpdateOptionalParams): Promise<IdentityProviderCreateOrUpdateResponse>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

identityProviderName

string

Identyfikator typu dostawcy tożsamości.

parameters

IdentityProviderCreateContract

Utwórz parametry.

options

IdentityProviderCreateOrUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<IdentityProviderCreateOrUpdateResponse>

delete(string, string, string, string, IdentityProviderDeleteOptionalParams)

Usuwa określoną konfigurację dostawcy tożsamości.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

identityProviderName

string

Identyfikator typu dostawcy tożsamości.

ifMatch

string

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

options

IdentityProviderDeleteOptionalParams

Parametry opcji.

Zwraca

Promise<void>

get(string, string, string, IdentityProviderGetOptionalParams)

Pobiera szczegóły konfiguracji dostawcy tożsamości skonfigurowanego w określonym wystąpieniu usługi.

function get(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderGetOptionalParams): Promise<IdentityProviderGetResponse>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

identityProviderName

string

Identyfikator typu dostawcy tożsamości.

options

IdentityProviderGetOptionalParams

Parametry opcji.

Zwraca

Promise<IdentityProviderGetResponse>

getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)

Pobiera wersję stanu jednostki (Etag) elementu identityProvider określonego przez jego identyfikator.

function getEntityTag(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderGetEntityTagOptionalParams): Promise<IdentityProviderGetEntityTagHeaders>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

identityProviderName

string

Identyfikator typu dostawcy tożsamości.

options

IdentityProviderGetEntityTagOptionalParams

Parametry opcji.

Zwraca

Promise<IdentityProviderGetEntityTagHeaders>

listByService(string, string, IdentityProviderListByServiceOptionalParams)

Wyświetla kolekcję dostawcy tożsamości skonfigurowaną w określonym wystąpieniu usługi.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

options

IdentityProviderListByServiceOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<IdentityProviderContract, IdentityProviderContract[], PageSettings>

listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)

Pobiera szczegóły wpisu tajnego klienta dostawcy tożsamości.

function listSecrets(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderListSecretsOptionalParams): Promise<IdentityProviderListSecretsResponse>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

identityProviderName

string

Identyfikator typu dostawcy tożsamości.

options

IdentityProviderListSecretsOptionalParams

Parametry opcji.

Zwraca

Promise<IdentityProviderListSecretsResponse>

update(string, string, string, string, IdentityProviderUpdateParameters, IdentityProviderUpdateOptionalParams)

Aktualizacje istniejącej konfiguracji IdentityProvider.

function update(resourceGroupName: string, serviceName: string, identityProviderName: string, ifMatch: string, parameters: IdentityProviderUpdateParameters, options?: IdentityProviderUpdateOptionalParams): Promise<IdentityProviderUpdateResponse>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

identityProviderName

string

Identyfikator typu dostawcy tożsamości.

ifMatch

string

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

parameters

IdentityProviderUpdateParameters

Zaktualizuj parametry.

options

IdentityProviderUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<IdentityProviderUpdateResponse>