PolicyDefinitions interface

Пакет:

@azure/arm-policy

Интерфейс, представляющий PolicyDefinitions.

Методы

createOrUpdate(string, PolicyDefinition, PolicyDefinitionsCreateOrUpdateOptionalParams)	Эта операция создает или обновляет определение политики в заданной подписке с заданным именем.
createOrUpdateAtManagementGroup(string, string, PolicyDefinition, PolicyDefinitionsCreateOrUpdateAtManagementGroupOptionalParams)	Эта операция создает или обновляет определение политики в заданной группе управления с заданным именем.
delete(string, PolicyDefinitionsDeleteOptionalParams)	Эта операция удаляет определение политики в заданной подписке с заданным именем.
deleteAtManagementGroup(string, string, PolicyDefinitionsDeleteAtManagementGroupOptionalParams)	Эта операция удаляет определение политики в заданной группе управления с заданным именем.
get(string, PolicyDefinitionsGetOptionalParams)	Эта операция извлекает определение политики в заданной подписке с заданным именем.
getAtManagementGroup(string, string, PolicyDefinitionsGetAtManagementGroupOptionalParams)	Эта операция извлекает определение политики в заданной группе управления с заданным именем.
getBuiltIn(string, PolicyDefinitionsGetBuiltInOptionalParams)	Эта операция извлекает встроенное определение политики с заданным именем.
list(PolicyDefinitionsListOptionalParams)	Эта операция извлекает список всех определений политик в заданной подписке, которые соответствуют необязательному заданному $filter. Допустимые значения для $filter: "atExactScope()", "policyType -eq {value}" или "category eq "{value}". Если $filter не указан, неотфильтрованный список включает все определения политик, связанные с подпиской, в том числе те, которые применяются непосредственно или из групп управления, содержащих указанную подписку. Если указан параметр $filter=atExactScope(), возвращенный список содержит только все определения политик, указанные в данной подписке. Если указан $filter='policyType -eq {value}', возвращаемый список включает только все определения политик, тип которых соответствует {value}. Возможные значения policyType: NotSpecified, BuiltIn, Custom и Static. Если указан $filter='category -eq {value}', возвращенный список включает только все определения политик, категория которых соответствует {value}.
listBuiltIn(PolicyDefinitionsListBuiltInOptionalParams)	Эта операция извлекает список всех встроенных определений политик, соответствующих необязательному $filter. Если указан $filter='policyType -eq {value}', возвращенный список включает только все встроенные определения политик, тип которых соответствует {value}. Возможные значения policyType: NotSpecified, BuiltIn, Custom и Static. Если указан $filter='category -eq {value}', возвращенный список включает только все встроенные определения политик, категория которых соответствует {value}.
listByManagementGroup(string, PolicyDefinitionsListByManagementGroupOptionalParams)	Эта операция извлекает список всех определений политик в заданной группе управления, которые соответствуют необязательным заданным $filter. Допустимые значения для $filter: "atExactScope()", "policyType -eq {value}" или "category eq "{value}". Если $filter не указан, нефильтрованный список включает все определения политик, связанные с группой управления, включая те, которые применяются непосредственно или из групп управления, содержащих указанную группу управления. Если указан $filter=atExactScope(), возвращенный список содержит только все определения политик, которые относятся к заданной группе управления. Если указан $filter='policyType -eq {value}', возвращаемый список включает только все определения политик, тип которых соответствует {value}. Возможные значения policyType: NotSpecified, BuiltIn, Custom и Static. Если указан $filter='category -eq {value}', возвращенный список включает только все определения политик, категория которых соответствует {value}.

Сведения о методе

createOrUpdate(string, PolicyDefinition, PolicyDefinitionsCreateOrUpdateOptionalParams)

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

function createOrUpdate(policyDefinitionName: string, parameters: PolicyDefinition, options?: PolicyDefinitionsCreateOrUpdateOptionalParams): Promise<PolicyDefinition>

Параметры

policyDefinitionName

string

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

parameters

PolicyDefinition

Свойства определения политики.

options

PolicyDefinitionsCreateOrUpdateOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<PolicyDefinition>

createOrUpdateAtManagementGroup(string, string, PolicyDefinition, PolicyDefinitionsCreateOrUpdateAtManagementGroupOptionalParams)

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

function createOrUpdateAtManagementGroup(policyDefinitionName: string, managementGroupId: string, parameters: PolicyDefinition, options?: PolicyDefinitionsCreateOrUpdateAtManagementGroupOptionalParams): Promise<PolicyDefinition>

Параметры

policyDefinitionName

string

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

managementGroupId

string

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

parameters

PolicyDefinition

Свойства определения политики.

options

PolicyDefinitionsCreateOrUpdateAtManagementGroupOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<PolicyDefinition>

delete(string, PolicyDefinitionsDeleteOptionalParams)

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

function delete(policyDefinitionName: string, options?: PolicyDefinitionsDeleteOptionalParams): Promise<void>

