PolicyDefinitions interface

Pacote:

@azure/arm-policy

Interface que representa um PolicyDefinitions.

Métodos

createOrUpdate(string, PolicyDefinition, PolicyDefinitionsCreateOrUpdateOptionalParams)	Essa operação cria ou atualiza uma definição de política na assinatura fornecida com o nome fornecido.
createOrUpdateAtManagementGroup(string, string, PolicyDefinition, PolicyDefinitionsCreateOrUpdateAtManagementGroupOptionalParams)	Essa operação cria ou atualiza uma definição de política no grupo de gerenciamento fornecido com o nome fornecido.
delete(string, PolicyDefinitionsDeleteOptionalParams)	Essa operação exclui a definição de política na assinatura fornecida com o nome fornecido.
deleteAtManagementGroup(string, string, PolicyDefinitionsDeleteAtManagementGroupOptionalParams)	Essa operação exclui a definição de política no grupo de gerenciamento fornecido com o nome fornecido.
get(string, PolicyDefinitionsGetOptionalParams)	Essa operação recupera a definição de política na assinatura fornecida com o nome fornecido.
getAtManagementGroup(string, string, PolicyDefinitionsGetAtManagementGroupOptionalParams)	Essa operação recupera a definição de política no grupo de gerenciamento fornecido com o nome fornecido.
getBuiltIn(string, PolicyDefinitionsGetBuiltInOptionalParams)	Essa operação recupera a definição de política interna com o nome fornecido.
list(PolicyDefinitionsListOptionalParams)	Essa operação recupera uma lista de todas as definições de política em uma determinada assinatura que correspondem à $filter opcional fornecida. Os valores válidos para $filter são: 'atExactScope()', 'policyType -eq {value}' ou 'category eq '{value}''. Se $filter não for fornecido, a lista não filtrada incluirá todas as definições de política associadas à assinatura, incluindo aquelas que se aplicam diretamente ou de grupos de gerenciamento que contêm a assinatura fornecida. Se $filter=atExactScope() for fornecido, a lista retornada incluirá apenas todas as definições de política que estão na assinatura fornecida. Se $filter='policyType -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cujo tipo corresponde ao {value}. Os valores possíveis policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cuja categoria corresponde ao {value}.
listBuiltIn(PolicyDefinitionsListBuiltInOptionalParams)	Essa operação recupera uma lista de todas as definições de política internas que correspondem à $filter opcional fornecida. Se $filter='policyType -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política internas cujo tipo corresponde ao {value}. Os valores possíveis policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política internas cuja categoria corresponde ao {value}.
listByManagementGroup(string, PolicyDefinitionsListByManagementGroupOptionalParams)	Essa operação recupera uma lista de todas as definições de política em um determinado grupo de gerenciamento que correspondem à $filter opcional fornecida. Os valores válidos para $filter são: 'atExactScope()', 'policyType -eq {value}' ou 'category eq '{value}''. Se $filter não for fornecido, a lista não filtrada incluirá todas as definições de política associadas ao grupo de gerenciamento, incluindo aquelas que se aplicam diretamente ou de grupos de gerenciamento que contêm o grupo de gerenciamento fornecido. Se $filter=atExactScope() for fornecido, a lista retornada incluirá apenas todas as definições de política que estão no grupo de gerenciamento fornecido. Se $filter='policyType -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cujo tipo corresponde ao {value}. Os valores possíveis policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cuja categoria corresponde ao {value}.

Detalhes do método

createOrUpdate(string, PolicyDefinition, PolicyDefinitionsCreateOrUpdateOptionalParams)

Essa operação cria ou atualiza uma definição de política na assinatura fornecida com o nome fornecido.

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

Parâmetros

policyDefinitionName

string

O nome da definição de política a ser criada.

parameters

PolicyDefinition

As propriedades de definição de política.

options

PolicyDefinitionsCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<PolicyDefinition>

createOrUpdateAtManagementGroup(string, string, PolicyDefinition, PolicyDefinitionsCreateOrUpdateAtManagementGroupOptionalParams)

Essa operação cria ou atualiza uma definição de política no grupo de gerenciamento fornecido com o nome fornecido.

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

Parâmetros

policyDefinitionName

string

O nome da definição de política a ser criada.

managementGroupId

string

A ID do grupo de gerenciamento.

parameters

PolicyDefinition

As propriedades de definição de política.

options

PolicyDefinitionsCreateOrUpdateAtManagementGroupOptionalParams

Os parâmetros de opções.

