Session Host Provisioning Statuses - Get

Servizio:
Desktop Virtualization
Versione API:
2026-01-01-preview

Ottenere lo stato di provisioning dell'host sessione per un determinato pool di host.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
hostPoolName
 path True

string

minLength: 3
maxLength: 64
pattern: ^[A-Za-z0-9@.\-_ ]*$

Nome del pool di host all'interno del gruppo di risorse specificato
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
subscriptionId
 path True

string (uuid)

ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version
 query True

string

minLength: 1

Versione dell'API da usare per questa operazione.

Risposte

Nome Tipo Descrizione
200 OK

SessionHostManagementProvisioningStatus

L'operazione di Azure è stata completata correttamente.
Other Status Codes

ErrorResponse

Risposta di errore imprevista.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

SessionHostManagements_SessionHostProvisioningStatuses_Get

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
200 
{
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/sessionHostProvisioningStatuses/default",
  "name": "30972f1b-b61d-4fd8-bd34-3dcfa24670f3",
  "status": "Failed",
  "startTime": "2020-10-26T13:45:39.6554616Z",
  "endTime": "2020-10-26T13:45:42.7025301Z",
  "percentComplete": 1,
  "error": {
    "code": "BadArgument",
    "message": "The provided database 'foo' has an invalid username."
  }
}

Definizioni

Nome Descrizione
CanaryPolicy

Criteri per stabilire se è necessario effettuare il provisioning di una macchina virtuale Canary (una singola macchina virtuale per convalidare la configurazione) durante un'operazione di provisioning dell'host sessione.
createdByType

Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail

Dettagli dell'errore.
ErrorResponse

Risposta di errore
FailedSessionHostCleanupPolicySHC

Criterio da applicare quando l'operazione di provisioning dell'host sessione non riesce.
HostPoolUpdateConfigurationProperties

Le configurazioni di un aggiornamento del pool di host.
SessionHostManagement

Schema per le proprietà SessionHostManagement.
SessionHostManagementProvisioningOperationProgress

Informazioni sullo stato di avanzamento dell'operazione di provisioning SessionHostManagement.
SessionHostManagementProvisioningOperationStatus

Stato dell'operazione per SessionHostManagementUpdate.
SessionHostManagementProvisioningStatus

Schema per le proprietà SessionHostManagementUpdateStatus.
SessionHostManagementProvisioningStatusProperties

Contenitore delle proprietà per gli stati di provisioning di sessionHostManagement.
SessionHostProvisioningConfigurationProperties

Configurazione per le operazioni di provisioning dell'host sessione.
systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

CanaryPolicy

Enumerazione

Criteri per stabilire se è necessario effettuare il provisioning di una macchina virtuale Canary (una singola macchina virtuale per convalidare la configurazione) durante un'operazione di provisioning dell'host sessione.

Valore Descrizione
Auto

Decidere in base al servizio se effettuare il provisioning di Canary VM.
Never

Non effettuare mai il provisioning di una macchina virtuale Canary.
Always

Effettuare sempre il provisioning di una macchina virtuale Canary.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore Descrizione
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.
type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.
code

string

Codice di errore.
details

ErrorDetail[]

Dettagli dell'errore.
message

string

Messaggio di errore.
target

string

Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

FailedSessionHostCleanupPolicySHC

Enumerazione

Criterio da applicare quando l'operazione di provisioning dell'host sessione non riesce.

Valore Descrizione
KeepAll

Mantieni tutto.
KeepOne

Tienine uno.
KeepNone

Mantenere Nessuno.

HostPoolUpdateConfigurationProperties

Oggetto

Le configurazioni di un aggiornamento del pool di host.

Nome Tipo Descrizione
deleteOriginalVm

boolean

Se non salvare il disco originale. False per impostazione predefinita.
logOffDelayMinutes

integer (int32)

Periodo di tolleranza prima di disconnettere gli utenti in pochi minuti.
logOffMessage

string

maxLength: 260

Messaggio di disconnessione inviato all'utente per la disconnessione. Il valore predefinito è una stringa vuota.
maxVmsRemoved

integer (int32)

minimum: 1

Il numero massimo di macchine virtuali da rimuovere durante l'aggiornamento dell'hostpool.

SessionHostManagement

Oggetto

Schema per le proprietà SessionHostManagement.

Nome Tipo Descrizione
id

string (arm-id)

ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

