PolicySetDefinitions interface

Pacote:

@azure/arm-policy

Interface que representa um PolicySetDefinitions.

Métodos

createOrUpdate(string, PolicySetDefinition, PolicySetDefinitionsCreateOrUpdateOptionalParams)	Essa operação cria ou atualiza uma definição de conjunto de políticas na assinatura fornecida com o nome fornecido.
createOrUpdateAtManagementGroup(string, string, PolicySetDefinition, PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams)	Essa operação cria ou atualiza uma definição de conjunto de políticas no grupo de gerenciamento fornecido com o nome fornecido.
delete(string, PolicySetDefinitionsDeleteOptionalParams)	Essa operação exclui a definição do conjunto de políticas na assinatura fornecida com o nome fornecido.
deleteAtManagementGroup(string, string, PolicySetDefinitionsDeleteAtManagementGroupOptionalParams)	Essa operação exclui a definição do conjunto de políticas no grupo de gerenciamento fornecido com o nome fornecido.
get(string, PolicySetDefinitionsGetOptionalParams)	Essa operação recupera a definição do conjunto de políticas na assinatura fornecida com o nome fornecido.
getAtManagementGroup(string, string, PolicySetDefinitionsGetAtManagementGroupOptionalParams)	Essa operação recupera a definição do conjunto de políticas no grupo de gerenciamento fornecido com o nome fornecido.
getBuiltIn(string, PolicySetDefinitionsGetBuiltInOptionalParams)	Essa operação recupera a definição de conjunto de políticas interna com o nome fornecido.
list(PolicySetDefinitionsListOptionalParams)	Essa operação recupera uma lista de todas as definições do conjunto de políticas em uma determinada assinatura que correspondem ao $filter opcional determinado. 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 conjunto de políticas 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 conjunto de políticas que estão na assinatura fornecida. Se $filter='policyType -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de conjunto de políticas cujo tipo corresponde ao {value}. Os valores possíveis policyType são NotSpecified, BuiltIn e Custom. Se $filter='category -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de conjunto de políticas cuja categoria corresponde ao {value}.
listBuiltIn(PolicySetDefinitionsListBuiltInOptionalParams)	Essa operação recupera uma lista de todas as definições internas do conjunto de políticas que correspondem ao $filter opcional determinado. Se $filter='category -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições internas do conjunto de políticas cuja categoria corresponde ao {value}.
listByManagementGroup(string, PolicySetDefinitionsListByManagementGroupOptionalParams)	Essa operação recupera uma lista de todas as definições do conjunto de políticas em um determinado grupo de gerenciamento que correspondem ao $filter opcional determinado. 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 conjunto de políticas 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 conjunto de políticas 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 conjunto de políticas cujo tipo corresponde ao {value}. Os valores possíveis policyType são NotSpecified, BuiltIn e Custom. Se $filter='category -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de conjunto de políticas cuja categoria corresponde ao {value}.

Detalhes do método

createOrUpdate(string, PolicySetDefinition, PolicySetDefinitionsCreateOrUpdateOptionalParams)

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

function createOrUpdate(policySetDefinitionName: string, parameters: PolicySetDefinition, options?: PolicySetDefinitionsCreateOrUpdateOptionalParams): Promise<PolicySetDefinition>

Parâmetros

policySetDefinitionName

string

O nome da definição do conjunto de políticas a ser criada.

parameters

PolicySetDefinition

As propriedades de definição do conjunto de políticas.

options

PolicySetDefinitionsCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<PolicySetDefinition>

createOrUpdateAtManagementGroup(string, string, PolicySetDefinition, PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams)

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

function createOrUpdateAtManagementGroup(policySetDefinitionName: string, managementGroupId: string, parameters: PolicySetDefinition, options?: PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams): Promise<PolicySetDefinition>

Parâmetros

policySetDefinitionName

string

O nome da definição do conjunto de políticas a ser criada.

managementGroupId

string

A ID do grupo de gerenciamento.

parameters

PolicySetDefinition

As propriedades de definição do conjunto de políticas.

options

PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams

Os parâmetros de opções.

Retornos

Promise<PolicySetDefinition>

delete(string, PolicySetDefinitionsDeleteOptionalParams)

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

function delete(policySetDefinitionName: string, options?: PolicySetDefinitionsDeleteOptionalParams): Promise<void>

Parâmetros

policySetDefinitionName

string

O nome da definição do conjunto de políticas a ser excluída.

