User interface
Interface die een gebruiker vertegenwoordigt.
Methoden
| create |
Hiermee wordt een gebruiker gemaakt of Updates. |
| delete(string, string, string, string, User |
Hiermee verwijdert u een specifieke gebruiker. |
| generate |
Haalt een omleidings-URL op met een verificatietoken voor het ondertekenen van een bepaalde gebruiker in de ontwikkelaarsportal. |
| get(string, string, string, User |
Hiermee haalt u de details van de gebruiker op die is opgegeven door de id. |
| get |
Hiermee haalt u de versie van de entiteitsstatus (Etag) op van de gebruiker die is opgegeven door de id. |
| get |
Hiermee haalt u het autorisatietoken voor gedeelde toegang voor de gebruiker op. |
| list |
Hiermee wordt een verzameling geregistreerde gebruikers in het opgegeven service-exemplaar weergegeven. |
| update(string, string, string, string, User |
Updates de details van de gebruiker die is opgegeven door de id. |
Methodedetails
createOrUpdate(string, string, string, UserCreateParameters, UserCreateOrUpdateOptionalParams)
Hiermee wordt een gebruiker gemaakt of Updates.
function createOrUpdate(resourceGroupName: string, serviceName: string, userId: string, parameters: UserCreateParameters, options?: UserCreateOrUpdateOptionalParams): Promise<UserCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- userId
-
string
Gebruikers-id. Moet uniek zijn in het huidige API Management service-exemplaar.
- parameters
- UserCreateParameters
Parameters maken of bijwerken.
- options
- UserCreateOrUpdateOptionalParams
De optiesparameters.
Retouren
Promise<UserCreateOrUpdateResponse>
delete(string, string, string, string, UserDeleteOptionalParams)
Hiermee verwijdert u een specifieke gebruiker.
function delete(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, options?: UserDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- userId
-
string
Gebruikers-id. Moet uniek zijn in het huidige API Management service-exemplaar.
- ifMatch
-
string
ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus uit het headerantwoord van de GET-aanvraag of moet * zijn voor onvoorwaardelijke update.
- options
- UserDeleteOptionalParams
De optiesparameters.
Retouren
Promise<void>
generateSsoUrl(string, string, string, UserGenerateSsoUrlOptionalParams)
Haalt een omleidings-URL op met een verificatietoken voor het ondertekenen van een bepaalde gebruiker in de ontwikkelaarsportal.
function generateSsoUrl(resourceGroupName: string, serviceName: string, userId: string, options?: UserGenerateSsoUrlOptionalParams): Promise<GenerateSsoUrlResult>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- userId
-
string
Gebruikers-id. Moet uniek zijn in het huidige API Management service-exemplaar.
- options
- UserGenerateSsoUrlOptionalParams
De optiesparameters.
Retouren
Promise<GenerateSsoUrlResult>
get(string, string, string, UserGetOptionalParams)
Hiermee haalt u de details van de gebruiker op die is opgegeven door de id.
function get(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetOptionalParams): Promise<UserGetResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- userId
-
string
Gebruikers-id. Moet uniek zijn in het huidige API Management service-exemplaar.
- options
- UserGetOptionalParams
De optiesparameters.
Retouren
Promise<UserGetResponse>
getEntityTag(string, string, string, UserGetEntityTagOptionalParams)
Hiermee haalt u de versie van de entiteitsstatus (Etag) op van de gebruiker die is opgegeven door de id.
function getEntityTag(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetEntityTagOptionalParams): Promise<UserGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- userId
-
string
Gebruikers-id. Moet uniek zijn in het huidige API Management service-exemplaar.
- options
- UserGetEntityTagOptionalParams
De optiesparameters.
Retouren
Promise<UserGetEntityTagHeaders>
getSharedAccessToken(string, string, string, UserTokenParameters, UserGetSharedAccessTokenOptionalParams)
Hiermee haalt u het autorisatietoken voor gedeelde toegang voor de gebruiker op.
function getSharedAccessToken(resourceGroupName: string, serviceName: string, userId: string, parameters: UserTokenParameters, options?: UserGetSharedAccessTokenOptionalParams): Promise<UserTokenResult>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- userId
-
string
Gebruikers-id. Moet uniek zijn in het huidige API Management service-exemplaar.
- parameters
- UserTokenParameters
Parameters voor autorisatietoken maken.
De optiesparameters.
Retouren
Promise<UserTokenResult>
listByService(string, string, UserListByServiceOptionalParams)
Hiermee wordt een verzameling geregistreerde gebruikers in het opgegeven service-exemplaar weergegeven.
function listByService(resourceGroupName: string, serviceName: string, options?: UserListByServiceOptionalParams): PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- options
- UserListByServiceOptionalParams
De optiesparameters.
Retouren
update(string, string, string, string, UserUpdateParameters, UserUpdateOptionalParams)
Updates de details van de gebruiker die is opgegeven door de id.
function update(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, parameters: UserUpdateParameters, options?: UserUpdateOptionalParams): Promise<UserUpdateResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- userId
-
string
Gebruikers-id. Moet uniek zijn in het huidige API Management service-exemplaar.
- ifMatch
-
string
ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus uit het headerantwoord van de GET-aanvraag of moet * zijn voor onvoorwaardelijke update.
- parameters
- UserUpdateParameters
Parameters bijwerken.
- options
- UserUpdateOptionalParams
De optiesparameters.
Retouren
Promise<UserUpdateResponse>