Set-AzResource

Module:

Az.Resources Module

Modifies a resource.

Set-AzResource
 -ResourceId <String>
 [-Kind <String>]
 [-Properties <PSObject>]
 [-Plan <Hashtable>]
 [-Sku <Hashtable>]
 [-Tag <Hashtable>]
 [-UsePatchSemantics]
 [-AsJob]
 [-ODataQuery <String>]
 [-Force]
 [-ApiVersion <String>]
 [-Pre]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Set-AzResource
 -InputObject <PSResource>
 [-Kind <String>]
 [-Properties <PSObject>]
 [-Plan <Hashtable>]
 [-Sku <Hashtable>]
 [-Tag <Hashtable>]
 [-UsePatchSemantics]
 [-AsJob]
 [-ODataQuery <String>]
 [-Force]
 [-ApiVersion <String>]
 [-Pre]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Set-AzResource
 -ResourceName <String>
 -ResourceType <String>
 [-Kind <String>]
 [-Properties <PSObject>]
 [-Plan <Hashtable>]
 [-Sku <Hashtable>]
 [-Tag <Hashtable>]
 [-UsePatchSemantics]
 [-AsJob]
 [-ExtensionResourceName <String>]
 [-ExtensionResourceType <String>]
 [-ODataQuery <String>]
 [-ResourceGroupName <String>]
 [-Force]
 [-ApiVersion <String>]
 [-Pre]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Set-AzResource
 -ResourceName <String>
 -ResourceType <String>
 [-Kind <String>]
 [-Properties <PSObject>]
 [-Plan <Hashtable>]
 [-Sku <Hashtable>]
 [-Tag <Hashtable>]
 [-UsePatchSemantics]
 [-AsJob]
 [-ExtensionResourceName <String>]
 [-ExtensionResourceType <String>]
 [-ODataQuery <String>]
 [-TenantLevel]
 [-Force]
 [-ApiVersion <String>]
 [-Pre]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

The Set-AzResource cmdlet modifies an existing Azure resource. Specify a resource to modify by name and type or by ID.

$Resource = Get-AzResource -ResourceType Microsoft.Web/sites -ResourceGroupName ResourceGroup11 -ResourceName ContosoSite
$Resource.Properties.Enabled = "False"
$Resource | Set-AzResource -Force

The first command gets the resource named ContosoSite by using the Get-AzResource cmdlet, and then stores it in the $Resource variable. The second command modifies a property of $Resource. The final command updates the resource to match $Resource.

$Resource = Get-AzResource -ResourceGroupName testrg
$Resource | ForEach-Object { $_.Tags.Add("testkey", "testval") }
$Resource | Set-AzResource -Force

Name : kv-test
ResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Microsoft.KeyVault/vaults/kv-test
ResourceName : kv-test
ResourceType : Microsoft.KeyVault/vaults
ResourceGroupName : testrg
Location : westus
SubscriptionId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Tags : {testrgkey, key}
Properties : @{}

Name : testresource
ResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Providers.Test/statefulResources/testresource
ResourceName : testresource
ResourceType : Providers.Test/statefulResources
ResourceGroupName : testrg
Location : West US 2
SubscriptionId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Tags : {testrgkey, anothertesttag}
Properties : @{key=value}
Sku : @{name=A0}

The first command gets the resources in the testrg resource group, and then stores them in the $Resource variable.

The second command iterates over each of these resources in the resource group and adds a new tag to them.

The final command updates each of these resources.

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.