PolicySetDefinitions interface

Pacote:

@azure/arm-policy

Interface que representa um PolicySetDefinitions.

Métodos

createOrUpdate(string, PolicySetDefinition, PolicySetDefinitionsCreateOrUpdateOptionalParams)	Esta operação cria ou atualiza uma definição de conjunto de políticas na subscrição especificada com o nome especificado.
createOrUpdateAtManagementGroup(string, string, PolicySetDefinition, PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams)	Esta operação cria ou atualiza uma definição de conjunto de políticas no grupo de gestão especificado com o nome especificado.
delete(string, PolicySetDefinitionsDeleteOptionalParams)	Esta operação elimina a definição do conjunto de políticas na subscrição especificada com o nome especificado.
deleteAtManagementGroup(string, string, PolicySetDefinitionsDeleteAtManagementGroupOptionalParams)	Esta operação elimina a definição do conjunto de políticas no grupo de gestão especificado com o nome especificado.
get(string, PolicySetDefinitionsGetOptionalParams)	Esta operação obtém a definição do conjunto de políticas na subscrição especificada com o nome especificado.
getAtManagementGroup(string, string, PolicySetDefinitionsGetAtManagementGroupOptionalParams)	Esta operação obtém a definição do conjunto de políticas no grupo de gestão especificado com o nome especificado.
getBuiltIn(string, PolicySetDefinitionsGetBuiltInOptionalParams)	Esta operação obtém a definição do conjunto de políticas incorporada com o nome especificado.
list(PolicySetDefinitionsListOptionalParams)	Esta operação obtém uma lista de todas as definições do conjunto de políticas numa determinada subscrição que correspondem à opção dada $filter. Os valores válidos para $filter são: "atExactScope()", "policyType -eq {value}" ou "category eq '{value}'". Se $filter não for fornecida, a lista não filtrada inclui todas as definições de conjuntos de políticas associadas à subscrição, incluindo as que se aplicam diretamente ou a partir de grupos de gestão que contêm a subscrição especificada. Se for fornecido $filter=atExactScope(), a lista devolvida inclui apenas todas as definições de conjuntos de políticas na subscrição especificada. Se for fornecido $filter='policyType -eq {value}', a lista devolvida inclui apenas todas as definições de conjuntos de políticas cujo tipo corresponde ao {value}. Os valores policyType possíveis são NotSpecified, BuiltIn e Custom. Se for fornecido $filter='category -eq {value}', a lista devolvida inclui apenas todas as definições de conjuntos de políticas cuja categoria corresponde ao {value}.
listBuiltIn(PolicySetDefinitionsListBuiltInOptionalParams)	Esta operação obtém uma lista de todas as definições de conjuntos de políticas incorporadas que correspondem à opção dada $filter. Se for fornecido $filter='category -eq {value}', a lista devolvida inclui apenas todas as definições de conjuntos de políticas incorporadas cuja categoria corresponde ao {value}.
listByManagementGroup(string, PolicySetDefinitionsListByManagementGroupOptionalParams)	Esta operação obtém uma lista de todas as definições do conjunto de políticas num determinado grupo de gestão que correspondem ao $filter opcional fornecido. Os valores válidos para $filter são: "atExactScope()", "policyType -eq {value}" ou "category eq '{value}'". Se $filter não for fornecida, a lista não filtrada inclui todas as definições de conjuntos de políticas associadas ao grupo de gestão, incluindo as que se aplicam diretamente ou a partir de grupos de gestão que contêm o determinado grupo de gestão. Se for fornecido $filter=atExactScope(), a lista devolvida inclui apenas todas as definições de conjuntos de políticas que estejam no grupo de gestão especificado. Se for fornecido $filter='policyType -eq {value}', a lista devolvida inclui apenas todas as definições de conjuntos de políticas cujo tipo corresponde ao {value}. Os valores policyType possíveis são NotSpecified, BuiltIn e Custom. Se for fornecido $filter='category -eq {value}', a lista devolvida inclui apenas todas as definições de conjuntos de políticas cuja categoria corresponde ao {value}.

Detalhes de Método

createOrUpdate(string, PolicySetDefinition, PolicySetDefinitionsCreateOrUpdateOptionalParams)

Esta operação cria ou atualiza uma definição de conjunto de políticas na subscrição especificada com o nome especificado.

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 criar.

parameters

PolicySetDefinition

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

options

PolicySetDefinitionsCreateOrUpdateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<PolicySetDefinition>

createOrUpdateAtManagementGroup(string, string, PolicySetDefinition, PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams)

Esta operação cria ou atualiza uma definição de conjunto de políticas no grupo de gestão especificado com o nome especificado.

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 criar.

managementGroupId

string

O ID do grupo de gestão.

parameters

PolicySetDefinition

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

options

PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams

Os parâmetros de opções.

Devoluções

