@azure/arm-policy package

Classes

PolicyClient

Interfaces

Alias

O tipo de alias.

AliasPath

O tipo dos caminhos para alias.

AliasPathMetadata

Os metadados do caminho do alias.

AliasPattern

O tipo do padrão para um caminho de alias.

DataEffect

A definição do efeito de dados.

DataManifestCustomResourceFunctionDefinition

A definição da função de recurso personalizada.

DataManifestResourceFunctionsDefinition

As funções de recurso suportadas por um manifesto.

DataPolicyManifest

O manifesto da política de dados.

DataPolicyManifestProperties

As propriedades da política de dados manifestam.

DataPolicyManifestsGetByPolicyModeOptionalParams

Parâmetros opcionais.

DataPolicyManifestsListOptionalParams

Parâmetros opcionais.

DataPolicyManifestsOperations

Interface representando operações DataPolicyManifests.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha.

ExtensionResource

O recurso de extensão base.

ExternalEvaluationEndpointInvocationResult

Os resultados da invocação do endpoint de avaliação externa.

ExternalEvaluationEndpointSettings

As configurações de um ponto de extremidade externo fornecendo resultados de avaliação.

ExternalEvaluationEnforcementSettings

Os detalhes da origem dos resultados de avaliação externa exigidos pela política durante a avaliação de imposição.

Identity

Identidade do recurso. As atribuições de política dão suporte a no máximo uma identidade. Essa é uma identidade atribuída pelo sistema ou uma única identidade atribuída pelo usuário.

NonComplianceMessage

Uma mensagem que descreve por que um recurso não está em conformidade com a política. Isso é mostrado em mensagens de erro 'deny' e nos resultados de conformidade não compatíveis do recurso.

Override

A substituição do valor da propriedade da política.

PageSettings

Opções para o método byPage

PagedAsyncIterableIterator

Uma interface que permite iteração assíncrona iterável tanto para conclusão quanto por página.

ParameterDefinitionsValue

A definição de um parâmetro que pode ser fornecido para a política.

ParameterDefinitionsValueMetadata

Metadados gerais para o parâmetro.

ParameterValuesValue

O valor de um parâmetro.

PolicyAssignment

A atribuição de política.

PolicyAssignmentProperties

As propriedades de cessão de políticas.

PolicyAssignmentUpdate

A atribuição de política para solicitação de patch.

PolicyAssignmentUpdateProperties

As propriedades de atribuição de políticas para a solicitação de patch.

PolicyAssignmentsCreateOptionalParams

Parâmetros opcionais.

PolicyAssignmentsDeleteOptionalParams

Parâmetros opcionais.

PolicyAssignmentsGetOptionalParams

Parâmetros opcionais.

PolicyAssignmentsListForManagementGroupOptionalParams

Parâmetros opcionais.

PolicyAssignmentsListForResourceGroupOptionalParams

Parâmetros opcionais.

PolicyAssignmentsListForResourceOptionalParams

Parâmetros opcionais.

PolicyAssignmentsListOptionalParams

Parâmetros opcionais.

PolicyAssignmentsOperations

Interface representando uma operação de PolicyAssignments.

PolicyAssignmentsUpdateOptionalParams

Parâmetros opcionais.

PolicyClientOptionalParams

Parâmetros opcionais para o cliente.

PolicyDefinition

A definição de política.

PolicyDefinitionGroup

O grupo de definição de política.

PolicyDefinitionProperties

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

PolicyDefinitionReference

A referência de definição de política.

PolicyDefinitionVersion

A ID da versão de definição de política.

PolicyDefinitionVersionListResult

A resposta de uma operação de lista PolicyDefinitionVersion.

PolicyDefinitionVersionProperties

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

PolicyDefinitionVersionsCreateOrUpdateAtManagementGroupOptionalParams

Parâmetros opcionais.

PolicyDefinitionVersionsCreateOrUpdateOptionalParams

Parâmetros opcionais.

PolicyDefinitionVersionsDeleteAtManagementGroupOptionalParams

Parâmetros opcionais.

PolicyDefinitionVersionsDeleteOptionalParams

Parâmetros opcionais.

PolicyDefinitionVersionsGetAtManagementGroupOptionalParams

Parâmetros opcionais.

PolicyDefinitionVersionsGetBuiltInOptionalParams

Parâmetros opcionais.

PolicyDefinitionVersionsGetOptionalParams

Parâmetros opcionais.

PolicyDefinitionVersionsListAllAtManagementGroupOptionalParams

Parâmetros opcionais.

