Get-AzureRmResource
リソースを取得します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日に正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールの機能は今後も使用できますが、メンテナンスやサポートは行われないため、引き続きの使用はユーザーの判断に委ねられ、リスクが発生することがあります。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Get-AzureRmResource
[[-Name] <String>]
[-ResourceType <String>]
[-ODataQuery <String>]
[-ResourceGroupName <String>]
[-TagName <String>]
[-TagValue <String>]
[-ExpandProperties]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzureRmResource
-ResourceId <String>
[-ExpandProperties]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzureRmResource
[[-Name] <String>]
[-ResourceType <String>]
[-ODataQuery <String>]
[-ResourceGroupName <String>]
-Tag <Hashtable>
[-ExpandProperties]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] 説明
Get-AzureRmResource コマンドレットは Azure リソースを取得します。
例
例 1: 現在のサブスクリプション内のすべてのリソースを取得する
PS C:\> Get-AzureRmResource | ft
Name ResourceGroupName ResourceType Location
---- ----------------- ------------ --------
testVM testRG Microsoft.Compute/virtualMachines westus
disk testRG Microsoft.Compute/disks westus
nic testRG Microsoft.Network/networkInterfaces westus
nsg testRG Microsoft.Network/networkSecurityGroups westus
ip testRG Microsoft.Network/publicIPAddresses westus
vnet testRG Microsoft.Network/virtualNetworks westus
testKV otherRG Microsoft.KeyVault/vaults eastus
storage otherResourceGroup Microsoft.Storage/storageAccounts eastus
testVM2 otherResourceGroup Microsoft.Compute/virtualMachines eastusこのコマンドは、現在のサブスクリプション内のすべてのリソースを取得します。
例 2: リソース グループ内のすべてのリソースを取得する
PS C:\> Get-AzureRmResource -ResourceGroupName testRG | ft
Name ResourceGroupName ResourceType Location
---- ----------------- ------------ --------
testVM testRG Microsoft.Compute/virtualMachines westus
disk testRG Microsoft.Compute/disks westus
nic testRG Microsoft.Network/networkInterfaces westus
nsg testRG Microsoft.Network/networkSecurityGroups westus
ip testRG Microsoft.Network/publicIPAddresses westus
vnet testRG Microsoft.Network/virtualNetworks westusこのコマンドは、リソース グループ "testRG" 内のすべてのリソースを取得します。
例 3: 指定されたワイルドカードと一致するリソース グループを持つすべてのリソースを取得する
PS C:\> Get-AzureRmResource -ResourceGroupName other* | ft
Name ResourceGroupName ResourceType Location
---- ----------------- ------------ --------
testKV otherRG Microsoft.KeyVault/vaults eastus
storage otherResourceGroup Microsoft.Storage/storageAccounts eastus
testVM2 otherResourceGroup Microsoft.Compute/virtualMachines eastusこのコマンドは、そのリソース グループが属するすべてのリソースを "other" と共に取得します。
例 4: 特定の名前を持つすべてのリソースを取得する
PS C:\> Get-AzureRmResource -Name testVM | fl
Name : testVM
ResourceGroupName : testRG
ResourceType : Microsoft.Compute/virtualMachines
Location : westus
ResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/testVMこのコマンドは、リソース名が "testVM" であるすべてのリソースを取得します。
例 5: 指定されたワイルドカードと一致する名前を持つすべてのリソースを取得する
PS C:\> Get-AzureRmResource -Name test* | ft
Name ResourceGroupName ResourceType Location
---- ----------------- ------------ --------
testVM testRG Microsoft.Compute/virtualMachines westus
testKV otherRG Microsoft.KeyVault/vaults eastus
testVM2 otherResourceGroup Microsoft.Compute/virtualMachines eastusこのコマンドは、リソース名が "test" で始まるすべてのリソースを取得します。
例 6: 特定のリソースの種類のすべてのリソースを取得する
PS C:\> Get-AzureRmResource -ResourceType Microsoft.Compute/virtualMachines | ft
Name ResourceGroupName ResourceType Location
---- ----------------- ------------ --------
testVM testRG Microsoft.Compute/virtualMachines westus
testVM2 otherResourceGroup Microsoft.Compute/virtualMachines eastusこのコマンドは、仮想マシンである現在のサブスクリプション内のすべてのリソースを取得します。
例 7: リソース ID でリソースを取得する
PS C:\> Get-AzureRmResource -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/testVM
Name : testVM
ResourceGroupName : testRG
ResourceType : Microsoft.Compute/virtualMachines
Location : westus
ResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/testVMこのコマンドは、指定されたリソース ID を持つリソースを取得します。これは、リソース グループ "testRG" の "testVM" という仮想マシンです。
パラメーター
-ApiVersion
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
| 型: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ExpandProperties
指定すると、リソースのプロパティが展開されます。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Name
取得するリソースの名前。 このパラメーターは、文字列の先頭または末尾でワイルドカードをサポートします。
| 型: | String |
| Aliases: | ResourceName |
| 配置: | 0 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ODataQuery
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Pre
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ResourceGroupName
インベントリから削除されたリソースが属しているリソース グループ。 このパラメーターは、文字列の先頭または末尾でワイルドカードをサポートします。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ResourceId
次の例のように、完全修飾リソース ID を指定します。 /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Compute/virtualMachines
| 型: | String |
| Aliases: | Id |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-ResourceType
取得するリソースのリソースの種類。 たとえば、Microsoft.Compute/virtualMachines
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Tag
指定した Azure タグを持つリソースを取得します。 Name キーまたは Name キーと Value キーを持つハッシュ テーブルを入力します。 ワイルドカード文字はサポートされていません。"タグ" は、リソースとリソース グループに適用できる名前と値のペアです。 タグを使用して、部門やコスト センターなどのリソースを分類したり、リソースに関するメモやコメントを追跡したりできます。 リソースにタグを追加するには、New-AzureRmResource コマンドレットまたは Set-AzureRmResource コマンドレットの Tag パラメーターを使用します。 定義済みのタグを作成するには、New-AzureRmTag コマンドレットを使用します。 Windows PowerShell のハッシュ テーブルに関するヘルプについては、「Get-Help about_Hashtables」を実行してください。
| 型: | Hashtable |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-TagName
取得するリソースのタグ内のキー。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-TagValue
取得するリソースのタグ内の値。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
入力
None
出力
Microsoft.Azure.Commands.ResourceManagement.Models.PSResource