Set-AzResource
Изменяет ресурс.
Синтаксис
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>]
Описание
Командлет Set-AzResource изменяет существующий ресурс Azure. Укажите ресурс для изменения по имени и типу или по идентификатору.
Примеры
Пример 1. Изменение ресурса
$Resource = Get-AzResource -ResourceType Microsoft.Web/sites -ResourceGroupName ResourceGroup11 -ResourceName ContosoSite
$Resource.Properties.Enabled = "False"
$Resource | Set-AzResource -Force
Первая команда получает ресурс с именем ContosoSite с помощью командлета Get-AzResource, а затем сохраняет его в переменной $Resource. Вторая команда изменяет свойство $Resource. Последняя команда обновляет ресурс в соответствии с $Resource.
Пример 2. Изменение всех ресурсов в заданной группе ресурсов
$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}
Первая команда получает ресурсы в группе ресурсов testrg, а затем сохраняет их в переменной $Resource.
Вторая выполняет итерацию по каждому из этих ресурсов в группе ресурсов и добавляет к ним новый тег.
Последняя команда обновляет каждый из этих ресурсов.
Параметры
-ApiVersion
Указывает версию API поставщика ресурсов для использования. Если вы не указываете версию, этот командлет использует последнюю доступную версию.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-AsJob
Запуск командлета в фоновом режиме
Тип: | SwitchParameter |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Confirm
Запрос подтверждения перед выполнением командлета.
Тип: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-DefaultProfile
Учетные данные, учетная запись, клиент и подписка, используемые для обмена данными с Azure
Тип: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-ExtensionResourceName
Указывает имя ресурса расширения для ресурса.
Например, чтобы указать базу данных, используйте следующий формат: имя базы данных имени/
сервера.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-ExtensionResourceType
Указывает тип ресурса расширения.
Например, если ресурс расширения является базой данных, укажите следующее: Microsoft.Sql/Servers/Databases
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-Force
Принудительное выполнение команды без запроса на подтверждение пользователем.
Тип: | SwitchParameter |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-InputObject
Представление объекта обновляемого ресурса.
Тип: | PSResource |
Position: | Named |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-Kind
Указывает тип ресурса для ресурса.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-ODataQuery
Задает фильтр стиля Open Data Protocol (OData). Этот командлет добавляет это значение к запросу в дополнение к любым другим фильтрам.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Plan
Задает свойства плана ресурсов в виде хэш-таблицы для ресурса.
Тип: | Hashtable |
Aliases: | PlanObject |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-Pre
Указывает, что этот командлет рассматривает версии API предварительной версии, когда она автоматически определяет, какую версию следует использовать.
Тип: | SwitchParameter |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Properties
Задает свойства ресурса для ресурса.
Тип: | PSObject |
Aliases: | PropertyObject |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-ResourceGroupName
Указывает имя группы ресурсов, в которой этот командлет изменяет ресурс.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-ResourceId
Указывает полный идентификатор ресурса, включая подписку, как в следующем примере: /subscriptions/
идентификатор подписки/providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase
Тип: | String |
Aliases: | Id |
Position: | Named |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-ResourceName
Указывает имя ресурса.
Например, чтобы указать базу данных, используйте следующий формат: ContosoServer/ContosoDatabase
Тип: | String |
Aliases: | Name |
Position: | Named |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-ResourceType
Указывает тип ресурса.
Например, для базы данных тип ресурса выглядит следующим образом: Microsoft.Sql/Servers/Databases
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-Sku
Задает объект SKU ресурса в виде хэш-таблицы.
Тип: | Hashtable |
Aliases: | SkuObject |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-Tag
Пары "ключ-значение" в виде хэш-таблицы. Например: @{key0="value0"; key1=$null; key2="value2"}
Тип: | Hashtable |
Aliases: | Tags |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-TenantLevel
Указывает, что этот командлет работает на уровне клиента.
Тип: | SwitchParameter |
Position: | Named |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-UsePatchSemantics
Указывает, что этот командлет использует HTTP PATCH для обновления объекта, а не HTTP PUT.
Тип: | SwitchParameter |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-WhatIf
Показывает, что произойдет при запуске командлета. Командлет не выполняется.
Тип: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |