PolicyDefinitions interface

Pacote:

@azure/arm-policy

Interface que representa uma PolicyDefinitions.

Métodos

createOrUpdate(string, PolicyDefinition, PolicyDefinitionsCreateOrUpdateOptionalParams)	Esta operação cria ou atualiza uma definição de política na subscrição especificada com o nome especificado.
createOrUpdateAtManagementGroup(string, string, PolicyDefinition, PolicyDefinitionsCreateOrUpdateAtManagementGroupOptionalParams)	Esta operação cria ou atualiza uma definição de política no grupo de gestão especificado com o nome especificado.
delete(string, PolicyDefinitionsDeleteOptionalParams)	Esta operação elimina a definição de política na subscrição especificada com o nome especificado.
deleteAtManagementGroup(string, string, PolicyDefinitionsDeleteAtManagementGroupOptionalParams)	Esta operação elimina a definição de política no grupo de gestão especificado com o nome especificado.
get(string, PolicyDefinitionsGetOptionalParams)	Esta operação obtém a definição de política na subscrição especificada com o nome especificado.
getAtManagementGroup(string, string, PolicyDefinitionsGetAtManagementGroupOptionalParams)	Esta operação obtém a definição de política no grupo de gestão especificado com o nome especificado.
getBuiltIn(string, PolicyDefinitionsGetBuiltInOptionalParams)	Esta operação obtém a definição de política incorporada com o nome especificado.
list(PolicyDefinitionsListOptionalParams)	Esta operação obtém uma lista de todas as definições de política numa determinada subscrição que correspondem ao $filter opcional especificado. 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 inclui todas as definições de política 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 $filter=atExactScope() for fornecido, a lista devolvida inclui apenas todas as definições de política na subscrição especificada. Se $filter='policyType -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política cujo tipo corresponde ao {value}. Os possíveis valores policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política cuja categoria corresponde ao {value}.
listBuiltIn(PolicyDefinitionsListBuiltInOptionalParams)	Esta operação obtém uma lista de todas as definições de política incorporadas que correspondem ao $filter opcional especificado. Se $filter='policyType -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política incorporadas cujo tipo corresponde ao {value}. Os possíveis valores policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política incorporadas cuja categoria corresponde ao {value}.
listByManagementGroup(string, PolicyDefinitionsListByManagementGroupOptionalParams)	Esta operação obtém uma lista de todas as definições de política 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 política associadas ao grupo de gestão, incluindo as que se aplicam diretamente ou a partir de grupos de gestão que contêm o grupo de gestão especificado. Se $filter=atExactScope() for fornecido, a lista devolvida inclui apenas todas as definições de política que estejam no grupo de gestão especificado. Se $filter='policyType -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política cujo tipo corresponde ao {value}. Os possíveis valores policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política cuja categoria corresponde ao {value}.

Detalhes de Método

createOrUpdate(string, PolicyDefinition, PolicyDefinitionsCreateOrUpdateOptionalParams)

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

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

Parâmetros

policyDefinitionName

string

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

parameters

PolicyDefinition

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

options

PolicyDefinitionsCreateOrUpdateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<PolicyDefinition>

createOrUpdateAtManagementGroup(string, string, PolicyDefinition, PolicyDefinitionsCreateOrUpdateAtManagementGroupOptionalParams)

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

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

managementGroupId

string

O ID do grupo de gestão.

parameters

PolicyDefinition

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

options

PolicyDefinitionsCreateOrUpdateAtManagementGroupOptionalParams

Os parâmetros de opções.

Devoluções

Promise<PolicyDefinition>

delete(string, PolicyDefinitionsDeleteOptionalParams)

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

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

Parâmetros

policyDefinitionName

string

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

options

PolicyDefinitionsDeleteOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

deleteAtManagementGroup(string, string, PolicyDefinitionsDeleteAtManagementGroupOptionalParams)

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

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

Parâmetros

policyDefinitionName

string

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

managementGroupId

string

O ID do grupo de gestão.

options

PolicyDefinitionsDeleteAtManagementGroupOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

get(string, PolicyDefinitionsGetOptionalParams)

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

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

Parâmetros

policyDefinitionName

string

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

options

PolicyDefinitionsGetOptionalParams

Os parâmetros de opções.

Devoluções

Promise<PolicyDefinition>

getAtManagementGroup(string, string, PolicyDefinitionsGetAtManagementGroupOptionalParams)

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

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

Parâmetros

policyDefinitionName

string

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

managementGroupId

string

O ID do grupo de gestão.

options

PolicyDefinitionsGetAtManagementGroupOptionalParams

Os parâmetros de opções.

Devoluções

Promise<PolicyDefinition>

getBuiltIn(string, PolicyDefinitionsGetBuiltInOptionalParams)

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

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

Parâmetros

policyDefinitionName

string

O nome da definição de política incorporada a obter.

options

PolicyDefinitionsGetBuiltInOptionalParams

Os parâmetros de opções.

Devoluções

Promise<PolicyDefinition>

list(PolicyDefinitionsListOptionalParams)

Esta operação obtém uma lista de todas as definições de política numa determinada subscrição que correspondem ao $filter opcional especificado. 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 inclui todas as definições de política 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 $filter=atExactScope() for fornecido, a lista devolvida inclui apenas todas as definições de política na subscrição especificada. Se $filter='policyType -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política cujo tipo corresponde ao {value}. Os possíveis valores policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista devolvida inclui 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.

Devoluções

PagedAsyncIterableIterator<PolicyDefinition, PolicyDefinition[], PageSettings>

listBuiltIn(PolicyDefinitionsListBuiltInOptionalParams)

Esta operação obtém uma lista de todas as definições de política incorporadas que correspondem ao $filter opcional especificado. Se $filter='policyType -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política incorporadas cujo tipo corresponde ao {value}. Os possíveis valores policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política incorporadas cuja categoria corresponde ao {value}.

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

Parâmetros

options

PolicyDefinitionsListBuiltInOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<PolicyDefinition, PolicyDefinition[], PageSettings>

listByManagementGroup(string, PolicyDefinitionsListByManagementGroupOptionalParams)

Esta operação obtém uma lista de todas as definições de política 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 política associadas ao grupo de gestão, incluindo as que se aplicam diretamente ou a partir de grupos de gestão que contêm o grupo de gestão especificado. Se $filter=atExactScope() for fornecido, a lista devolvida inclui apenas todas as definições de política que estejam no grupo de gestão especificado. Se $filter='policyType -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política cujo tipo corresponde ao {value}. Os possíveis valores policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista devolvida inclui 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

O ID do grupo de gestão.

options

PolicyDefinitionsListByManagementGroupOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<PolicyDefinition, PolicyDefinition[], PageSettings>