User - List By Service
Belirtilen hizmet örneğindeki kayıtlı kullanıcılar koleksiyonunu listeler.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users?api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users?$filter={$filter}&$top={$top}&$skip={$skip}&expandGroups={expandGroups}&api-version=2022-08-01
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir. |
service
|
path | True |
string |
API Management hizmetinin adı. Normal ifade deseni: |
subscription
|
path | True |
string |
Hedef aboneliğin kimliği. |
api-version
|
query | True |
string |
Bu işlem için kullanılacak API sürümü. |
$filter
|
query |
string |
| Alan | Kullanım | Desteklenen işleçler | Desteklenen işlevler | |
|
$skip
|
query |
integer int32 |
Atacak kayıt sayısı. |
|
$top
|
query |
integer int32 |
Döndürülecek kayıt sayısı. |
|
expand
|
query |
boolean |
Yanıt olarak Ayrıntılı Grup. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
Kullanıcı varlıklarından oluşan bir koleksiyonu listeler. |
|
Other Status Codes |
İşlemin neden başarısız olduğunu açıklayan hata yanıtı. |
Güvenlik
azure_auth
Azure Active Directory OAuth2 Flow.
Tür:
oauth2
Akış:
implicit
Yetkilendirme URL’si:
https://login.microsoftonline.com/common/oauth2/authorize
Kapsamlar
Name | Description |
---|---|
user_impersonation | kullanıcı hesabınızın kimliğine bürünme |
Örnekler
ApiManagementListUsers
Örnek isteği
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users?api-version=2022-08-01
Örnek yanıt
{
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1",
"type": "Microsoft.ApiManagement/service/users",
"name": "1",
"properties": {
"firstName": "Administrator",
"lastName": "",
"email": "admin@live.com",
"state": "active",
"registrationDate": "2015-09-22T01:57:39.677Z",
"identities": [
{
"provider": "Azure",
"id": "admin@live.com"
}
]
}
},
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/56eaec62baf08b06e46d27fd",
"type": "Microsoft.ApiManagement/service/users",
"name": "56eaec62baf08b06e46d27fd",
"properties": {
"firstName": "foo",
"lastName": "bar",
"email": "foo.bar.83@gmail.com",
"state": "active",
"registrationDate": "2016-03-17T17:41:56.327Z",
"identities": [
{
"provider": "Basic",
"id": "foo.bar.83@gmail.com"
}
]
}
},
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b",
"type": "Microsoft.ApiManagement/service/users",
"name": "5931a75ae4bbd512a88c680b",
"properties": {
"firstName": "foo",
"lastName": "bar",
"email": "foobar@outlook.com",
"state": "active",
"registrationDate": "2017-06-02T17:58:50.357Z",
"identities": [
{
"provider": "Microsoft",
"id": "*************"
}
]
}
}
],
"count": 3,
"nextLink": ""
}
Tanımlar
Name | Description |
---|---|
Error |
Hata Alanı sözleşmesi. |
Error |
Hata Yanıtı. |
Group |
Grup sözleşmesi Özellikleri. |
Group |
Grup türü. |
User |
Sayfalanmış Kullanıcılar listesi gösterimi. |
User |
Kullanıcı ayrıntıları. |
User |
Kullanıcı kimliği ayrıntıları. |
User |
Hesap durumu. Kullanıcının etkin olup olmadığını belirtir. Engellenen kullanıcılar geliştirici portalında oturum açamaz veya abone olunan ürünlerin API'lerini çağıramaz. Varsayılan durum Etkin'dir. |
ErrorFieldContract
Hata Alanı sözleşmesi.
Name | Tür | Description |
---|---|---|
code |
string |
Özellik düzeyi hata kodu. |
message |
string |
Özellik düzeyi hatanın insan tarafından okunabilir gösterimi. |
target |
string |
Özellik adı. |
ErrorResponse
Hata Yanıtı.
Name | Tür | Description |
---|---|---|
error.code |
string |
Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum görevi görür. |
error.details |
Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi. |
|
error.message |
string |
Hatanın insan tarafından okunabilir gösterimi. |
GroupContractProperties
Grup sözleşmesi Özellikleri.
Name | Tür | Description |
---|---|---|
builtIn |
boolean |
Grup üç sistem grubundan biriyse (Yöneticiler, Geliştiriciler veya Konuklar); aksi takdirde false. |
description |
string |
Grup açıklaması. HTML biçimlendirme etiketleri içerebilir. |
displayName |
string |
Grup adı. |
externalId |
string |
Dış gruplar için bu özellik, dış kimlik sağlayıcısından gelen grubun kimliğini (örneğin, Azure Active Directory |
type |
Grup türü. |
GroupType
Grup türü.
Name | Tür | Description |
---|---|---|
custom |
string |
|
external |
string |
|
system |
string |
UserCollection
Sayfalanmış Kullanıcılar listesi gösterimi.
Name | Tür | Description |
---|---|---|
count |
integer |
Tüm sayfalardaki toplam kayıt sayısı. |
nextLink |
string |
Varsa sonraki sayfa bağlantısı. |
value |
Sayfa değerleri. |
UserContract
Kullanıcı ayrıntıları.
Name | Tür | Default value | Description |
---|---|---|---|
id |
string |
Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
name |
string |
Kaynağın adı |
|
properties.email |
string |
E-posta adresi. |
|
properties.firstName |
string |
Adı. |
|
properties.groups |
Kullanıcının parçası olduğu grup koleksiyonu. |
||
properties.identities |
Kullanıcı kimlikleri koleksiyonu. |
||
properties.lastName |
string |
Soyadı. |
|
properties.note |
string |
Yönetici tarafından ayarlanan bir kullanıcı hakkında isteğe bağlı not. |
|
properties.registrationDate |
string |
Kullanıcı kaydı tarihi. Tarih şu biçime uygundur: |
|
properties.state | active |
Hesap durumu. Kullanıcının etkin olup olmadığını belirtir. Engellenen kullanıcılar geliştirici portalında oturum açamaz veya abone olunan ürünlerin API'lerini çağıramaz. Varsayılan durum Etkin'dir. |
|
type |
string |
Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts" |
UserIdentityContract
Kullanıcı kimliği ayrıntıları.
Name | Tür | Description |
---|---|---|
id |
string |
Sağlayıcı içindeki tanımlayıcı değeri. |
provider |
string |
Kimlik sağlayıcısı adı. |
UserState
Hesap durumu. Kullanıcının etkin olup olmadığını belirtir. Engellenen kullanıcılar geliştirici portalında oturum açamaz veya abone olunan ürünlerin API'lerini çağıramaz. Varsayılan durum Etkin'dir.
Name | Tür | Description |
---|---|---|
active |
string |
Kullanıcı durumu etkin. |
blocked |
string |
Kullanıcı engellendi. Engellenen kullanıcılar geliştirici portalında veya çağrı API'sinde kimlik doğrulaması yapamaz. |
deleted |
string |
Kullanıcı hesabı kapatıldı. Tüm kimlikler ve ilgili varlıklar kaldırılır. |
pending |
string |
Kullanıcı hesabı beklemede. Etkin hale getirilmeden önce kimlik onayı gerektirir. |