Set-AzResource

Moduł:

Az.Resources Module

Modyfikuje zasób.

Składnia

ByResourceId (domyślnie)

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>]

ByInputObject

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>]

BySubscriptionLevel

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>]

ByTenantLevel

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>]

Opis

Polecenie cmdlet Set-AzResource modyfikuje istniejący zasób platformy Azure. Określ zasób, który ma być modyfikowany według nazwy i typu lub identyfikatora.

Przykłady

Przykład 1. Modyfikowanie zasobu

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

Pierwsze polecenie pobiera zasób o nazwie ContosoSite przy użyciu polecenia cmdlet Get-AzResource, a następnie zapisuje go w zmiennej $Resource. Drugie polecenie modyfikuje właściwość $Resource. Ostatnie polecenie aktualizuje zasób tak, aby był zgodny z $Resource.

Przykład 2. Modyfikowanie wszystkich zasobów w danej grupie zasobów

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

Pierwsze polecenie pobiera zasoby w grupie zasobów testrg, a następnie przechowuje je w zmiennej $Resource.

Drugie polecenie iteruje każdą z tych zasobów w grupie zasobów i dodaje do nich nowy tag.

Ostatnie polecenie aktualizuje każdy z tych zasobów.

Parametry

-ApiVersion

Określa wersję interfejsu API dostawcy zasobów do użycia. Jeśli nie określisz wersji, to polecenie cmdlet używa najnowszej dostępnej wersji.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-AsJob

Uruchamianie polecenia cmdlet w tle

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Confirm

Prosi o potwierdzenie przed uruchomieniem cmdletu.

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	False
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	por

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure

Właściwości parametru

Typ:	IAzureContextContainer
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	AzContext, AzureRmContext, AzureCredential

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-ExtensionResourceName

Określa nazwę zasobu rozszerzenia dla zasobu. Aby na przykład określić bazę danych, użyj następującego formatu: nazwa bazy danych nazwy/serwera

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

BySubscriptionLevel

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

ByTenantLevel

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-ExtensionResourceType

Określa typ zasobu rozszerzenia. Jeśli na przykład zasób rozszerzenia jest bazą danych, określ następujące elementy: Microsoft.Sql/Servers/Databases

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

BySubscriptionLevel

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

ByTenantLevel

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-Force

Wymusza uruchomienie polecenia bez monitowania o potwierdzenie użytkownika.

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-InputObject

Reprezentacja obiektu zasobu do zaktualizowania.

Właściwości parametru

Typ:	PSResource
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

ByInputObject

Position:	Named
Obowiązkowe:	True
Wartość z potoku:	True
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Kind

Określa rodzaj zasobu dla zasobu.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-ODataQuery

Określa filtr stylu protokołu Open Data Protocol (OData). To polecenie cmdlet dołącza tę wartość do żądania oprócz innych filtrów.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Plan

Określa właściwości planu zasobów jako tabelę skrótów dla zasobu.

Właściwości parametru

Typ:	Hashtable
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	PlanObject

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-Pre

Wskazuje, że to polecenie cmdlet uwzględnia wersje interfejsu API wersji wstępnej, gdy automatycznie określa wersję do użycia.

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Properties

Określa właściwości zasobu.

Właściwości parametru

Typ:	PSObject
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	PropertyObject

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-ResourceGroupName

Określa nazwę grupy zasobów, w której to polecenie cmdlet modyfikuje zasób.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

BySubscriptionLevel

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-ResourceId

Określa w pełni kwalifikowany identyfikator zasobu, w tym subskrypcję, jak w poniższym przykładzie: /subscriptions/identyfikator subskrypcji/providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	Id

Zestawy parametrów

ByResourceId

Position:	Named
Obowiązkowe:	True
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-ResourceName

Określa nazwę zasobu. Aby na przykład określić bazę danych, użyj następującego formatu: ContosoServer/ContosoDatabase

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	Name

Zestawy parametrów

BySubscriptionLevel

Position:	Named
Obowiązkowe:	True
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

ByTenantLevel

Position:	Named
Obowiązkowe:	True
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-ResourceType

Określa typ zasobu. Na przykład w przypadku bazy danych typ zasobu jest następujący: Microsoft.Sql/Servers/Databases

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

BySubscriptionLevel

Position:	Named
Obowiązkowe:	True
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

ByTenantLevel

Position:	Named
Obowiązkowe:	True
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-Sku

Określa obiekt jednostki SKU zasobu jako tabelę skrótów.

Właściwości parametru

Typ:	Hashtable
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	SkuObject

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-Tag

Pary klucz-wartość w postaci tabeli skrótów. Na przykład: @{key0="value0"; key1=$null; key2="value2"}

Właściwości parametru

Typ:	Hashtable
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	Etykiety

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	True
Wartość z pozostałych argumentów:	False

-TenantLevel

Wskazuje, że to polecenie cmdlet działa na poziomie dzierżawy.

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

ByTenantLevel

Position:	Named
Obowiązkowe:	True
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-UsePatchSemantics

Wskazuje, że to polecenie cmdlet używa poprawki HTTP do zaktualizowania obiektu, a nie HTTP PUT.

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-WhatIf

Pokazuje, co się stanie, jeśli polecenie cmdlet zostanie uruchomione. Cmdlet nie jest uruchomiony.

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	False
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	Wi

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Dane wejściowe

PSResource

String

PSObject

Hashtable

Dane wyjściowe

PSObject

Linki powiązane

• Get-AzResource
• Move-AzResource
• New-AzResource
• Remove-AzResource