Compartilhar via


@azure/arm-policy package

Classes

PolicyClient

Interfaces

CloudError

Uma resposta de erro de uma operação de política.

ErrorAdditionalInfo

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

ErrorResponse

Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.)

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.

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.

PolicyAssignmentListResult

Lista de atribuições de política.

PolicyAssignmentUpdate

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

PolicyAssignments

Interface que representa um PolicyAssignments.

PolicyAssignmentsCreateByIdOptionalParams

Parâmetros opcionais.

PolicyAssignmentsCreateOptionalParams

Parâmetros opcionais.

PolicyAssignmentsDeleteByIdOptionalParams

Parâmetros opcionais.

PolicyAssignmentsDeleteOptionalParams

Parâmetros opcionais.

PolicyAssignmentsGetByIdOptionalParams

Parâmetros opcionais.

PolicyAssignmentsGetOptionalParams

Parâmetros opcionais.

PolicyAssignmentsListForManagementGroupNextOptionalParams

Parâmetros opcionais.

PolicyAssignmentsListForManagementGroupOptionalParams

Parâmetros opcionais.

PolicyAssignmentsListForResourceGroupNextOptionalParams

Parâmetros opcionais.

PolicyAssignmentsListForResourceGroupOptionalParams

Parâmetros opcionais.

PolicyAssignmentsListForResourceNextOptionalParams

Parâmetros opcionais.

PolicyAssignmentsListForResourceOptionalParams

Parâmetros opcionais.

PolicyAssignmentsListNextOptionalParams

Parâmetros opcionais.

PolicyAssignmentsListOptionalParams

Parâmetros opcionais.

PolicyAssignmentsUpdateByIdOptionalParams

Parâmetros opcionais.

PolicyAssignmentsUpdateOptionalParams

Parâmetros opcionais.

PolicyClientOptionalParams

Parâmetros opcionais.

PolicyDefinition

A definição de política.

PolicyDefinitionGroup

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

PolicyDefinitionListResult

Lista de definições 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

Lista de versões de definição de política.

PolicyDefinitionVersions

Interface que representa um PolicyDefinitionVersions.

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.

PolicyDefinitionVersionsListBuiltInNextOptionalParams

Parâmetros opcionais.

PolicyDefinitionVersionsListBuiltInOptionalParams

Parâmetros opcionais.

PolicyDefinitionVersionsListByManagementGroupNextOptionalParams

Parâmetros opcionais.

PolicyDefinitionVersionsListByManagementGroupOptionalParams

Parâmetros opcionais.

PolicyDefinitionVersionsListNextOptionalParams

Parâmetros opcionais.

PolicyDefinitionVersionsListOptionalParams

Parâmetros opcionais.

PolicyDefinitions

Interface que representa um PolicyDefinitions.

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.

PolicyDefinitionsListBuiltInNextOptionalParams

Parâmetros opcionais.

PolicyDefinitionsListBuiltInOptionalParams

Parâmetros opcionais.

PolicyDefinitionsListByManagementGroupNextOptionalParams

Parâmetros opcionais.

PolicyDefinitionsListByManagementGroupOptionalParams

Parâmetros opcionais.

PolicyDefinitionsListNextOptionalParams

Parâmetros opcionais.

PolicyDefinitionsListOptionalParams

Parâmetros opcionais.

PolicySetDefinition

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

PolicySetDefinitionListResult

Lista de definições de conjunto de políticas.

PolicySetDefinitionVersion

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

PolicySetDefinitionVersionListResult

Lista de versões de definição do conjunto de políticas.

PolicySetDefinitionVersions

Interface que representa um PolicySetDefinitionVersions.

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.

PolicySetDefinitionVersionsListBuiltInNextOptionalParams

Parâmetros opcionais.

PolicySetDefinitionVersionsListBuiltInOptionalParams

Parâmetros opcionais.

PolicySetDefinitionVersionsListByManagementGroupNextOptionalParams

Parâmetros opcionais.

PolicySetDefinitionVersionsListByManagementGroupOptionalParams

Parâmetros opcionais.

PolicySetDefinitionVersionsListNextOptionalParams

Parâmetros opcionais.

PolicySetDefinitionVersionsListOptionalParams

Parâmetros opcionais.

PolicySetDefinitions

Interface que representa um PolicySetDefinitions.

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.

PolicySetDefinitionsListBuiltInNextOptionalParams

Parâmetros opcionais.

PolicySetDefinitionsListBuiltInOptionalParams

Parâmetros opcionais.

PolicySetDefinitionsListByManagementGroupNextOptionalParams

Parâmetros opcionais.

PolicySetDefinitionsListByManagementGroupOptionalParams

