Machines - Update

Referencia

Service:: Hybrid Compute

API Version:: 2022-12-27

Operación para actualizar una máquina híbrida.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}?api-version=2022-12-27

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
machineName	path	True	string	Nombre de la máquina híbrida. Regex pattern: `^[a-zA-Z0-9-_\.]{1,54}$`
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
identity	Identity	Identidad del recurso.
properties.agentUpgrade	AgentUpgrade	Información de la actualización del agente w.r.t de la máquina
properties.cloudMetadata	CloudMetadata	Metadatos del entorno de nube (Azure/GCP/AWS/OCI...).
properties.locationData	locationData	Metadatos relacionados con la ubicación geográfica del recurso.
properties.osProfile	OSProfile	Especifica la configuración del sistema operativo para la máquina híbrida.
properties.parentClusterResourceId	string	El identificador de recurso del clúster primario (Azure HCI) al que se asigna esta máquina, si existe.
properties.privateLinkScopeResourceId	string	El identificador de recurso del ámbito de vínculo privado al que se asigna esta máquina, si existe.
tags	object	Etiquetas del recurso

Respuestas

Nombre	Tipo	Description
200 OK	Machine	Aceptar
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Update a Machine

PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine?api-version=2022-12-27

{
  "properties": {
    "locationData": {
      "name": "Redmond"
    },
    "osProfile": {
      "windowsConfiguration": {
        "patchSettings": {
          "assessmentMode": "ImageDefault",
          "patchMode": "Manual"
        }
      },
      "linuxConfiguration": {
        "patchSettings": {
          "assessmentMode": "ImageDefault",
          "patchMode": "Manual"
        }
      }
    },
    "parentClusterResourceId": "{AzureStackHCIResourceId}",
    "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName"
  },
  "identity": {
    "type": "SystemAssigned"
  }
}

using System;
using System.Threading.Tasks;
using System.Xml;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.HybridCompute;
using Azure.ResourceManager.HybridCompute.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/hybridcompute/resource-manager/Microsoft.HybridCompute/stable/2022-12-27/examples/Machines_Update.json
// this example is just showing the usage of "Machines_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this HybridComputeMachineResource created on azure
// for more information of creating HybridComputeMachineResource, please refer to the document of HybridComputeMachineResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string machineName = "myMachine";
ResourceIdentifier hybridComputeMachineResourceId = HybridComputeMachineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, machineName);
HybridComputeMachineResource hybridComputeMachine = client.GetHybridComputeMachineResource(hybridComputeMachineResourceId);

// invoke the operation
HybridComputeMachinePatch patch = new HybridComputeMachinePatch()
{
    Identity = new ManagedServiceIdentity("SystemAssigned"),
    LocationData = new LocationData("Redmond"),
    OSProfile = new OSProfile()
    {
        WindowsConfiguration = new OSProfileWindowsConfiguration()
        {
            AssessmentMode = AssessmentModeType.ImageDefault,
            PatchMode = PatchModeType.Manual,
        },
        LinuxConfiguration = new OSProfileLinuxConfiguration()
        {
            AssessmentMode = AssessmentModeType.ImageDefault,
            PatchMode = PatchModeType.Manual,
        },
    },
    ParentClusterResourceId = new ResourceIdentifier("{AzureStackHCIResourceId}"),
    PrivateLinkScopeResourceId = new ResourceIdentifier("/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName"),
};
HybridComputeMachineResource result = await hybridComputeMachine.UpdateAsync(patch);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
HybridComputeMachineData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine",
  "name": "myMachine",
  "location": "eastus2euap",
  "tags": null,
  "identity": {
    "type": "SystemAssigned",
    "principalId": "string",
    "tenantId": "string"
  },
  "type": "Microsoft.HybridCompute/machines",
  "properties": {
    "provisioningState": "Succeeded",
    "agentVersion": null,
    "status": null,
    "lastStatusChange": null,
    "errorDetails": null,
    "displayName": null,
    "machineFqdn": null,
    "vmUuid": null,
    "osSku": null,
    "domainName": null,
    "adFqdn": null,
    "dnsFqdn": null,
    "osVersion": null,
    "osType": null,
    "osProfile": {
      "computerName": null,
      "windowsConfiguration": {
        "patchSettings": {
          "assessmentMode": "ImageDefault",
          "patchMode": "Manual"
        }
      },
      "linuxConfiguration": {
        "patchSettings": {
          "assessmentMode": "ImageDefault",
          "patchMode": "Manual"
        }
      }
    },
    "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f",
    "locationData": {
      "name": "Redmond"
    },
    "clientPublicKey": "string",
    "parentClusterResourceId": "{AzureStackHCIResourceId}",
    "detectedProperties": null,
    "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName"
  }
}

