Поделиться через

Update-AzPolicySetDefinition

  • Ссылка
Модуль:
Az.Resources

Эта операция обновляет существующее определение набора политик в заданной подписке или группе управления с заданным именем.

Синтаксис

Update-AzPolicySetDefinition
      -Name <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-PolicyDefinition <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-PolicyDefinitionGroup <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzPolicySetDefinition
      -Name <String>
      -ManagementGroupName <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-PolicyDefinition <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-PolicyDefinitionGroup <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzPolicySetDefinition
      -Name <String>
      -SubscriptionId <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-PolicyDefinition <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-PolicyDefinitionGroup <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzPolicySetDefinition
      -Id <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-PolicyDefinition <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-PolicyDefinitionGroup <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzPolicySetDefinition
      [-DisplayName <String>]
      [-Description <String>]
      [-PolicyDefinition <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-PolicyDefinitionGroup <String>]
      [-BackwardCompatible]
      -InputObject <IPolicySetDefinition>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Описание

Эта операция обновляет существующее определение набора политик в заданной подписке или группе управления с заданным именем.

Примеры

Пример 1. Обновление описания определения набора политик

$PolicySetDefinition = Get-AzPolicySetDefinition -ResourceId '/subscriptions/mySub/Microsoft.Authorization/policySetDefinitions/myPSSetDefinition'
Update-AzPolicySetDefinition -Id $PolicySetDefinition.ResourceId -Description 'Updated policy to not allow virtual machine creation'

Первая команда получает определение набора политик с помощью командлета Get-AzPolicySetDefinition. Команда сохраняет этот объект в переменной $PolicySetDefinition. Вторая команда обновляет описание определения набора политик, определяемого свойством ResourceId $PolicySetDefinition.

Пример 2. Обновление метаданных определения набора политик

Update-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -Metadata '{"category":"Virtual Machine"}'

Эта команда обновляет метаданные определения набора политик с именем VMPolicySetDefinition, чтобы указать, что ее категория — "Виртуальная машина".

Пример 3. Обновление групп определения набора политик

Update-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -GroupDefinition '[{ "name": "group1", "displayName": "Virtual Machine Security" }, { "name": "group2" }]'

Эта команда обновляет группы определения набора политик с именем VMPolicySetDefinition.

Пример 4. Обновление групп определения набора политик с помощью хэш-таблицы

$groupsJson = ConvertTo-Json @{ name = "group1"; displayName = "Virtual Machine Security" }, @{ name = "group2" }
Update-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -GroupDefinition $groupsJson

Эта команда обновляет группы определения набора политик с именем VMPolicySetDefinition из хэш-таблицы.

Пример 5. [Backcompat] Обновление метаданных определения набора политик

Set-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -Metadata '{"category":"Virtual Machine"}'

Эта команда обновляет метаданные определения набора политик с именем VMPolicySetDefinition, чтобы указать, что ее категория — "Виртуальная машина".

Параметры

-BackwardCompatible

Позволяет командлету возвращать артефакты с помощью устаревшего формата размещения свойств, относящихся к политике, в объекте контейнера свойств.

Тип:SwitchParameter
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Запрос подтверждения перед выполнением командлета.

Тип:SwitchParameter
Aliases:cf
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Параметр DefaultProfile не работает. Используйте параметр SubscriptionId, если он доступен при выполнении командлета в другой подписке.

Тип:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Описание определения набора политик.

Тип:String
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:True
Accept wildcard characters:False

-DisplayName

Отображаемое имя определения набора политик.

Тип:String
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:True
Accept wildcard characters:False

-Id

Идентификатор ресурса определения политики для обновления.

Тип:String
Aliases:ResourceId
Position:Named
значение по умолчанию:None
Обязательно:True
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

Тип:IPolicySetDefinition
Position:Named
значение по умолчанию:None
Обязательно:True
Accept pipeline input:True
Accept wildcard characters:False

-ManagementGroupName

Идентификатор группы управления.

Тип:String
Position:Named
значение по умолчанию:None
Обязательно:True
Accept pipeline input:True
Accept wildcard characters:False

-Metadata

Метаданные определения набора политик. Метаданные — это открытый завершенный объект, который обычно представляет собой коллекцию пар значений ключей.

Тип:String
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Имя определения набора политик для обновления.

Тип:String
Aliases:PolicySetDefinitionName
Position:Named
значение по умолчанию:None
Обязательно:True
Accept pipeline input:True
Accept wildcard characters:False

-Parameter

Определения параметров для параметров, используемых в наборе политик. Ключи — это имена параметров.

Тип:String
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:True
Accept wildcard characters:False

-PolicyDefinition

Массив определений политики в строковой форме JSON.

Тип:String
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-PolicyDefinitionGroup

Метаданные, описывающие группы ссылок на определения политики в определении набора политик. Сведения о создании см. в разделе NOTES для свойств POLICYDEFINITIONGROUP и создания хэш-таблицы.

Тип:String
Aliases:GroupDefinition
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

Идентификатор целевой подписки.

Тип:String
Position:Named
значение по умолчанию:None
Обязательно:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Показывает, что произойдет при запуске командлета. Командлет не выполняется.

Тип:SwitchParameter
Aliases:wi
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

Входные данные

IPolicySetDefinition

String

Выходные данные

IPolicySetDefinition

Примечания

ПСЕВДОНИМЫ

Set-AzPolicySetDefinition