Set-AzResource
Modifie une ressource.
Syntaxe
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
L’applet de commande Set-AzResource modifie une ressource Azure existante. Spécifiez une ressource à modifier par nom et par type ou par ID.
Exemples
Exemple 1 : Modifier une ressource
$Resource = Get-AzResource -ResourceType Microsoft.Web/sites -ResourceGroupName ResourceGroup11 -ResourceName ContosoSite
$Resource.Properties.Enabled = "False"
$Resource | Set-AzResource -Force
La première commande obtient la ressource nommée ContosoSite à l’aide de l’applet de commande Get-AzResource, puis la stocke dans la variable $Resource. La deuxième commande modifie une propriété de $Resource. La commande finale met à jour la ressource pour qu’elle corresponde à $Resource.
Exemple 2 : Modifier toutes les ressources d’un groupe de ressources donné
$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}
La première commande obtient les ressources du groupe de ressources testrg, puis les stocke dans la variable $Resource.
La deuxième commande effectue une itération sur chacune de ces ressources dans le groupe de ressources et y ajoute une nouvelle étiquette.
La dernière commande met à jour chacune de ces ressources.
Paramètres
-ApiVersion
Spécifie la version de l’API du fournisseur de ressources à utiliser. Si vous ne spécifiez pas de version, cette applet de commande utilise la dernière version disponible.
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-AsJob
Exécuter l’applet de commande en arrière-plan
Type: | SwitchParameter |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-Confirm
Vous demande une confirmation avant d’exécuter la commande cmdlet.
Type: | SwitchParameter |
Alias: | cf |
Position: | Named |
Valeur par défaut: | False |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-DefaultProfile
Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure
Type: | IAzureContextContainer |
Alias: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-ExtensionResourceName
Spécifie le nom d’une ressource d’extension pour la ressource.
Par exemple, pour spécifier une base de données, utilisez le format suivant : nom de la base de données de nom/
de serveur
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-ExtensionResourceType
Spécifie le type de ressource d’une ressource d’extension.
Par exemple, si la ressource d’extension est une base de données, spécifiez ce qui suit : Microsoft.Sql/Servers/Databases
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-Force
Force l’exécution de la commande sans demander la confirmation de l’utilisateur.
Type: | SwitchParameter |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-InputObject
Représentation d’objet de la ressource à mettre à jour.
Type: | PSResource |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-Kind
Spécifie le type de ressource de la ressource.
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-ODataQuery
Spécifie un filtre de style OData (Open Data Protocol). Cette applet de commande ajoute cette valeur à la demande en plus des autres filtres.
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-Plan
Spécifie les propriétés du plan de ressources, en tant que table de hachage, pour la ressource.
Type: | Hashtable |
Alias: | PlanObject |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-Pre
Indique que cette applet de commande prend en compte les versions d’API en préversion lorsqu’elle détermine automatiquement la version à utiliser.
Type: | SwitchParameter |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-Properties
Spécifie les propriétés de ressource de la ressource.
Type: | PSObject |
Alias: | PropertyObject |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-ResourceGroupName
Spécifie le nom du groupe de ressources dans lequel cette applet de commande modifie la ressource.
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-ResourceId
Spécifie l’ID de ressource complet, y compris l’abonnement, comme dans l’exemple suivant : /subscriptions/
ID d’abonnement/providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase
Type: | String |
Alias: | Id |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-ResourceName
Spécifie le nom de la ressource.
Par exemple, pour spécifier une base de données, utilisez le format suivant : ContosoServer/ContosoDatabase
Type: | String |
Alias: | Name |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-ResourceType
Spécifie le type de la ressource.
Par exemple, pour une base de données, le type de ressource est le suivant : Microsoft.Sql/Servers/Databases
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-Sku
Spécifie l’objet SKU de la ressource en tant que table de hachage.
Type: | Hashtable |
Alias: | SkuObject |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-Tag
Paires clé-valeur sous la forme d’une table de hachage. Par exemple : @{key0="value0 » ; key1=$null ; key2="value2"}
Type: | Hashtable |
Alias: | Tags |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-TenantLevel
Indique que cette applet de commande fonctionne au niveau du locataire.
Type: | SwitchParameter |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-UsePatchSemantics
Indique que cette applet de commande utilise un CORRECTIF HTTP pour mettre à jour l’objet, au lieu d’un HTTP PUT.
Type: | SwitchParameter |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-WhatIf
Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.
Type: | SwitchParameter |
Alias: | wi |
Position: | Named |
Valeur par défaut: | False |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |