User interface
Antarmuka yang mewakili Pengguna.
Metode
Detail Metode
beginDelete(string, string, string, string, UserDeleteOptionalParams)
Menghapus pengguna tertentu.
function beginDelete(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, options?: UserDeleteOptionalParams): Promise<SimplePollerLike<OperationState<UserDeleteHeaders>, UserDeleteHeaders>>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
- serviceName
-
string
Nama layanan API Management.
- userId
-
string
Pengidentifikasi pengguna. Harus unik dalam instans layanan API Management saat ini.
- ifMatch
-
string
ETag Entitas. ETag harus cocok dengan status entitas saat ini dari respons header permintaan GET atau harus * untuk pembaruan tanpa syarat.
- options
- UserDeleteOptionalParams
Parameter opsi.
Mengembalikan
Promise<@azure/core-lro.SimplePollerLike<OperationState<UserDeleteHeaders>, UserDeleteHeaders>>
beginDeleteAndWait(string, string, string, string, UserDeleteOptionalParams)
Menghapus pengguna tertentu.
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, options?: UserDeleteOptionalParams): Promise<UserDeleteHeaders>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
- serviceName
-
string
Nama layanan API Management.
- userId
-
string
Pengidentifikasi pengguna. Harus unik dalam instans layanan API Management saat ini.
- ifMatch
-
string
ETag Entitas. ETag harus cocok dengan status entitas saat ini dari respons header permintaan GET atau harus * untuk pembaruan tanpa syarat.
- options
- UserDeleteOptionalParams
Parameter opsi.
Mengembalikan
Promise<UserDeleteHeaders>
createOrUpdate(string, string, string, UserCreateParameters, UserCreateOrUpdateOptionalParams)
Membuat atau Memperbarui pengguna.
function createOrUpdate(resourceGroupName: string, serviceName: string, userId: string, parameters: UserCreateParameters, options?: UserCreateOrUpdateOptionalParams): Promise<UserCreateOrUpdateResponse>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
- serviceName
-
string
Nama layanan API Management.
- userId
-
string
Pengidentifikasi pengguna. Harus unik dalam instans layanan API Management saat ini.
- parameters
- UserCreateParameters
Membuat atau memperbarui parameter.
- options
- UserCreateOrUpdateOptionalParams
Parameter opsi.
Mengembalikan
Promise<UserCreateOrUpdateResponse>
generateSsoUrl(string, string, string, UserGenerateSsoUrlOptionalParams)
Mengambil URL pengalihan yang berisi token autentikasi untuk menandatangani pengguna tertentu ke portal pengembang.
function generateSsoUrl(resourceGroupName: string, serviceName: string, userId: string, options?: UserGenerateSsoUrlOptionalParams): Promise<GenerateSsoUrlResult>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
- serviceName
-
string
Nama layanan API Management.
- userId
-
string
Pengidentifikasi pengguna. Harus unik dalam instans layanan API Management saat ini.
- options
- UserGenerateSsoUrlOptionalParams
Parameter opsi.
Mengembalikan
Promise<GenerateSsoUrlResult>
get(string, string, string, UserGetOptionalParams)
Mendapatkan detail pengguna yang ditentukan oleh pengidentifikasinya.
function get(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetOptionalParams): Promise<UserGetResponse>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
- serviceName
-
string
Nama layanan API Management.
- userId
-
string
Pengidentifikasi pengguna. Harus unik dalam instans layanan API Management saat ini.
- options
- UserGetOptionalParams
Parameter opsi.
Mengembalikan
Promise<UserGetResponse>
getEntityTag(string, string, string, UserGetEntityTagOptionalParams)
Mendapatkan versi status entitas (Etag) dari pengguna yang ditentukan oleh pengidentifikasinya.
function getEntityTag(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetEntityTagOptionalParams): Promise<UserGetEntityTagHeaders>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
- serviceName
-
string
Nama layanan API Management.
- userId
-
string
Pengidentifikasi pengguna. Harus unik dalam instans layanan API Management saat ini.
- options
- UserGetEntityTagOptionalParams
Parameter opsi.
Mengembalikan
Promise<UserGetEntityTagHeaders>
getSharedAccessToken(string, string, string, UserTokenParameters, UserGetSharedAccessTokenOptionalParams)
Mendapatkan Token Otorisasi Akses Bersama untuk Pengguna.
function getSharedAccessToken(resourceGroupName: string, serviceName: string, userId: string, parameters: UserTokenParameters, options?: UserGetSharedAccessTokenOptionalParams): Promise<UserTokenResult>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
- serviceName
-
string
Nama layanan API Management.
- userId
-
string
Pengidentifikasi pengguna. Harus unik dalam instans layanan API Management saat ini.
- parameters
- UserTokenParameters
Membuat parameter Token Otorisasi.
Parameter opsi.
Mengembalikan
Promise<UserTokenResult>
listByService(string, string, UserListByServiceOptionalParams)
Mencantumkan kumpulan pengguna terdaftar dalam instans layanan yang ditentukan.
function listByService(resourceGroupName: string, serviceName: string, options?: UserListByServiceOptionalParams): PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
- serviceName
-
string
Nama layanan API Management.
- options
- UserListByServiceOptionalParams
Parameter opsi.
Mengembalikan
update(string, string, string, string, UserUpdateParameters, UserUpdateOptionalParams)
Memperbarui detail pengguna yang ditentukan oleh pengidentifikasinya.
function update(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, parameters: UserUpdateParameters, options?: UserUpdateOptionalParams): Promise<UserUpdateResponse>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
- serviceName
-
string
Nama layanan API Management.
- userId
-
string
Pengidentifikasi pengguna. Harus unik dalam instans layanan API Management saat ini.
- ifMatch
-
string
ETag Entitas. ETag harus cocok dengan status entitas saat ini dari respons header permintaan GET atau harus * untuk pembaruan tanpa syarat.
- parameters
- UserUpdateParameters
Perbarui parameter.
- options
- UserUpdateOptionalParams
Parameter opsi.
Mengembalikan
Promise<UserUpdateResponse>