User interface
Interface représentant un utilisateur.
Méthodes
| create |
Crée ou met à jour un utilisateur. |
| delete(string, string, string, string, User |
Supprime un utilisateur spécifique. |
| generate |
Récupère une URL de redirection contenant un jeton d’authentification pour connecter un utilisateur donné au portail des développeurs. |
| get(string, string, string, User |
Obtient les détails de l’utilisateur spécifié par son identificateur. |
| get |
Obtient la version d’état d’entité (Etag) de l’utilisateur spécifié par son identificateur. |
| get |
Obtient le jeton d’autorisation d’accès partagé pour l’utilisateur. |
| list |
Répertorie une collection d’utilisateurs enregistrés dans l’instance de service spécifiée. |
| update(string, string, string, string, User |
Mises à jour les détails de l’utilisateur spécifiés par son identificateur. |
Détails de la méthode
createOrUpdate(string, string, string, UserCreateParameters, UserCreateOrUpdateOptionalParams)
Crée ou met à jour un utilisateur.
function createOrUpdate(resourceGroupName: string, serviceName: string, userId: string, parameters: UserCreateParameters, options?: UserCreateOrUpdateOptionalParams): Promise<UserCreateOrUpdateResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- userId
-
string
Identificateur de l'utilisateur. Doit être unique dans le instance de service Gestion des API actuel.
- parameters
- UserCreateParameters
Créer ou mettre à jour des paramètres.
- options
- UserCreateOrUpdateOptionalParams
Paramètres d’options.
Retours
Promise<UserCreateOrUpdateResponse>
delete(string, string, string, string, UserDeleteOptionalParams)
Supprime un utilisateur spécifique.
function delete(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, options?: UserDeleteOptionalParams): 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.
- userId
-
string
Identificateur de l'utilisateur. Doit être unique dans le instance de service Gestion des API actuel.
- 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.
- options
- UserDeleteOptionalParams
Paramètres d’options.
Retours
Promise<void>
generateSsoUrl(string, string, string, UserGenerateSsoUrlOptionalParams)
Récupère une URL de redirection contenant un jeton d’authentification pour connecter un utilisateur donné au portail des développeurs.
function generateSsoUrl(resourceGroupName: string, serviceName: string, userId: string, options?: UserGenerateSsoUrlOptionalParams): Promise<GenerateSsoUrlResult>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- userId
-
string
Identificateur de l'utilisateur. Doit être unique dans le instance de service Gestion des API actuel.
- options
- UserGenerateSsoUrlOptionalParams
Paramètres d’options.
Retours
Promise<GenerateSsoUrlResult>
get(string, string, string, UserGetOptionalParams)
Obtient les détails de l’utilisateur spécifié par son identificateur.
function get(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetOptionalParams): Promise<UserGetResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- userId
-
string
Identificateur de l'utilisateur. Doit être unique dans le instance de service Gestion des API actuel.
- options
- UserGetOptionalParams
Paramètres d’options.
Retours
Promise<UserGetResponse>
getEntityTag(string, string, string, UserGetEntityTagOptionalParams)
Obtient la version d’état d’entité (Etag) de l’utilisateur spécifié par son identificateur.
function getEntityTag(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetEntityTagOptionalParams): Promise<UserGetEntityTagHeaders>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- userId
-
string
Identificateur de l'utilisateur. Doit être unique dans le instance de service Gestion des API actuel.
- options
- UserGetEntityTagOptionalParams
Paramètres d’options.
Retours
Promise<UserGetEntityTagHeaders>
getSharedAccessToken(string, string, string, UserTokenParameters, UserGetSharedAccessTokenOptionalParams)
Obtient le jeton d’autorisation d’accès partagé pour l’utilisateur.
function getSharedAccessToken(resourceGroupName: string, serviceName: string, userId: string, parameters: UserTokenParameters, options?: UserGetSharedAccessTokenOptionalParams): Promise<UserTokenResult>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- userId
-
string
Identificateur de l'utilisateur. Doit être unique dans le instance de service Gestion des API actuel.
- parameters
- UserTokenParameters
Créez des paramètres de jeton d’autorisation.
Paramètres d’options.
Retours
Promise<UserTokenResult>
listByService(string, string, UserListByServiceOptionalParams)
Répertorie une collection d’utilisateurs enregistrés dans l’instance de service spécifiée.
function listByService(resourceGroupName: string, serviceName: string, options?: UserListByServiceOptionalParams): PagedAsyncIterableIterator<UserContract, UserContract[], 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
- UserListByServiceOptionalParams
Paramètres d’options.
Retours
update(string, string, string, string, UserUpdateParameters, UserUpdateOptionalParams)
Mises à jour les détails de l’utilisateur spécifiés par son identificateur.
function update(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, parameters: UserUpdateParameters, options?: UserUpdateOptionalParams): Promise<UserUpdateResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- userId
-
string
Identificateur de l'utilisateur. Doit être unique dans le instance de service Gestion des API actuel.
- 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
- UserUpdateParameters
Mettre à jour les paramètres.
- options
- UserUpdateOptionalParams
Paramètres d’options.
Retours
Promise<UserUpdateResponse>