User - List By Service

Mencantumkan kumpulan pengguna terdaftar dalam instans layanan yang ditentukan.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users?api-version=2021-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=2021-08-01

Parameter URI

Name In Required Type Description
resourceGroupName
path True
  • string

Nama grup sumber daya.

serviceName
path True
  • string

Nama layanan API Management.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Info masuk langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.

api-version
query True
  • string

Versi API yang akan digunakan dengan permintaan klien.

$filter
query
  • string

| | Bidang | penggunaan Operator yang didukung | Fungsi yang didukung |
|-------------|-------------|-------------|-------------|
| nama | filter | ge, le, eq, ne, gt, lt | substringof, berisi, dimulai dengan, diakhiri dengan |
| | firstName filter | ge, le, eq, ne, gt, lt | substringof, berisi, dimulai dengan, diakhiri dengan |
| | lastName filter | ge, le, eq, ne, gt, lt | substringof, berisi, dimulai dengan, diakhiri dengan |
| | email filter | ge, le, eq, ne, gt, lt | substringof, berisi, dimulai dengan, diakhiri dengan |
| | status filter | eq | |
| registrationDate | filter | ge, le, eq, ne, gt, lt | |
| catatan | filter | ge, le, eq, ne, gt, lt | substringof, berisi, dimulai dengan, diakhiri dengan |
| | grup perluas | | |

$skip
query
  • integer
int32

Jumlah rekaman yang akan dilewati.

$top
query
  • integer
int32

Jumlah rekaman yang akan dikembalikan.

expandGroups
query
  • boolean

Grup Terperinci sebagai respons.

Respons

Name Type Description
200 OK

Mencantumkan kumpulan entitas Pengguna.

Other Status Codes

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation meniru akun pengguna Anda

Contoh

ApiManagementListUsers

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users?api-version=2021-08-01

Sample Response

{
  "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": ""
}

Definisi

ErrorFieldContract

Kontrak Bidang Kesalahan.

ErrorResponse

Respons Kesalahan.

GroupContractProperties

Properti kontrak grup.

GroupType

Jenis grup.

UserCollection

Representasi daftar Pengguna Berhala.

UserContract

Detail pengguna.

UserIdentityContract

Detail identitas pengguna.

UserState

Status akun. Menentukan apakah pengguna aktif atau tidak. Pengguna yang diblokir tidak dapat masuk ke portal pengembang atau memanggil API produk langganan apa pun. Status default adalah Aktif.

ErrorFieldContract

Kontrak Bidang Kesalahan.

Name Type Description
code
  • string

Kode kesalahan tingkat properti.

message
  • string

Representasi kesalahan tingkat properti yang dapat dibaca manusia.

target
  • string

Nama properti.

ErrorResponse

Respons Kesalahan.

Name Type Description
error.code
  • string

Kode kesalahan yang ditentukan layanan. Kode ini berfungsi sebagai sub-status untuk kode kesalahan HTTP yang ditentukan dalam respons.

error.details

Daftar bidang yang tidak valid dikirim dalam permintaan, jika terjadi kesalahan validasi.

error.message
  • string

Representasi kesalahan yang dapat dibaca manusia.

GroupContractProperties

Properti kontrak grup.

Name Type Description
builtIn
  • boolean

true jika grup adalah salah satu dari tiga grup sistem (Administrator, Pengembang, atau Tamu); jika tidak salah.

description
  • string

Deskripsi grup. Dapat berisi tag pemformatan HTML.

displayName
  • string

Nama grup.

externalId
  • string

Untuk grup eksternal, properti ini berisi id grup dari penyedia identitas eksternal, misalnya untuk Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; jika tidak, nilainya null.

type

Jenis grup.

GroupType

Jenis grup.

Name Type Description
custom
  • string
external
  • string
system
  • string

UserCollection

Representasi daftar Pengguna Berhala.

Name Type Description
count
  • integer

Jumlah jumlah rekaman total di semua halaman.

nextLink
  • string

Tautan halaman berikutnya jika ada.

value

Nilai halaman.

UserContract

Detail pengguna.

Name Type Default Value Description
id
  • string

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

Nama sumber daya.

properties.email
  • string

Alamat Email.

properties.firstName
  • string

Nama depan.

properties.groups

Kumpulan pengguna grup adalah bagian dari.

properties.identities

Kumpulan identitas pengguna.

properties.lastName
  • string

Nama belakang.

properties.note
  • string

Catatan opsional tentang pengguna yang ditetapkan oleh administrator.

properties.registrationDate
  • string

Tanggal pendaftaran pengguna. Tanggal sesuai dengan format berikut: yyyy-MM-ddTHH:mm:ssZ seperti yang ditentukan oleh standar ISO 8601.

properties.state active

Status akun. Menentukan apakah pengguna aktif atau tidak. Pengguna yang diblokir tidak dapat masuk ke portal pengembang atau memanggil API produk langganan apa pun. Status default adalah Aktif.

type
  • string

Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft. Storage/storageAccounts"

UserIdentityContract

Detail identitas pengguna.

Name Type Description
id
  • string

Nilai pengidentifikasi dalam penyedia.

provider
  • string

Nama penyedia identitas.

UserState

Status akun. Menentukan apakah pengguna aktif atau tidak. Pengguna yang diblokir tidak dapat masuk ke portal pengembang atau memanggil API produk langganan apa pun. Status default adalah Aktif.

Name Type Description
active
  • string

Status pengguna aktif.

blocked
  • string

Pengguna diblokir. Pengguna yang diblokir tidak dapat mengautentikasi di portal pengembang atau memanggil API.

deleted
  • string

Akun pengguna ditutup. Semua identitas dan entitas terkait dihapus.

pending
  • string

Akun pengguna tertunda. Memerlukan konfirmasi identitas sebelum dapat dibuat aktif.