PolicyDefinitionVersionsListAllBuiltinsOptionalParams

Parâmetros opcionais.

PolicyDefinitionVersionsListAllOptionalParams

Parâmetros opcionais.

PolicyDefinitionVersionsListBuiltInOptionalParams

Parâmetros opcionais.

PolicyDefinitionVersionsListByManagementGroupOptionalParams

Parâmetros opcionais.

PolicyDefinitionVersionsListOptionalParams

Parâmetros opcionais.

PolicyDefinitionVersionsOperations

Interface representando uma operação PolicyDefinitionVersions.

PolicyDefinitionsCreateOrUpdateAtManagementGroupOptionalParams

Parâmetros opcionais.

PolicyDefinitionsCreateOrUpdateOptionalParams

Parâmetros opcionais.

PolicyDefinitionsDeleteAtManagementGroupOptionalParams

Parâmetros opcionais.

PolicyDefinitionsDeleteOptionalParams

Parâmetros opcionais.

PolicyDefinitionsGetAtManagementGroupOptionalParams

Parâmetros opcionais.

PolicyDefinitionsGetBuiltInOptionalParams

Parâmetros opcionais.

PolicyDefinitionsGetOptionalParams

Parâmetros opcionais.

PolicyDefinitionsListBuiltInOptionalParams

Parâmetros opcionais.

PolicyDefinitionsListByManagementGroupOptionalParams

Parâmetros opcionais.

PolicyDefinitionsListOptionalParams

Parâmetros opcionais.

PolicyDefinitionsOperations

Interface representando uma operação de PolicyDefinitions.

PolicyLogInfo

As informações do registro de políticas.

PolicySetDefinition

A definição do conjunto de políticas.

PolicySetDefinitionProperties

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

PolicySetDefinitionVersion

A versão de definição do conjunto de políticas.

PolicySetDefinitionVersionListResult

A resposta de uma operação de lista PolicySetDefinitionVersion.

PolicySetDefinitionVersionProperties

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

PolicySetDefinitionVersionsCreateOrUpdateAtManagementGroupOptionalParams

Parâmetros opcionais.

PolicySetDefinitionVersionsCreateOrUpdateOptionalParams

Parâmetros opcionais.

PolicySetDefinitionVersionsDeleteAtManagementGroupOptionalParams

Parâmetros opcionais.

PolicySetDefinitionVersionsDeleteOptionalParams

Parâmetros opcionais.

PolicySetDefinitionVersionsGetAtManagementGroupOptionalParams

Parâmetros opcionais.

PolicySetDefinitionVersionsGetBuiltInOptionalParams

Parâmetros opcionais.

PolicySetDefinitionVersionsGetOptionalParams

Parâmetros opcionais.

PolicySetDefinitionVersionsListAllAtManagementGroupOptionalParams

Parâmetros opcionais.

PolicySetDefinitionVersionsListAllBuiltinsOptionalParams

Parâmetros opcionais.

PolicySetDefinitionVersionsListAllOptionalParams

Parâmetros opcionais.

PolicySetDefinitionVersionsListBuiltInOptionalParams

Parâmetros opcionais.

PolicySetDefinitionVersionsListByManagementGroupOptionalParams

Parâmetros opcionais.

PolicySetDefinitionVersionsListOptionalParams

Parâmetros opcionais.

PolicySetDefinitionVersionsOperations

Interface representando operações de PolicySetDefinitionVersions.

PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams

Parâmetros opcionais.

PolicySetDefinitionsCreateOrUpdateOptionalParams

Parâmetros opcionais.

PolicySetDefinitionsDeleteAtManagementGroupOptionalParams

Parâmetros opcionais.

PolicySetDefinitionsDeleteOptionalParams

Parâmetros opcionais.

PolicySetDefinitionsGetAtManagementGroupOptionalParams

Parâmetros opcionais.

PolicySetDefinitionsGetBuiltInOptionalParams

Parâmetros opcionais.

PolicySetDefinitionsGetOptionalParams

Parâmetros opcionais.

PolicySetDefinitionsListBuiltInOptionalParams

Parâmetros opcionais.

PolicySetDefinitionsListByManagementGroupOptionalParams

Parâmetros opcionais.

PolicySetDefinitionsListOptionalParams

Parâmetros opcionais.

PolicySetDefinitionsOperations

Interface representando uma operação de PolicySetDefinitions.

PolicyTokenEvaluatedRequestDetails

O token de apólice avaliou os detalhes dos pedidos.

PolicyTokenOperation

A operação de recurso para adquirir um token para.

PolicyTokenRequest

