Freigeben über


IdentityProvider interface

Schnittstelle, die einen IdentityProvider darstellt.

Methoden

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

Erstellt oder aktualisiert die Konfiguration des Identitätsanbieters

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

Löscht die angegebene Konfiguration des Identitätsanbieters

get(string, string, string, IdentityProviderGetOptionalParams)

Ruft die Konfigurationsdetails des Identitätsanbieters ab, der in der angegebenen Dienst-instance konfiguriert ist.

getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)

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

listByService(string, string, IdentityProviderListByServiceOptionalParams)

Listet eine Auflistung der in der angegebenen Dienstinstanz konfigurierten Identitätsanbieter auf

listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)

Ruft die geheimen Clientdetails des Identitätsanbieters ab.

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

Updates einer vorhandenen IdentityProvider-Konfiguration.

Details zur Methode

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

Erstellt oder aktualisiert die Konfiguration des Identitätsanbieters

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

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.

identityProviderName

string

Bezeichner des Identitätsanbietertyps.

parameters
IdentityProviderCreateContract

Erstellen Sie Parameter.

options
IdentityProviderCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

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

Löscht die angegebene Konfiguration des Identitätsanbieters

function delete(resourceGroupName: string, serviceName: string, identityProviderName: string, ifMatch: string, options?: IdentityProviderDeleteOptionalParams): 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.

identityProviderName

string

Bezeichner des Identitätsanbietertyps.

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
IdentityProviderDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

get(string, string, string, IdentityProviderGetOptionalParams)

Ruft die Konfigurationsdetails des Identitätsanbieters ab, der in der angegebenen Dienst-instance konfiguriert ist.

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

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.

identityProviderName

string

Bezeichner des Identitätsanbietertyps.

options
IdentityProviderGetOptionalParams

Die Optionsparameter.

Gibt zurück

getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)

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

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

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.

identityProviderName

string

Bezeichner des Identitätsanbietertyps.

options
IdentityProviderGetEntityTagOptionalParams

Die Optionsparameter.

Gibt zurück

listByService(string, string, IdentityProviderListByServiceOptionalParams)

Listet eine Auflistung der in der angegebenen Dienstinstanz konfigurierten Identitätsanbieter auf

function listByService(resourceGroupName: string, serviceName: string, options?: IdentityProviderListByServiceOptionalParams): PagedAsyncIterableIterator<IdentityProviderContract, IdentityProviderContract[], 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
IdentityProviderListByServiceOptionalParams

Die Optionsparameter.

Gibt zurück

listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)

Ruft die geheimen Clientdetails des Identitätsanbieters ab.

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

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.

identityProviderName

string

Bezeichner des Identitätsanbietertyps.

options
IdentityProviderListSecretsOptionalParams

Die Optionsparameter.

Gibt zurück

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

Updates einer vorhandenen IdentityProvider-Konfiguration.

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

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.

identityProviderName

string

Bezeichner des Identitätsanbietertyps.

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
IdentityProviderUpdateParameters

Aktualisieren von Parametern.

options
IdentityProviderUpdateOptionalParams

Die Optionsparameter.

Gibt zurück