次の方法で共有


HostPool interface

HostPool 定義を表します。

Extends

プロパティ

agentUpdate

エージェント、監視エージェント、スタック コンポーネントを更新するためのセッション ホスト構成。

appAttachPackageReferences

アプリアタッチ パッケージ リンクの一覧。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

applicationGroupReferences

applicationGroup リンクの一覧。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

cloudPcResource

クラウド PC リソースです。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

customRdpProperty

HostPool のカスタム rdp プロパティ。

description

HostPool の説明。

friendlyName

HostPool のフレンドリ名。

hostPoolType

デスクトップ用の HostPool の種類。

loadBalancerType

ロード バランサーの種類。

maxSessionLimit

HostPool の最大セッション制限。

objectId

HostPool の ObjectId。 (内部使用)注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

personalDesktopAssignmentType

HostPool の PersonalDesktopAssignment 型。

preferredAppGroupType

優先するアプリケーション グループの種類 (既定はデスクトップ アプリケーション グループ)

privateEndpointConnections

指定したリソースに関連付けられているプライベート エンドポイント接続の一覧注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

publicNetworkAccess

有効にすると、パブリック ネットワークとプライベート ネットワークの両方からこのリソースにアクセスできます。無効にすると、このリソースはプライベート エンドポイント経由でのみアクセスできます

registrationInfo

HostPool の登録情報。

ring

HostPool のリング番号。

ssoadfsAuthority

WVD SSO 証明書に署名するための顧客 ADFS サーバーへの URL。

ssoClientId

WVD SSO 証明書の発行に使用される登録済み証明書利用者の ClientId。

ssoClientSecretKeyVaultPath

ADFS への通信に使用されるシークレットを格納する Azure KeyVault へのパス。

ssoSecretType

シークレットの種類に対するシングル サインオンの種類。

startVMOnConnect

StartVMOnConnect 機能のオン/オフを切り替えるフラグ。

validationEnvironment

検証環境です。

vmTemplate

hostpool 内の sessionhosts 構成用の VM テンプレート。

継承されたプロパティ

etag

etag フィールドは 必要ありません。 応答本文で指定する場合は、通常の etag 規則に従ってヘッダーとしても指定する必要があります。 エンティティ タグは、同じ要求されたリソースから 2 つ以上のエンティティを比較するために使用されます。 HTTP/1.1 では、etag (セクション 14.19)、If-Match (セクション 14.24)、If-None-Match (セクション 14.26)、および If-Range (セクション 14.27) ヘッダー フィールドのエンティティ タグを使用します。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

id

リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

identity
kind

同じ種類のリソースに対して異なる UX エクスペリエンスをレンダリングするためにポータルやツールなどで使用されるメタデータ。 たとえば、ApiApps は一種の Microsoft.Web/sites 型です。 サポートされている場合、リソース プロバイダーはこの値を検証して保持する必要があります。

location

リソースが存在する地理的な場所

managedBy

このリソースを管理するリソースの完全修飾リソース ID。 このリソースが別の Azure リソースによって管理されているかどうかを示します。 これが存在する場合、完全モードのデプロイでは、別のリソースによって管理されているため、テンプレートから削除された場合、リソースは削除されません。

name

リソースの名前注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

plan
sku
systemData

createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

tags

リソース タグ。

type

リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

プロパティの詳細

agentUpdate

エージェント、監視エージェント、スタック コンポーネントを更新するためのセッション ホスト構成。

agentUpdate?: AgentUpdateProperties

プロパティ値

appAttachPackageReferences

アプリアタッチ パッケージ リンクの一覧。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

appAttachPackageReferences?: string[]

プロパティ値

string[]

applicationGroupReferences

applicationGroup リンクの一覧。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

applicationGroupReferences?: string[]

プロパティ値

string[]

cloudPcResource

クラウド PC リソースです。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

cloudPcResource?: boolean

プロパティ値

boolean

customRdpProperty

HostPool のカスタム rdp プロパティ。

customRdpProperty?: string

プロパティ値

string

description

HostPool の説明。

description?: string

プロパティ値

string

friendlyName

HostPool のフレンドリ名。

friendlyName?: string

プロパティ値

string

hostPoolType

デスクトップ用の HostPool の種類。

hostPoolType: string

プロパティ値

string

loadBalancerType

ロード バランサーの種類。

loadBalancerType: string

プロパティ値

string

maxSessionLimit

HostPool の最大セッション制限。

maxSessionLimit?: number

プロパティ値

number

objectId

HostPool の ObjectId。 (内部使用)注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

objectId?: string

プロパティ値

string

personalDesktopAssignmentType

