Get-AzResourceGroup
構文
GetByResourceGroupName (既定)
Get-AzResourceGroup
[[-Name] <String>]
[[-Location] <String>]
[-Tag <Hashtable>]
[-ExpandProperties]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByResourceGroupId
Get-AzResourceGroup
[[-Location] <String>]
[-Id <String>]
[-ExpandProperties]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
Get-AzResourceGroup コマンドレットは、現在のサブスクリプションの Azure リソース グループを取得します。
すべてのリソース グループを取得することも、名前やその他のプロパティでリソース グループを指定することもできます。
既定では、このコマンドレットは現在のサブスクリプション内のすべてのリソース グループを取得します。
Azure リソースと Azure リソース グループの詳細については、New-AzResourceGroup コマンドレットを参照してください。
例
例 1: 名前でリソース グループを取得する
Get-AzResourceGroup -Name "EngineerBlog"
このコマンドは、EngineerBlog という名前のサブスクリプション内の Azure リソース グループを取得します。
例 2: リソース グループのすべてのタグを取得する
(Get-AzResourceGroup -Name "ContosoRG").Tags
このコマンドは、ContosoRG という名前のリソース グループを取得し、そのグループに関連付けられているタグを表示します。
例 3: タグに基づいてリソース グループを取得する
Get-AzResourceGroup -Tag @{'environment'='prod'}
例 4: 場所別にリソース グループを表示する
Get-AzResourceGroup |
Sort-Object Location,ResourceGroupName |
Format-Table -GroupBy Location ResourceGroupName,ProvisioningState,Tags
例 5: 特定の場所にあるすべてのリソース グループの名前を表示する
Get-AzResourceGroup -Location westus2 |
Sort-Object ResourceGroupName |
Format-Wide ResourceGroupName -Column 4
例 6: 名前が WebServer で始まるリソース グループを表示する
Get-AzResourceGroup -Name WebServer*
例 7: 展開されたプロパティを持つリソース グループを取得する
Get-AzResourceGroup -Name "ContosoRG" -ExpandProperties
パラメーター
-ApiVersion
リソース プロバイダーでサポートされている API バージョンを指定します。
既定のバージョンとは異なるバージョンを指定できます。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
パラメーターのプロパティ
| 型: | IAzureContextContainer
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ExpandProperties
指定すると、リソースの CreatedTime と ChangedTime が出力に含まれます。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Id
取得するリソース グループの ID を指定します。
ワイルドカード文字は使用できません。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ResourceGroupId, リソースID |
パラメーター セット
GetByResourceGroupId
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Location
取得するリソース グループの場所を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Name
取得するリソース グループの名前を指定します。 このパラメーターは、文字列の先頭または末尾でワイルドカードをサポートします。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | True |
| DontShow: | False |
| Aliases: | リソースグループ名 |
パラメーター セット
GetByResourceGroupName
| 配置: | 0 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Pre
このコマンドレットは、使用するバージョンを自動的に決定するときに、プレリリース API バージョンを考慮することを示します。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Tag
リソース グループをフィルター処理するタグ ハッシュテーブル。
パラメーターのプロパティ
| 型: | Hashtable
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
GetByResourceGroupName
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力