Definiciones

Nombre	Description
agent configuration mode	Nombre del modo de configuración que se va a usar. Los modos son configuraciones predefinidas de controles de seguridad, listas de permitidos de extensión y configuración de invitado, mantenidas por Microsoft.
AgentConfiguration	Propiedades configurables que el usuario puede establecer localmente mediante el comando azcmagent config o de forma remota a través de ARM.
AgentUpgrade	La información w.r.t Agent Upgrade.
AssessmentModeTypes	Especifica el modo de evaluación.
CloudMetadata	Metadatos del entorno de nube (Azure/GCP/AWS/OCI...).
ConfigurationExtension	Describe las propiedades que pueden identificar extensiones.
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
Identity	Identidad del recurso.
LastAttemptStatusEnum	Especifica el estado de actualización del agente.
LinuxConfiguration	Especifica la configuración de Linux para update Management.
locationData	Metadatos relacionados con la ubicación geográfica del recurso.
Machine	Describe una máquina híbrida.
MachineExtension	Describe una extensión de máquina.
MachineExtensionInstanceView	Describe la vista de instancia de extensión de máquina.
MachineExtensionProperties	Describe las propiedades de una extensión de máquina.
MachineUpdate	Describe una actualización de máquina híbrida.
OSProfile	Especifica la configuración del sistema operativo para la máquina híbrida.
PatchModeTypes	Especifica el modo de revisión.
ResourceIdentityType	Tipo de identidad.
ServiceStatus	Describe el estado y el comportamiento de un servicio.
ServiceStatuses	Informa del estado y el comportamiento de los servicios dependientes.
Status	Estado de la vista de instancia.
StatusLevelTypes	El código de nivel.
StatusTypes	Estado del agente de máquina híbrida.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
WindowsConfiguration	Especifica la configuración de Windows para update Management.

agent configuration mode

Nombre del modo de configuración que se va a usar. Los modos son configuraciones predefinidas de controles de seguridad, listas de permitidos de extensión y configuración de invitado, mantenidas por Microsoft.

Nombre	Tipo	Description
full	string
monitor	string

AgentConfiguration

Propiedades configurables que el usuario puede establecer localmente mediante el comando azcmagent config o de forma remota a través de ARM.

Nombre	Tipo	Description
configMode	agent configuration mode	Nombre del modo de configuración que se va a usar. Los modos son configuraciones predefinidas de controles de seguridad, listas de permitidos de extensión y configuración de invitado, mantenidas por Microsoft.
extensionsAllowList	ConfigurationExtension[]	Matriz de extensiones que se pueden instalar o actualizar.
extensionsBlockList	ConfigurationExtension[]	Matriz de extensiones bloqueadas (no se pueden instalar ni actualizar)
extensionsEnabled	string	Especifica si el servicio de extensión está habilitado o deshabilitado.
guestConfigurationEnabled	string	Se especifica si el servicio de configuración de invitado está habilitado o deshabilitado.
incomingConnectionsPorts	string[]	Especifica la lista de puertos en los que el agente podrá escuchar.
proxyBypass	string[]	Lista de nombres de servicio que no deben usar el servidor proxy especificado.
proxyUrl	string	Especifica la dirección URL del proxy que se va a usar.

AgentUpgrade

La información w.r.t Agent Upgrade.

Nombre	Tipo	Description
correlationId	string	Identificador de correlación pasado desde RSM por actualización.
desiredVersion	string	Especifica la información de versión w.r.t AgentUpgrade para la máquina.
enableAutomaticUpgrade	boolean	Especifica si RSM debe intentar actualizar esta máquina.
lastAttemptMessage	string	Mensaje de error del último intento de actualización si existe.
lastAttemptStatus	LastAttemptStatusEnum	Especifica el estado de actualización del agente.
lastAttemptTimestamp	string	Marca de tiempo del último intento de actualización

AssessmentModeTypes

Especifica el modo de evaluación.

Nombre	Tipo	Description
AutomaticByPlatform	string
ImageDefault	string

CloudMetadata

Metadatos del entorno de nube (Azure/GCP/AWS/OCI...).

Nombre	Tipo	Description
provider	string	Especifica el proveedor de nube (Azure/AWS/GCP...).

