@azure/arm-resourcesdeployments package

Interfaces

Alias

O tipo de alias.

AliasPath

O tipo dos caminhos para alias.

AliasPathMetadata

interface de modelo AliasPathMetadata

AliasPattern

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

ApiProfile

interface de modelo ApiProfile

BasicDependency

Informações de dependência de implantação.

CloudError

Uma resposta de erro para uma solicitação de gerenciamento de recursos.

DebugSetting

A configuração de depuração.

Dependency

Informações de dependência de implantação.

Deployment

Parâmetros de operação de implantação.

DeploymentDiagnosticsDefinition

interface de modelo ImplantaçãoDiagnósticoDefinição

DeploymentExportResult

O resultado da exportação da implantação.

DeploymentExtended

Informações de implantação.

DeploymentExtensionConfigItem

interface do modelo DeploymentExtensionConfigItem

DeploymentExtensionDefinition

interface do modelo ImplantaçãoExtensãoDefinição

DeploymentExternalInput

Entrada externa de implantação para parametrização.

DeploymentExternalInputDefinition

Definição de entrada externa de implantação para parametrização.

DeploymentIdentity

A configuração de Identidade Gerenciada para uma implantação.

DeploymentOperation

Informações da operação de implantação.

DeploymentOperationProperties

Propriedades da operação de implantação.

DeploymentOperationsGetAtManagementGroupScopeOptionalParams

Parâmetros opcionais.

DeploymentOperationsGetAtScopeOptionalParams

Parâmetros opcionais.

DeploymentOperationsGetAtSubscriptionScopeOptionalParams

Parâmetros opcionais.

DeploymentOperationsGetAtTenantScopeOptionalParams

Parâmetros opcionais.

DeploymentOperationsGetOptionalParams

Parâmetros opcionais.

DeploymentOperationsListAtManagementGroupScopeOptionalParams

Parâmetros opcionais.

DeploymentOperationsListAtScopeOptionalParams

Parâmetros opcionais.

DeploymentOperationsListAtSubscriptionScopeOptionalParams

Parâmetros opcionais.

DeploymentOperationsListAtTenantScopeOptionalParams

Parâmetros opcionais.

DeploymentOperationsListOptionalParams

Parâmetros opcionais.

DeploymentOperationsOperations

Interface representando uma operação de DeploymentOperations.

DeploymentParameter

Parâmetro de implantação para o modelo.

DeploymentProperties

Propriedades de implantação.

DeploymentPropertiesExtended

Propriedades de implantação com detalhes adicionais.

DeploymentValidateResult

Informações da resposta de implantação de modelo de validação.

DeploymentWhatIf

Parâmetros de operação what-if de implantação.

DeploymentWhatIfProperties

Propriedades what-if de implantação.

DeploymentWhatIfSettings

Configurações de operação de What-If de implantação.

DeploymentsCalculateTemplateHashOptionalParams

Parâmetros opcionais.

DeploymentsCancelAtManagementGroupScopeOptionalParams

Parâmetros opcionais.

DeploymentsCancelAtScopeOptionalParams

Parâmetros opcionais.

DeploymentsCancelAtSubscriptionScopeOptionalParams

Parâmetros opcionais.

DeploymentsCancelAtTenantScopeOptionalParams

Parâmetros opcionais.

DeploymentsCancelOptionalParams

Parâmetros opcionais.

DeploymentsCheckExistenceAtManagementGroupScopeOptionalParams

Parâmetros opcionais.

DeploymentsCheckExistenceAtScopeOptionalParams

Parâmetros opcionais.

DeploymentsCheckExistenceAtSubscriptionScopeOptionalParams

Parâmetros opcionais.

DeploymentsCheckExistenceAtTenantScopeOptionalParams

Parâmetros opcionais.

DeploymentsCheckExistenceOptionalParams

Parâmetros opcionais.

DeploymentsClientOptionalParams

Parâmetros opcionais para o cliente.

DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams

Parâmetros opcionais.

DeploymentsCreateOrUpdateAtScopeOptionalParams

Parâmetros opcionais.

DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams

Parâmetros opcionais.

DeploymentsCreateOrUpdateAtTenantScopeOptionalParams

Parâmetros opcionais.

DeploymentsCreateOrUpdateOptionalParams

Parâmetros opcionais.

DeploymentsDeleteAtManagementGroupScopeOptionalParams

Parâmetros opcionais.

DeploymentsDeleteAtScopeOptionalParams

Parâmetros opcionais.

DeploymentsDeleteAtSubscriptionScopeOptionalParams

Parâmetros opcionais.

