AuthorizationServer interface

Paquet:

@azure/arm-apimanagement

Interface représentant un Serveur d’autorisation.

Méthodes

createOrUpdate(string, string, string, AuthorizationServerContract, AuthorizationServerCreateOrUpdateOptionalParams)	Crée un nouveau serveur d’autorisation ou met à jour un serveur d’autorisation existant.
delete(string, string, string, string, AuthorizationServerDeleteOptionalParams)	Supprime une instance de serveur d’autorisation spécifique.
get(string, string, string, AuthorizationServerGetOptionalParams)	Obtient les détails du serveur d’autorisation spécifié par son identificateur.
getEntityTag(string, string, string, AuthorizationServerGetEntityTagOptionalParams)	Obtient la version d’état d’entité (Etag) de l’objet authorizationServer spécifié par son identificateur.
listByService(string, string, AuthorizationServerListByServiceOptionalParams)	Répertorie un ensemble de serveurs d’autorisation définis dans une instance de service.
listSecrets(string, string, string, AuthorizationServerListSecretsOptionalParams)	Obtient les détails de la clé secrète client du serveur d’autorisation.
update(string, string, string, string, AuthorizationServerUpdateContract, AuthorizationServerUpdateOptionalParams)	Mises à jour les détails du serveur d’autorisation spécifié par son identificateur.

Détails de la méthode

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

Crée un nouveau serveur d’autorisation ou met à jour un serveur d’autorisation existant.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

authsid

string

Identificateur du serveur d’autorisation.

parameters

AuthorizationServerContract

Créer ou mettre à jour des paramètres.

options

AuthorizationServerCreateOrUpdateOptionalParams

Paramètres d’options.

Retours

Promise<AuthorizationServerCreateOrUpdateResponse>

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

Supprime une instance de serveur d’autorisation spécifique.

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

authsid

string

Identificateur du serveur d’autorisation.

ifMatch

string

ETag de l’entité. ETag doit correspondre à l’état actuel de l’entité à partir de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.

options

AuthorizationServerDeleteOptionalParams

Paramètres d’options.

Retours

Promise<void>

get(string, string, string, AuthorizationServerGetOptionalParams)

Obtient les détails du serveur d’autorisation spécifié par son identificateur.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

authsid

string

Identificateur du serveur d’autorisation.

options

AuthorizationServerGetOptionalParams

Paramètres d’options.

Retours

Promise<AuthorizationServerGetResponse>

getEntityTag(string, string, string, AuthorizationServerGetEntityTagOptionalParams)

Obtient la version d’état d’entité (Etag) de l’objet authorizationServer spécifié par son identificateur.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

authsid

string

Identificateur du serveur d’autorisation.

options

AuthorizationServerGetEntityTagOptionalParams

Paramètres d’options.

Retours

Promise<AuthorizationServerGetEntityTagHeaders>

listByService(string, string, AuthorizationServerListByServiceOptionalParams)

Répertorie un ensemble de serveurs d’autorisation définis dans une instance de service.

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

options

AuthorizationServerListByServiceOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<AuthorizationServerContract, AuthorizationServerContract[], PageSettings>

listSecrets(string, string, string, AuthorizationServerListSecretsOptionalParams)

Obtient les détails de la clé secrète client du serveur d’autorisation.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

authsid

string

Identificateur du serveur d’autorisation.

options

AuthorizationServerListSecretsOptionalParams

Paramètres d’options.

Retours

Promise<AuthorizationServerListSecretsResponse>

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

Mises à jour les détails du serveur d’autorisation spécifié par son identificateur.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

authsid

string

Identificateur du serveur d’autorisation.

ifMatch

string

ETag de l’entité. ETag doit correspondre à l’état actuel de l’entité à partir de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.

parameters

AuthorizationServerUpdateContract

Paramètres du serveur OAuth2 Paramètres de mise à jour.

options

AuthorizationServerUpdateOptionalParams

Paramètres d’options.

Retours

Promise<AuthorizationServerUpdateResponse>