User interface
Gränssnitt som representerar en användare.
Metoder
Metodinformation
createOrUpdate(string, string, string, UserCreateParameters, UserCreateOrUpdateOptionalParams)
Skapar eller Uppdateringar en användare.
function createOrUpdate(resourceGroupName: string, serviceName: string, userId: string, parameters: UserCreateParameters, options?: UserCreateOrUpdateOptionalParams): Promise<UserCreateOrUpdateResponse>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- userId
-
string
Användaridentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
- parameters
- UserCreateParameters
Skapa eller uppdatera parametrar.
- options
- UserCreateOrUpdateOptionalParams
Alternativparametrarna.
Returer
Promise<UserCreateOrUpdateResponse>
delete(string, string, string, string, UserDeleteOptionalParams)
Tar bort en specifik användare.
function delete(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, options?: UserDeleteOptionalParams): Promise<void>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- userId
-
string
Användaridentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
- ifMatch
-
string
ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.
- options
- UserDeleteOptionalParams
Alternativparametrarna.
Returer
Promise<void>
generateSsoUrl(string, string, string, UserGenerateSsoUrlOptionalParams)
Hämtar en omdirigerings-URL som innehåller en autentiseringstoken för signering av en viss användare till utvecklarportalen.
function generateSsoUrl(resourceGroupName: string, serviceName: string, userId: string, options?: UserGenerateSsoUrlOptionalParams): Promise<GenerateSsoUrlResult>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- userId
-
string
Användaridentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
- options
- UserGenerateSsoUrlOptionalParams
Alternativparametrarna.
Returer
Promise<GenerateSsoUrlResult>
get(string, string, string, UserGetOptionalParams)
Hämtar information om användaren som anges av dess identifierare.
function get(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetOptionalParams): Promise<UserGetResponse>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- userId
-
string
Användaridentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
- options
- UserGetOptionalParams
Alternativparametrarna.
Returer
Promise<UserGetResponse>
getEntityTag(string, string, string, UserGetEntityTagOptionalParams)
Hämtar entitetstillståndsversionen (Etag) för användaren som anges av dess identifierare.
function getEntityTag(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetEntityTagOptionalParams): Promise<UserGetEntityTagHeaders>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- userId
-
string
Användaridentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
- options
- UserGetEntityTagOptionalParams
Alternativparametrarna.
Returer
Promise<UserGetEntityTagHeaders>
getSharedAccessToken(string, string, string, UserTokenParameters, UserGetSharedAccessTokenOptionalParams)
Hämtar auktoriseringstoken för delad åtkomst för användaren.
function getSharedAccessToken(resourceGroupName: string, serviceName: string, userId: string, parameters: UserTokenParameters, options?: UserGetSharedAccessTokenOptionalParams): Promise<UserTokenResult>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- userId
-
string
Användaridentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
- parameters
- UserTokenParameters
Skapa parametrar för auktoriseringstoken.
Alternativparametrarna.
Returer
Promise<UserTokenResult>
listByService(string, string, UserListByServiceOptionalParams)
Visar en samling registrerade användare i den angivna tjänstinstansen.
function listByService(resourceGroupName: string, serviceName: string, options?: UserListByServiceOptionalParams): PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- options
- UserListByServiceOptionalParams
Alternativparametrarna.
Returer
update(string, string, string, string, UserUpdateParameters, UserUpdateOptionalParams)
Uppdateringar information om användaren som anges av dess identifierare.
function update(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, parameters: UserUpdateParameters, options?: UserUpdateOptionalParams): Promise<UserUpdateResponse>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- userId
-
string
Användaridentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
- ifMatch
-
string
ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.
- parameters
- UserUpdateParameters
Uppdatera parametrar.
- options
- UserUpdateOptionalParams
Alternativparametrarna.
Returer
Promise<UserUpdateResponse>