Get-EntraAgentUser

Modül:
Microsoft.Entra.Users Module v1.3

Bir Aracı Kullanıcısını kimliğine göre alır veya Bir Aracı Kimliğine bağlı tüm Aracı Kullanıcılarını listeler.

Syntax

GetById (Varsayılan) 

Get-EntraAgentUser

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

GetByAgentId 

Get-EntraAgentUser

    -AgentId <String>
    [<CommonParameters>]

Description

cmdlet'i Get-EntraAgentUser v1.0 API'sini kullanarak Microsoft Graph Aracı Kullanıcılarını alır. ile -AgentUserIdkullanıldığında tek bir aracı kullanıcı döndürür. ile -AgentIdkullanıldığında, belirtilen Aracı Kimliğine bağlı tüm aracı kullanıcılarını döndürür. GetById parametre kümesinde hiçbir aracı kullanıcı kimliği sağlanmazsa, geçerli oturumdaki depolanan aracı kullanıcı kimliğini kullanır veya bir tane ister.

Örnekler

Örnek 1: Kimliğine Göre Aracı Kullanıcısı Alma

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

Bu örnek, belirtilen kimlikle Aracı Kullanıcısını alır.

Örnek 2: Aracı Kullanıcısını geçerli oturumdan alma

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)"

Bu örnek, depolanan aracı kullanıcı kimliği kullanılarak geçerli oturumda oluşturulan Aracı Kullanıcısını alır.

Örnek 3: Bir Aracı Kimliği için Tüm Aracı Kullanıcılarını Listeleme

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

Bu örnek, belirtilen Aracı Kimliğine bağlı tüm Aracı Kullanıcılarını alır.

Örnek 4: Hata işleme ile aracı kullanıcı alma

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: $_"
}

Bu örnekte, kullanıcının mevcut olmadığı durumları yakalamak için hata işlemeye sahip bir Aracı Kullanıcısının nasıl alınacağı gösterilmektedir.

Parametreler

-AgentId

Bağlı Aracı Kullanıcılarını almak için Aracı Kimliğinin kimliği. Belirtilen aracı kimliğine bağlı tüm aracı kullanıcılarını döndürür. GetByAgentId parametre kümesiyle kullanılır.

Parametre özellikleri

Tür:System.String
Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

GetByAgentId
Position:Named
Zorunlu:True
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-AgentUserId

Alınacak Aracı Kullanıcı kimliği. Sağlanmadıysa, geçerli oturumdaki depolanan aracı kullanıcı kimliğini kullanır veya bir tane ister. GetById parametre kümesiyle kullanılır.

Parametre özellikleri

Tür:System.String
Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

GetById
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

CommonParameters

Bu cmdlet yaygın parametreleri destekler: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction ve -WarningVariable. Daha fazla bilgi için bkz. about_CommonParameters.

Girişler

None

Çıkışlar

System.Object

kullanırken -AgentUserIdtek bir Aracı Kullanıcı nesnesi döndürür. kullanırken -AgentId, Aracı Kullanıcısı nesnelerinin bir dizisini döndürür. Her nesne id, displayName, userPrincipalName, mailNickname, accountEnabled ve identityParentId gibi özellikler içerir.

Notlar

Belirtilen kimliğe sahip Aracı Kullanıcı veya Aracı Kimliği bulunamazsa, cmdlet bir hata oluşturur. Aracı Kimliğine göre listelendiğinde, tüm sonuçları almak için sayfalandırmayı destekler.

Bu cmdlet aşağıdaki Microsoft Graph izinlerini gerektirir:

  • User.Read.All