Az.Resources Module
This document provides reference information for the Az.Resources PowerShell module, which enables you to manage Azure resources, resource groups, and deployments.
Overview
The Az.Resources module is a core component of Azure PowerShell, providing cmdlets for managing the fundamental building blocks of your Azure infrastructure. You can create, retrieve, update, and delete resource groups, individual resources, and deploy templates to your Azure subscriptions.
Key capabilities include:
- Resource Group Management
- Resource Management
- Resource Group Deployment
- Resource Provider Management
- Quota Management
- Resource Locking
Cmdlets
The Az.Resources module offers a comprehensive set of cmdlets for managing your Azure resources.
New-AzResourceGroup
Creates a new Azure resource group.
New-AzResourceGroup [-Name] <String> [-Location] <String> [-Tag <Hashtable>] [-Force] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>]Parameters:
| Name | Type | Description |
|---|---|---|
-Name |
String | Specifies the name of the resource group to create. |
-Location |
String | Specifies the Azure region for the resource group. |
-Tag |
Hashtable | Specifies resource tags as key-value pairs. |
Get-AzResourceGroup
Retrieves resource groups.
Get-AzResourceGroup [-Name] <String> [-Id] <String> [-Tag <Hashtable>] [-Status] [-DefaultProfile] [<CommonParameters>]Parameters:
| Name | Type | Description |
|---|---|---|
-Name |
String | Specifies the name of the resource group to retrieve. |
-Id |
String | Specifies the ID of the resource group. |
Remove-AzResourceGroup
Deletes a resource group.
Remove-AzResourceGroup [-Name] <String> [-Force] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>]Set-AzResourceGroup
Updates a resource group.
Set-AzResourceGroup [-Name] <String> [-Location] <String> [-Tag <Hashtable>] [-Force] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>]New-AzResource
Creates a new Azure resource.
New-AzResource -Location <String> -ResourceGroupName <String> -ResourceType <String> -Name <String> [-ApiVersion <String>] [-Force] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>]Get-AzResource
Retrieves Azure resources.
Get-AzResource -Location <String> -ResourceGroupName <String> [-ResourceType <String>] [-Name <String>] [-ApiVersion <String>] [-DefaultProfile] [<CommonParameters>]Remove-AzResource
Deletes an Azure resource.
Remove-AzResource -Location <String> -ResourceGroupName <String> -ResourceType <String> -Name <String> [-ApiVersion <String>] [-Force] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>]Set-AzResource
Updates an Azure resource.
Set-AzResource -Location <String> -ResourceGroupName <String> -ResourceType <String> -Name <String> [-ApiVersion <String>] [-Force] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>]New-AzResourceGroupDeployment
Deploys resources to a resource group.
New-AzResourceGroupDeployment -Name <String> -ResourceGroupName <String> -TemplateFile <String> [-TemplateUri <String>] [-ParameterFile <String>] [-ParameterObject <Object>] [-Mode <DeploymentMode>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>]Get-AzResourceGroupDeployment
Retrieves deployments for a resource group.
Get-AzResourceGroupDeployment -ResourceGroupName <String> [-Name <String>] [-DefaultProfile] [<CommonParameters>]Remove-AzResourceGroupDeployment
Deletes a resource group deployment.
Remove-AzResourceGroupDeployment -Name <String> -ResourceGroupName <String> [-Force] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>]Test-AzResourceGroupDeployment
Validates a resource group deployment template without deploying.
Test-AzResourceGroupDeployment -Name <String> -ResourceGroupName <String> -TemplateFile <String> [-TemplateUri <String>] [-ParameterFile <String>] [-ParameterObject <Object>] [-Mode <DeploymentMode>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>]Invoke-AzResourceGroupDeployment
Applies changes from a resource group deployment template.
Invoke-AzResourceGroupDeployment -Name <String> -ResourceGroupName <String> -TemplateFile <String> [-TemplateUri <String>] [-ParameterFile <String>] [-ParameterObject <Object>] [-Mode <DeploymentMode>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>]Get-AzResourceProvider
Gets Azure resource providers.
Get-AzResourceProvider [-ProviderNamespace] <String> [-DefaultProfile] [<CommonParameters>]Register-AzResourceProvider
Registers an Azure resource provider.
Register-AzResourceProvider -ProviderNamespace <String> [-Force] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>]Unregister-AzResourceProvider
Unregisters an Azure resource provider.
Unregister-AzResourceProvider -ProviderNamespace <String> [-Force] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>]Get-AzResourceGroupQuota
Gets quota limits for a resource group.
Get-AzResourceGroupQuota -Location <String> [-ProviderNamespace <String>] [-ResourceName <String>] [-DefaultProfile] [<CommonParameters>]Get-AzResourceQuotaUsage
Gets quota usage for a resource group.
Get-AzResourceQuotaUsage -Location <String> [-ProviderNamespace <String>] [-ResourceName <String>] [-DefaultProfile] [<CommonParameters>]Get-AzResourceUnlock
Gets resource locks.
Get-AzResourceUnlock -ResourceGroupName <String> [-ResourceId] <String> [-DefaultProfile] [<CommonParameters>]Lock-AzResource
Applies a lock to a resource or resource group.
Lock-AzResource -ResourceGroupName <String> -ResourceType <String> -ResourceName <String> -Name <String> -LockLevel <LockLevel> [-Notes <String>] [-Force] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>]Unlock-AzResource
Removes a resource lock.
Unlock-AzResource -ResourceGroupName <String> -ResourceType <String> -ResourceName <String> -Name <String> [-Force] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>]Remove-AzResourceUnlock
Removes a resource lock.
Remove-AzResourceUnlock -ResourceGroupName <String> -ResourceType <String> -ResourceName <String> -Name <String> [-Force] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>]About AzResourceGroup
This section explains the concept of Azure Resource Groups and their management using cmdlets like New-AzResourceGroup, Get-AzResourceGroup, and Remove-AzResourceGroup. Resource groups are logical containers for your Azure resources.
About AzResource
This section details how to manage individual Azure resources using cmdlets such as New-AzResource, Get-AzResource, Remove-AzResource, and Set-AzResource. Resources can be of various types, including virtual machines, storage accounts, and web apps.
Examples
Example 1: Create a resource group
New-AzResourceGroup -Name "MyResourceGroup" -Location "East US" -Tag @{Environment="Dev"; Project="Alpha"}Example 2: Get all resource groups
Get-AzResourceGroupExample 3: Deploy an ARM template
New-AzResourceGroupDeployment -Name "MyDeployment" -ResourceGroupName "MyResourceGroup" -TemplateFile "C:\Templates\azuredeploy.json" -ParameterFile "C:\Templates\azuredeploy.parameters.json"Example 4: Apply a read-only lock to a resource group
Lock-AzResource -ResourceGroupName "MyResourceGroup" -Name "ReadOnlyLock" -LockLevel "ReadOnly"