

的版本 5 (V5) Amazon Tools for PowerShell 已经发布！

有关重大更改和迁移应用程序的信息，请参阅[迁移主题](https://docs.amazonaws.cn/powershell/v5/userguide/migrating-v5.html)。

 [https://docs.amazonaws.cn/powershell/v5/userguide/migrating-v5.html](https://docs.amazonaws.cn/powershell/v5/userguide/migrating-v5.html)

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# Resource Groups 使用适用于 V5 的 PowerShell 工具标记 API 示例
<a name="powershell_resource-groups-tagging-api_code_examples"></a>

以下代码示例向您展示了如何使用带有 Resource Groups Tagging API 的 Amazon Tools for PowerShell V5 来执行操作和实现常见场景。

*操作*是大型程序的代码摘录，必须在上下文中运行。您可以通过操作了解如何调用单个服务函数，还可以通过函数相关场景的上下文查看操作。

每个示例都包含一个指向完整源代码的链接，您可以从中找到有关如何在上下文中设置和运行代码的说明。

**Topics**
+ [操作](#actions)

## 操作
<a name="actions"></a>

### `Add-RGTResourceTag`
<a name="resource-groups-tagging-api_TagResources_powershell_topic"></a>

以下代码示例演示了如何使用 `Add-RGTResourceTag`。

**适用于 PowerShell V5 的工具**  
**示例 1：此示例将值为“beta”和“preprod\$1test”的标签键“stage”和“version”添加到 Amazon S3 存储桶和 Amazon DynamoDB 表中。调用服务一次，即可应用这些标签。**  

```
$arn1 = "arn:aws:s3:::amzn-s3-demo-bucket"
$arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable"

Add-RGTResourceTag -ResourceARNList $arn1,$arn2 -Tag @{ "stage"="beta"; "version"="preprod_test" }
```
**示例 2：此示例将指定的标签和值添加到 Amazon S3 存储桶和 Amazon DynamoDB 表中。对该服务进行了两次调用，即对于通过管道传入 cmdlet 的每个资源 ARN 进行一次调用。**  

```
$arn1 = "arn:aws:s3:::amzn-s3-demo-bucket"
$arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable"

$arn1,$arn2 | Add-RGTResourceTag -Tag @{ "stage"="beta"; "version"="preprod_test" }
```
+  有关 API 的详细信息，请参阅 *Amazon Tools for PowerShell Cmdlet 参考 (V* 5) [TagResources](https://docs.amazonaws.cn/powershell/v5/reference)中的。

### `Get-RGTResource`
<a name="resource-groups-tagging-api_GetResources_powershell_topic"></a>

以下代码示例演示了如何使用 `Get-RGTResource`。

**适用于 PowerShell V5 的工具**  
**示例 1：返回某个区域中所有带标签的资源及与资源关联的标签键。如果没有向 cmdlet 提供-Region 参数，它将尝试从 shell 或实例元数据中推断出区域。 EC2 **  

```
Get-RGTResource
```
**输出**：  

```
ResourceARN                                                      Tags          
-----------                                                      ----            
arn:aws:dynamodb:us-west-2:123456789012:table/mytable            {stage, version}   
arn:aws:s3:::amzn-s3-demo-bucket                                            {stage, version, othertag}
```
**示例 2：返回某个区域中指定类型的所有带标签的资源。每个服务名称和资源类型的字符串都与嵌入在资源的 Amazon 资源名称（ARN）中的字符串相同。**  

```
Get-RGTResource -ResourceType "s3"
```
**输出**：  

```
ResourceARN                                                      Tags          
-----------                                                      ----            
arn:aws:s3:::amzn-s3-demo-bucket                                            {stage, version, othertag}
```
**示例 3：返回某个区域中指定类型的所有带标签的资源。请注意，当资源类型通过管道传输到 cmdlet 时，将为每个提供的资源类型向服务发出一个调用。**  

```
"dynamodb","s3" | Get-RGTResource
```
**输出**：  

```
ResourceARN                                                      Tags          
-----------                                                      ----            
arn:aws:dynamodb:us-west-2:123456789012:table/mytable            {stage, version}   
arn:aws:s3:::amzn-s3-demo-bucket                                            {stage, version, othertag}
```
**示例 4：返回与指定筛选条件匹配的所有带标签的资源。**  

```
Get-RGTResource -TagFilter @{ Key="stage" }
```
**输出**：  

```
ResourceARN                                                      Tags          
-----------                                                      ----            
arn:aws:s3:::amzn-s3-demo-bucket                                            {stage, version, othertag}
```
**示例 5：返回与指定筛选条件和资源类型匹配的所有带标签的资源。**  

```
Get-RGTResource -TagFilter @{ Key="stage" } -ResourceType "dynamodb"
```
**输出**：  

```
ResourceARN                                                      Tags          
-----------                                                      ----            
arn:aws:dynamodb:us-west-2:123456789012:table/mytable            {stage, version}
```
**示例 6：返回与指定筛选条件匹配的所有带标签的资源。**  

```
Get-RGTResource -TagFilter @{ Key="stage"; Values=@("beta","gamma") }
```
**输出**：  

```
ResourceARN                                                      Tags          
-----------                                                      ----            
arn:aws:dynamodb:us-west-2:123456789012:table/mytable            {stage, version}
```
+  有关 API 的详细信息，请参阅 *Amazon Tools for PowerShell Cmdlet 参考 (V* 5) [GetResources](https://docs.amazonaws.cn/powershell/v5/reference)中的。

### `Get-RGTTagKey`
<a name="resource-groups-tagging-api_GetTagKeys_powershell_topic"></a>

以下代码示例演示了如何使用 `Get-RGTTagKey`。

**适用于 PowerShell V5 的工具**  
**示例 1：返回指定区域中的所有标签键。如果未指定-Region 参数，cmdlet 将尝试从默认外壳区域或实例元数据中推断出该区域。 EC2 请注意，标签键不会按任何特定顺序返回。**  

```
Get-RGTTagKey -region us-west-2
```
**输出**：  

```
version
stage
```
+  有关 API 的详细信息，请参阅 *Amazon Tools for PowerShell Cmdlet 参考 (V* 5) [GetTagKeys](https://docs.amazonaws.cn/powershell/v5/reference)中的。

### `Get-RGTTagValue`
<a name="resource-groups-tagging-api_GetTagValues_powershell_topic"></a>

以下代码示例演示了如何使用 `Get-RGTTagValue`。

**适用于 PowerShell V5 的工具**  
**示例 1：返回某个区域中指定标签的值。如果未指定-Region 参数，cmdlet 将尝试从默认外壳区域或实例元数据中推断出该区域。 EC2 **  

```
Get-RGTTagValue -Key "stage" -Region us-west-2
```
**输出**：  

```
beta
```
+  有关 API 的详细信息，请参阅 *Amazon Tools for PowerShell Cmdlet 参考 (V* 5) [GetTagValues](https://docs.amazonaws.cn/powershell/v5/reference)中的。

### `Remove-RGTResourceTag`
<a name="resource-groups-tagging-api_UntagResources_powershell_topic"></a>

以下代码示例演示了如何使用 `Remove-RGTResourceTag`。

**适用于 PowerShell V5 的工具**  
**示例 1：从 Amazon S3 存储桶和 Amazon DynamoDB 表中移除标签键“stage”和“version”以及关联的值。调用服务一次，即可删除标签。在移除标签之前，cmdlet 将提示进行确认。要绕过确认，请添加 -Force 参数。**  

```
$arn1 = "arn:aws:s3:::amzn-s3-demo-bucket"
$arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable"

Remove-RGTResourceTag -ResourceARNList $arn1,$arn2 -TagKey "stage","version"
```
**示例 2：从 Amazon S3 存储桶和 Amazon DynamoDB 表中移除标签键“stage”和“version”以及关联的值。对该服务进行了两次调用，即对于通过管道传入 cmdlet 的每个资源 ARN 进行一次调用。每次调用之前，cmdlet 都会提示进行确认。要绕过确认，请添加 -Force 参数。**  

```
$arn1 = "arn:aws:s3:::amzn-s3-demo-bucket"
$arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable"

$arn1,$arn2 | Remove-RGTResourceTag -TagKey "stage","version"
```
+  有关 API 的详细信息，请参阅 *Amazon Tools for PowerShell Cmdlet 参考 (V* 5) [UntagResources](https://docs.amazonaws.cn/powershell/v5/reference)中的。