DeploymentsDeleteAtTenantScopeOptionalParams

Parâmetros opcionais.

DeploymentsDeleteOptionalParams

Parâmetros opcionais.

DeploymentsExportTemplateAtManagementGroupScopeOptionalParams

Parâmetros opcionais.

DeploymentsExportTemplateAtScopeOptionalParams

Parâmetros opcionais.

DeploymentsExportTemplateAtSubscriptionScopeOptionalParams

Parâmetros opcionais.

DeploymentsExportTemplateAtTenantScopeOptionalParams

Parâmetros opcionais.

DeploymentsExportTemplateOptionalParams

Parâmetros opcionais.

DeploymentsGetAtManagementGroupScopeOptionalParams

Parâmetros opcionais.

DeploymentsGetAtScopeOptionalParams

Parâmetros opcionais.

DeploymentsGetAtSubscriptionScopeOptionalParams

Parâmetros opcionais.

DeploymentsGetAtTenantScopeOptionalParams

Parâmetros opcionais.

DeploymentsGetOptionalParams

Parâmetros opcionais.

DeploymentsListAtManagementGroupScopeOptionalParams

Parâmetros opcionais.

DeploymentsListAtScopeOptionalParams

Parâmetros opcionais.

DeploymentsListAtSubscriptionScopeOptionalParams

Parâmetros opcionais.

DeploymentsListAtTenantScopeOptionalParams

Parâmetros opcionais.

DeploymentsListByResourceGroupOptionalParams

Parâmetros opcionais.

DeploymentsOperations

Interface representando uma operação de Implantações.

DeploymentsValidateAtManagementGroupScopeOptionalParams

Parâmetros opcionais.

DeploymentsValidateAtScopeOptionalParams

Parâmetros opcionais.

DeploymentsValidateAtSubscriptionScopeOptionalParams

Parâmetros opcionais.

DeploymentsValidateAtTenantScopeOptionalParams

Parâmetros opcionais.

DeploymentsValidateOptionalParams

Parâmetros opcionais.

DeploymentsWhatIfAtManagementGroupScopeOptionalParams

Parâmetros opcionais.

DeploymentsWhatIfAtSubscriptionScopeOptionalParams

Parâmetros opcionais.

DeploymentsWhatIfAtTenantScopeOptionalParams

Parâmetros opcionais.

DeploymentsWhatIfOptionalParams

Parâmetros opcionais.

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

ExpressionEvaluationOptions

Especifica se as expressões de modelo são avaliadas dentro do escopo do modelo pai ou do modelo aninhado.

ExtensionResource

O recurso de extensão base.

HttpMessage

Mensagem HTTP.

KeyVaultParameterReference

Referência de parâmetro do Azure Key Vault.

KeyVaultReference

Referência do Azure Key Vault.

OnErrorDeployment

Implantação no comportamento de erro.

OnErrorDeploymentExtended

Implantação no comportamento de erro com detalhes adicionais.

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.

ParametersLink

Entidade que representa a referência aos parâmetros de implantação.

Provider

Informações do provedor de recursos.

ProviderExtendedLocation

O local estendido do provedor.

ProviderResourceType

Tipo de recurso gerenciado pelo provedor de recursos.

Resource

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

ResourceReference

O modelo de ID do recurso.

RestorePollerOptions
ScopedDeployment

Parâmetros de operação de implantação.

ScopedDeploymentWhatIf

Parâmetros de operação what-if de implantação.

SimplePollerLike

Um sondador simples que pode ser usado para sondar uma operação de longa execução.

StatusMessage

Objeto de mensagem de status da operação.

SystemData

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

TargetResource

Recurso de destino.

TemplateHashResult

Resultado da solicitação para calcular o hash do modelo. Ele contém uma cadeia de caracteres de modelo minificado e seu hash.

TemplateLink

Entidade que representa a referência ao modelo.

UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário

WhatIfChange

Informações sobre uma única alteração de recurso prevista por What-If operação.

WhatIfOperationProperties

Propriedades da operação de implantação.

WhatIfOperationResult

Resultado da operação de What-If. Contém uma lista de alterações previstas e um link de URL para chegar ao próximo conjunto de resultados.

WhatIfPropertyChange

A alteração prevista para a propriedade do recurso.

ZoneMapping

Interface de modelo ZoneMapping

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 alias

AliasType

O tipo do alias.

AzureSupportedClouds

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

ChangeType

Tipo de alteração que será feita no recurso quando a implantação for executada.

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.

DeploymentIdentityType

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

Valores conhecidos compatíveis com o serviço

Nenhum: Nenhum
UserAssigned: UserAssigned

