User interface
واجهة تمثل مستخدما.
الأساليب
تفاصيل الأسلوب
beginDelete(string, string, string, string, UserDeleteOptionalParams)
حذف مستخدم معين.
function beginDelete(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, options?: UserDeleteOptionalParams): Promise<SimplePollerLike<OperationState<UserDeleteHeaders>, UserDeleteHeaders>>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- userId
-
string
معرف المستخدم. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- ifMatch
-
string
ETag للكيان. يجب أن يتطابق ETag مع حالة الكيان الحالية من استجابة العنوان لطلب GET أو يجب أن يكون * للتحديث غير المشروط.
- options
- UserDeleteOptionalParams
معلمات الخيارات.
المرتجعات
Promise<@azure/core-lro.SimplePollerLike<OperationState<UserDeleteHeaders>, UserDeleteHeaders>>
beginDeleteAndWait(string, string, string, string, UserDeleteOptionalParams)
حذف مستخدم معين.
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, options?: UserDeleteOptionalParams): Promise<UserDeleteHeaders>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- userId
-
string
معرف المستخدم. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- ifMatch
-
string
ETag للكيان. يجب أن يتطابق ETag مع حالة الكيان الحالية من استجابة العنوان لطلب GET أو يجب أن يكون * للتحديث غير المشروط.
- options
- UserDeleteOptionalParams
معلمات الخيارات.
المرتجعات
Promise<UserDeleteHeaders>
createOrUpdate(string, string, string, UserCreateParameters, UserCreateOrUpdateOptionalParams)
إنشاء مستخدم أو تحديثه.
function createOrUpdate(resourceGroupName: string, serviceName: string, userId: string, parameters: UserCreateParameters, options?: UserCreateOrUpdateOptionalParams): Promise<UserCreateOrUpdateResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- userId
-
string
معرف المستخدم. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- parameters
- UserCreateParameters
إنشاء معلمات أو تحديثها.
- options
- UserCreateOrUpdateOptionalParams
معلمات الخيارات.
المرتجعات
Promise<UserCreateOrUpdateResponse>
generateSsoUrl(string, string, string, UserGenerateSsoUrlOptionalParams)
استرداد عنوان URL لإعادة التوجيه يحتوي على رمز مصادقة لتوقيع مستخدم معين في مدخل المطور.
function generateSsoUrl(resourceGroupName: string, serviceName: string, userId: string, options?: UserGenerateSsoUrlOptionalParams): Promise<GenerateSsoUrlResult>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- userId
-
string
معرف المستخدم. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- options
- UserGenerateSsoUrlOptionalParams
معلمات الخيارات.
المرتجعات
Promise<GenerateSsoUrlResult>
get(string, string, string, UserGetOptionalParams)
يحصل على تفاصيل المستخدم المحدد بواسطة معرفه.
function get(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetOptionalParams): Promise<UserGetResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- userId
-
string
معرف المستخدم. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- options
- UserGetOptionalParams
معلمات الخيارات.
المرتجعات
Promise<UserGetResponse>
getEntityTag(string, string, string, UserGetEntityTagOptionalParams)
الحصول على إصدار حالة الكيان (Etag) للمستخدم المحدد بواسطة المعرف الخاص به.
function getEntityTag(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetEntityTagOptionalParams): Promise<UserGetEntityTagHeaders>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- userId
-
string
معرف المستخدم. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- options
- UserGetEntityTagOptionalParams
معلمات الخيارات.
المرتجعات
Promise<UserGetEntityTagHeaders>
getSharedAccessToken(string, string, string, UserTokenParameters, UserGetSharedAccessTokenOptionalParams)
يحصل على الرمز المميز لتخويل الوصول المشترك للمستخدم.
function getSharedAccessToken(resourceGroupName: string, serviceName: string, userId: string, parameters: UserTokenParameters, options?: UserGetSharedAccessTokenOptionalParams): Promise<UserTokenResult>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- userId
-
string
معرف المستخدم. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- parameters
- UserTokenParameters
إنشاء معلمات رمز التخويل المميز.
معلمات الخيارات.
المرتجعات
Promise<UserTokenResult>
listByService(string, string, UserListByServiceOptionalParams)
يسرد مجموعة من المستخدمين المسجلين في مثيل الخدمة المحدد.
function listByService(resourceGroupName: string, serviceName: string, options?: UserListByServiceOptionalParams): PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- options
- UserListByServiceOptionalParams
معلمات الخيارات.
المرتجعات
update(string, string, string, string, UserUpdateParameters, UserUpdateOptionalParams)
تحديث تفاصيل المستخدم المحدد بواسطة معرفه.
function update(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, parameters: UserUpdateParameters, options?: UserUpdateOptionalParams): Promise<UserUpdateResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- userId
-
string
معرف المستخدم. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- ifMatch
-
string
ETag للكيان. يجب أن يتطابق ETag مع حالة الكيان الحالية من استجابة العنوان لطلب GET أو يجب أن يكون * للتحديث غير المشروط.
- parameters
- UserUpdateParameters
تحديث المعلمات.
- options
- UserUpdateOptionalParams
معلمات الخيارات.
المرتجعات
Promise<UserUpdateResponse>