Microsoft.Azure.Commands.Tags.dll-help.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml">
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <!--Generated by PS Cmdlet Help Editor-->
    <command:details>
      <command:name>Get-AzureRmTag</command:name>
      <maml:description>
        <maml:para>Gets predefined Azure tags</maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para />
      </maml:copyright>
      <command:verb>Get</command:verb>
      <command:noun>AzureTag</command:noun>
      <dev:version />
    </command:details>
    <maml:description>
      <!--This is the Description section-->
      <maml:para>The Get-AzureRmTag cmdlet gets predefined Azure tags in your subscription. This cmdlet returns basic information about the tags or detailed information about tags and their values. All output objects include a Count property that represents the number of resources and resource groups to which the tags and values have been applied. Get-AzureRmTag is part of a set of cmdlets (New/Get/Remove) that help you manage predefined Azure tags.An Azure "tag" is a name-value pair that you can use to categorize your Azure resources and resource groups, such as by department or cost center, or to track notes or comments about the resources and groups. You can define and apply tags in a single step, but predefined tags let you establish standard, consistent, predictable names and values for the tags in your subscription. If the subscription includes any predefined tags, you cannot apply undefined tags or values to any resource or resource group in the subscription.To create a predefined tag, use the New-AzureRmTag cmdlet. To apply a predefined tag to a resource or resource group. use the Tag parameters of the New and Set cmdlets in the AzureResourceManager module. To search for resources or resource groups with a specified tag name or name and value, use the Tag parameters of the Get-AzureRmResource and Get-AzureRmResourceGroup cmdlets.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-AzureRmTag</maml:name>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0">
          <maml:name>Name</maml:name>
          <maml:description>
            <maml:para>Gets detailed information about the predefined tag with the specified name. By default, Get-AzureRmTag gets basic information about all predefined tags in the subscription.When you use the Name parameter, the Detailed parameter has no effect.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
          <maml:name>Detailed</maml:name>
          <maml:description>
            <maml:para>Adds information about tag values to the output.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0">
        <maml:name>Name</maml:name>
        <maml:description>
          <maml:para>Gets detailed information about the predefined tag with the specified name. By default, Get-AzureRmTag gets basic information about all predefined tags in the subscription.When you use the Name parameter, the Detailed parameter has no effect.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
        <maml:name>Detailed</maml:name>
        <maml:description>
          <maml:para>Adds information about tag values to the output.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>None</maml:name>
          <maml:uri />
          <maml:description>
            <maml:para>
            </maml:para>
          </maml:description>
        </dev:type>
        <maml:description>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>Microsoft.Azure.Commands.Tags.Model.PSTag, Microsoft.Azure.Commands.Tags</maml:name>
          <maml:uri />
          <maml:description>
            <maml:para>
            </maml:para>
          </maml:description>
        </dev:type>
        <maml:description>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <command:terminatingErrors>
    </command:terminatingErrors>
    <command:nonTerminatingErrors>
    </command:nonTerminatingErrors>
    <maml:alertSet>
      <maml:title>
      </maml:title>
      <maml:alert>
        <maml:para>
        </maml:para>
        <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, tag, tags, resource, group</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>--------------------------  Example 1: Get all predefined tags  --------------------------</maml:title>
        <maml:introduction>
          <maml:para>
          </maml:para>
        </maml:introduction>
        <dev:code>PS C:\&gt;Get-AzureRmTag
Name      Count

========  =====

Department    5

FY2015        2

CostCenter   20</dev:code>
        <dev:remarks>
          <maml:para>This command gets all predefined tags in the subscription. The Count property shows how many times the tag has been applied to resources and resource groups in the subscription.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText>
            </command:commandText>
          </command:commandLine>
        </command:commandLines>
      </command:example>
      <command:example>
        <maml:title>--------------------------  Example 2: Get a tag by name  --------------------------</maml:title>
        <maml:introduction>
          <maml:para>
          </maml:para>
        </maml:introduction>
        <dev:code>PS C:\&gt;Get-AzureRmTag -Name Department
Name:   Department

Count:  5

