@azure/arm-imagebuilder package
Clases
| ImageBuilderClient |
Interfaces
| DataDisk |
Propiedades del disco de datos. |
| DistributeVersioner |
Describe cómo generar un nuevo número de versión x.y.z para la distribución. |
| DistributeVersionerLatest |
Genera el número de versión más reciente en función de los números de versión existentes. |
| DistributeVersionerSource |
Genera un número de versión basado en el número de versión de la imagen de origen. |
| ErrorAdditionalInfo |
Información adicional sobre el error de administración de recursos. |
| ErrorDetail |
Detalle del error. |
| 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. |
| ImageBuilderClientOptionalParams |
Parámetros opcionales para el cliente. |
| ImageTemplate |
La plantilla de imagen es un recurso de ARM administrado por el proveedor Microsoft.VirtualMachineImages. |
| ImageTemplateAutoRun |
Indica si es necesario crear o actualizar la plantilla de imagen. |
| ImageTemplateCustomizer |
Describe una unidad de personalización de imagen |
| ImageTemplateDistributor |
Objeto de distribución genérico |
| ImageTemplateFileCustomizer |
Carga archivos en máquinas virtuales (Linux, Windows). Corresponde al aprovisionamiento de archivos Packer. |
| ImageTemplateFileValidator |
Carga los archivos necesarios para la validación en máquinas virtuales (Linux, Windows). Corresponde al aprovisionamiento de archivos Packer. |
| ImageTemplateIdentity |
Identidad de la plantilla de imagen. |
| ImageTemplateInVMValidator |
Describe una unidad de in-VM validación de la imagen |
| ImageTemplateLastRunStatus |
Describe el estado más reciente de ejecutar una plantilla de imagen. |
| ImageTemplateManagedImageDistributor |
Distribuir como una imagen de disco administrado. |
| ImageTemplateManagedImageSource |
Describe un origen de imagen que es una imagen administrada en la suscripción del cliente. Esta imagen debe residir en la misma suscripción y región que la plantilla de Image Builder. |
| ImageTemplatePlatformImageSource |
Describe un origen de imagen de Imágenes de la Galería de Azure. |
| ImageTemplatePowerShellCustomizer |
Ejecuta powerShell especificado en la máquina virtual (Windows). Corresponde al aprovisionamiento de PowerShell packer. Se puede especificar exactamente uno de "scriptUri" o "insertado". |
| ImageTemplatePowerShellValidator |
Ejecuta el script de PowerShell especificado durante la fase de validación (Windows). Corresponde al aprovisionamiento de PowerShell packer. Se puede especificar exactamente uno de "scriptUri" o "insertado". |
| ImageTemplateProperties |
Describe las propiedades de una plantilla de imagen |
| ImageTemplatePropertiesErrorHandling |
Opciones de control de errores tras un error de compilación |
| ImageTemplatePropertiesOptimize |
Especifica la optimización que se va a realizar en la imagen. |
| ImageTemplatePropertiesOptimizeVmBoot |
La optimización se aplica en la imagen para un arranque de máquina virtual más rápido. |
| ImageTemplatePropertiesOptimizeWorkload |
La optimización se aplica a la imagen para cargas de trabajo específicas. |
| ImageTemplatePropertiesValidate |
Opciones de configuración y lista de validaciones que se van a realizar en la imagen resultante. |
| ImageTemplateRestartCustomizer |
Reinicia una máquina virtual y espera a que vuelva a estar en línea (Windows). Corresponde al aprovisionamiento de reinicio de Windows Packer. |
| ImageTemplateSharedImageDistributor |
Distribuir a través de Azure Compute Gallery. |
| ImageTemplateSharedImageVersionSource |
Describe un origen de imagen que es una versión de imagen en una instancia de Azure Compute Gallery o una galería compartida directa. |
| ImageTemplateShellCustomizer |
Ejecuta un script de shell durante la fase de personalización (Linux). Corresponde al aprovisionamiento de shell de Packer. Se puede especificar exactamente uno de "scriptUri" o "insertado". |
| ImageTemplateShellValidator |
Ejecuta el script de shell especificado durante la fase de validación (Linux). Corresponde al aprovisionamiento de shell de Packer. Se puede especificar exactamente uno de "scriptUri" o "insertado". |
| ImageTemplateSource |
Describe un origen de imagen de máquina virtual para crear, personalizar y distribuir |
| ImageTemplateUpdateParameters |
Parámetros para actualizar una plantilla de imagen. |
| ImageTemplateUpdateParametersProperties |
Parámetros para actualizar una plantilla de imagen. |
| ImageTemplateVhdDistributor |
Distribuir a través de VHD en una cuenta de almacenamiento. |
| ImageTemplateVmProfile |
Describe las máquinas virtuales que se usan para compilar y validar imágenes. |
| ImageTemplateWindowsUpdateCustomizer |
Instala actualizaciones de Windows. Corresponde al aprovisionamiento de Windows Update packer (https://github.com/rgl/packer-provisioner-windows-update) |
| Operation |
Una operación de API REST |
| OperationDisplay |
Objeto que describe la operación. |
| OperationsListOptionalParams |
Parámetros opcionales. |
| OperationsOperations |
Interfaz que representa operaciones de operaciones. |
| 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. |
| PlatformImagePurchasePlan |
Configuración del plan de compra para la imagen de plataforma. |
| ProvisioningError |
Describe el error que se produjo al crear o actualizar una plantilla de imagen |
| ProxyResource |
Definición del modelo de recursos para un recurso proxy de Azure Resource Manager. No tendrá etiquetas ni una ubicación |
| Resource |
Campos comunes que se devuelven en la respuesta de todos los recursos de Azure Resource Manager |
| RestorePollerOptions | |
| RunOutput |
Representa una salida que se creó mediante la ejecución de una plantilla de imagen. |
| RunOutputProperties |
Describe las propiedades de una salida de ejecución |
| SimplePollerLike |
Un sondeo sencillo que se puede usar para sondear una operación de larga duración. |
| SourceImageTriggerProperties |
Propiedades del tipo SourceImage de desencadenador |
| SystemData |
Metadatos relativos a la creación y última modificación del recurso. |
| TargetRegion |
Describe la información de la región de destino. |
| TrackedResource |
La definición del modelo de recursos para un recurso de nivel superior con seguimiento de Azure Resource Manager que tiene "etiquetas" y una "ubicación". |
| Trigger |
Representa un desencadenador que puede invocar una compilación de plantilla de imagen. |
| TriggerProperties |
Describe las propiedades de un desencadenador |
| TriggerStatus |
Describe el estado de un desencadenador. |
| TriggersCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| TriggersDeleteOptionalParams |
Parámetros opcionales. |
| TriggersGetOptionalParams |
Parámetros opcionales. |
| TriggersListByImageTemplateOptionalParams |
Parámetros opcionales. |
| TriggersOperations |
Interfaz que representa una operación de Triggers. |
| UserAssignedIdentity |
Propiedades de identidad asignadas por el usuario |
| VirtualMachineImageTemplatesCancelOptionalParams |
Parámetros opcionales. |
| VirtualMachineImageTemplatesCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| VirtualMachineImageTemplatesDeleteOptionalParams |
Parámetros opcionales. |
| VirtualMachineImageTemplatesGetOptionalParams |
Parámetros opcionales. |
| VirtualMachineImageTemplatesGetRunOutputOptionalParams |
Parámetros opcionales. |
| VirtualMachineImageTemplatesListByResourceGroupOptionalParams |
Parámetros opcionales. |
| VirtualMachineImageTemplatesListOptionalParams |
Parámetros opcionales. |
| VirtualMachineImageTemplatesListRunOutputsOptionalParams |
Parámetros opcionales. |
| VirtualMachineImageTemplatesOperations |
Interfaz que representa una operación de VirtualMachineImageTemplates. |
| VirtualMachineImageTemplatesRunOptionalParams |
Parámetros opcionales. |
| VirtualMachineImageTemplatesUpdateOptionalParams |
Parámetros opcionales. |
| VirtualNetworkConfig |
Configuración de red virtual. |
Alias de tipos
| AutoRunState |
Al habilitar este campo, se desencadenará una compilación automática en la creación o actualización de plantillas de imagen. |
| AzureSupportedClouds |
Los valores admitidos para la configuración de nube como un tipo literal de cadena |
| 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. |
| DistributeVersionerUnion |
Alias para DistributeVersionerUnion |
| ImageTemplateCustomizerUnion |
Alias para ImageTemplateCustomizerUnion |
| ImageTemplateDistributorUnion |
Alias para ImageTemplateDistributorUnion |
| ImageTemplateInVMValidatorUnion |
Alias para ImageTemplateInVMValidatorUnion |
| ImageTemplateSourceUnion |
Alias para ImageTemplateSourceUnion |
| OnBuildError |
Comportamiento de manejo de errores tras fallo en la compilación Valores conocidos admitidos por el servicio
Limpieza: Limpieza |
| ProvisioningErrorCode |
Código de error del fallo de aprovisionamiento Valores conocidos admitidos por el servicio
MalaFuenteTipo: Mala FuenteTipo |
| ProvisioningState |
Estado de aprovisionamiento del recurso |
| ReplicationMode |
Describe el modo de replicación para la distribución en Azure Compute Gallery. Omite usar el predeterminado (Full). Valores conocidos admitidos por el servicio
Completo: Modo de replicación completo |
| ResourceIdentityType |
Tipo de identidad que se usa para la plantilla de imagen. El tipo "None" quitará las identidades de la plantilla de imagen. |
| RunState |
Estado de la última tirada |
| RunSubState |
Subestado de la última etapa |
| SharedImageStorageAccountType |
Especifica el tipo de cuenta de almacenamiento que se usará para almacenar la versión de la imagen de la Galería de Cálculo de Azure. Valores conocidos admitidos por el servicio
Standard_LRS: Standard_LRS |
| TriggerPropertiesUnion |
Alias para TriggerPropertiesUnion |
| VMBootOptimizationState |
La habilitación de este campo mejorará el tiempo de arranque de la máquina virtual mediante la optimización de la salida final de la imagen personalizada. |
| WorkloadOptimizationState |
Activar este campo optimizará las imágenes de la VM para cargas de trabajo específicas. |
Enumeraciones
| AzureClouds |
Un enum para describir los entornos de Azure Cloud. |
| KnownCreatedByType |
Tipo de entidad que creó el recurso. |
| KnownOnBuildError |
Comportamiento de manejo de errores tras fallo en la compilación |
| KnownProvisioningErrorCode |
Código de error del fallo de aprovisionamiento |
| KnownReplicationMode |
Describe el modo de replicación para la distribución en Azure Compute Gallery. Omite usar el predeterminado (Full). |
| KnownSharedImageStorageAccountType |
Especifica el tipo de cuenta de almacenamiento que se usará para almacenar la versión de la imagen de la Galería de Cálculo de Azure. |
| KnownVersions |
Las versiones de API disponibles. |
Funciones
| is |
Typeguard para RestError |
| restore |
Crea un sondeador a partir del estado serializado de otro sondeador. Esto puede ser útil cuando desea crear sondeadores en un host diferente o cuando es necesario construir un sondeador 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>(ImageBuilderClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Crea un sondeador a partir del estado serializado de otro sondeador. Esto puede ser útil cuando desea crear sondeadores en un host diferente o cuando es necesario construir un sondeador después de que el original no esté en el ámbito.
function restorePoller<TResponse, TResult>(client: ImageBuilderClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parámetros
- client
- ImageBuilderClient
- 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