Get-EntraSubscription

Módulo:
Microsoft.Entra.DirectoryManagement Module v1.3

Listar as assinaturas comerciais da organização.

Sintaxe

GetQuery (Default) 

Get-EntraSubscription

    [-Top <Int32>]
    [-All]
    [-Filter <String>]
    [-Property <String[]>]
    [<CommonParameters>]

GetById 

Get-EntraSubscription

    -CommerceSubscriptionId <String>
    [-Property <String[]>]
    [<CommonParameters>]

Description

O Get-EntraSubscription cmdlet lista as assinaturas comerciais da organização.

Em cenários delegados com contas corporativas ou de estudante, ao agir em outro usuário, o usuário conectado deve ter uma função de Microsoft Entra com suporte ou uma função personalizada com as permissões necessárias. As seguintes funções com privilégios mínimos dão suporte a esta operação:

  • Administrador do Dynamics 365 Business Central - propriedades padrão só de leitura
  • Leitor Global
  • Leitores de diretório

Exemplos

Exemplo 1: Obter todas as assinaturas comerciais da organização

Connect-Entra -Scopes 'Organization.Read.All'
Get-EntraSubscription -All

skuPartNumber          : POWER_BI_STANDARD
ownerId                :
id                     : aaaa0000-bb11-2222-33cc-444444dddddd
nextLifecycleDateTime  : 9/24/2025 11:59:59 PM
ownerType              :
isTrial                : True
ownerTenantId          :
createdDateTime        : 9/24/2023 12:00:00 AM
serviceStatus          : {EXCHANGE_S_FOUNDATION, DYN365_ENTERPRISE_P1_IW}
totalLicenses          : 1
skuId                  : 0000aaaa-11bb-cccc-dd22-eeeeee333333
status                 : Enabled
commerceSubscriptionId : eeeeeeee-4444-5555-6666-ffffffffffff

Este exemplo demonstra como recuperar assinaturas comerciais especificadas.

Exemplo 2: Obter assinaturas comerciais por CommerceSubscriptionId

Connect-Entra -Scopes 'Organization.Read.All'
Get-EntraSubscription -CommerceSubscriptionId 'eeeeeeee-4444-5555-6666-ffffffffffff'

skuPartNumber          : POWER_BI_STANDARD
ownerId                :
id                     : aaaa0000-bb11-2222-33cc-444444dddddd
nextLifecycleDateTime  : 9/24/2025 11:59:59 PM
ownerType              :
isTrial                : True
ownerTenantId          :
createdDateTime        : 9/24/2023 12:00:00 AM
serviceStatus          : {EXCHANGE_S_FOUNDATION, DYN365_ENTERPRISE_P1_IW}
totalLicenses          : 1
skuId                  : 0000aaaa-11bb-cccc-dd22-eeeeee333333
status                 : Enabled
commerceSubscriptionId : eeeeeeee-4444-5555-6666-ffffffffffff

Este exemplo demonstra como recuperar assinaturas comerciais especificadas por CommerceSubscriptionId.

  • -CommerceSubscriptionId O parâmetro especifica a ID da assinatura no sistema de comércio.

Exemplo 3: Obter planos de licença disponíveis com filtragem

Connect-Entra -Scopes 'Organization.Read.All'
Get-EntraSubscription -Filter "id eq 'aaaa0000-bb11-2222-33cc-444444dddddd'"

skuPartNumber          : POWER_BI_STANDARD
ownerId                :
id                     : aaaa0000-bb11-2222-33cc-444444dddddd
nextLifecycleDateTime  : 9/24/2025 11:59:59 PM
ownerType              :
isTrial                : True
ownerTenantId          :
createdDateTime        : 9/24/2023 12:00:00 AM
serviceStatus          : {EXCHANGE_S_FOUNDATION, DYN365_ENTERPRISE_P1_IW}
totalLicenses          : 1
skuId                  : 0000aaaa-11bb-cccc-dd22-eeeeee333333
status                 : Enabled
commerceSubscriptionId : eeeeeeee-4444-5555-6666-ffffffffffff

Este exemplo demonstra como recuperar assinaturas comerciais especificadas com a propriedade de filtragem Id .

Exemplo 4: recuperar o SKU da assinatura (unidade de manutenção do repositório)

Connect-Entra -Scopes 'Organization.Read.All'
Get-EntraSubscription -Property skuPartNumber, Status | Select-Object skuPartNumber, Status

skuPartNumber                                                   status
-------------                                                   ------
STREAM                                                          Enabled
EMSPREMIUM                                                      Enabled
UNIVERSAL_PRINT_M365                                            Enabled
Microsoft_365_Copilot                                           Enabled
WINDOWS_STORE                                                   Enabled

Este exemplo demonstra como recuperar a SKU da assinatura. Você pode usar -Select como um alias para -Property.

Exemplo 5: Obter uma lista de assinaturas comerciais ativas

Connect-Entra -Scopes 'Organization.Read.All'
Get-EntraSubscription |
    Where-Object {
        ($_.Status -ne "Suspended" -and $_.Status -ne "LockedOut") -and
        ($_.NextLifecycleDateTime -ne $null)
    } |
    Sort-Object NextLifecycleDateTime |
    Select-Object *

skuPartNumber          : POWER_BI_STANDARD
ownerId                :
id                     : aaaa0000-bb11-2222-33cc-444444dddddd
nextLifecycleDateTime  : 9/24/2025 11:59:59 PM
ownerType              :
isTrial                : True
ownerTenantId          :
createdDateTime        : 9/24/2023 12:00:00 AM
serviceStatus          : {EXCHANGE_S_FOUNDATION, DYN365_ENTERPRISE_P1_IW}
totalLicenses          : 1000
skuId                  : 0000aaaa-11bb-cccc-dd22-eeeeee333333
status                 : Enabled
commerceSubscriptionId : eeeeeeee-4444-5555-6666-ffffffffffff

Este exemplo demonstra como recuperar assinaturas comerciais ativas.

Parâmetros

-All

Listar todas as páginas.

Propriedades do parâmetro

Tipo:System.Management.Automation.SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-CommerceSubscriptionId

Especifica a ID da assinatura no sistema de comércio.

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:Id de Assinatura

Conjuntos de parâmetros

GetById
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Filter

Especifica uma instrução de filtro OData v4.0. Esse parâmetro filtra quais objetos são retornados.

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

GetQuery
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Property

Especifica as propriedades a serem retornadas.

Propriedades do parâmetro

Tipo:

System.String[]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:Select

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Top

Especifica o número máximo de registros a serem retornados.

Propriedades do parâmetro

Tipo:System.Int32
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:Limit

Conjuntos de parâmetros

GetQuery
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Observações

Get-EntraDirectorySubscription é um alias para Get-EntraSubscription.