Session Host Managements - Create Or Update

Referencia

Servicio:: Desktop Virtualization

Versión de la API:: 2024-11-01-preview

Cree o actualice un sessionHostManagement.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default?api-version=2024-11-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
hostPoolName	path	True	string minLength: 1 maxLength: 255 pattern: ^[A-Za-z0-9@.\-_ ]*$	Nombre del grupo de hosts dentro del grupo de recursos especificado.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties.scheduledDateTimeZone	True	string	Zona horaria para las operaciones sessionHostManagement tal como se define en https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Debe establecerse si useLocalTime es true.
properties.update	True	HostPoolUpdateConfigurationProperties	Parámetros para una actualización del grupo de hosts.

Respuestas

Nombre	Tipo	Description
200 OK	SessionHostManagement	SessionHostManagement se actualizó correctamente.
201 Created	SessionHostManagement	SessionHostManagement se creó correctamente.
Other Status Codes	CloudError	Respuesta de error de Automation que describe por qué se produjo un error en la operación.

Ejemplos

SessionHostManagements_Create

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default?api-version=2024-11-01-preview

{
  "properties": {
    "scheduledDateTimeZone": "Alaskan Standard Time",
    "update": {
      "deleteOriginalVm": true,
      "maxVmsRemoved": 4,
      "logOffDelayMinutes": 10,
      "logOffMessage": "logging off for hostpool update"
    }
  }
}

Respuesta de muestra

status code:: 200

{
  "name": "default",
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default",
  "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "scheduledDateTimeZone": "Alaskan Standard Time",
    "update": {
      "deleteOriginalVm": true,
      "maxVmsRemoved": 4,
      "logOffDelayMinutes": 10,
      "logOffMessage": "logging off for hostpool update"
    }
  }
}

status code:: 201

{
  "name": "default",
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default",
  "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "scheduledDateTimeZone": "Alaskan Standard Time",
    "update": {
      "deleteOriginalVm": true,
      "maxVmsRemoved": 4,
      "logOffDelayMinutes": 10,
      "logOffMessage": "logging off for hostpool update"
    }
  }
}

Definiciones

Nombre	Description
CloudError	Objeto de error en la nube.
CloudErrorProperties	Propiedades del objeto de error en la nube.
createdByType	Tipo de identidad que creó el recurso.
HostPoolUpdateConfigurationProperties	Las configuraciones de una actualización del grupo de hosts.
SessionHostManagement	Representa una definición sessionHostManagement.
systemData	Metadatos relativos a la creación y última modificación del recurso.

CloudError

Object

Objeto de error en la nube.

Nombre	Tipo	Description
error	CloudErrorProperties	Propiedades del objeto de error en la nube.

CloudErrorProperties

Object

Propiedades del objeto de error en la nube.

Nombre	Tipo	Description
code	string	Código de error
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

HostPoolUpdateConfigurationProperties

Object

Las configuraciones de una actualización del grupo de hosts.

Nombre	Tipo	Description
deleteOriginalVm	boolean	Si no se va a guardar el disco original. False de forma predeterminada.
logOffDelayMinutes	integer (int32)	Período de gracia antes de cerrar la sesión de los usuarios en minutos.
logOffMessage	string maxLength: 260	Cierre la sesión del mensaje enviado al usuario para el inicio de sesión. El valor predeterminado es una cadena vacía.
maxVmsRemoved	integer (int32) minimum: 1	Número máximo de máquinas virtuales que se van a quitar durante la actualización del grupo de hosts.

SessionHostManagement

Object

Representa una definición sessionHostManagement.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nombre del recurso
properties.scheduledDateTimeZone	string	Zona horaria para las operaciones sessionHostManagement tal como se define en https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Debe establecerse si useLocalTime es true.
properties.update	HostPoolUpdateConfigurationProperties	Parámetros para una actualización del grupo de hosts.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	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 (date-time)	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.

Compartir a través de

Session Host Managements - Create Or Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

SessionHostManagements_Create

Solicitud de ejemplo

Respuesta de muestra

Definiciones

CloudError

CloudErrorProperties

createdByType

HostPoolUpdateConfigurationProperties

SessionHostManagement

systemData