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

Update-AzPolicySetDefinition

Модуль:
Az.Resources Module

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

Синтаксис

Name (по умолчанию) 

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

ManagementGroupName 

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

SubscriptionId 

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

Id 

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

InputObject 

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

Описание

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

Примеры

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

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

Первая команда получает определение набора политик с помощью командлета Get-AzPolicySetDefinition. Команда сохраняет этот объект в переменной $PolicySetDefinition. Вторая команда обновляет описание определения набора политик, определяемого свойством Id $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
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Confirm

Запрашивает подтверждение перед запуском cmdlet.

Свойства параметра

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:cf

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-DefaultProfile

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

Свойства параметра

Тип:PSObject
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Description

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

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-DisplayName

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

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-Id

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

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:ResourceId (Идентификатор ресурса)

Наборы параметров

Id
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-InputObject

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

Свойства параметра

Тип:IPolicySetDefinition
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

InputObject
Position:Named
Обязательно:True
Значение из конвейера:True
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-ManagementGroupName

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

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

ManagementGroupName
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-Metadata

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

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-Name

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

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:PolicySetDefinitionName

Наборы параметров

Name
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
ManagementGroupName
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
SubscriptionId
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-Parameter

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

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-PolicyDefinition

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

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-PolicyDefinitionGroup

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

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:GroupDefinition

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-SubscriptionId

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

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

SubscriptionId
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-WhatIf

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

Свойства параметра

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:wi

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

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

IPolicySetDefinition

String

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

IPolicySetDefinition

Примечания

ПСЕВДОНИМЫ

Set-AzPolicySetDefinition