DeploymentMode

O modo usado para implantar recursos. Esse valor pode ser Incremental ou Concluído. No modo incremental, os recursos são implantados sem excluir recursos existentes que não estão incluídos no modelo. No modo Completo, os recursos são implantados e os recursos existentes no grupo de recursos que não estão incluídos no modelo são excluídos. Tenha cuidado ao usar o modo Completo, pois você pode excluir recursos sem querer.

DeploymentsCheckExistenceAtManagementGroupScopeResponse
DeploymentsCheckExistenceAtScopeResponse
DeploymentsCheckExistenceAtSubscriptionScopeResponse
DeploymentsCheckExistenceAtTenantScopeResponse
DeploymentsCheckExistenceResponse
ExpressionEvaluationOptionsScopeType

O escopo a ser usado para avaliação de parâmetros, variáveis e funções em um modelo aninhado.
KnownExpressionEvaluationOptionsScopeType pode ser usado de forma intercambiável com ExpressionEvaluationOptionsScopeType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

NotSspecificified: NotSpecified
Exterior: Externo
Interior: Interior

ExtensionConfigPropertyType

Tipo de ExtensionConfigPropertyType

Level

Indica o nível de resposta adicional.
KnownLevel pode ser usado de forma intercambiável com Level, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Aviso: Aviso
Info: Info
Erro: Erro

OnErrorDeploymentType

A implantação no tipo de comportamento de erro. Os valores possíveis são LastSuccessful e SpecificDeployment.

PropertyChangeType

O tipo de alteração de propriedade.

ProviderAuthorizationConsentState

O estado de consentimento de autorização do provedor.
KnownProviderAuthorizationConsentState pode ser usado de forma intercambiável com ProviderAuthorizationConsentState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

NotSspecificified: NotSpecified
Obrigatório: Obrigatório
NãoObrigatório: NãoObrigatório
Consentiu: Consentiu

ProvisioningOperation

O nome da operação de provisionamento atual.

ProvisioningState

Indica o estado do provisionamento.
KnownProvisioningState pode ser usado de forma intercambiável com ProvisioningState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

NotSspecificified: NotSpecified
Aceito: Aceito
Correndo: Correndo
Pronto: Pronto
Criando: Criando
Criado: Criado
Eliminando: Excluindo
Excluído: Excluído
Cancelado: Cancelado
Falha: Falha
Sucesso: Sucessor
Atualizando: Atualizando

ValidationLevel

O nível de validação executado na implantação.
KnownValidationLevel pode ser usado de forma intercambiável com ValidationLevel, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Modelo: A análise estática do modelo é executada.
Provedor: a análise estática do modelo é executada e as declarações de recursos são enviadas aos provedores de recursos para validação semântica. Valida se o chamador tem permissões de gravação RBAC em cada recurso.
ProviderNoRbac: a análise estática do modelo é executada e as declarações de recursos são enviadas aos provedores de recursos para validação semântica. Ignora a validação de que o chamador tem permissões de gravação RBAC em cada recurso.

WhatIfResultFormat

O formato dos resultados do What-If

Enumerações

AzureClouds

Um enum para descrever ambientes de nuvem 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.

KnownCreatedByType

O tipo de entidade que criou o recurso.

KnownDeploymentIdentityType

O tipo de identidade.

KnownExpressionEvaluationOptionsScopeType

O escopo a ser usado para avaliação de parâmetros, variáveis e funções em um modelo aninhado.

KnownExtensionConfigPropertyType

Valores conhecidos de ExtensionConfigPropertyType que o serviço aceita.

KnownLevel

Indica o nível de resposta adicional.

KnownProviderAuthorizationConsentState

O estado de consentimento de autorização do provedor.

KnownProvisioningState

Indica o estado do provisionamento.

KnownValidationLevel

O nível de validação executado na implantação.

KnownVersions

As versões de API disponíveis.

Funções

isRestError(unknown)

Typeguard para RestError

restorePoller<TResponse, TResult>(DeploymentsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Cria um sondador do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondadores em um host diferente ou um sondador precisa ser construído depois que o original não estiver no escopo.

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

Parâmetros

e

unknown

Algo pego por uma cláusula catch.

Retornos

e

restorePoller<TResponse, TResult>(DeploymentsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Cria um sondador do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondadores em um host diferente ou um sondador precisa ser construído depois que o original não estiver no escopo.

function restorePoller<TResponse, TResult>(client: DeploymentsClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parâmetros

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Retornos

PollerLike<OperationState<TResult>, TResult>

Detalhes da variável

RestError

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

RestError: RestErrorConstructor

Tipo