@azure/arm-resourcesdeployments package
Clases
| DeploymentsClient |
Interfaces
| Alias |
Tipo de alias. |
| AliasPath |
Tipo de las rutas de acceso para alias. |
| AliasPathMetadata |
interfaz de modelo AliasPathMetadata |
| AliasPattern |
Tipo del patrón para una ruta de acceso de alias. |
| ApiProfile |
interfaz de modelo ApiProfile |
| BasicDependency |
Información de dependencia de implementación. |
| CloudError |
Respuesta de error para una solicitud de administración de recursos. |
| DebugSetting |
Configuración de depuración. |
| Dependency |
Información de dependencia de implementación. |
| Deployment |
Parámetros de la operación de implementación. |
| DeploymentDiagnosticsDefinition |
interfaz de modelo DespliegueDiagnósticoDefinición |
| DeploymentExportResult |
Resultado de la exportación de implementación. |
| DeploymentExtended |
Información de implementación. |
| DeploymentExtensionConfigItem |
interfaz de modelo DespliegueExtensiónElemento de Configuración |
| DeploymentExtensionDefinition |
Interfaz de modelo DespliegueExtensiónDefinición |
| DeploymentExternalInput |
Entrada externa de implementación para parametrización. |
| DeploymentExternalInputDefinition |
Definición de entrada externa de despliegue para la parametrización. |
| DeploymentIdentity |
La configuración de identidad administrada para una implementación. |
| DeploymentOperation |
Información de la operación de implementación. |
| DeploymentOperationProperties |
Propiedades de la operación de implementación. |
| DeploymentOperationsGetAtManagementGroupScopeOptionalParams |
Parámetros opcionales. |
| DeploymentOperationsGetAtScopeOptionalParams |
Parámetros opcionales. |
| DeploymentOperationsGetAtSubscriptionScopeOptionalParams |
Parámetros opcionales. |
| DeploymentOperationsGetAtTenantScopeOptionalParams |
Parámetros opcionales. |
| DeploymentOperationsGetOptionalParams |
Parámetros opcionales. |
| DeploymentOperationsListAtManagementGroupScopeOptionalParams |
Parámetros opcionales. |
| DeploymentOperationsListAtScopeOptionalParams |
Parámetros opcionales. |
| DeploymentOperationsListAtSubscriptionScopeOptionalParams |
Parámetros opcionales. |
| DeploymentOperationsListAtTenantScopeOptionalParams |
Parámetros opcionales. |
| DeploymentOperationsListOptionalParams |
Parámetros opcionales. |
| DeploymentOperationsOperations |
Interfaz que representa una operación de DeploymentOperations. |
| DeploymentParameter |
Parámetro de implementación de la plantilla. |
| DeploymentProperties |
Propiedades de implementación. |
| DeploymentPropertiesExtended |
Propiedades de implementación con detalles adicionales. |
| DeploymentValidateResult |
Información de la respuesta de implementación de la plantilla de validación. |
| DeploymentWhatIf |
Parámetros de operación what-if de implementación. |
| DeploymentWhatIfProperties |
Propiedades what-if de implementación. |
| DeploymentWhatIfSettings |
Configuración de la operación de What-If de implementación. |
| DeploymentsCalculateTemplateHashOptionalParams |
Parámetros opcionales. |
| DeploymentsCancelAtManagementGroupScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsCancelAtScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsCancelAtSubscriptionScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsCancelAtTenantScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsCancelOptionalParams |
Parámetros opcionales. |
| DeploymentsCheckExistenceAtManagementGroupScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsCheckExistenceAtScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsCheckExistenceAtSubscriptionScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsCheckExistenceAtTenantScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsCheckExistenceOptionalParams |
Parámetros opcionales. |
| DeploymentsClientOptionalParams |
Parámetros opcionales para el cliente. |
| DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsCreateOrUpdateAtScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsCreateOrUpdateAtTenantScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| DeploymentsDeleteAtManagementGroupScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsDeleteAtScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsDeleteAtSubscriptionScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsDeleteAtTenantScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsDeleteOptionalParams |
Parámetros opcionales. |
| DeploymentsExportTemplateAtManagementGroupScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsExportTemplateAtScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsExportTemplateAtSubscriptionScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsExportTemplateAtTenantScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsExportTemplateOptionalParams |
Parámetros opcionales. |
| DeploymentsGetAtManagementGroupScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsGetAtScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsGetAtSubscriptionScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsGetAtTenantScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsGetOptionalParams |
Parámetros opcionales. |
| DeploymentsListAtManagementGroupScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsListAtScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsListAtSubscriptionScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsListAtTenantScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsListByResourceGroupOptionalParams |
Parámetros opcionales. |
| DeploymentsOperations |
Interfaz que representa una operación de despliegues. |
| DeploymentsValidateAtManagementGroupScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsValidateAtScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsValidateAtSubscriptionScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsValidateAtTenantScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsValidateOptionalParams |
Parámetros opcionales. |
| DeploymentsWhatIfAtManagementGroupScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsWhatIfAtSubscriptionScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsWhatIfAtTenantScopeOptionalParams |
Parámetros opcionales. |
| DeploymentsWhatIfOptionalParams |
Parámetros opcionales. |
| ErrorAdditionalInfo |
Información adicional sobre el error de administración de recursos. |
| ErrorResponse |
Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData). |
| ExpressionEvaluationOptions |
Especifica si las expresiones de plantilla se evalúan dentro del ámbito de la plantilla primaria o de la plantilla anidada. |
| ExtensionResource |
El recurso de extensión base. |
| HttpMessage |
Mensaje HTTP. |
| KeyVaultParameterReference |
Referencia de parámetros de Azure Key Vault. |
| KeyVaultReference |
Referencia de Azure Key Vault. |
| OnErrorDeployment |
Implementación en el comportamiento del error. |
| OnErrorDeploymentExtended |
Implementación en el comportamiento del error con detalles adicionales. |
| PageSettings |
Opciones para el método byPage |
| PagedAsyncIterableIterator |
Interfaz que permite la iteración asincrónica tanto a la finalización como a la página. |
| ParametersLink |
Entidad que representa la referencia a los parámetros de implementación. |
| Provider |
Información del proveedor de recursos. |
| ProviderExtendedLocation |
Ubicación extendida del proveedor. |
| ProviderResourceType |
Tipo de recurso administrado por el proveedor de recursos. |
| Resource |
Campos comunes que se devuelven en la respuesta de todos los recursos de Azure Resource Manager |
| ResourceReference |
Modelo de identificador de recurso. |
| RestorePollerOptions | |
| ScopedDeployment |
Parámetros de la operación de implementación. |
| ScopedDeploymentWhatIf |
Parámetros de operación what-if de implementación. |
| SimplePollerLike |
Un sondeo sencillo que se puede usar para sondear una operación de larga duración. |
| StatusMessage |
Objeto de mensaje de estado de la operación. |
| SystemData |
Metadatos relativos a la creación y última modificación del recurso. |
| TargetResource |
Recurso de destino. |
| TemplateHashResult |
Resultado de la solicitud para calcular el hash de plantilla. Contiene una cadena de plantilla minimizada y su hash. |
| TemplateLink |
Entidad que representa la referencia a la plantilla. |
| UserAssignedIdentity |
Propiedades de identidad asignadas por el usuario |
| WhatIfChange |
Información sobre un único cambio de recursos previsto por What-If operación. |
| WhatIfOperationProperties |
Propiedades de la operación de implementación. |
| WhatIfOperationResult |
Resultado de la operación de What-If. Contiene una lista de cambios previstos y un vínculo de dirección URL para obtener el siguiente conjunto de resultados. |
| WhatIfPropertyChange |
Cambio previsto en la propiedad de recurso. |
| ZoneMapping |
Interfaz de modelos ZoneMapping |
Alias de tipos
| AliasPathAttributes |
Atributos del token al que hace referencia la ruta de acceso del alias. Valores conocidos admitidos por el servicio
Ninguno: el token al que hace referencia la ruta de acceso del alias no tiene atributos. |
| AliasPathTokenType |
Tipo del token al que hace referencia la ruta de acceso del alias. Valores conocidos admitidos por el servicio
notSpecified: no se especifica el tipo de token. |
| AliasPatternType |
Tipo de patrón de alias |
| AliasType |
Tipo del alias. |
| AzureSupportedClouds |
Los valores admitidos para la configuración de nube como un tipo literal de cadena |
| ChangeType |
Tipo de cambio que se realizará en el recurso cuando se ejecute la implementación. |
| ContinuablePage |
Interfaz que describe una página de resultados. |
| CreatedByType |
Tipo de entidad que creó el recurso. Valores conocidos admitidos por el servicio
Usuario: un usuario creó la entidad. |
| DeploymentIdentityType |
Tipo de identidad. Valores conocidos admitidos por el servicio
Ninguno: Ninguno |
| DeploymentMode |
Modo que se usa para implementar recursos. Este valor puede ser Incremental o Completado. En modo incremental, los recursos se implementan sin eliminar los recursos existentes que no se incluyen en la plantilla. En modo completo, los recursos se implementan y se eliminan los recursos existentes del grupo de recursos que no se incluyen en la plantilla. Tenga cuidado al usar el modo Completo, ya que puede eliminar accidentalmente los recursos. |
| DeploymentsCheckExistenceAtManagementGroupScopeResponse | |
| DeploymentsCheckExistenceAtScopeResponse | |
| DeploymentsCheckExistenceAtSubscriptionScopeResponse | |
| DeploymentsCheckExistenceAtTenantScopeResponse | |
| DeploymentsCheckExistenceResponse | |
| ExpressionEvaluationOptionsScopeType |
Ámbito que se va a utilizar para la evaluación de parámetros, variables y funciones en una plantilla anidada. Valores conocidos admitidos por el servicio
NoEspecificado: NoEspecificado |
| ExtensionConfigPropertyType |
Tipo de ExtensionConfigPropertyType |
| Level |
Indica el nivel de respuesta adicional. Valores conocidos admitidos por el servicio
Advertencia: Advertencia |
| OnErrorDeploymentType |
La implementación en el tipo de comportamiento de error. Los valores posibles son LastSuccessful y SpecificDeployment. |
| PropertyChangeType |
Tipo de cambio de propiedad. |
| ProviderAuthorizationConsentState |
Estado de consentimiento de autorización del proveedor. Valores conocidos admitidos por el servicio
NoEspecificado: NoEspecificado |
| ProvisioningOperation |
Nombre de la operación de aprovisionamiento actual. |
| ProvisioningState |
Indica el estado del aprovisionamiento. Valores conocidos admitidos por el servicio
NoEspecificado: NoEspecificado |
| ValidationLevel |
El nivel de validación realizado en la implementación. Valores conocidos admitidos por el servicio
Plantilla: Se realiza un análisis estático de la plantilla. |
| WhatIfResultFormat |
El formato de los resultados del What-If |
Enumeraciones
| AzureClouds |
Un enum para describir los entornos de Azure Cloud. |
| KnownAliasPathAttributes |
Atributos del token al que hace referencia la ruta de acceso del alias. |
| KnownAliasPathTokenType |
Tipo del token al que hace referencia la ruta de acceso del alias. |
| KnownCreatedByType |
Tipo de entidad que creó el recurso. |
| KnownDeploymentIdentityType |
Tipo de identidad. |
| KnownExpressionEvaluationOptionsScopeType |
Ámbito que se va a utilizar para la evaluación de parámetros, variables y funciones en una plantilla anidada. |
| KnownExtensionConfigPropertyType |
Valores conocidos de ExtensionConfigPropertyType que acepta el servicio. |
| KnownLevel |
Indica el nivel de respuesta adicional. |
| KnownProviderAuthorizationConsentState |
Estado de consentimiento de autorización del proveedor. |
| KnownProvisioningState |
Indica el estado del aprovisionamiento. |
| KnownValidationLevel |
El nivel de validación realizado en la implementación. |
| KnownVersions |
Las versiones de API disponibles. |
Funciones
| is |
Typeguard para RestError |
| restore |
Crea un sondeo a partir del estado serializado de otro sondeo. Esto puede ser útil cuando desea crear sondeos en un host diferente o un sondeo debe construirse después de que el original no esté en el ámbito. |
Variables
| Rest |
Tipo de error personalizado para solicitudes de canalización con error. |
Detalles de la función
isRestError(unknown)
Typeguard para RestError
function isRestError(e: unknown): e
Parámetros
- e
-
unknown
Algo capturado por una cláusula catch.
Devoluciones
e
restorePoller<TResponse, TResult>(DeploymentsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Crea un sondeo a partir del estado serializado de otro sondeo. Esto puede ser útil cuando desea crear sondeos en un host diferente o un sondeo debe construirse después de que el original no esté en el ámbito.
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
- client
- DeploymentsClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Devoluciones
PollerLike<OperationState<TResult>, TResult>
Detalles de variables
RestError
Tipo de error personalizado para solicitudes de canalización con error.
RestError: RestErrorConstructor