Retornos

Promise<PolicyDefinition>

delete(string, PolicyDefinitionsDeleteOptionalParams)

Essa operação exclui a definição de política na assinatura fornecida com o nome fornecido.

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

Parâmetros

policyDefinitionName

string

O nome da definição de política a ser excluída.

options

PolicyDefinitionsDeleteOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

deleteAtManagementGroup(string, string, PolicyDefinitionsDeleteAtManagementGroupOptionalParams)

Essa operação exclui a definição de política no grupo de gerenciamento fornecido com o nome fornecido.

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

Parâmetros

policyDefinitionName

string

O nome da definição de política a ser excluída.

managementGroupId

string

A ID do grupo de gerenciamento.

options

PolicyDefinitionsDeleteAtManagementGroupOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

get(string, PolicyDefinitionsGetOptionalParams)

Essa operação recupera a definição de política na assinatura fornecida com o nome fornecido.

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

Parâmetros

policyDefinitionName

string

O nome da definição de política a ser obtido.

options

PolicyDefinitionsGetOptionalParams

Os parâmetros de opções.

Retornos

Promise<PolicyDefinition>

getAtManagementGroup(string, string, PolicyDefinitionsGetAtManagementGroupOptionalParams)

Essa operação recupera a definição de política no grupo de gerenciamento fornecido com o nome fornecido.

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

Parâmetros

policyDefinitionName

string

O nome da definição de política a ser obtido.

managementGroupId

string

A ID do grupo de gerenciamento.

options

PolicyDefinitionsGetAtManagementGroupOptionalParams

Os parâmetros de opções.

Retornos

Promise<PolicyDefinition>

getBuiltIn(string, PolicyDefinitionsGetBuiltInOptionalParams)

Essa operação recupera a definição de política interna com o nome fornecido.

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

Parâmetros

policyDefinitionName

string

O nome da definição de política interna a ser obtido.

options

PolicyDefinitionsGetBuiltInOptionalParams

Os parâmetros de opções.

Retornos

Promise<PolicyDefinition>

list(PolicyDefinitionsListOptionalParams)

Essa operação recupera uma lista de todas as definições de política em uma determinada assinatura que correspondem à $filter opcional fornecida. Os valores válidos para $filter são: 'atExactScope()', 'policyType -eq {value}' ou 'category eq '{value}''. Se $filter não for fornecido, a lista não filtrada incluirá todas as definições de política associadas à assinatura, incluindo aquelas que se aplicam diretamente ou de grupos de gerenciamento que contêm a assinatura fornecida. Se $filter=atExactScope() for fornecido, a lista retornada incluirá apenas todas as definições de política que estão na assinatura fornecida. Se $filter='policyType -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cujo tipo corresponde ao {value}. Os valores possíveis policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cuja categoria corresponde ao {value}.

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

Parâmetros

options

PolicyDefinitionsListOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<PolicyDefinition, PolicyDefinition[], PageSettings>

listBuiltIn(PolicyDefinitionsListBuiltInOptionalParams)

Essa operação recupera uma lista de todas as definições de política internas que correspondem à $filter opcional fornecida. Se $filter='policyType -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política internas cujo tipo corresponde ao {value}. Os valores possíveis policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política internas cuja categoria corresponde ao {value}.

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

Parâmetros

options

PolicyDefinitionsListBuiltInOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<PolicyDefinition, PolicyDefinition[], PageSettings>

listByManagementGroup(string, PolicyDefinitionsListByManagementGroupOptionalParams)

Essa operação recupera uma lista de todas as definições de política em um determinado grupo de gerenciamento que correspondem à $filter opcional fornecida. Os valores válidos para $filter são: 'atExactScope()', 'policyType -eq {value}' ou 'category eq '{value}''. Se $filter não for fornecido, a lista não filtrada incluirá todas as definições de política associadas ao grupo de gerenciamento, incluindo aquelas que se aplicam diretamente ou de grupos de gerenciamento que contêm o grupo de gerenciamento fornecido. Se $filter=atExactScope() for fornecido, a lista retornada incluirá apenas todas as definições de política que estão no grupo de gerenciamento fornecido. Se $filter='policyType -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cujo tipo corresponde ao {value}. Os valores possíveis policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cuja categoria corresponde ao {value}.

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

Parâmetros

managementGroupId

string

A ID do grupo de gerenciamento.

options

PolicyDefinitionsListByManagementGroupOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<PolicyDefinition, PolicyDefinition[], PageSettings>