Parâmetros opcionais.

PolicySetDefinitionsListNextOptionalParams

Parâmetros opcionais.

PolicySetDefinitionsListOptionalParams

Parâmetros opcionais.

ResourceSelector

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

Selector

A expressão do seletor.

SystemData

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

UserAssignedIdentitiesValue

Aliases de tipo

AssignmentType

Define valores para AssignmentType.
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

Não Especificada
Sistema
Sistema oculto
Personalizado

CreatedByType

Define valores para CreatedByType.
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

de usuário do
application
ManagedIdentity
key

EnforcementMode

Define valores para EnforcementMode.
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.

OverrideKind

Define valores para OverrideKind.
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

Define valores para ParameterType.
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
Array
do objeto
booliano
inteiro
Float
datetime

PolicyAssignmentsCreateByIdResponse

Contém dados de resposta para a operação createById.

PolicyAssignmentsCreateResponse

Contém dados de resposta para a operação de criação.

PolicyAssignmentsDeleteByIdResponse

Contém dados de resposta para a operação deleteById.

PolicyAssignmentsDeleteResponse

Contém dados de resposta para a operação de exclusão.

PolicyAssignmentsGetByIdResponse

Contém dados de resposta para a operação getById.

PolicyAssignmentsGetResponse

Contém dados de resposta para a operação de obtenção.

PolicyAssignmentsListForManagementGroupNextResponse

Contém dados de resposta para a operação listForManagementGroupNext.

PolicyAssignmentsListForManagementGroupResponse

Contém dados de resposta para a operação listForManagementGroup.

PolicyAssignmentsListForResourceGroupNextResponse

Contém dados de resposta para a operação listForResourceGroupNext.

PolicyAssignmentsListForResourceGroupResponse

Contém dados de resposta para a operação listForResourceGroup.

PolicyAssignmentsListForResourceNextResponse

Contém dados de resposta para a operação listForResourceNext.

PolicyAssignmentsListForResourceResponse

Contém dados de resposta para a operação listForResource.

PolicyAssignmentsListNextResponse

Contém dados de resposta para a operação listNext.

PolicyAssignmentsListResponse

Contém dados de resposta para a operação de lista.

PolicyAssignmentsUpdateByIdResponse

Contém dados de resposta para a operação updateById.

PolicyAssignmentsUpdateResponse

Contém dados de resposta para a operação de atualização.

PolicyDefinitionVersionsCreateOrUpdateAtManagementGroupResponse

Contém dados de resposta para a operação createOrUpdateAtManagementGroup.

PolicyDefinitionVersionsCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.

PolicyDefinitionVersionsGetAtManagementGroupResponse

Contém dados de resposta para a operação getAtManagementGroup.

PolicyDefinitionVersionsGetBuiltInResponse

Contém dados de resposta para a operação getBuiltIn.

PolicyDefinitionVersionsGetResponse

Contém dados de resposta para a operação de obtenção.

PolicyDefinitionVersionsListAllAtManagementGroupResponse

Contém dados de resposta para a operação listAllAtManagementGroup.

PolicyDefinitionVersionsListAllBuiltinsResponse

Contém dados de resposta para a operação listAllBuiltins.

PolicyDefinitionVersionsListAllResponse

Contém dados de resposta para a operação listAll.

PolicyDefinitionVersionsListBuiltInNextResponse

Contém dados de resposta para a operação listBuiltInNext.

PolicyDefinitionVersionsListBuiltInResponse

Contém dados de resposta para a operação listBuiltIn.

PolicyDefinitionVersionsListByManagementGroupNextResponse

Contém dados de resposta para a operação listByManagementGroupNext.

PolicyDefinitionVersionsListByManagementGroupResponse

Contém dados de resposta para a operação listByManagementGroup.

PolicyDefinitionVersionsListNextResponse

Contém dados de resposta para a operação listNext.

PolicyDefinitionVersionsListResponse

Contém dados de resposta para a operação de lista.

PolicyDefinitionsCreateOrUpdateAtManagementGroupResponse

Contém dados de resposta para a operação createOrUpdateAtManagementGroup.

PolicyDefinitionsCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.

PolicyDefinitionsGetAtManagementGroupResponse

Contém dados de resposta para a operação getAtManagementGroup.

PolicyDefinitionsGetBuiltInResponse

Contém dados de resposta para a operação getBuiltIn.

PolicyDefinitionsGetResponse

Contém dados de resposta para a operação de obtenção.

PolicyDefinitionsListBuiltInNextResponse

Contém dados de resposta para a operação listBuiltInNext.

PolicyDefinitionsListBuiltInResponse

Contém dados de resposta para a operação listBuiltIn.