Values: 

        Name        Count

        ==========  =====

        Finance       2

        IT            3</dev:code>
        <dev:remarks>
          <maml:para>This command gets detailed information about the Department tag and its values. The Count property shows how many times the tag and each of its values has been applied to resources and resource groups in the subscription.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText>
            </command:commandText>
          </command:commandLine>
        </command:commandLines>
      </command:example>
      <command:example>
        <maml:title>--------------------------  Example 3: Get values of all tags  --------------------------</maml:title>
        <maml:introduction>
          <maml:para>
          </maml:para>
        </maml:introduction>
        <dev:code>PS C:\&gt;Get-AzureRmTag -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</dev:code>
        <dev:remarks>
          <maml:para>This command uses the Detailed parameter to get detailed information about all predefined tags in the subscription. It's the equivalent of using the Name parameter for every tag.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=404173</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmTag</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmTag</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureRmTag</command:name> <maml:description> <maml:para>Creates a predefined Azure tag or adds values to an existing tag</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureTag</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The New-AzureRmTag cmdlet creates a predefined Azure tag with an optional predefined value. You can also use it to add additional values to existing predefined tags. To create a new predefined tag, enter a unique tag name. To add a value to an existing predefined tag, specify the name of the existing tag and the new value. This cmdlet returns an object that represents the new or changed tag with its values and the number of resources to which it has been applied. New-AzureRmTag is part of a set of cmdlets (New/Get/Remove) that let you manage predefined Azure tags.An Azure "tag" is a name-value pair that you can use to categorize your Azure resources and resource groups, such as by department or cost center, or to track notes or comments about the resources and groups. You can define and apply tags in a single step, but predefined tags let you establish standard, consistent, predictable names and values for the tags in your subscription. If the subscription includes any predefined tags, you cannot apply undefined tags or values to any resource or resource group in the subscription.To apply a predefined tag to a resource or resource group. use the Tag parameters of the New and Set cmdlets in the AzureResourceManager module. To search for resources or resource groups with a specified tag name or name and value, use the Tag parameters of the Get-AzureRmResource and Get-AzureRmResourceGroup cmdlets.Every tag has a name. The values are optional. A predefined Azure tag can have multiple values, but when you apply the tag to a resource or resource group, you apply the tag name and only one of its values. For example, you can create a predefined Department tag with a value for each department, such as Finance, Human Resources, and IT. When you apply the Department tag to a resource, you apply only one predefined value, such as Finance.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmTag</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the tag name. To create a new predefined tag, enter a unique name. To add a new value to an existing tag, enter the name of the existing tag.If an existing predefined tag has the specified name, New-AzureRmTag adds the specified value, if any, to the tag with that name, instead of creating a new tag.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies a tag value. Predefined tags can have multiple value, but you can enter only one value in each command. This parameter is optional, because tags can have names and no values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the tag name. To create a new predefined tag, enter a unique name. To add a new value to an existing tag, enter the name of the existing tag.If an existing predefined tag has the specified name, New-AzureRmTag adds the specified value, if any, to the tag with that name, instead of creating a new tag.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies a tag value. Predefined tags can have multiple value, but you can enter only one value in each command. This parameter is optional, because tags can have names and no values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Tags.Model.PSTag</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, tag, tags, resource, group</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Create a predefined tag --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\&gt;New-AzureRmTag -Name FY2015 Name: Department Count: 0 Values: Name Count ========= ===== Finance 0</dev:code> <dev:remarks> <maml:para>This command creates a predefined tag named "FY2015". This tag has no values. You can apply a tag with no values to a resource or resource group, or use New-AzureRmTag to add values to the tag. You can also specify a value when you apply the tag to the resource or resource group.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Create a predefined tag with a value --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\&gt;New-AzureRmTag -Name Department -Value Finance Name: Department Count: 0 Values: Name Count ========= ===== Finance 0</dev:code> <dev:remarks> <maml:para>This command creates a Department predefined tag with a value of Finance.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3: Add a value to a predefined tag --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\&gt;New-AzureRmTag -Name Department -Value Finance Name: Department Count: 0 Values: Name Count ========= ===== Finance 0 PS C:\&gt;New-AzureRmTag -Name Department -Value IT Name: Department Count: 0 Values: Name Count ========= ===== Finance 0 IT 0</dev:code> <dev:remarks> <maml:para>These commands creates a Department predefined tag with two values. When the tag name exists, New-AzureRmTag adds the value to the existing tag, instead of creating a new one.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>You can create multiple values for a predefined tag. When you apply the tag to a resource, you apply just one of its values.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4: Use a predefined tag --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\&gt;New-AzureRmTag -Name CostCenter -Value 0001 Name: CostCenter Count: 0 Values: Name Count ========= ===== 0001 0 PS C:\&gt;Set-AzureRmResourceGroup -Name EngineerBlog -Tag @{Name="CostCenter";Value="0001"} Name: EngineerBlog Location: East US Resources: Name Type Location =============== ======================= ======== EngineerBlog Microsoft.Web/sites West US EngSvr01 Microsoft.Sql/servers West US EngDB02 Microsoft.Sql/databases West US Tags: Name Value ========== ===== CostCenter 0001 PS C:\&gt;Get-AzureRmTag -Name CostCenter Name: CostCenter Count: 1 Values: Name Count ========= ===== 0001 1 PS C:\&gt;Get-AzureRmResourceGroup -Tag @{Name="CostCenter"} Name: EngineerBlog Location: East US Resources: Name Type Location =============== ======================= ======== EngineerBlog Microsoft.Web/sites West US EngSvr01 Microsoft.Sql/servers West US EngDB02 Microsoft.Sql/databases West US Tags: Name Value ========== ===== CostCenter 0001</dev:code> <dev:remarks> <maml:para>The commands in this example create and use a predefined tag.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>The first command uses the New-AzureRmTag cmdlet to create a predefined CostCenter tag with a value of 0001. You can use New-AzureRmTag again to add more values to the predefined tag.The second command uses the Set-AzureRmResourceGroup cmdlet to apply the CostCenter tag to the EngineerBlog resource group.The third command uses the Get-AzureRmTag cmdlet to get the CostCenter tag. The output shows that the Count property of the tag and its values were incremented when the tag was applied to the EngineeringBlog resource group.The fourth command uses the Tag parameter of the Get-AzureRmResource cmdlet to search for resource groups with the CostCenter tag (and any value). The cmdlet returns the EngineeringBlog resource group.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=404172</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmTag</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmTag</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmTag</command:name> <maml:description> <maml:para>Deletes predefined Azure tags or values</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureTag</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Remove-AzureRmTag cmdlet deletes predefined Azure tags and values from your subscription. To delete particular values from a predefined tag, use the Value parameter. By default, Remove-AzureRmTag deletes the specified tag and all of its values.You cannot delete a tag or value that is currently applied to a resource or resource group. Before using Remove-AzureRmTag, use the Tag parameter of the Set-AzureRmResource or Set-AzureRmResourceGroup cmdlets to delete the tag or values from the resource or resource group. The Remove-AzureRmTag cmdlet is part of a set of cmdlets (New/Get/Remove) that help you to manage your predefined Azure tags.An Azure "tag" is a name-value pair that you can use to categorize your Azure resources and resource groups, such as by department or cost center, or to track notes or comments about the resources and groups.You can define and apply tags in a single step, but predefined tags let you establish standard, consistent, predictable names and values for the tags in your subscription. If the subscription includes any predefined tags, you cannot apply undefined tags or values to any resource or resource group in the subscription.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmTag</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the tag to be deleted. This parameter is required. By default, Remove-AzureRmTag removes the specified tag and all of its values. To delete selected values, but not delete the tag, use the Value parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Value</maml:name> <maml:description> <maml:para>Deletes the specified values from the predefined tag, but does not delete the tag.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the confirmation prompt. By default, Remove-AzureRmTag prompts for confirmation before deleting a predefined Azure tag.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object that represents the deleted tag or the resulting tag with deleted valued.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the tag to be deleted. This parameter is required. By default, Remove-AzureRmTag removes the specified tag and all of its values. To delete selected values, but not delete the tag, use the Value parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Value</maml:name> <maml:description> <maml:para>Deletes the specified values from the predefined tag, but does not delete the tag.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the confirmation prompt. By default, Remove-AzureRmTag prompts for confirmation before deleting a predefined Azure tag.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object that represents the deleted tag or the resulting tag with deleted valued.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None or Microsoft.Azure.Commands.Tags.Model.PSTag</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, tag, tags, resource, group</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Delete a predefined tag --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\&gt;Remove-AzureRmTag -Name Department</dev:code> <dev:remarks> <maml:para>This command deletes the predefined Department tag and all of its resources. If the tag has been applied to any resources or resource groups, the command fails.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Delete a value from a predefined tag --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\&gt;Remove-AzureRmTag -Name Department -Value HumanResources -PassThru Name: Department Count: 14 Values: Name Count ========= ===== Finance 2 IT 12</dev:code> <dev:remarks> <maml:para>This command deletes the HumanResources value from the predefined Department tag. It does not delete the tag. If the value has been applied to any resources or resource groups, the command fails.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>Because the command uses the PassThru parameter, the cmdlet returns the object tag without the HumanResources value.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkId=404174</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmTag</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmTag</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems>