User - Get

Hizmet:

API Management

API Sürümü:

2024-05-01

Tanımlayıcısı tarafından belirtilen kullanıcının ayrıntılarını alır.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?api-version=2024-05-01

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management hizmetinin adı.
subscriptionId	path	True	string (uuid)	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
userId	path	True	string minLength: 1 maxLength: 80	Kullanıcı tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	UserContract	Belirtilen kullanıcı varlığını alır. Üst Bilgiler ETag: string
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

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

ApiManagementGetUser

Örnek isteği

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b?api-version=2024-05-01

Örnek yanıt

Durum kodu:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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": "*************"
      }
    ]
  }
}

Tanımlar

Name	Description
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
GroupContractProperties	Grup sözleşmesi Özellikleri.
GroupType	Grup türü.
UserContract	Kullanıcı ayrıntıları.
UserIdentityContract	Kullanıcı kimliği ayrıntıları.
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.

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Object

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Object

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

GroupContractProperties

Object

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 maxLength: 1000	Grup açıklaması. HTML biçimlendirme etiketleri içerebilir.
displayName	string minLength: 1 maxLength: 300	Grup adı.
externalId	string	Dış gruplar için, bu özellik dış kimlik sağlayıcısından grubun kimliğini içerir; örneğin Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; aksi takdirde değer null değeridir.
type	GroupType	Grup türü.

GroupType

Listeleme

Grup türü.

Değer	Description
custom
system
external

UserContract

Object

Kullanıcı ayrıntıları.

Name	Tür	Default value	Description
id	string		Kaynağın tam kaynak kimliği. Örn - /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	GroupContractProperties[]		Kullanıcının bir parçası olduğu grup koleksiyonu.
properties.identities	UserIdentityContract[]		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 (date-time)		Kullanıcı kaydının tarihi. Tarih şu biçime uygundur: ISO 8601 standardı tarafından belirtilen yyyy-MM-ddTHH:mm:ssZ.
properties.state	UserState	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

Object

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

Listeleme

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.

Değer	Description
active	Kullanıcı durumu etkin.
blocked	Kullanıcı engellendi. Engellenen kullanıcılar geliştirici portalında veya çağrı API'sinde kimlik doğrulaması yapamaz.
pending	Kullanıcı hesabı bekliyor. Etkin hale getirilmeden önce kimlik onayı gerektirir.
deleted	Kullanıcı hesabı kapatıldı. Tüm kimlikler ve ilgili varlıklar kaldırılır.