Get-EntraAgentUser

Modul:
Microsoft.Entra.Users Module v1.3

Mendapatkan Pengguna Agen berdasarkan ID-nya, atau mencantumkan semua Pengguna Agen yang tersambung ke Identitas Agen.

Sintaks

GetById (Default) 

Get-EntraAgentUser

    [-AgentUserId <String>]
    [<CommonParameters>]

GetByAgentId 

Get-EntraAgentUser

    -AgentId <String>
    [<CommonParameters>]

Deskripsi

Get-EntraAgentUser Cmdlet mengambil Pengguna Agen dari Microsoft Graph menggunakan API v1.0. Saat digunakan dengan -AgentUserId, ini mengembalikan satu pengguna agen. Saat digunakan dengan -AgentId, ini mengembalikan semua pengguna agen yang terhubung ke Identitas Agen yang ditentukan. Jika tidak ada ID pengguna agen yang disediakan dalam set parameter GetById, id pengguna agen yang disimpan dari sesi saat ini atau permintaan untuk satu.

Contoh

Contoh 1: Mendapatkan Pengguna Agen berdasarkan ID

Connect-Entra -Scopes 'User.Read.All'
Get-EntraAgentUser -AgentUserId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"

Contoh ini mengambil Pengguna Agen dengan ID yang ditentukan.

Contoh 2: Dapatkan Pengguna Agen dari sesi saat ini

Connect-Entra -Scopes 'AgentIdUser.ReadWrite.All'
New-EntraAgentUserForAgentId -DisplayName "My Agent User" -UserPrincipalName "myagent@contoso.onmicrosoft.com"
$agentUser = Get-EntraAgentUser
Write-Host "Agent User: $($agentUser.displayName)"

Contoh ini mengambil Pengguna Agen yang dibuat dalam sesi saat ini menggunakan ID pengguna agen tersimpan.

Contoh 3: Mencantumkan semua Pengguna Agen untuk Identitas Agen

Connect-Entra -Scopes 'User.Read.All'
$agentUsers = Get-EntraAgentUser -AgentId "cccccccc-3333-4444-5555-dddddddddddd"
$agentUsers | ForEach-Object { Write-Host "$($_.displayName) ($($_.userPrincipalName))" }

Contoh ini mengambil semua Pengguna Agen yang tersambung ke Identitas Agen yang ditentukan.

Contoh 4: Mendapatkan Pengguna Agen dengan penanganan kesalahan

Connect-Entra -Scopes 'User.Read.All'
try {
    $agentUser = Get-EntraAgentUser -AgentUserId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
    Write-Host "Agent User found: $($agentUser.displayName) ($($agentUser.userPrincipalName))"
} catch {
    Write-Host "Agent User not found or error occurred: $_"
}

Contoh ini menunjukkan cara mengambil Pengguna Agen dengan penanganan kesalahan untuk menangkap kasus di mana pengguna tidak ada.

Parameter

-AgentId

ID Identitas Agen untuk mengambil Pengguna Agen yang terhubung. Mengembalikan semua pengguna agen yang tersambung ke identitas agen yang ditentukan. Digunakan dengan set parameter GetByAgentId.

Properti parameter

Jenis:System.String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

GetByAgentId
Position:Named
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-AgentUserId

ID Pengguna Agen yang akan diambil. Jika tidak disediakan, menggunakan ID pengguna agen tersimpan dari sesi saat ini atau memintanya. Digunakan dengan set parameter GetById.

Properti parameter

Jenis:System.String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

GetById
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

CommonParameters

Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.

Input

None

Output

System.Object

Saat menggunakan -AgentUserId, mengembalikan satu objek Pengguna Agen. Saat menggunakan -AgentId, mengembalikan array objek Pengguna Agen. Setiap objek mencakup properti seperti id, displayName, userPrincipalName, mailNickname, accountEnabled, dan identityParentId.

Catatan

Jika Pengguna Agen atau Identitas Agen dengan ID yang ditentukan tidak ditemukan, cmdlet akan melemparkan kesalahan. Saat mencantumkan menurut Identitas Agen, mendukung penomoran halaman untuk mengambil semua hasil.

Cmdlet ini memerlukan izin Microsoft Graph berikut:

  • User.Read.All