IdentityProvider interface
Interfejs reprezentujący dostawcę tożsamości.
Metody
Szczegóły metody
createOrUpdate(string, string, string, IdentityProviderCreateContract, IdentityProviderCreateOrUpdateOptionalParams)
Tworzy lub aktualizuje konfigurację IdentityProvider.
function createOrUpdate(resourceGroupName: string, serviceName: string, identityProviderName: string, parameters: IdentityProviderCreateContract, options?: IdentityProviderCreateOrUpdateOptionalParams): Promise<IdentityProviderCreateOrUpdateResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- identityProviderName
-
string
Identyfikator typu dostawcy tożsamości.
- parameters
- IdentityProviderCreateContract
Utwórz parametry.
Parametry opcji.
Zwraca
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. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- identityProviderName
-
string
Identyfikator typu dostawcy tożsamości.
- 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.
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. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- identityProviderName
-
string
Identyfikator typu dostawcy tożsamości.
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. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- identityProviderName
-
string
Identyfikator typu dostawcy tożsamości.
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. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
Parametry opcji.
Zwraca
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. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- identityProviderName
-
string
Identyfikator typu dostawcy tożsamości.
Parametry opcji.
Zwraca
Promise<IdentityProviderListSecretsResponse>
update(string, string, string, string, IdentityProviderUpdateParameters, IdentityProviderUpdateOptionalParams)
Aktualizuje istniejącą konfigurację IdentityProvider.
function update(resourceGroupName: string, serviceName: string, identityProviderName: string, ifMatch: string, parameters: IdentityProviderUpdateParameters, options?: IdentityProviderUpdateOptionalParams): Promise<IdentityProviderUpdateResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- identityProviderName
-
string
Identyfikator typu dostawcy tożsamości.
- 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
- IdentityProviderUpdateParameters
Aktualizuj parametry.
Parametry opcji.
Zwraca
Promise<IdentityProviderUpdateResponse>