Set-AzResource

  • Referentie
Module:
Az.Resources

Wijzigt een resource.

Syntax

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

Description

Met de cmdlet Set-AzResource wordt een bestaande Azure-resource gewijzigd. Geef een resource op die moet worden gewijzigd op naam en type of op id.

Voorbeelden

Voorbeeld 1: Een resource wijzigen

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

Met de eerste opdracht wordt de resource ContosoSite met behulp van de Cmdlet Get-AzResource opgeslagen en vervolgens opgeslagen in de $Resource variabele. Met de tweede opdracht wordt een eigenschap van $Resource gewijzigd. Met de laatste opdracht wordt de resource bijgewerkt zodat deze overeenkomt met $Resource.

Voorbeeld 2: Alle resources in een bepaalde resourcegroep wijzigen

$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}

De eerste opdracht haalt de resources in de resourcegroep testrg op en slaat deze vervolgens op in de variabele $Resource.

Met de tweede opdracht wordt elk van deze resources in de resourcegroep geïtereerd en wordt er een nieuwe tag aan toegevoegd.

Met de laatste opdracht worden al deze resources bijgewerkt.

Parameters

-ApiVersion

Hiermee geeft u de versie van de resourceprovider-API die moet worden gebruikt. Als u geen versie opgeeft, gebruikt deze cmdlet de meest recente beschikbare versie.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AsJob

Cmdlet op de achtergrond uitvoeren

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Hiermee wordt u gevraagd om bevestiging voordat u de cmdlet uitvoert.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

De referenties, het account, de tenant en het abonnement dat wordt gebruikt voor communicatie met Azure

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ExtensionResourceName

Hiermee geeft u de naam van een extensieresource voor de resource. Als u bijvoorbeeld een database wilt opgeven, gebruikt u de volgende indeling: servernaamdatabasenaam/

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ExtensionResourceType

Hiermee geeft u het resourcetype voor een extensieresource op. Als de extensieresource bijvoorbeeld een database is, geeft u het volgende op: Microsoft.Sql/Servers/Databases

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Force

Hiermee dwingt u de opdracht uit te voeren zonder dat u om bevestiging van de gebruiker wordt gevraagd.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

De objectweergave van de resource die moet worden bijgewerkt.

Type:PSResource
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Kind

Hiermee geeft u het type resource voor de resource.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ODataQuery

Hiermee geeft u een OData-stijlfilter (Open Data Protocol) op. Deze cmdlet voegt deze waarde toe aan de aanvraag naast andere filters.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Plan

Hiermee geeft u eigenschappen van het resourceplan op, als een hash-tabel, voor de resource.

Type:Hashtable
Aliases:PlanObject
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Pre

Hiermee wordt aangegeven dat deze cmdlet api-versies van de voorlopige versie beschouwt wanneer deze automatisch bepaalt welke versie moet worden gebruikt.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Properties

Hiermee geeft u resource-eigenschappen voor de resource.

Type:PSObject
Aliases:PropertyObject
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Hiermee geeft u de naam op van de resourcegroep waarin deze cmdlet de resource wijzigt.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ResourceId

Hiermee geeft u de volledig gekwalificeerde resource-id op, inclusief het abonnement, zoals in het volgende voorbeeld: /subscriptions/abonnements-id/providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase

Type:String
Aliases:Id
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceName

Hiermee geeft u de naam van de resource. Als u bijvoorbeeld een database wilt opgeven, gebruikt u de volgende indeling: ContosoServer/ContosoDatabase

Type:String
Aliases:Name
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceType

Hiermee geeft u het type van de resource. Voor een database is het resourcetype bijvoorbeeld als volgt: Microsoft.Sql/Servers/Databases

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Sku

Hiermee geeft u het SKU-object van de resource op als een hash-tabel.

Type:Hashtable
Aliases:SkuObject
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Tag

Sleutel-waardeparen in de vorm van een hash-tabel. Bijvoorbeeld: @{key0="value0"; key1=$null; key2="value2"}

Type:Hashtable
Aliases:Tags
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-TenantLevel

Geeft aan dat deze cmdlet werkt op tenantniveau.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-UsePatchSemantics

Geeft aan dat deze cmdlet een HTTP PATCH gebruikt om het object bij te werken in plaats van een HTTP PUT.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Hiermee wordt weergegeven wat er zou gebeuren als u de cmdlet uitvoert. De cmdlet wordt niet uitgevoerd.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Invoerwaarden

PSResource

String

PSObject

Hashtable

Uitvoerwaarden

PSObject