options

PolicySetDefinitionsDeleteOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

deleteAtManagementGroup(string, string, PolicySetDefinitionsDeleteAtManagementGroupOptionalParams)

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

function deleteAtManagementGroup(policySetDefinitionName: string, managementGroupId: string, options?: PolicySetDefinitionsDeleteAtManagementGroupOptionalParams): Promise<void>

Parâmetros

policySetDefinitionName

string

O nome da definição do conjunto de políticas a ser excluída.

managementGroupId

string

A ID do grupo de gerenciamento.

options

PolicySetDefinitionsDeleteAtManagementGroupOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

get(string, PolicySetDefinitionsGetOptionalParams)

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

function get(policySetDefinitionName: string, options?: PolicySetDefinitionsGetOptionalParams): Promise<PolicySetDefinition>

Parâmetros

policySetDefinitionName

string

O nome da definição do conjunto de políticas a ser obtido.

options

PolicySetDefinitionsGetOptionalParams

Os parâmetros de opções.

Retornos

Promise<PolicySetDefinition>

getAtManagementGroup(string, string, PolicySetDefinitionsGetAtManagementGroupOptionalParams)

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

function getAtManagementGroup(policySetDefinitionName: string, managementGroupId: string, options?: PolicySetDefinitionsGetAtManagementGroupOptionalParams): Promise<PolicySetDefinition>

Parâmetros

policySetDefinitionName

string

O nome da definição do conjunto de políticas a ser obtido.

managementGroupId

string

A ID do grupo de gerenciamento.

options

PolicySetDefinitionsGetAtManagementGroupOptionalParams

Os parâmetros de opções.

Retornos

Promise<PolicySetDefinition>

getBuiltIn(string, PolicySetDefinitionsGetBuiltInOptionalParams)

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

function getBuiltIn(policySetDefinitionName: string, options?: PolicySetDefinitionsGetBuiltInOptionalParams): Promise<PolicySetDefinition>

Parâmetros

policySetDefinitionName

string

O nome da definição do conjunto de políticas a ser obtido.

options

PolicySetDefinitionsGetBuiltInOptionalParams

Os parâmetros de opções.

Retornos

Promise<PolicySetDefinition>

list(PolicySetDefinitionsListOptionalParams)

Essa operação recupera uma lista de todas as definições do conjunto de políticas em uma determinada assinatura que correspondem ao $filter opcional determinado. 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 conjunto de políticas 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 conjunto de políticas que estão na assinatura fornecida. Se $filter='policyType -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de conjunto de políticas cujo tipo corresponde ao {value}. Os valores possíveis policyType são NotSpecified, BuiltIn e Custom. Se $filter='category -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de conjunto de políticas cuja categoria corresponde ao {value}.

function list(options?: PolicySetDefinitionsListOptionalParams): PagedAsyncIterableIterator<PolicySetDefinition, PolicySetDefinition[], PageSettings>

Parâmetros

options

PolicySetDefinitionsListOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<PolicySetDefinition, PolicySetDefinition[], PageSettings>

listBuiltIn(PolicySetDefinitionsListBuiltInOptionalParams)

Essa operação recupera uma lista de todas as definições internas do conjunto de políticas que correspondem ao $filter opcional determinado. Se $filter='category -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições internas do conjunto de políticas cuja categoria corresponde ao {value}.

function listBuiltIn(options?: PolicySetDefinitionsListBuiltInOptionalParams): PagedAsyncIterableIterator<PolicySetDefinition, PolicySetDefinition[], PageSettings>

Parâmetros

options

PolicySetDefinitionsListBuiltInOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<PolicySetDefinition, PolicySetDefinition[], PageSettings>

listByManagementGroup(string, PolicySetDefinitionsListByManagementGroupOptionalParams)

Essa operação recupera uma lista de todas as definições do conjunto de políticas em um determinado grupo de gerenciamento que correspondem ao $filter opcional determinado. 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 conjunto de políticas 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 conjunto de políticas 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 conjunto de políticas cujo tipo corresponde ao {value}. Os valores possíveis policyType são NotSpecified, BuiltIn e Custom. Se $filter='category -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de conjunto de políticas cuja categoria corresponde ao {value}.

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

Parâmetros

managementGroupId

string

A ID do grupo de gerenciamento.

options

PolicySetDefinitionsListByManagementGroupOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<PolicySetDefinition, PolicySetDefinition[], PageSettings>