Session Host Configurations - Get

Referenz

Dienst:: Desktop Virtualization

API-Version:: 2024-11-01-preview

Rufen Sie eine SessionHostConfiguration ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
hostPoolName	path	True	string minLength: 1 maxLength: 255 pattern: ^[A-Za-z0-9@.\-_ ]*$	Der Name des Hostpools innerhalb der angegebenen Ressourcengruppe
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	SessionHostConfiguration	SessionHostConfiguration wurde erfolgreich abgerufen.
Other Status Codes	CloudError	Automatisierungsfehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

SessionHostConfigurations_Get

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "name": "default",
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default",
  "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "version": "2022-10-21T17:18:19.1234567Z",
    "friendlyName": "InitialConfiguration",
    "provisioningState": "Provisioning",
    "vmTags": {
      "Department": "myDepartment",
      "Team": "myTeam"
    },
    "vmLocation": "eastus2",
    "vmResourceGroup": "myResourceGroup",
    "vmNamePrefix": "westus2-vm",
    "availabilityZones": [
      1,
      3
    ],
    "networkInfo": {
      "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1",
      "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1"
    },
    "vmSizeId": "Standard_D2s_v3",
    "diskInfo": {
      "type": "Standard_LRS"
    },
    "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file",
    "imageInfo": {
      "type": "Marketplace",
      "marketplaceInfo": {
        "offer": "Windows-10",
        "publisher": "MicrosoftWindowsDesktop",
        "sku": "19h2-ent",
        "exactVersion": "2019.0.20190115"
      },
      "customInfo": {
        "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName"
      }
    },
    "domainInfo": {
      "joinType": "ActiveDirectory",
      "activeDirectoryInfo": {
        "domainCredentials": {
          "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername",
          "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname"
        },
        "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com",
        "domainName": "wvdarmtest1.net"
      },
      "azureActiveDirectoryInfo": {
        "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa"
      }
    },
    "securityInfo": {
      "type": "TrustedLaunch",
      "secureBootEnabled": true,
      "vTpmEnabled": true
    },
    "vmAdminCredentials": {
      "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername",
      "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname"
    },
    "bootDiagnosticsInfo": {
      "enabled": true,
      "storageUri": "https://myStorageAccountName.blob.core.windows.net"
    }
  }
}

Definitionen

Name	Beschreibung
ActiveDirectoryInfoProperties	Active Directory-Informationen. Nur eins sollte basierend auf dem Verknüpfungstyp aufgefüllt werden.
AzureActiveDirectoryInfoProperties	Azure Active Directory-Informationen. Nur eins sollte basierend auf dem Verknüpfungstyp aufgefüllt werden.
BootDiagnosticsInfoProperties	Die Startdiagnose ist ein Debugfeature, mit dem Sie die Konsolenausgabe und den Screenshot anzeigen können, um den VM-Status zu diagnostizieren. Sie können die Ausgabe ihres Konsolenprotokolls ganz einfach anzeigen. Azure ermöglicht ihnen auch das Anzeigen eines Screenshots des virtuellen Computers vom Hypervisor.
CloudError	Cloudfehlerobjekt.
CloudErrorProperties	Eigenschaften des Cloudfehlerobjekts.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
CustomInfoProperties	Benutzerdefinierte Bildinformationen.
DiskInfoProperties	Datenträgerinformationen.
DomainInfoProperties	Domänenkonfigurationen von Sitzungshosts.
DomainJoinType	Der Typ des Domänenbeitritts, der vom virtuellen Computer ausgeführt wird.
ImageInfoProperties	Bildkonfigurationen des Sitzungshosts in einem HostPool.
KeyVaultCredentialsProperties	Im Keyvault gespeicherte Anmeldeinformationen.
MarketplaceInfoProperties	Marketplace-Bildinformationen.
NetworkInfoProperties	Netzwerkinformationen.
ProvisioningStateSHC	Bereitstellungsstatus der Sitzungshostkonfiguration.
SecurityInfoProperties	Sicherheitsinformationen.
SessionHostConfiguration	Stellt eine SessionHostConfiguration-Definition dar.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
type	Der Typ der Bildsitzungshosts, die im Hostpool verwendet werden.
VirtualMachineDiskType	Der Datenträgertyp, der vom virtuellen Computer im Hostpoolsitzungshost verwendet wird.
VirtualMachineSecurityType	Der sicherheitstyp, der vom virtuellen Computer im Hostpoolsitzungshost verwendet wird. Der Standardwert ist "Standard".

ActiveDirectoryInfoProperties

Objekt

Active Directory-Informationen. Nur eins sollte basierend auf dem Verknüpfungstyp aufgefüllt werden.

Name	Typ	Beschreibung
domainCredentials	KeyVaultCredentialsProperties	Zum Erstellen des virtuellen Computers erforderliche Anmeldeinformationen.
domainName	string	Die Domäne eines virtuellen Computers, der mit einem Hostpool verbunden ist, wird verknüpft.
ouPath	string	Der Organisationseinheitspfad(OU).