PolicyDefinitionsListByManagementGroupNextResponse

Contém dados de resposta para a operação listByManagementGroupNext.

PolicyDefinitionsListByManagementGroupResponse

Contém dados de resposta para a operação listByManagementGroup.

PolicyDefinitionsListNextResponse

Contém dados de resposta para a operação listNext.

PolicyDefinitionsListResponse

Contém dados de resposta para a operação de lista.

PolicySetDefinitionVersionsCreateOrUpdateAtManagementGroupResponse

Contém dados de resposta para a operação createOrUpdateAtManagementGroup.

PolicySetDefinitionVersionsCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.

PolicySetDefinitionVersionsGetAtManagementGroupResponse

Contém dados de resposta para a operação getAtManagementGroup.

PolicySetDefinitionVersionsGetBuiltInResponse

Contém dados de resposta para a operação getBuiltIn.

PolicySetDefinitionVersionsGetResponse

Contém dados de resposta para a operação de obtenção.

PolicySetDefinitionVersionsListAllAtManagementGroupResponse

Contém dados de resposta para a operação listAllAtManagementGroup.

PolicySetDefinitionVersionsListAllBuiltinsResponse

Contém dados de resposta para a operação listAllBuiltins.

PolicySetDefinitionVersionsListAllResponse

Contém dados de resposta para a operação listAll.

PolicySetDefinitionVersionsListBuiltInNextResponse

Contém dados de resposta para a operação listBuiltInNext.

PolicySetDefinitionVersionsListBuiltInResponse

Contém dados de resposta para a operação listBuiltIn.

PolicySetDefinitionVersionsListByManagementGroupNextResponse

Contém dados de resposta para a operação listByManagementGroupNext.

PolicySetDefinitionVersionsListByManagementGroupResponse

Contém dados de resposta para a operação listByManagementGroup.

PolicySetDefinitionVersionsListNextResponse

Contém dados de resposta para a operação listNext.

PolicySetDefinitionVersionsListResponse

Contém dados de resposta para a operação de lista.

PolicySetDefinitionsCreateOrUpdateAtManagementGroupResponse

Contém dados de resposta para a operação createOrUpdateAtManagementGroup.

PolicySetDefinitionsCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.

PolicySetDefinitionsGetAtManagementGroupResponse

Contém dados de resposta para a operação getAtManagementGroup.

PolicySetDefinitionsGetBuiltInResponse

Contém dados de resposta para a operação getBuiltIn.

PolicySetDefinitionsGetResponse

Contém dados de resposta para a operação de obtenção.

PolicySetDefinitionsListBuiltInNextResponse

Contém dados de resposta para a operação listBuiltInNext.

PolicySetDefinitionsListBuiltInResponse

Contém dados de resposta para a operação listBuiltIn.

PolicySetDefinitionsListByManagementGroupNextResponse

Contém dados de resposta para a operação listByManagementGroupNext.

PolicySetDefinitionsListByManagementGroupResponse

Contém dados de resposta para a operação listByManagementGroup.

PolicySetDefinitionsListNextResponse

Contém dados de resposta para a operação listNext.

PolicySetDefinitionsListResponse

Contém dados de resposta para a operação de lista.

PolicyType

Define valores para PolicyType.
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

Não Especificada
BuiltIn
Personalizado
estático

ResourceIdentityType

Define valores para ResourceIdentityType.

SelectorKind

Define valores para SelectorKind.
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.

Enumerações

KnownAssignmentType

Valores conhecidos de AssignmentType que o serviço aceita.

KnownCreatedByType

Valores conhecidos de CreatedByType que o serviço aceita.

KnownEnforcementMode

Valores conhecidos de EnforcementMode que o serviço aceita.

KnownOverrideKind

Valores conhecidos de OverrideKind que o serviço aceita.

KnownParameterType

Valores conhecidos de ParameterType que o serviço aceita.

KnownPolicyType

Valores conhecidos de PolicyType que o serviço aceita.

KnownSelectorKind

Valores conhecidos de SelectorKind que o serviço aceita.

Funções

getContinuationToken(unknown)

Dado o último .value produzido pelo iterador byPage, retorna um token de continuação que pode ser usado para iniciar a paginação a partir desse ponto mais tarde.

Detalhes da função

getContinuationToken(unknown)

Dado o último .value produzido pelo iterador byPage, retorna um token de continuação que pode ser usado para iniciar a paginação a partir desse ponto mais tarde.

function getContinuationToken(page: unknown): string | undefined

Parâmetros

page

unknown

Um objeto de acessar value no IteratorResult de um iterador de byPage.

Retornos

string | undefined

O token de continuação que pode ser passado para byPage() durante chamadas futuras.