HostPool の PersonalDesktopAssignment 型。

personalDesktopAssignmentType?: string

プロパティ値

string

preferredAppGroupType

優先するアプリケーション グループの種類 (既定はデスクトップ アプリケーション グループ)

preferredAppGroupType: string

プロパティ値

string

privateEndpointConnections

指定したリソースに関連付けられているプライベート エンドポイント接続の一覧注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

privateEndpointConnections?: PrivateEndpointConnection[]

プロパティ値

publicNetworkAccess

有効にすると、パブリック ネットワークとプライベート ネットワークの両方からこのリソースにアクセスできます。無効にすると、このリソースはプライベート エンドポイント経由でのみアクセスできます

publicNetworkAccess?: string

プロパティ値

string

registrationInfo

HostPool の登録情報。

registrationInfo?: RegistrationInfo

プロパティ値

ring

HostPool のリング番号。

ring?: number

プロパティ値

number

ssoadfsAuthority

WVD SSO 証明書に署名するための顧客 ADFS サーバーへの URL。

ssoadfsAuthority?: string

プロパティ値

string

ssoClientId

WVD SSO 証明書の発行に使用される登録済み証明書利用者の ClientId。

ssoClientId?: string

プロパティ値

string

ssoClientSecretKeyVaultPath

ADFS への通信に使用されるシークレットを格納する Azure KeyVault へのパス。

ssoClientSecretKeyVaultPath?: string

プロパティ値

string

ssoSecretType

シークレットの種類に対するシングル サインオンの種類。

ssoSecretType?: string

プロパティ値

string

startVMOnConnect

StartVMOnConnect 機能のオン/オフを切り替えるフラグ。

startVMOnConnect?: boolean

プロパティ値

boolean

validationEnvironment

検証環境です。

validationEnvironment?: boolean

プロパティ値

boolean

vmTemplate

hostpool 内の sessionhosts 構成用の VM テンプレート。

vmTemplate?: string

プロパティ値

string

継承されたプロパティの詳細

etag

etag フィールドは 必要ありません。 応答本文で指定する場合は、通常の etag 規則に従ってヘッダーとしても指定する必要があります。 エンティティ タグは、同じ要求されたリソースから 2 つ以上のエンティティを比較するために使用されます。 HTTP/1.1 では、etag (セクション 14.19)、If-Match (セクション 14.24)、If-None-Match (セクション 14.26)、および If-Range (セクション 14.27) ヘッダー フィールドのエンティティ タグを使用します。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

etag?: string

プロパティ値

string

resourceModelWithAllowedPropertySet.etagから継承された

id

リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

id?: string

プロパティ値

string

ResourceModelWithAllowedPropertySet.id から継承された

identity

identity?: ResourceModelWithAllowedPropertySetIdentity

プロパティ値

ResourceModelWithAllowedPropertySet.identityから継承

kind

同じ種類のリソースに対して異なる UX エクスペリエンスをレンダリングするためにポータルやツールなどで使用されるメタデータ。 たとえば、ApiApps は一種の Microsoft.Web/sites 型です。 サポートされている場合、リソース プロバイダーはこの値を検証して保持する必要があります。

kind?: string

プロパティ値

string

resourceModelWithAllowedPropertySet.kindから継承された

location

リソースが存在する地理的な場所

location: string

プロパティ値

string

resourceModelWithAllowedPropertySet.locationから継承された

managedBy

このリソースを管理するリソースの完全修飾リソース ID。 このリソースが別の Azure リソースによって管理されているかどうかを示します。 これが存在する場合、完全モードのデプロイでは、別のリソースによって管理されているため、テンプレートから削除された場合、リソースは削除されません。

managedBy?: string

プロパティ値

string

resourceModelWithAllowedPropertySet.managedBy から継承

name

リソースの名前注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

name?: string

プロパティ値

string

ResourceModelWithAllowedPropertySet.name から継承された

plan

plan?: ResourceModelWithAllowedPropertySetPlan

プロパティ値

ResourceModelWithAllowedPropertySet.plan から継承

sku

sku?: ResourceModelWithAllowedPropertySetSku

プロパティ値

ResourceModelWithAllowedPropertySet.sku から継承

systemData

createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

systemData?: SystemData

プロパティ値

resourceModelWithAllowedPropertySet.systemDataから継承された

tags

リソース タグ。

tags?: {[propertyName: string]: string}

プロパティ値

{[propertyName: string]: string}

ResourceModelWithAllowedPropertySet.tags から継承された

type

リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

type?: string

プロパティ値

string

resourceModelWithAllowedPropertySet.typeから継承された