@azure/arm-resourcesdeployments package

Interfaces

Alias

O tipo de alias.

AliasPath

O tipo de caminhos para alias.

AliasPathMetadata

interface de modelos 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 DeploymentDiagnosticsDefinition

DeploymentExportResult

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

DeploymentExtended

Informações de implantação.

DeploymentExtensionConfigItem

interface do modelo DeploymentExtensionConfigItem

DeploymentExtensionDefinition

Interface do modelo DeploymentExtensionDefinition

DeploymentExternalInput

Implantação de entrada externa 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 sobre a 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 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 do modelo de validação.

DeploymentWhatIf

Parâmetros de operação hipotéticos de implantação.

DeploymentWhatIfProperties

Propriedades hipotéticas de implantação.

DeploymentWhatIfSettings

Configurações de implantação What-If operaçã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 que representa 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

O erro de gerenciamento de recursos informações adicionais.

ErrorResponse

Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar 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 aninhado.

ExtensionResource

O recurso de extensão de base.

HttpMessage

Mensagem HTTP.

KeyVaultParameterReference

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

KeyVaultReference

Referência do Azure Key Vault.

OnErrorDeployment

Implantação em comportamento de erro.

OnErrorDeploymentExtended

Implantação sobre 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 até a conclusão e por página.

ParametersLink

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

Provider

Informações do provedor de recursos.

ProviderExtendedLocation

A localização estendida 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 hipotéticos de implantação.

SimplePollerLike

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

StatusMessage

Objeto de mensagem de status da operação.

SystemData

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

TargetResource

Recurso de destino.

TemplateHashResult

Resultado da solicitação para calcular hash de 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 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 de recurso.

ZoneMapping

Interface do modelo ZoneMapping

Aliases de Tipo

AliasPathAttributes

Os atributos do token ao qual o caminho do alias está se referindo.
KnownAliasPathAttributes pode ser usado de forma intercambiável com AliasPathAttributes, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

Nenhum: 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 'modificar'.

AliasPathTokenType

O tipo de token ao qual o caminho do alias está se referindo.
KnownAliasPathTokenType pode ser usado de forma intercambiável com AliasPathTokenType, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

NotSpecified: O tipo de token não é especificado.
Qualquer: O tipo de token pode ser qualquer coisa.
String: O tipo de token é string.
Object: O tipo de token é object.
Array: O tipo de token é array.
Integer: O tipo de token é inteiro.
Número: O tipo de token é número.
Boolean: O tipo de token é booleano.

AliasPatternType

O tipo de padrão de alias

AliasType

O tipo do alias.

AzureSupportedClouds

Os valores suportados 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, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo 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, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

Nenhum: Nenhum
UserAssigned: UserAssigned

DeploymentMode

O modo usado para implantar recursos. Esse valor pode ser Incremental ou Completo. No modo Incremental, os recursos são implantados sem excluir os 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 involuntariamente.

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, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

NotSpecified: NotSpecified
Exterior: Exterior
Interior: Interior

ExtensionConfigPropertyType

Tipo de ExtensionConfigPropertyType

Level

Indica o nível de resposta adicional.
KnownLevel pode ser usado de forma intercambiável com Level, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo 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, este enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

NotSpecified: 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 de provisionamento.
KnownProvisioningState pode ser usado de forma intercambiável com ProvisioningState, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

NotSpecified: NotSpecified
Aceito: Aceito
Corrida: Corrida
Pronto: Pronto
Criando: Criando
Criado: Criado
Excluindo: Excluindo
Eliminado: Eliminado
Cancelado: Cancelado
Falha: Falha
Sucesso: Sucessor
Atualização: Atualização

ValidationLevel

O nível de validação realizado na implantação.
KnownValidationLevel pode ser usado de forma intercambiável com ValidationLevel, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

Gabarito: A análise estática do modelo é realizada.
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 What-If

Enumerações

AzureClouds

Um enum para descrever ambientes Azure Cloud.

KnownAliasPathAttributes

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

KnownAliasPathTokenType

O tipo de 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 de provisionamento.

KnownValidationLevel

O nível de validação realizado 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 poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo.

Variáveis

RestError

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

Detalhes de Função

isRestError(unknown)

Typeguard para RestError

function isRestError(e: unknown): e

Parâmetros

e

unknown

Algo apanhado por uma cláusula de captura.

Devoluções

e

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

Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está 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>

Devoluções

PollerLike<OperationState<TResult>, TResult>

Detalhes das variáveis

RestError

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

RestError: RestErrorConstructor

Tipo