Get-AzureRmResource
取得資源。
警告
自 2024 年 2 月 29 日起，AzureRM PowerShell 模組已正式淘汰。 建議使用者從 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>] Description
Get-AzureRmResource Cmdlet 會取得 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此命令會取得其資源群組所屬的資源群組與 「其他」。
範例 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：依資源標識碼取得資源
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此命令會取得具有所提供資源標識符的資源，這是資源群組 「testRG」 中名為 「testVM」 的虛擬機。
參數
-ApiVersion
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-DefaultProfile
用於與 azure 通訊的認證、帳戶、租用戶和訂用帳戶
| 類型: | IAzureContextContainer |
| 別名: | AzureRmContext, AzureCredential |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-ExpandProperties
指定時，展開資源的屬性。
| 類型: | SwitchParameter |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-Name
要擷取之資源的名稱。 此參數支援字串開頭和/或結尾的通配符。
| 類型: | String |
| 別名: | ResourceName |
| Position: | 0 |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-ODataQuery
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-Pre
| 類型: | SwitchParameter |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-ResourceGroupName
已淘汰的資源群組屬於 。 此參數支援字串開頭和/或結尾的通配符。
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-ResourceId
指定完整資源標識碼，如下列範例所示 /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Compute/virtualMachines
| 類型: | String |
| 別名: | Id |
| Position: | Named |
| 預設值: | None |
| 必要: | True |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-ResourceType
要擷取之資源的資源類型。 例如，Microsoft.Compute/virtualMachines
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-Tag
取得具有指定 Azure 標籤的資源。 輸入具有名稱索引鍵或 Name 和 Value 索引鍵的哈希表。 不支援通配符。「標記」是可套用至資源和資源群組的名稱/值組。 使用標籤來分類您的資源，例如依部門或成本中心，或追蹤有關資源的附註或批註。 若要將標籤新增至資源，請使用 New-AzureRmResource 或 Set-AzureRmResource Cmdlet 的 Tag 參數。 若要建立預先定義的標籤，請使用 New-AzureRmTag Cmdlet。 如需 Windows PowerShell 中哈希表的說明，請執行 『Get-Help about_Hashtables』。
| 類型: | Hashtable |
| Position: | Named |
| 預設值: | None |
| 必要: | True |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-TagName
要擷取之資源標籤中的索引鍵。
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-TagValue
要擷取之資源標籤中的值。
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
輸入
None
輸出
Microsoft.Azure.Commands.ResourceManagement.Models.PSResource