Get-EntraAgentIdentity

Модуль:
Microsoft.Entra.Applications Module v1.3

Возвращает удостоверение агента по идентификатору или перечисляет все удостоверения агента для схемы удостоверения агента.

Синтаксис

GetById (По умолчанию) 

Get-EntraAgentIdentity

    -AgentId <String>
    [<CommonParameters>]

GetByBlueprint 

Get-EntraAgentIdentity

    [-AgentIdentityBlueprintId <String>]
    [<CommonParameters>]

Описание

Командлет Get-EntraAgentIdentity получает удостоверение агента из Microsoft Graph. При использовании с ним возвращается -AgentIdодно удостоверение агента. При использовании -AgentIdentityBlueprintIdон возвращает все удостоверения агента, которые являются дочерними элементами указанной схемы. Если идентификатор схемы не указан, использует хранимый идентификатор схемы из текущего сеанса или запрашивает его.

Примеры

Пример 1. Получение удостоверения агента по идентификатору

Connect-Entra -Scopes 'Application.Read.All'
Get-EntraAgentIdentity -AgentId "27a3cf14-5bdc-4814-bb13-8f1740ca9a4f"

В этом примере извлекается удостоверение агента с указанным идентификатором.

Пример 2. Вывод списка всех удостоверений агента для схемы

Connect-Entra -Scopes 'Application.Read.All'
$agents = Get-EntraAgentIdentity -AgentIdentityBlueprintId "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
$agents | ForEach-Object { Write-Host "$($_.displayName) ($($_.id))" }

В этом примере извлекаются все удостоверения агента, которые являются дочерними элементами указанной схемы удостоверения агента.

Пример 3. Перечисление удостоверений агента для текущей схемы сеанса

Connect-Entra -Scopes 'Application.Read.All'
New-EntraAgentIdentityBlueprint -DisplayName "My Blueprint" -SponsorUserIds @("admin@contoso.com")
$agents = Get-EntraAgentIdentity -AgentIdentityBlueprintId
$agents | ForEach-Object { Write-Host "$($_.displayName)" }

В этом примере перечислены все удостоверения агента для схемы, созданной в текущем сеансе, с помощью хранимого идентификатора схемы.

Пример 4. Получение удостоверения агента с обработкой ошибок

Connect-Entra -Scopes 'Application.Read.All'
try {
    $agent = Get-EntraAgentIdentity -AgentId "27a3cf14-5bdc-4814-bb13-8f1740ca9a4f"
    Write-Host "Agent found: $($agent.displayName)"
} catch {
    Write-Host "Agent not found or error occurred: $_"
}

В этом примере показано, как получить удостоверение агента с обработкой ошибок для перехвата случаев, когда агент не существует.

Параметры

-AgentId

Идентификатор извлекаемого удостоверения агента. Используется с набором параметров GetById.

Свойства параметров

Тип:System.String
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

GetById
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-AgentIdentityBlueprintId

Идентификатор схемы удостоверения агента для перечисления удостоверений дочернего агента. Если он не указан, использует хранимый идентификатор схемы из текущего сеанса или запрашивает его. Используется с набором параметров GetByBlueprint.

Свойства параметров

Тип:System.String
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

GetByBlueprint
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

Входные данные

None

Выходные данные

System.Object

При использовании -AgentIdвозвращает один объект идентификатора агента. При использовании -AgentIdentityBlueprintIdвозвращает массив объектов удостоверений агента. Каждый объект включает такие свойства, как id, displayName, appId и servicePrincipalType.

Примечания

Если идентификатор агента или схема с указанным идентификатором не найдена, командлет вызовет ошибку. При перечислении по схеме поддерживает разбиение на страницы для получения всех результатов.

Для этого командлета требуются следующие разрешения Microsoft Graph:

  • Application.Read.All