Set-AzResource
Sintaxe
ByResourceId (Predefinição)
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>]
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>]
Description
O cmdlet Set-AzResource modifica um recurso existente do Azure.
Especifique um recurso a ser modificado por nome e tipo ou por ID.
Exemplos
Exemplo 1: Modificar um recurso
$Resource = Get-AzResource -ResourceType Microsoft.Web/sites -ResourceGroupName ResourceGroup11 -ResourceName ContosoSite
$Resource.Properties.Enabled = "False"
$Resource | Set-AzResource -Force
O primeiro comando obtém o recurso chamado ContosoSite usando o cmdlet Get-AzResource e, em seguida, armazena-o na variável $Resource.
O segundo comando modifica uma propriedade de $Resource.
O comando final atualiza o recurso para corresponder a $Resource.
Exemplo 2: Modificar todos os recursos em um determinado grupo de recursos
$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}
O primeiro comando obtém os recursos no grupo de recursos testrg e, em seguida, armazena-os na variável $Resource.
O segundo comando itera sobre cada um desses recursos no grupo de recursos e adiciona uma nova tag a eles.
O comando final atualiza cada um desses recursos.
Parâmetros
-ApiVersion
Especifica a versão da API do provedor de recursos a ser usada.
Se você não especificar uma versão, esse cmdlet usará a versão mais recente disponível.
Propriedades dos parâmetros
Tipo: String
Default value: None Suporta carateres universais: False NãoMostrar: False
Conjuntos de parâmetros
(All)
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: False Valor dos restantes argumentos: False
-AsJob
Executar cmdlet em segundo plano
Propriedades dos parâmetros
Tipo: SwitchParameter
Default value: None Suporta carateres universais: False NãoMostrar: False
Conjuntos de parâmetros
(All)
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: False Valor dos restantes argumentos: False
-Confirm
Solicita confirmação antes de executar o cmdlet.
Propriedades dos parâmetros
Tipo: SwitchParameter
Default value: False Suporta carateres universais: False NãoMostrar: False Aliases: Cf.
Conjuntos de parâmetros
(All)
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: False Valor dos restantes argumentos: False
-DefaultProfile
As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure
Propriedades dos parâmetros
Tipo: IAzureContextContainer
Default value: None Suporta carateres universais: False NãoMostrar: False Aliases: AzContext, AzureRmContext, AzureCredential
Conjuntos de parâmetros
(All)
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: False Valor dos restantes argumentos: False
-ExtensionResourceName
Especifica o nome de um recurso de extensão para o recurso.
Por exemplo, para especificar um banco de dados, use o seguinte formato: nome/do servidor nome do banco de dados
Propriedades dos parâmetros
Tipo: String
Default value: None Suporta carateres universais: False NãoMostrar: False
Conjuntos de parâmetros
BySubscriptionLevel
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
ByTenantLevel
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
-ExtensionResourceType
Especifica o tipo de recurso para um recurso de extensão.
Por exemplo, se o recurso de extensão for um banco de dados, especifique o seguinte: Microsoft.Sql/Servers/Databases
Propriedades dos parâmetros
Tipo: String
Default value: None Suporta carateres universais: False NãoMostrar: False
Conjuntos de parâmetros
BySubscriptionLevel
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
ByTenantLevel
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
-Force
Força o comando a ser executado sem pedir a confirmação do usuário.
Propriedades dos parâmetros
Tipo: SwitchParameter
Default value: None Suporta carateres universais: False NãoMostrar: False
Conjuntos de parâmetros
(All)
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: False Valor dos restantes argumentos: False
A representação do objeto do recurso a ser atualizado.
Tipo: PSResource
Default value: None Suporta carateres universais: False NãoMostrar: False
ByInputObject
Position: Named Obrigatório: True Valor do pipeline: True Valor do pipeline por nome de propriedade: False Valor dos restantes argumentos: False
-Kind
Especifica o tipo de recurso para o recurso.
Propriedades dos parâmetros
Tipo: String
Default value: None Suporta carateres universais: False NãoMostrar: False
Conjuntos de parâmetros
(All)
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
-ODataQuery
Especifica um filtro de estilo OData (Open Data Protocol).
Este cmdlet acrescenta esse valor à solicitação, além de quaisquer outros filtros.
Propriedades dos parâmetros
Tipo: String
Default value: None Suporta carateres universais: False NãoMostrar: False
Conjuntos de parâmetros
(All)
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: False Valor dos restantes argumentos: False
-Plan
Especifica as propriedades do plano de recursos, como uma tabela de hash, para o recurso.
Propriedades dos parâmetros
Tipo: Hashtable
Default value: None Suporta carateres universais: False NãoMostrar: False Aliases: PlanObject
Conjuntos de parâmetros
(All)
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
-Pre
Indica que esse cmdlet considera versões de API de pré-lançamento quando determina automaticamente qual versão usar.
Propriedades dos parâmetros
Tipo: SwitchParameter
Default value: None Suporta carateres universais: False NãoMostrar: False
Conjuntos de parâmetros
(All)
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: False Valor dos restantes argumentos: False
-Properties
Especifica as propriedades do recurso.
Propriedades dos parâmetros
Tipo: PSObject
Default value: None Suporta carateres universais: False NãoMostrar: False Aliases: PropertyObject
Conjuntos de parâmetros
(All)
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
-ResourceGroupName
Especifica o nome do grupo de recursos onde esse cmdlet modifica o recurso.
Propriedades dos parâmetros
Tipo: String
Default value: None Suporta carateres universais: False NãoMostrar: False
Conjuntos de parâmetros
BySubscriptionLevel
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
-ResourceId
Especifica a ID de recurso totalmente qualificada, incluindo a assinatura, como no exemplo a seguir: /subscriptions/ID da assinatura/providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase
Propriedades dos parâmetros
Tipo: String
Default value: None Suporta carateres universais: False NãoMostrar: False Aliases: Id
Conjuntos de parâmetros
ByResourceId
Position: Named Obrigatório: True Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
-ResourceName
Especifica o nome do recurso.
Por exemplo, para especificar um banco de dados, use o seguinte formato: ContosoServer/ContosoDatabase
Propriedades dos parâmetros
Tipo: String
Default value: None Suporta carateres universais: False NãoMostrar: False Aliases: Nome
Conjuntos de parâmetros
BySubscriptionLevel
Position: Named Obrigatório: True Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
ByTenantLevel
Position: Named Obrigatório: True Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
-ResourceType
Especifica o tipo do recurso.
Por exemplo, para um banco de dados, o tipo de recurso é o seguinte: Microsoft.Sql/Servers/Databases
Propriedades dos parâmetros
Tipo: String
Default value: None Suporta carateres universais: False NãoMostrar: False
Conjuntos de parâmetros
BySubscriptionLevel
Position: Named Obrigatório: True Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
ByTenantLevel
Position: Named Obrigatório: True Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
-Sku
Especifica o objeto SKU do recurso como uma tabela de hash.
Propriedades dos parâmetros
Tipo: Hashtable
Default value: None Suporta carateres universais: False NãoMostrar: False Aliases: SkuObject
Conjuntos de parâmetros
(All)
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
-Tag
Pares chave-valor na forma de uma tabela de hash. Por exemplo: @{key0="value0"; chave1=$null; key2="valor2"}
Propriedades dos parâmetros
Tipo: Hashtable
Default value: None Suporta carateres universais: False NãoMostrar: False Aliases: Etiquetas
Conjuntos de parâmetros
(All)
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
-TenantLevel
Indica que esse cmdlet opera no nível do locatário.
Propriedades dos parâmetros
Tipo: SwitchParameter
Default value: None Suporta carateres universais: False NãoMostrar: False
Conjuntos de parâmetros
ByTenantLevel
Position: Named Obrigatório: True Valor do pipeline: False Valor do pipeline por nome de propriedade: False Valor dos restantes argumentos: False
-UsePatchSemantics
Indica que esse cmdlet usa um HTTP PATCH para atualizar o objeto, em vez de um HTTP PUT.
Propriedades dos parâmetros
Tipo: SwitchParameter
Default value: None Suporta carateres universais: False NãoMostrar: False
Conjuntos de parâmetros
(All)
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: False Valor dos restantes argumentos: False
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado.
O cmdlet não é executado.
Propriedades dos parâmetros
Tipo: SwitchParameter
Default value: False Suporta carateres universais: False NãoMostrar: False Aliases: Wi
Conjuntos de parâmetros
(All)
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: False Valor dos restantes argumentos: False
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters .
Saídas