As propriedades de solicitação de token de política.

PolicyTokenResponse

As propriedades de resposta do token de política.

PolicyTokensAcquireAtManagementGroupOptionalParams

Parâmetros opcionais.

PolicyTokensAcquireOptionalParams

Parâmetros opcionais.

PolicyTokensOperations

Interface representando uma operação de PolicyTokens.

ProxyResource

A definição do modelo de recurso para um recurso proxy do Azure Resource Manager. Ele não terá marcas e um local

Resource

Campos comuns que são retornados na resposta para todos os recursos do Azure Resource Manager

ResourceSelector

O seletor de recursos para filtrar políticas por propriedades de recurso.

ResourceTypeAliases

A definição de aliases de tipo de recurso.

Selector

A expressão do seletor.

SelfServeExemptionSettings

As configurações de isenção de autoatendimento para uma atribuição de política.

SystemData

Metadados relativos à criação e última modificação do recurso.

UserAssignedIdentitiesValue

interface de modelo UserAssignedIdentitiesValue

Aliases de tipo

AliasPathAttributes

Os atributos do token ao qual o caminho do alias está se referindo.
KnownAliasPathAttributes podem ser usados de forma intercambiável com AliasPathAttributes, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

None: o token ao qual o caminho do alias está se referindo não tem atributos.
modificável: o token ao qual o caminho do alias está se referindo é modificável por políticas com efeito 'modify'.

AliasPathTokenType

O tipo do token ao qual o caminho do alias está se referindo.
KnownAliasPathTokenType pode ser usado de forma intercambiável com AliasPathTokenType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Não Especificado: o tipo de token não é especificado.
Qualquer: o tipo de token pode ser qualquer coisa.
String: o tipo de token é cadeia de caracteres.
Object: o tipo de token é objeto.
Array: o tipo de token é matriz.
inteiro: o tipo de token é inteiro.
Número: o tipo de token é número.
booliano: o tipo de token é booliano.

AliasPatternType

O tipo de padrão de pseudônimo.

AliasType

O tipo do alias.

AssignmentType

O tipo de atribuição de política. Os valores possíveis são NotSpecified, System, SystemHidden e Custom. Imutável.
KnownAssignmentType pode ser usado de forma intercambiável com AssignmentType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

NotSpecified: O tipo de atribuição não especificado.
Sistema: O tipo de atribuição do sistema.
SystemHidden: O tipo de atribuição oculta do sistema.
Personalizado: O tipo de tarefa personalizada.

AzureSupportedClouds

Os valores com suporte para a configuração de nuvem como um tipo literal de cadeia de caracteres

ContinuablePage

Uma interface que descreve uma página de resultados.

CreatedByType

O tipo de entidade que criou o recurso.
KnownCreatedByType pode ser usado de forma intercambiável com CreatedByType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

User: a entidade foi criada por um usuário.
Application: a entidade foi criada por um aplicativo.
ManagedIdentity: a entidade foi criada por uma identidade gerenciada.
Key: a entidade foi criada por uma chave.

EnforcementMode

O modo de imposição da atribuição de política. Os valores possíveis são Default, DoNotEnforce e Enroll
KnownEnforcementMode pode ser usado de forma intercambiável com EnforcementMode, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

padrão: o efeito da política é imposto durante a criação ou atualização de recursos.
DoNotEnforce: o efeito da política não é imposto durante a criação ou atualização de recursos.
Inscrição: O efeito da política não é aplicado durante a criação ou atualização do recurso até que o recurso ou escopo do recurso seja registrado na instância de atribuição. A inscrição ocorre após a implantação do recurso de inscrição de políticas.

ExternalEndpointResult

O resultado do endpoint externo. Valores possíveis são Sucessos e Falhados.
KnowExternalEndpointResult pode ser usado de forma intercambiável com ExternalEndpointResult, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos compatíveis com o serviço

Sucesso: O endpoint externo teve sucesso.
Falhou: O endpoint externo falhou.

OverrideKind

O tipo de substituição.
KnownOverrideKind pode ser usado de forma intercambiável com OverrideKind, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

policyEffect: ele substituirá o tipo de efeito de política.
definitionVersion: ele substituirá o valor da propriedade da versão de definição da atribuição de política.

ParameterType

O tipo de dados do parâmetro.
KnownParameterType pode ser usado de forma intercambiável com ParameterType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

String: O tipo de parâmetro de string.
Array: O tipo de parâmetro do array.
Objeto: O tipo de parâmetro do objeto.
Booleano: O tipo de parâmetro booleano.
Inteiro: O tipo de parâmetro inteiro.
Flutuação: O tipo de parâmetro flutuante.
DateTime: O tipo de parâmetro data-hora.