Nome della risorsa
properties.failedSessionHostCleanupPolicy

FailedSessionHostCleanupPolicySHC

Criterio da applicare quando l'operazione di provisioning dell'host sessione non riesce.
properties.provisioning

SessionHostProvisioningConfigurationProperties

Parametri che si applicano quando viene effettuato il provisioning degli host di sessione.
properties.scheduledDateTimeZone

string

Fuso orario per le operazioni sessionHostManagement come definito in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Deve essere impostato se useLocalTime è true.
properties.update

HostPoolUpdateConfigurationProperties

Parametri per un aggiornamento del pool di host.
systemData

systemData

Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
type

string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SessionHostManagementProvisioningOperationProgress

Oggetto

Informazioni sullo stato di avanzamento dell'operazione di provisioning SessionHostManagement.

Nome Tipo Descrizione
executionStartTime

string (date-time)

Ora in cui è stata creata l'operazione sessionHostManagement.
finalSessionHostsCount

integer (int32)

Conteggio finale delle istanze del pool di host per l'operazione di provisioning.
initialSessionHostsCount

integer (int32)

Numero iniziale di istanze del pool di host per l'operazione di provisioning.
sessionHostsCompleted

integer (int32)

Numero di sessionHosts completati nell'operazione di provisioning sessionHostManagement.
sessionHostsInProgress

integer (int32)

Numero di sessionHosts in corso nell'operazione di provisioning sessionHostManagement

SessionHostManagementProvisioningOperationStatus

Enumerazione

Stato dell'operazione per SessionHostManagementUpdate.

Valore Descrizione
Scheduled

L'operazione è programmata.
ValidatingSessionHostProvisioning

L'operazione sta attualmente convalidando il provisioning.
Cancelling

Annullamento dell'operazione.
ProvisioningSessionHosts

L'operazione sta attualmente effettuando il provisioning degli host di sessione.
Succeeded

L'operazione è stata completata.
Failed

Operazione non riuscita.
Canceled

L'operazione viene annullata.

SessionHostManagementProvisioningStatus

Oggetto

Schema per le proprietà SessionHostManagementUpdateStatus.

Nome Tipo Descrizione
endTime

string (date-time)

Ora di fine dell'operazione.
error

ErrorDetail

Se presente, i dettagli dell'errore dell'operazione.
id

string (arm-id)

ID completo per l'operazione asincrona.
name

string

Nome dell'operazione asincrona.
percentComplete

number (double)

minimum: 0
maximum: 100

Percentuale dell'operazione completata.
properties

SessionHostManagementProvisioningStatusProperties

Le proprietà personalizzate dello stato del provisioning SessionHost.
startTime

string (date-time)

Ora di inizio dell'operazione.
status

SessionHostManagementProvisioningOperationStatus

Stato dell'operazione.

SessionHostManagementProvisioningStatusProperties

Oggetto

Contenitore delle proprietà per gli stati di provisioning di sessionHostManagement.

Nome Tipo Descrizione
correlationId

string

ID di correlazione per Log Analytics.
progress

SessionHostManagementProvisioningOperationProgress

Informazioni sullo stato di avanzamento dell'operazione sessionHostManagement.
scheduledDateTime

string (date-time)

Il timestamp per il quale è pianificato l'aggiornamento.
sessionHostManagement

SessionHostManagement

Proprietà SessionHostManagement utilizzate per l'operazione.

SessionHostProvisioningConfigurationProperties

Oggetto

Configurazione per le operazioni di provisioning dell'host sessione.

Nome Tipo Descrizione
canaryPolicy

CanaryPolicy

Criteri per stabilire se è necessario effettuare il provisioning di una macchina virtuale Canary (una singola macchina virtuale per convalidare la configurazione) durante un'operazione di provisioning dell'host sessione.
instanceCount

integer (int32)

minimum: 1

Numero di host di sessione presenti nel pool di host.
setDrainMode

boolean

Se l'host della sessione deve essere impostato in modalità di svuotamento dopo il provisioning.

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome Tipo Descrizione
createdAt

string (date-time)

Timestamp della creazione della risorsa (UTC).
createdBy

string

Identità che ha creato la risorsa.
createdByType

createdByType

Tipo di identità che ha creato la risorsa.
lastModifiedAt

string (date-time)

Il timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy

string

Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType

createdByType

Tipo di identità che ha modificato l'ultima volta la risorsa.