Get-AzTag
Obtém marcas predefinidas do Azure | Obtém todo o conjunto de marcas em um recurso ou assinatura.
Sintaxe
GetPredefinedTagParameterSet
Get-AzTag
[[-Name] <String>]
[-Detailed]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByResourceIdParameterSet
Get-AzTag
-ResourceId <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
GetPredefinedTagSet: o cmdlet Get-AzTag obtém marcas predefinidas do Azure em sua assinatura. Esse cmdlet retorna informações básicas sobre as marcas ou informações detalhadas sobre marcas 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 valores foram aplicados. O módulo Azure Tags do qual Get-AzTag faz parte pode ajudá-lo a gerenciar marcas predefinidas do Azure. 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 custos, ou para acompanhar anotações ou comentários sobre os recursos e grupos. Você pode definir e aplicar marcas em uma única etapa, mas marcas predefinidas permitem estabelecer nomes e valores padrão, consistentes e previsíveis para as marcas em sua assinatura. Para criar uma marca predefinida, use o cmdlet New-AzTag. Para aplicar uma marca predefinida a um grupo de recursos, use o parâmetro Tag do cmdlet New-AzTag. Para pesquisar em grupos de recursos um nome ou nome e valor de marca específicos, use o parâmetro Tag do cmdlet Get-AzResourceGroup.
GetByResourceIdParameterSet: o cmdlet Get-AzTag com um ResourceId obtém todo o conjunto de marcas em um recurso ou assinatura.
Exemplos
Exemplo 1: Obter todas as marcas predefinidas
Get-AzTag
Name Count
======== =====
Department 5
FY2015 2
CostCenter 20
Esse comando obtém todas as marcas predefinidas na assinatura. A propriedade Count mostra quantas vezes a marca foi aplicada a recursos e grupos de recursos na assinatura.
Exemplo 2: Obter uma marca por nome
Get-AzTag -Name "Department"
Name: Department
Count: 5
Values:
Name Count
========== =====
Finance 2
IT 3
Esse comando obtém informações detalhadas sobre a marca departamento e seus valores. A propriedade Count mostra quantas vezes a marca e cada um de seus valores foram aplicados a recursos e grupos de recursos na assinatura.
Exemplo 3: Obter valores de todas as marcas
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
Esse comando usa o parâmetro Detalhado para obter informações detalhadas sobre todas as marcas predefinidas na assinatura. Usar o parâmetro Detalhado é o equivalente a usar o parâmetro Name para cada marca.
Exemplo 4: Obter todo o conjunto de marcas em uma assinatura
Get-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Id : {Id}
Name : {Name}
Type : {Type}
Properties :
Name Value
======= =========
tagKey1 tagValue1
tagKey2 tagValue2
Esse comando obtém todo o conjunto de marcas na assinatura com {subId}.
Exemplo 5: Obter todo o conjunto de marcas 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
Esse comando obtém todo o conjunto de marcas no recurso com {resourceId}.
Parâmetros
-DefaultProfile
As credenciais, a conta, o locatário e a assinatura usados para comunicação com o Azure.
Propriedades do parâmetro
| Tipo: | IAzureContextContainer |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
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 |
-Detailed
Indica que essa operação adiciona informações sobre valores de marca à saída.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
GetPredefinedTagParameterSet
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-Name
Nome da marca predefinida. Por padrão, Get-AzTag obtém informações básicas sobre todas as marcas predefinidas na assinatura. Quando você especifica o parâmetro Name , o parâmetro Detalhado não tem efeito.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
GetPredefinedTagParameterSet
| Cargo: | 0 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-ResourceId
O identificador de recurso para a entidade marcada. Um recurso, um grupo de recursos ou uma assinatura podem ser marcados.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
GetByResourceIdParameterSet
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| 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.