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

Get-AzPolicyDefinition

Модуль:
Az.Resources Module

Возвращает определения набора политик.

Синтаксис

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

Get-AzPolicyDefinition
    [-Name <String>]
    [-BackwardCompatible]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

ManagementGroupName 

Get-AzPolicyDefinition
    -ManagementGroupName <String>
    [-Name <String>]
    [-BackwardCompatible]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

SubscriptionId 

Get-AzPolicyDefinition
    -SubscriptionId <String>
    [-Name <String>]
    [-BackwardCompatible]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Version 

Get-AzPolicyDefinition
    -Version <String>
    [-Name <String>]
    [-Id <String>]
    [-BackwardCompatible]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

ListVersion 

Get-AzPolicyDefinition
    [-Name <String>]
    [-Id <String>]
    [-ListVersion]
    [-BackwardCompatible]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Id 

Get-AzPolicyDefinition
    -Id <String>
    [-BackwardCompatible]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Builtin 

Get-AzPolicyDefinition
    [-SubscriptionId <String>]
    [-ManagementGroupName <String>]
    [-Builtin]
    [-BackwardCompatible]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Custom 

Get-AzPolicyDefinition
    [-SubscriptionId <String>]
    [-ManagementGroupName <String>]
    [-Custom]
    [-BackwardCompatible]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Static 

Get-AzPolicyDefinition
    [-SubscriptionId <String>]
    [-ManagementGroupName <String>]
    [-Static]
    [-BackwardCompatible]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Описание

Командлет Get-AzPolicyDefinition получает коллекцию определений набора политик или определенное определение набора политик, определяемое по имени или идентификатору.

Примеры

Пример 1. Получение всех определений политик

Get-AzPolicyDefinition

Эта команда получает все определения политики.

Пример 2. Получение определения политики из текущей подписки по имени

Get-AzPolicyDefinition -Name 'VMPolicyDefinition'

Эта команда получает определение политики с именем VMPolicyDefinition из текущей подписки по умолчанию.

Пример 3. Получение определения политики из группы управления по имени

Get-AzPolicyDefinition -Name 'VMPolicyDefinition' -ManagementGroupName 'Dept42'

Эта команда получает определение политики с именем VMPolicyDefinition из группы управления с именем Dept42.

Пример 4. Получение всех встроенных определений политик из подписки

Get-AzPolicyDefinition -SubscriptionId '3bf44b72-c631-427a-b8c8-53e2595398ca' -Builtin

Эта команда получает все встроенные определения политик из подписки с идентификатором 3bf44b72-c631-427a-b8c8-53e2595398ca.

Пример 5. Получение определений политик из заданной категории

Get-AzPolicyDefinition | Where-Object {$_.Properties.metadata.category -eq 'Tags'}

Эта команда получает все определения политики в тегах категории.

Пример 6. Получение отображаемого имени, описания, типа политики и метаданных всех определений политик, отформатированных в виде списка

Get-AzPolicyDefinition | Select-Object -Property DisplayName, Description, PolicyType, Metadata | Format-List

Эта команда полезна при поиске свойства DisplayName , понятного для чтения, определения политики Azure. Вы можете проанализировать свойство метаданных , чтобы обнаружить номер версии определения политики и назначение категории.

Пример 7. [Backcompat] Получение отображаемого имени, описания, типа политики и метаданных всех определений политик, отформатированных в виде списка

Get-AzPolicyDefinition -BackwardCompatible | Select-Object -ExpandProperty properties | Select-Object -Property DisplayName, Description, PolicyType, Metadata | Format-List

Эта команда полезна при поиске свойства DisplayName , понятного для чтения, определения политики Azure. Вы можете проанализировать свойство метаданных , чтобы обнаружить номер версии определения политики и назначение категории.

Параметры

-BackwardCompatible

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

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

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

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

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

-Builtin

Вызывает возврат только встроенных определений политик командлета.

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

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

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

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

-Custom

Вызывает возврат только пользовательских определений политик командлета.

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

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

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

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

-DefaultProfile

Учетные данные, учетная запись, клиент и подписка, используемые для взаимодействия с Azure.

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

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

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

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

-Id

Полный идентификатор определения политики для получения.

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

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

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

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

-ListVersion

Вызывает возврат только пользовательских определений политик командлета.

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

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

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

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

-ManagementGroupName

Имя группы управления.

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

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

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

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

-Name

Имя определения политики для получения.

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

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

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

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

-Static

Вызывает возврат только статических определений политик командлета.

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

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

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

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

-SubscriptionId

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

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

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

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

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

-Version

Версия определения политики в формате #.#.#

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

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

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

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

CommonParameters

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

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

SwitchParameter

String

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

IPolicyDefinition