ConfigurationExtension

Describe las propiedades que pueden identificar extensiones.

Nombre	Tipo	Description
publisher	string	Publicador de la extensión.
type	string	Tipo de la extensión.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

Identity

Identidad del recurso.

Nombre	Tipo	Description
principalId	string	Identificador de entidad de seguridad de la identidad de recurso.
tenantId	string	Identificador de inquilino del recurso.
type	ResourceIdentityType	Tipo de identidad.

LastAttemptStatusEnum

Especifica el estado de actualización del agente.

Nombre	Tipo	Description
Failed	string
Success	string

LinuxConfiguration

Especifica la configuración de Linux para update Management.

Nombre	Tipo	Description
patchSettings.assessmentMode	AssessmentModeTypes	Especifica el modo de evaluación.
patchSettings.patchMode	PatchModeTypes	Especifica el modo de revisión.

locationData

Metadatos relacionados con la ubicación geográfica del recurso.

Nombre	Tipo	Description
city	string	Ciudad o localidad donde se encuentra el recurso.
countryOrRegion	string	País o región donde se encuentra el recurso
district	string	Distrito, estado o provincia donde se encuentra el recurso.
name	string	Un nombre canónico para la ubicación geográfica o física.

Machine

Describe una máquina híbrida.

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Identidad del recurso.
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso.
properties.adFqdn	string	Especifica el nombre para mostrar completo de AD.
properties.agentConfiguration	AgentConfiguration	Propiedades configurables que el usuario puede establecer localmente mediante el comando azcmagent config o de forma remota a través de ARM.
properties.agentUpgrade	AgentUpgrade	Información de la actualización del agente w.r.t de la máquina
properties.agentVersion	string	Versión completa del agente de máquina híbrida.
properties.clientPublicKey	string	Clave pública que proporciona el cliente que se va a usar durante la incorporación inicial de recursos
properties.cloudMetadata	CloudMetadata	Metadatos del entorno de nube (Azure/GCP/AWS/OCI...).
properties.detectedProperties	object	Propiedades detectadas de la máquina.
properties.displayName	string	Especifica el nombre para mostrar de la máquina híbrida.
properties.dnsFqdn	string	Especifica el nombre para mostrar completo de DNS.
properties.domainName	string	Especifica el nombre de dominio de Windows.
properties.errorDetails	ErrorDetail[]	Detalles sobre el estado de error.
properties.extensions	MachineExtensionInstanceView[]	Información de extensiones de máquina (campo en desuso)
properties.lastStatusChange	string	Hora del último cambio de estado.
properties.locationData	locationData	Metadatos relacionados con la ubicación geográfica del recurso.
properties.machineFqdn	string	Especifica el FQDN de la máquina híbrida.
properties.mssqlDiscovered	string	Especifica si se detecta alguna instancia de MS SQL en el equipo.
properties.osName	string	Sistema operativo que se ejecuta en la máquina híbrida.
properties.osProfile	OSProfile	Especifica la configuración del sistema operativo para la máquina híbrida.
properties.osSku	string	Especifica la SKU del producto del sistema operativo.
properties.osType	string	Tipo de sistema operativo (windows/linux).
properties.osVersion	string	La versión del sistema operativo que se ejecuta en la máquina híbrida.
properties.parentClusterResourceId	string	El identificador de recurso del clúster primario (Azure HCI) al que se asigna esta máquina, si existe.
properties.privateLinkScopeResourceId	string	El identificador de recurso del ámbito de vínculo privado al que se asigna esta máquina, si existe.
properties.provisioningState	string	Estado de aprovisionamiento, que solo aparece en la respuesta.
properties.serviceStatuses	ServiceStatuses	Estados de los servicios dependientes que se notifican de nuevo a ARM.
properties.status	StatusTypes	Estado del agente de máquina híbrida.
properties.vmId	string	Especifica el identificador único de la máquina híbrida.
properties.vmUuid	string	Especifica el identificador SMBIOS único de Arc Machine.
resources	MachineExtension[]	Lista de extensiones afiliadas a la máquina
systemData	systemData	Metadatos de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy.
tags	object	Etiquetas del recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

MachineExtension

Describe una extensión de máquina.

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso.
properties	MachineExtensionProperties	Describe las propiedades de la extensión de máquina.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy.
tags	object	Etiquetas del recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

MachineExtensionInstanceView

Describe la vista de instancia de extensión de máquina.

