Get-AzTag

  • Referência
Módulo:
Az.Resources

Obtém tags predefinidas do Azure | Obtém todo o conjunto de tags em um recurso ou assinatura.

Syntax

Get-AzTag
   [[-Name] <String>]
   [-Detailed]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzTag
   -ResourceId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

GetPredefinedTagSet: O cmdlet Get-AzTag obtém marcas predefinidas do Azure em sua assinatura. Este cmdlet retorna informações básicas sobre as tags ou informações detalhadas sobre tags e seus valores. Todos os objetos de saída incluem uma propriedade Count que representa o número de recursos e grupos de recursos aos quais as marcas e os valores foram aplicados. O módulo Marcas do Azure do qual Get-AzTag faz parte pode ajudá-lo a gerenciar marcas do Azure predefinidas. Uma marca do Azure é um par nome-valor que você pode usar para categorizar seus recursos e grupos de recursos do Azure, como por departamento ou centro de custo, ou para controlar anotações ou comentários sobre os recursos e grupos. Você pode definir e aplicar tags em uma única etapa, mas as tags predefinidas permitem estabelecer nomes e valores padrão, consistentes e previsíveis para as tags em sua assinatura. Para criar uma tag predefinida, use o cmdlet New-AzTag. Para aplicar uma tag predefinida a um grupo de recursos, use o parâmetro Tag do cmdlet New-AzTag. Para pesquisar grupos de recursos por um nome de marca específico ou nome e valor, use o parâmetro Tag do cmdlet Get-AzResourceGroup.

GetByResourceIdParameterSet: O cmdlet Get-AzTag com um ResourceId obtém todo o conjunto de tags em um recurso ou assinatura.

Exemplos

Exemplo 1: Obter todas as tags predefinidas

Get-AzTag

Name      Count
========  =====

Department    5
FY2015        2
CostCenter   20

Este comando obtém todas as tags predefinidas na assinatura. A propriedade Count mostra quantas vezes a tag foi aplicada a recursos e grupos de recursos na assinatura.

Exemplo 2: Obter uma etiqueta por nome

Get-AzTag -Name "Department"

Name:   Department
Count:  5
Values: 

        Name        Count
        ==========  =====

        Finance       2
        IT            3

Este comando obtém informações detalhadas sobre a tag Department e seus valores. A propriedade Count mostra quantas vezes a tag e cada um de seus valores foram aplicados a recursos e grupos de recursos na assinatura.

Exemplo 3: Obter valores de todas as tags

Get-AzTag -Detailed

Name:   Department
Count:  5
Values: 

        Name        Count
        ==========  =====

        Finance       2
        IT            3


Name:   FY2015
Count:  2


Name:   CostCenter
Count:  20
Values: 

        Name        Count
        ==========  =====

        0001          5
        0002         10
        0003          5

Este comando usa o parâmetro Detailed para obter informações detalhadas sobre todas as tags predefinidas na assinatura. Usar o parâmetro Detailed é o equivalente a usar o parâmetro Name para cada tag.

Exemplo 4: Obter todo o conjunto de etiquetas numa subscrição

Get-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Id         : {Id}
Name       : {Name}
Type       : {Type}
Properties :
             Name     Value
             =======  =========
             tagKey1  tagValue1
             tagKey2  tagValue2

Este comando obtém todo o conjunto de tags na assinatura com {subId}.

Exemplo 5: Obter todo o conjunto de tags em um recurso

Get-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/testrg/providers/Microsoft.Sql/servers/Server1

Id         : {Id}
Name       : {Name}
Type       : {Type}
Properties :
             Name     Value
             =======  =========
             Dept     Finance
             Status   Normal

Este comando obtém todo o conjunto de tags no recurso com {resourceId}.

Parâmetros

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Detailed

Indica que essa operação adiciona informações sobre valores de tag à saída.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Nome da tag predefinida. Por padrão, Get-AzTag obtém informações básicas sobre todas as tags predefinidas na assinatura. Quando você especifica o parâmetro Name , o parâmetro Detailed não tem efeito.

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ResourceId

O identificador de recurso para a entidade marcada. Um recurso, um grupo de recursos ou uma assinatura podem ser marcados.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Entradas

String

SwitchParameter

Saídas

Microsoft.Azure.Commands.ResourceManager.Common.Tags.PSTag | Microsoft.Azure.Commands.Tags.Model.PSTagResource