AzureActiveDirectoryInfoProperties

Objekt

Azure Active Directory-Informationen. Nur eins sollte basierend auf dem Verknüpfungstyp aufgefüllt werden.

Name	Typ	Beschreibung
mdmProviderGuid	string	Die GUID (Mobile Device Management, MDM).

BootDiagnosticsInfoProperties

Objekt

Die Startdiagnose ist ein Debugfeature, mit dem Sie die Konsolenausgabe und den Screenshot anzeigen können, um den VM-Status zu diagnostizieren.

Sie können die Ausgabe ihres Konsolenprotokolls ganz einfach anzeigen.

Azure ermöglicht ihnen auch das Anzeigen eines Screenshots des virtuellen Computers vom Hypervisor.

Name	Typ	Beschreibung
enabled	boolean	Gibt an, ob die Startdiagnose auf dem virtuellen Computer aktiviert werden soll.
storageUri	string (uri)	URI des Speicherkontos, das zum Platzieren der Konsolenausgabe und des Screenshots verwendet werden soll. Wenn "storageUri" beim Aktivieren der Startdiagnose nicht angegeben wird, wird verwalteter Speicher verwendet.

CloudError

Objekt

Cloudfehlerobjekt.

Name	Typ	Beschreibung
error	CloudErrorProperties	Eigenschaften des Cloudfehlerobjekts.

CloudErrorProperties

Objekt

Eigenschaften des Cloudfehlerobjekts.

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

CustomInfoProperties

Objekt

Benutzerdefinierte Bildinformationen.

Name	Typ	Beschreibung
resourceId	string (arm-id)	Die Ressourcen-ID des benutzerdefinierten Bilds.

DiskInfoProperties

Objekt

Datenträgerinformationen.

Name	Typ	Beschreibung
type	VirtualMachineDiskType	Der Datenträgertyp, der vom virtuellen Computer im Hostpoolsitzungshost verwendet wird.

DomainInfoProperties

Objekt

Domänenkonfigurationen von Sitzungshosts.

Name	Typ	Beschreibung
activeDirectoryInfo	ActiveDirectoryInfoProperties	Active Directory-Informationen. Nur eins sollte basierend auf dem Verknüpfungstyp aufgefüllt werden.
azureActiveDirectoryInfo	AzureActiveDirectoryInfoProperties	Azure Active Directory-Informationen. Nur eins sollte basierend auf dem Verknüpfungstyp aufgefüllt werden.
joinType	DomainJoinType	Der Typ des Domänenbeitritts, der vom virtuellen Computer ausgeführt wird.

DomainJoinType

Enumeration

Der Typ des Domänenbeitritts, der vom virtuellen Computer ausgeführt wird.

Wert	Beschreibung
ActiveDirectory	Verwenden von Microsoft Active Directory.
AzureActiveDirectory	Verwenden von Microsoft Azure Active Directory.

ImageInfoProperties

Objekt

Bildkonfigurationen des Sitzungshosts in einem HostPool.

Name	Typ	Beschreibung
customInfo	CustomInfoProperties	Die Werte, die ein benutzerdefiniertes Bild eindeutig identifizieren sollen. Nur eins sollte basierend auf dem Bildtyp aufgefüllt werden.
marketplaceInfo	MarketplaceInfoProperties	Die Werte, um ein Marketplace-Image eindeutig zu identifizieren. Nur eins sollte basierend auf dem Bildtyp aufgefüllt werden.
type	type	Der Typ der Bildsitzungshosts, die im Hostpool verwendet werden.

KeyVaultCredentialsProperties

Objekt

Im Keyvault gespeicherte Anmeldeinformationen.

Name	Typ	Beschreibung
passwordKeyVaultSecretUri	string (uri)	Der URI für den Zugriff auf den geheimen Schlüssel, in dem das Kennwort gespeichert ist.
usernameKeyVaultSecretUri	string (uri)	Der URI für den Zugriff auf den geheimen Schlüssel, in dem der Benutzername gespeichert ist.

MarketplaceInfoProperties

Objekt

Marketplace-Bildinformationen.

Name	Typ	Beschreibung
exactVersion	string	Die genaue Version des Bilds.
offer	string	Das Angebot des Bilds.
publisher	string	Der Herausgeber des Bilds.
sku	string	Die Sku des Bilds.

NetworkInfoProperties

Objekt

Netzwerkinformationen.

Name	Typ	Beschreibung
securityGroupId	string	Die Ressourcen-ID der Sicherheitsgruppe. Alle zulässigen/offenen Ports sollten in der Netzwerksicherheitsgruppe (Network Security Group, NSG) angegeben werden.
subnetId	string (arm-id)	Die Ressourcen-ID des Subnetzes.

ProvisioningStateSHC

Enumeration

Bereitstellungsstatus der Sitzungshostkonfiguration.

Wert	Beschreibung
Canceled
Failed
Provisioning
Succeeded

SecurityInfoProperties

Objekt

Sicherheitsinformationen.