Nombre	Tipo	Description
name	string	Nombre de la extensión de la máquina.
status	Status	Estado de la vista de instancia.
type	string	Especifica el tipo de la extensión; Un ejemplo es "CustomScriptExtension".
typeHandlerVersion	string	Especifica la versión del controlador de script.

MachineExtensionProperties

Describe las propiedades de una extensión de máquina.

Nombre	Tipo	Description
autoUpgradeMinorVersion	boolean	Indica si la extensión debe usar una versión secundaria más reciente si hay una disponible en el momento de la implementación. Sin embargo, una vez implementada, la extensión no actualizará las versiones secundarias a menos que se vuelva a implementar, incluso con esta propiedad establecida en true.
enableAutomaticUpgrade	boolean	Indica si la plataforma debe actualizar automáticamente la extensión si hay una versión más reciente disponible.
forceUpdateTag	string	Cómo se debe forzar el controlador de extensión para actualizar incluso si la configuración de la extensión no ha cambiado.
instanceView	MachineExtensionInstanceView	Vista de instancia de extensión de máquina.
protectedSettings		La extensión puede contener protectedSettings o protectedSettingsFromKeyVault o ninguna configuración protegida.
provisioningState	string	Estado de aprovisionamiento, que solo aparece en la respuesta.
publisher	string	Nombre del publicador de controladores de extensión.
settings		Configuración pública con formato JSON para la extensión.
type	string	Especifica el tipo de la extensión; Un ejemplo es "CustomScriptExtension".
typeHandlerVersion	string	Especifica la versión del controlador de script.

MachineUpdate

Describe una actualización de máquina híbrida.

Nombre	Tipo	Description
identity	Identity	Identidad del recurso.
properties.agentUpgrade	AgentUpgrade	Información de la actualización del agente w.r.t de la máquina
properties.cloudMetadata	CloudMetadata	Metadatos del entorno de nube (Azure/GCP/AWS/OCI...).
properties.locationData	locationData	Metadatos relacionados con la ubicación geográfica del recurso.
properties.osProfile	OSProfile	Especifica la configuración del sistema operativo para la máquina híbrida.
properties.parentClusterResourceId	string	El identificador de recurso del clúster primario (Azure HCI) al que se asigna esta máquina, si existe.
properties.privateLinkScopeResourceId	string	El identificador de recurso del ámbito de vínculo privado al que se asigna esta máquina, si existe.
tags	object	Etiquetas del recurso

OSProfile

Especifica la configuración del sistema operativo para la máquina híbrida.

Nombre	Tipo	Description
computerName	string	Especifica el nombre del sistema operativo host de la máquina híbrida.
linuxConfiguration	LinuxConfiguration	Especifica la configuración de Linux para update Management.
windowsConfiguration	WindowsConfiguration	Especifica la configuración de Windows para update Management.

PatchModeTypes

Especifica el modo de revisión.

Nombre	Tipo	Description
AutomaticByOS	string
AutomaticByPlatform	string
ImageDefault	string
Manual	string

ResourceIdentityType

Tipo de identidad.

Nombre	Tipo	Description
SystemAssigned	string

ServiceStatus

Describe el estado y el comportamiento de un servicio.

Nombre	Tipo	Description
startupType	string	Comportamiento del servicio cuando se inicia la máquina habilitada para Arc.
status	string	Estado actual del servicio.

ServiceStatuses

Informa del estado y el comportamiento de los servicios dependientes.

Nombre	Tipo	Description
extensionService	ServiceStatus	Estado del servicio de extensión en la máquina habilitada para Arc.
guestConfigurationService	ServiceStatus	Estado del servicio de configuración de invitado en la máquina habilitada para Arc.

Status

Estado de la vista de instancia.

Nombre	Tipo	Description
code	string	Código de estado.
displayStatus	string	Etiqueta localizable corta para el estado.
level	StatusLevelTypes	El código de nivel.
message	string	Mensaje de estado detallado, incluidas las alertas y los mensajes de error.
time	string	Hora del estado.

StatusLevelTypes

El código de nivel.

Nombre	Tipo	Description
Error	string
Info	string
Warning	string

StatusTypes

Estado del agente de máquina híbrida.

Nombre	Tipo	Description
Connected	string
Disconnected	string
Error	string

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

WindowsConfiguration

Especifica la configuración de Windows para update Management.

Nombre	Tipo	Description
patchSettings.assessmentMode	AssessmentModeTypes	Especifica el modo de evaluación.
patchSettings.patchMode	PatchModeTypes	Especifica el modo de revisión.