Promise<PolicySetDefinition>

delete(string, PolicySetDefinitionsDeleteOptionalParams)

Esta operação elimina a definição do conjunto de políticas na subscrição especificada com o nome especificado.

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

Parâmetros

policySetDefinitionName

string

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

options

PolicySetDefinitionsDeleteOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

deleteAtManagementGroup(string, string, PolicySetDefinitionsDeleteAtManagementGroupOptionalParams)

Esta operação elimina a definição do conjunto de políticas no grupo de gestão especificado com o nome especificado.

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 eliminar.

managementGroupId

string

O ID do grupo de gestão.

options

PolicySetDefinitionsDeleteAtManagementGroupOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

get(string, PolicySetDefinitionsGetOptionalParams)

Esta operação obtém a definição do conjunto de políticas na subscrição especificada com o nome especificado.

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

Parâmetros

policySetDefinitionName

string

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

options

PolicySetDefinitionsGetOptionalParams

Os parâmetros de opções.

Devoluções

Promise<PolicySetDefinition>

getAtManagementGroup(string, string, PolicySetDefinitionsGetAtManagementGroupOptionalParams)

Esta operação obtém a definição do conjunto de políticas no grupo de gestão especificado com o nome especificado.

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 obter.

managementGroupId

string

O ID do grupo de gestão.

options

PolicySetDefinitionsGetAtManagementGroupOptionalParams

Os parâmetros de opções.

Devoluções

Promise<PolicySetDefinition>

getBuiltIn(string, PolicySetDefinitionsGetBuiltInOptionalParams)

Esta operação obtém a definição do conjunto de políticas incorporada com o nome especificado.

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

Parâmetros

policySetDefinitionName

string

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

options

PolicySetDefinitionsGetBuiltInOptionalParams

Os parâmetros de opções.

Devoluções

Promise<PolicySetDefinition>

list(PolicySetDefinitionsListOptionalParams)

Esta operação obtém uma lista de todas as definições do conjunto de políticas numa determinada subscrição que correspondem à opção dada $filter. Os valores válidos para $filter são: "atExactScope()", "policyType -eq {value}" ou "category eq '{value}'". Se $filter não for fornecida, a lista não filtrada inclui todas as definições de conjuntos de políticas associadas à subscrição, incluindo as que se aplicam diretamente ou a partir de grupos de gestão que contêm a subscrição especificada. Se for fornecido $filter=atExactScope(), a lista devolvida inclui apenas todas as definições de conjuntos de políticas na subscrição especificada. Se for fornecido $filter='policyType -eq {value}', a lista devolvida inclui apenas todas as definições de conjuntos de políticas cujo tipo corresponde ao {value}. Os valores policyType possíveis são NotSpecified, BuiltIn e Custom. Se for fornecido $filter='category -eq {value}', a lista devolvida inclui apenas todas as definições de conjuntos 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.

Devoluções

PagedAsyncIterableIterator<PolicySetDefinition, PolicySetDefinition[], PageSettings>

listBuiltIn(PolicySetDefinitionsListBuiltInOptionalParams)

Esta operação obtém uma lista de todas as definições de conjuntos de políticas incorporadas que correspondem à opção dada $filter. Se for fornecido $filter='category -eq {value}', a lista devolvida inclui apenas todas as definições de conjuntos de políticas incorporadas cuja categoria corresponde ao {value}.

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

Parâmetros

options

PolicySetDefinitionsListBuiltInOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<PolicySetDefinition, PolicySetDefinition[], PageSettings>

listByManagementGroup(string, PolicySetDefinitionsListByManagementGroupOptionalParams)

Esta operação obtém uma lista de todas as definições do conjunto de políticas num determinado grupo de gestão que correspondem ao $filter opcional fornecido. Os valores válidos para $filter são: "atExactScope()", "policyType -eq {value}" ou "category eq '{value}'". Se $filter não for fornecida, a lista não filtrada inclui todas as definições de conjuntos de políticas associadas ao grupo de gestão, incluindo as que se aplicam diretamente ou a partir de grupos de gestão que contêm o determinado grupo de gestão. Se for fornecido $filter=atExactScope(), a lista devolvida inclui apenas todas as definições de conjuntos de políticas que estejam no grupo de gestão especificado. Se for fornecido $filter='policyType -eq {value}', a lista devolvida inclui apenas todas as definições de conjuntos de políticas cujo tipo corresponde ao {value}. Os valores policyType possíveis são NotSpecified, BuiltIn e Custom. Se for fornecido $filter='category -eq {value}', a lista devolvida inclui apenas todas as definições de conjuntos de políticas cuja categoria corresponde ao {value}.

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

Parâmetros

managementGroupId

string

O ID do grupo de gestão.

options

PolicySetDefinitionsListByManagementGroupOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<PolicySetDefinition, PolicySetDefinition[], PageSettings>