Параметры

policyDefinitionName

string

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

options

PolicyDefinitionsDeleteOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<void>

deleteAtManagementGroup(string, string, PolicyDefinitionsDeleteAtManagementGroupOptionalParams)

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

function deleteAtManagementGroup(policyDefinitionName: string, managementGroupId: string, options?: PolicyDefinitionsDeleteAtManagementGroupOptionalParams): Promise<void>

Параметры

policyDefinitionName

string

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

managementGroupId

string

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

options

PolicyDefinitionsDeleteAtManagementGroupOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<void>

get(string, PolicyDefinitionsGetOptionalParams)

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

function get(policyDefinitionName: string, options?: PolicyDefinitionsGetOptionalParams): Promise<PolicyDefinition>

Параметры

policyDefinitionName

string

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

options

PolicyDefinitionsGetOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<PolicyDefinition>

getAtManagementGroup(string, string, PolicyDefinitionsGetAtManagementGroupOptionalParams)

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

function getAtManagementGroup(policyDefinitionName: string, managementGroupId: string, options?: PolicyDefinitionsGetAtManagementGroupOptionalParams): Promise<PolicyDefinition>

Параметры

policyDefinitionName

string

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

managementGroupId

string

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

options

PolicyDefinitionsGetAtManagementGroupOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<PolicyDefinition>

getBuiltIn(string, PolicyDefinitionsGetBuiltInOptionalParams)

Эта операция извлекает встроенное определение политики с заданным именем.

function getBuiltIn(policyDefinitionName: string, options?: PolicyDefinitionsGetBuiltInOptionalParams): Promise<PolicyDefinition>

Параметры

policyDefinitionName

string

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

options

PolicyDefinitionsGetBuiltInOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<PolicyDefinition>

list(PolicyDefinitionsListOptionalParams)

Эта операция извлекает список всех определений политик в заданной подписке, которые соответствуют необязательному заданному $filter. Допустимые значения для $filter: "atExactScope()", "policyType -eq {value}" или "category eq "{value}". Если $filter не указан, неотфильтрованный список включает все определения политик, связанные с подпиской, в том числе те, которые применяются непосредственно или из групп управления, содержащих указанную подписку. Если указан параметр $filter=atExactScope(), возвращенный список содержит только все определения политик, указанные в данной подписке. Если указан $filter='policyType -eq {value}', возвращаемый список включает только все определения политик, тип которых соответствует {value}. Возможные значения policyType: NotSpecified, BuiltIn, Custom и Static. Если указан $filter='category -eq {value}', возвращенный список включает только все определения политик, категория которых соответствует {value}.

function list(options?: PolicyDefinitionsListOptionalParams): PagedAsyncIterableIterator<PolicyDefinition, PolicyDefinition[], PageSettings>

Параметры

options

PolicyDefinitionsListOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<PolicyDefinition, PolicyDefinition[], PageSettings>

listBuiltIn(PolicyDefinitionsListBuiltInOptionalParams)

Эта операция извлекает список всех встроенных определений политик, соответствующих необязательному $filter. Если указан $filter='policyType -eq {value}', возвращенный список включает только все встроенные определения политик, тип которых соответствует {value}. Возможные значения policyType: NotSpecified, BuiltIn, Custom и Static. Если указан $filter='category -eq {value}', возвращенный список включает только все встроенные определения политик, категория которых соответствует {value}.

function listBuiltIn(options?: PolicyDefinitionsListBuiltInOptionalParams): PagedAsyncIterableIterator<PolicyDefinition, PolicyDefinition[], PageSettings>

Параметры

options

PolicyDefinitionsListBuiltInOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<PolicyDefinition, PolicyDefinition[], PageSettings>

listByManagementGroup(string, PolicyDefinitionsListByManagementGroupOptionalParams)

Эта операция извлекает список всех определений политик в заданной группе управления, которые соответствуют необязательным заданным $filter. Допустимые значения для $filter: "atExactScope()", "policyType -eq {value}" или "category eq "{value}". Если $filter не указан, нефильтрованный список включает все определения политик, связанные с группой управления, включая те, которые применяются непосредственно или из групп управления, содержащих указанную группу управления. Если указан $filter=atExactScope(), возвращенный список содержит только все определения политик, которые относятся к заданной группе управления. Если указан $filter='policyType -eq {value}', возвращаемый список включает только все определения политик, тип которых соответствует {value}. Возможные значения policyType: NotSpecified, BuiltIn, Custom и Static. Если указан $filter='category -eq {value}', возвращенный список включает только все определения политик, категория которых соответствует {value}.

function listByManagementGroup(managementGroupId: string, options?: PolicyDefinitionsListByManagementGroupOptionalParams): PagedAsyncIterableIterator<PolicyDefinition, PolicyDefinition[], PageSettings>

Параметры

managementGroupId

string

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

options

PolicyDefinitionsListByManagementGroupOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<PolicyDefinition, PolicyDefinition[], PageSettings>