Name	Typ	Standardwert	Beschreibung
secureBootEnabled	boolean		Gibt an, ob secureBoot auf dem virtuellen Computer verwendet werden soll.
type	VirtualMachineSecurityType	Standard	Der sicherheitstyp, der vom virtuellen Computer im Hostpoolsitzungshost verwendet wird. Der Standardwert ist "Standard".
vTpmEnabled	boolean		Gibt an, ob vTPM auf dem virtuellen Computer verwendet werden soll.

SessionHostConfiguration

Objekt

Stellt eine SessionHostConfiguration-Definition dar.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.availabilityZones	integer[] (int32)	Wert für Verfügbarkeitszonen, die vom Sitzungshost verwendet werden sollen. Sollte von [1,2,3] sein.
properties.bootDiagnosticsInfo	BootDiagnosticsInfoProperties	Informationen zur Startdiagnose.
properties.customConfigurationScriptUrl	string (uri)	Der URI für den Speicher-BLOB, der die Armvorlage enthält, die nach der Bereitstellung auf dem virtuellen Computer ausgeführt werden soll.
properties.diskInfo	DiskInfoProperties	Datenträgerinformationen.
properties.domainInfo	DomainInfoProperties	Domänenkonfigurationen von Sitzungshosts.
properties.friendlyName	string maxLength: 260	Anzeigename zur Beschreibung dieser Version von SessionHostConfiguration.
properties.imageInfo	ImageInfoProperties	Bildkonfigurationen von HostPool.
properties.networkInfo	NetworkInfoProperties	Netzwerkinformationen.
properties.provisioningState	ProvisioningStateSHC	Bereitstellungsstatus der Sitzungshostkonfiguration.
properties.securityInfo	SecurityInfoProperties	Sicherheitsinformationen.
properties.version	string (date-time)	Der Zeitstempel der letzten Aktualisierung.
properties.vmAdminCredentials	KeyVaultCredentialsProperties	Lokale Administratoranmeldeinformationen für Sitzungshosts.
properties.vmLocation	string	Der Speicherort für den Sitzungshost, in dem erstellt werden soll. Wenn nicht angegeben, wird standardmäßig der Speicherort des Hostpools verwendet.
properties.vmNamePrefix	string maxLength: 11	Das Präfix, das sitzungshostnamen zugeordnet werden soll
properties.vmResourceGroup	string	Die ResourceGroup für die Sitzungshosts, in der erstellt werden soll. Wenn nicht angegeben, wird standardmäßig die ResourceGroup des Hostpools verwendet.
properties.vmSizeId	string	Die ID der Größe eines virtuellen Computers, der mit einem Hostpool verbunden ist. Beispiel: Standard_D2as_v6
properties.vmTags	object	Hashtabelle, in der Schlüssel-Wert-Paartags aufgelistet werden, die auf die virtuellen Computer angewendet werden sollen
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

type

Enumeration

Der Typ der Bildsitzungshosts, die im Hostpool verwendet werden.

Wert	Beschreibung
Custom	Verwenden eines benutzerdefinierten Bilds.
Marketplace	Verwenden von standardmäßigen Marketplace-Images, die von Azure Marketplace angeboten werden.

VirtualMachineDiskType

Enumeration

Der Datenträgertyp, der vom virtuellen Computer im Hostpoolsitzungshost verwendet wird.

Wert	Beschreibung
Premium_LRS	Premium SSD lokal redundanter Speicher. Am besten geeignet für produktions- und leistungsabhängige Arbeitsauslastungen.
StandardSSD_LRS	Standard-SSD lokal redundanter Speicher. Am besten geeignet für Webserver, leicht verwendete Unternehmensanwendungen und Dev/Test.
Standard_LRS	Standard-HDD lokal redundanter Speicher. Am besten geeignet für backup, nicht kritisch und seltenen Zugriff.

VirtualMachineSecurityType

Enumeration

Der sicherheitstyp, der vom virtuellen Computer im Hostpoolsitzungshost verwendet wird. Der Standardwert ist "Standard".

Wert	Beschreibung
ConfidentialVM	Sicherheitsprotokoll für vertrauliche virtuelle Computer
Standard	Standardsicherheitsprotokoll. Keine zusätzlichen Parameter
TrustedLaunch	TrustedLaunch ermöglicht den sicheren Start und vTPM

Freigeben über

Session Host Configurations - Get

URI-Parameter

Antworten

Beispiele

SessionHostConfigurations_Get

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ActiveDirectoryInfoProperties

AzureActiveDirectoryInfoProperties

BootDiagnosticsInfoProperties

CloudError

CloudErrorProperties

createdByType

CustomInfoProperties

DiskInfoProperties

DomainInfoProperties

DomainJoinType

ImageInfoProperties

KeyVaultCredentialsProperties

MarketplaceInfoProperties

NetworkInfoProperties

ProvisioningStateSHC

SecurityInfoProperties

SessionHostConfiguration

systemData

type

VirtualMachineDiskType

VirtualMachineSecurityType