PolicyAction

O resultado efetivo da avaliação da política baseado tanto no efeito da política quanto no resultado da avaliação. Os valores possíveis são Desconhecido, Permitir, Auditar, Negar, Erro.
KnownPolicyAction pode ser usado de forma intercambiável com PolicyAction, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos compatíveis com o serviço

Desconhecido: O resultado efetivo da avaliação de políticas é desconhecido.
Permitir: O resultado efetivo da avaliação da política é permitir o pedido.
Auditoria: O resultado efetivo da avaliação da política é auditar o pedido.
Deny: O resultado efetivo da avaliação da política é negar o pedido.
Erro: A avaliação da política resultou em um erro.

PolicyTokenResult

O resultado da operação concluída de aquisição de tokens. Valores possíveis são Sucessos e Falhados.
KnownPolicyTokenResult pode ser usado de forma intercambiável com PolicyTokenResult, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos compatíveis com o serviço

Sucesso: A aquisição do token foi bem-sucedida.
Fracassado: A aquisição do token falhou.

PolicyType

O tipo de definição de política. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static.
KnownPolicyType pode ser usado de forma intercambiável com PolicyType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

NotSpecified: O tipo de definição de apólice não especificado.
BuiltIn: O tipo de definição de política incorporada.
Personalizado: O tipo de definição de apólice personalizada.
Estática: O tipo de definição de política estática.

ResourceIdentityType

O tipo de identidade. Esse é o único campo necessário ao adicionar uma identidade atribuída pelo sistema ou ao usuário a um recurso.

SelectorKind

O tipo de seletor.
KnownSelectorKind pode ser usado de forma intercambiável com SelectorKind, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

resourceLocation: o tipo de seletor para filtrar políticas pelo local do recurso.
resourceType: o tipo de seletor para filtrar políticas pelo tipo de recurso.
resourceWithoutLocation: o tipo de seletor para filtrar políticas pelo recurso sem localização.
policyDefinitionReferenceId: o tipo de seletor para filtrar políticas pela ID de referência de definição de política.
resourceRolloutPercentage: O seletor para filtrar políticas pela porcentagem de lançamento de recursos.
userPrincipalId: O tipo seletor para filtrar políticas pelo ID principal do usuário.
groupPrincipalId: O tipo seletor para filtrar políticas pelo ID de membro do grupo de segurança.

Enumerações

AzureClouds

Um enumeração para descrever os ambientes de nuvem do Azure.

KnownAliasPathAttributes

Os atributos do token ao qual o caminho do alias está se referindo.

KnownAliasPathTokenType

O tipo do token ao qual o caminho do alias está se referindo.

KnownAssignmentType

O tipo de atribuição de política. Os valores possíveis são NotSpecified, System, SystemHidden e Custom. Imutável.

KnownCreatedByType

O tipo de entidade que criou o recurso.

KnownEnforcementMode

O modo de imposição da atribuição de política. Os valores possíveis são Default, DoNotEnforce e Enroll

KnownExternalEndpointResult

O resultado do endpoint externo. Valores possíveis são Sucessos e Falhados.

KnownOverrideKind

O tipo de substituição.

KnownParameterType

O tipo de dados do parâmetro.

KnownPolicyAction

O resultado efetivo da avaliação da política baseado tanto no efeito da política quanto no resultado da avaliação. Os valores possíveis são Desconhecido, Permitir, Auditar, Negar, Erro.

KnownPolicyTokenResult

O resultado da operação concluída de aquisição de tokens. Valores possíveis são Sucessos e Falhados.

KnownPolicyType

O tipo de definição de política. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static.

KnownSelectorKind

O tipo de seletor.

KnownVersions

As versões de API disponíveis.

A versão pré-visualizada (v2026_01_01_preview) inclui tudo, desde a versão estável mais recente além de novos tipos de recursos apenas para prévia:

  • Isenção de Política, Variável, Valor Variável (marcado com

Funções

isRestError(unknown)

Typeguard para RestError

Variáveis

RestError

Um tipo de erro personalizado para solicitações de pipeline com falha.

Detalhes da função

isRestError(unknown)

Typeguard para RestError

function isRestError(e: unknown): e is RestError

Parâmetros

e

unknown

Algo pego por uma cláusula catch.

Retornos

e is RestError

Detalhes da variável

RestError

Um tipo de erro personalizado para solicitações de pipeline com falha.

RestError: RestErrorConstructor

Tipo