Azure Resource Manager (az.arms) PowerShell Reference
This module contains cmdlets for managing Azure Resource Manager resources.
Get-AzResource
Gets information about Azure resources.
Parameters
| Name |
Description |
Type |
Required |
-Name |
Specifies the name of the resource. |
String |
No |
-ResourceType |
Specifies the type of the resource. |
String |
No |
-ResourceGroupName |
Specifies the name of the resource group. |
String |
No |
-Location |
Specifies the Azure region where the resource is located. |
String |
No |
-ExpandProperties |
Expands properties to show details. |
String |
No |
Examples
| Description |
Code |
| Get all resources in the current subscription. |
Get-AzResource |
| Get all resources of type 'Microsoft.Storage/storageAccounts' in a specific resource group. |
Get-AzResource -ResourceGroupName "myResourceGroup" -ResourceType "Microsoft.Storage/storageAccounts" |
| Get a specific storage account by name. |
Get-AzResource -Name "mystorageaccount" -ResourceType "Microsoft.Storage/storageAccounts" -ResourceGroupName "myResourceGroup" |
New-AzResource
Creates a new Azure resource.
Parameters
| Name |
Description |
Type |
Required |
-Name |
Specifies the name for the new resource. |
String |
Yes |
-ResourceType |
Specifies the type of resource to create. |
String |
Yes |
-ResourceGroupName |
Specifies the name of the resource group to create the resource in. |
String |
Yes |
-Location |
Specifies the Azure region for the resource. |
String |
No |
-PropertyObject |
A hashtable or JSON string representing the resource's properties. |
Object |
Yes |
Examples
| Description |
Code |
| Create a new storage account. |
New-AzResource -Name "myuniquestorage" -ResourceType "Microsoft.Storage/storageAccounts" -ResourceGroupName "myResourceGroup" -Location "eastus" -PropertyObject @{sku=@{name="Standard_LRS"}; kind="StorageV2"} |
Set-AzResource
Updates an existing Azure resource.
Parameters
| Name |
Description |
Type |
Required |
-Name |
Specifies the name of the resource to update. |
String |
Yes |
-ResourceType |
Specifies the type of the resource to update. |
String |
Yes |
-ResourceGroupName |
Specifies the name of the resource group containing the resource. |
String |
Yes |
-PropertyObject |
A hashtable or JSON string with the properties to update. |
Object |
Yes |
Examples
| Description |
Code |
| Update the SKU of a storage account. |
Set-AzResource -Name "mystorageaccount" -ResourceType "Microsoft.Storage/storageAccounts" -ResourceGroupName "myResourceGroup" -PropertyObject @{sku=@{name="Standard_GRS"}} |
Remove-AzResource
Deletes an Azure resource.
Parameters
| Name |
Description |
Type |
Required |
-Name |
Specifies the name of the resource to delete. |
String |
Yes |
-ResourceType |
Specifies the type of the resource to delete. |
String |
Yes |
-ResourceGroupName |
Specifies the name of the resource group containing the resource. |
String |
Yes |
-Force |
Suppresses confirmation messages. |
Switch |
No |
Examples
| Description |
Code |
| Delete a specific resource. |
Remove-AzResource -Name "myresource" -ResourceType "Microsoft.Compute/virtualMachines" -ResourceGroupName "myResourceGroup" -Force |