IdentityProvider interface
Interface représentant un IdentityProvider.
Méthodes
Détails de la méthode
createOrUpdate(string, string, string, IdentityProviderCreateContract, IdentityProviderCreateOrUpdateOptionalParams)
Crée ou met à jour la configuration du fournisseur d’identité.
function createOrUpdate(resourceGroupName: string, serviceName: string, identityProviderName: string, parameters: IdentityProviderCreateContract, options?: IdentityProviderCreateOrUpdateOptionalParams): Promise<IdentityProviderCreateOrUpdateResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- identityProviderName
-
string
Identificateur de type de fournisseur d’identité.
- parameters
- IdentityProviderCreateContract
Créez des paramètres.
Paramètres d’options.
Retours
delete(string, string, string, string, IdentityProviderDeleteOptionalParams)
Supprime la configuration du fournisseur d’identité spécifié.
function delete(resourceGroupName: string, serviceName: string, identityProviderName: string, ifMatch: string, options?: IdentityProviderDeleteOptionalParams): Promise<void>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- identityProviderName
-
string
Identificateur de type de fournisseur d’identité.
- ifMatch
-
string
ETag de l’entité. ETag doit correspondre à l’état d’entité actuel de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.
Paramètres d’options.
Retours
Promise<void>
get(string, string, string, IdentityProviderGetOptionalParams)
Obtient les détails de configuration du fournisseur d’identité configuré dans le instance de service spécifié.
function get(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderGetOptionalParams): Promise<IdentityProviderGetResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- identityProviderName
-
string
Identificateur de type de fournisseur d’identité.
Paramètres d’options.
Retours
Promise<IdentityProviderGetResponse>
getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)
Obtient la version d’état d’entité (Etag) de l’identityProvider spécifié par son identificateur.
function getEntityTag(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderGetEntityTagOptionalParams): Promise<IdentityProviderGetEntityTagHeaders>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- identityProviderName
-
string
Identificateur de type de fournisseur d’identité.
Paramètres d’options.
Retours
Promise<IdentityProviderGetEntityTagHeaders>
listByService(string, string, IdentityProviderListByServiceOptionalParams)
Répertorie un ensemble de fournisseurs d’identité configurés dans l’instance de service spécifié.
function listByService(resourceGroupName: string, serviceName: string, options?: IdentityProviderListByServiceOptionalParams): PagedAsyncIterableIterator<IdentityProviderContract, IdentityProviderContract[], PageSettings>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
Paramètres d’options.
Retours
listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)
Obtient les détails de la clé secrète client du fournisseur d’identité.
function listSecrets(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderListSecretsOptionalParams): Promise<IdentityProviderListSecretsResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- identityProviderName
-
string
Identificateur de type de fournisseur d’identité.
Paramètres d’options.
Retours
Promise<IdentityProviderListSecretsResponse>
update(string, string, string, string, IdentityProviderUpdateParameters, IdentityProviderUpdateOptionalParams)
Mises à jour une configuration IdentityProvider existante.
function update(resourceGroupName: string, serviceName: string, identityProviderName: string, ifMatch: string, parameters: IdentityProviderUpdateParameters, options?: IdentityProviderUpdateOptionalParams): Promise<IdentityProviderUpdateResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- identityProviderName
-
string
Identificateur de type de fournisseur d’identité.
- ifMatch
-
string
ETag de l’entité. ETag doit correspondre à l’état d’entité actuel de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.
- parameters
- IdentityProviderUpdateParameters
Mettre à jour les paramètres.
Paramètres d’options.
Retours
Promise<IdentityProviderUpdateResponse>