com.azure.resourcemanager.desktopvirtualization.models.HostPool Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-desktopvirtualization Show documentation
Show all versions of azure-resourcemanager-desktopvirtualization Show documentation
This package contains Microsoft Azure SDK for DesktopVirtualization Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. Package tag package-2024-04.
The newest version!
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.
package com.azure.resourcemanager.desktopvirtualization.models;
import com.azure.core.http.rest.Response;
import com.azure.core.management.Region;
import com.azure.core.management.SystemData;
import com.azure.core.util.Context;
import com.azure.resourcemanager.desktopvirtualization.fluent.models.HostPoolInner;
import com.azure.resourcemanager.desktopvirtualization.fluent.models.RegistrationInfoInner;
import java.util.List;
import java.util.Map;
/**
* An immutable client-side representation of HostPool.
*/
public interface HostPool {
/**
* Gets the id property: Fully qualified resource Id for the resource.
*
* @return the id value.
*/
String id();
/**
* Gets the name property: The name of the resource.
*
* @return the name value.
*/
String name();
/**
* Gets the type property: The type of the resource.
*
* @return the type value.
*/
String type();
/**
* Gets the location property: The geo-location where the resource lives.
*
* @return the location value.
*/
String location();
/**
* Gets the tags property: Resource tags.
*
* @return the tags value.
*/
Map tags();
/**
* Gets the managedBy property: The fully qualified resource ID of the resource that manages this resource.
* Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment
* will not delete the resource if it is removed from the template since it is managed by another resource.
*
* @return the managedBy value.
*/
String managedBy();
/**
* Gets the kind property: Metadata used by portal/tooling/etc to render different UX experiences for resources of
* the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must
* validate and persist this value.
*
* @return the kind value.
*/
String kind();
/**
* Gets the etag property: The etag field is *not* required. If it is provided in the response body, it must also be
* provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from
* the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24),
* If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
*
* @return the etag value.
*/
String etag();
/**
* Gets the identity property: The identity property.
*
* @return the identity value.
*/
ResourceModelWithAllowedPropertySetIdentity identity();
/**
* Gets the sku property: The sku property.
*
* @return the sku value.
*/
ResourceModelWithAllowedPropertySetSku sku();
/**
* Gets the plan property: The plan property.
*
* @return the plan value.
*/
ResourceModelWithAllowedPropertySetPlan plan();
/**
* Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
*
* @return the systemData value.
*/
SystemData systemData();
/**
* Gets the objectId property: ObjectId of HostPool. (internal use).
*
* @return the objectId value.
*/
String objectId();
/**
* Gets the friendlyName property: Friendly name of HostPool.
*
* @return the friendlyName value.
*/
String friendlyName();
/**
* Gets the description property: Description of HostPool.
*
* @return the description value.
*/
String description();
/**
* Gets the hostPoolType property: HostPool type for desktop.
*
* @return the hostPoolType value.
*/
HostPoolType hostPoolType();
/**
* Gets the personalDesktopAssignmentType property: PersonalDesktopAssignment type for HostPool.
*
* @return the personalDesktopAssignmentType value.
*/
PersonalDesktopAssignmentType personalDesktopAssignmentType();
/**
* Gets the customRdpProperty property: Custom rdp property of HostPool.
*
* @return the customRdpProperty value.
*/
String customRdpProperty();
/**
* Gets the maxSessionLimit property: The max session limit of HostPool.
*
* @return the maxSessionLimit value.
*/
Integer maxSessionLimit();
/**
* Gets the loadBalancerType property: The type of the load balancer.
*
* @return the loadBalancerType value.
*/
LoadBalancerType loadBalancerType();
/**
* Gets the ring property: The ring number of HostPool.
*
* @return the ring value.
*/
Integer ring();
/**
* Gets the validationEnvironment property: Is validation environment.
*
* @return the validationEnvironment value.
*/
Boolean validationEnvironment();
/**
* Gets the registrationInfo property: The registration info of HostPool.
*
* @return the registrationInfo value.
*/
RegistrationInfo registrationInfo();
/**
* Gets the vmTemplate property: VM template for sessionhosts configuration within hostpool.
*
* @return the vmTemplate value.
*/
String vmTemplate();
/**
* Gets the applicationGroupReferences property: List of applicationGroup links.
*
* @return the applicationGroupReferences value.
*/
List applicationGroupReferences();
/**
* Gets the appAttachPackageReferences property: List of App Attach Package links.
*
* @return the appAttachPackageReferences value.
*/
List appAttachPackageReferences();
/**
* Gets the ssoadfsAuthority property: URL to customer ADFS server for signing WVD SSO certificates.
*
* @return the ssoadfsAuthority value.
*/
String ssoadfsAuthority();
/**
* Gets the ssoClientId property: ClientId for the registered Relying Party used to issue WVD SSO certificates.
*
* @return the ssoClientId value.
*/
String ssoClientId();
/**
* Gets the ssoClientSecretKeyVaultPath property: Path to Azure KeyVault storing the secret used for communication
* to ADFS.
*
* @return the ssoClientSecretKeyVaultPath value.
*/
String ssoClientSecretKeyVaultPath();
/**
* Gets the ssoSecretType property: The type of single sign on Secret Type.
*
* @return the ssoSecretType value.
*/
SsoSecretType ssoSecretType();
/**
* Gets the preferredAppGroupType property: The type of preferred application group type, default to Desktop
* Application Group.
*
* @return the preferredAppGroupType value.
*/
PreferredAppGroupType preferredAppGroupType();
/**
* Gets the startVMOnConnect property: The flag to turn on/off StartVMOnConnect feature.
*
* @return the startVMOnConnect value.
*/
Boolean startVMOnConnect();
/**
* Gets the cloudPcResource property: Is cloud pc resource.
*
* @return the cloudPcResource value.
*/
Boolean cloudPcResource();
/**
* Gets the publicNetworkAccess property: Enabled allows this resource to be accessed from both public and private
* networks, Disabled allows this resource to only be accessed via private endpoints.
*
* @return the publicNetworkAccess value.
*/
HostpoolPublicNetworkAccess publicNetworkAccess();
/**
* Gets the agentUpdate property: The session host configuration for updating agent, monitoring agent, and stack
* component.
*
* @return the agentUpdate value.
*/
AgentUpdateProperties agentUpdate();
/**
* Gets the privateEndpointConnections property: List of private endpoint connection associated with the specified
* resource.
*
* @return the privateEndpointConnections value.
*/
List privateEndpointConnections();
/**
* Gets the region of the resource.
*
* @return the region of the resource.
*/
Region region();
/**
* Gets the name of the resource region.
*
* @return the name of the resource region.
*/
String regionName();
/**
* Gets the name of the resource group.
*
* @return the name of the resource group.
*/
String resourceGroupName();
/**
* Gets the inner com.azure.resourcemanager.desktopvirtualization.fluent.models.HostPoolInner object.
*
* @return the inner object.
*/
HostPoolInner innerModel();
/**
* The entirety of the HostPool definition.
*/
interface Definition extends DefinitionStages.Blank, DefinitionStages.WithLocation,
DefinitionStages.WithResourceGroup, DefinitionStages.WithHostPoolType, DefinitionStages.WithLoadBalancerType,
DefinitionStages.WithPreferredAppGroupType, DefinitionStages.WithCreate {
}
/**
* The HostPool definition stages.
*/
interface DefinitionStages {
/**
* The first stage of the HostPool definition.
*/
interface Blank extends WithLocation {
}
/**
* The stage of the HostPool definition allowing to specify location.
*/
interface WithLocation {
/**
* Specifies the region for the resource.
*
* @param location The geo-location where the resource lives.
* @return the next definition stage.
*/
WithResourceGroup withRegion(Region location);
/**
* Specifies the region for the resource.
*
* @param location The geo-location where the resource lives.
* @return the next definition stage.
*/
WithResourceGroup withRegion(String location);
}
/**
* The stage of the HostPool definition allowing to specify parent resource.
*/
interface WithResourceGroup {
/**
* Specifies resourceGroupName.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @return the next definition stage.
*/
WithHostPoolType withExistingResourceGroup(String resourceGroupName);
}
/**
* The stage of the HostPool definition allowing to specify hostPoolType.
*/
interface WithHostPoolType {
/**
* Specifies the hostPoolType property: HostPool type for desktop..
*
* @param hostPoolType HostPool type for desktop.
* @return the next definition stage.
*/
WithLoadBalancerType withHostPoolType(HostPoolType hostPoolType);
}
/**
* The stage of the HostPool definition allowing to specify loadBalancerType.
*/
interface WithLoadBalancerType {
/**
* Specifies the loadBalancerType property: The type of the load balancer..
*
* @param loadBalancerType The type of the load balancer.
* @return the next definition stage.
*/
WithPreferredAppGroupType withLoadBalancerType(LoadBalancerType loadBalancerType);
}
/**
* The stage of the HostPool definition allowing to specify preferredAppGroupType.
*/
interface WithPreferredAppGroupType {
/**
* Specifies the preferredAppGroupType property: The type of preferred application group type, default to
* Desktop Application Group.
*
* @param preferredAppGroupType The type of preferred application group type, default to Desktop Application
* Group.
* @return the next definition stage.
*/
WithCreate withPreferredAppGroupType(PreferredAppGroupType preferredAppGroupType);
}
/**
* The stage of the HostPool definition which contains all the minimum required properties for the resource to
* be created, but also allows for any other optional properties to be specified.
*/
interface WithCreate extends DefinitionStages.WithTags, DefinitionStages.WithManagedBy,
DefinitionStages.WithKind, DefinitionStages.WithIdentity, DefinitionStages.WithSku,
DefinitionStages.WithPlan, DefinitionStages.WithFriendlyName, DefinitionStages.WithDescription,
DefinitionStages.WithPersonalDesktopAssignmentType, DefinitionStages.WithCustomRdpProperty,
DefinitionStages.WithMaxSessionLimit, DefinitionStages.WithRing, DefinitionStages.WithValidationEnvironment,
DefinitionStages.WithRegistrationInfo, DefinitionStages.WithVmTemplate,
DefinitionStages.WithSsoadfsAuthority, DefinitionStages.WithSsoClientId,
DefinitionStages.WithSsoClientSecretKeyVaultPath, DefinitionStages.WithSsoSecretType,
DefinitionStages.WithStartVMOnConnect, DefinitionStages.WithPublicNetworkAccess,
DefinitionStages.WithAgentUpdate {
/**
* Executes the create request.
*
* @return the created resource.
*/
HostPool create();
/**
* Executes the create request.
*
* @param context The context to associate with this operation.
* @return the created resource.
*/
HostPool create(Context context);
}
/**
* The stage of the HostPool definition allowing to specify tags.
*/
interface WithTags {
/**
* Specifies the tags property: Resource tags..
*
* @param tags Resource tags.
* @return the next definition stage.
*/
WithCreate withTags(Map tags);
}
/**
* The stage of the HostPool definition allowing to specify managedBy.
*/
interface WithManagedBy {
/**
* Specifies the managedBy property: The fully qualified resource ID of the resource that manages this
* resource. Indicates if this resource is managed by another Azure resource. If this is present, complete
* mode deployment will not delete the resource if it is removed from the template since it is managed by
* another resource..
*
* @param managedBy The fully qualified resource ID of the resource that manages this resource. Indicates if
* this resource is managed by another Azure resource. If this is present, complete mode deployment will not
* delete the resource if it is removed from the template since it is managed by another resource.
* @return the next definition stage.
*/
WithCreate withManagedBy(String managedBy);
}
/**
* The stage of the HostPool definition allowing to specify kind.
*/
interface WithKind {
/**
* Specifies the kind property: Metadata used by portal/tooling/etc to render different UX experiences for
* resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the
* resource provider must validate and persist this value..
*
* @param kind Metadata used by portal/tooling/etc to render different UX experiences for resources of the
* same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must
* validate and persist this value.
* @return the next definition stage.
*/
WithCreate withKind(String kind);
}
/**
* The stage of the HostPool definition allowing to specify identity.
*/
interface WithIdentity {
/**
* Specifies the identity property: The identity property..
*
* @param identity The identity property.
* @return the next definition stage.
*/
WithCreate withIdentity(ResourceModelWithAllowedPropertySetIdentity identity);
}
/**
* The stage of the HostPool definition allowing to specify sku.
*/
interface WithSku {
/**
* Specifies the sku property: The sku property..
*
* @param sku The sku property.
* @return the next definition stage.
*/
WithCreate withSku(ResourceModelWithAllowedPropertySetSku sku);
}
/**
* The stage of the HostPool definition allowing to specify plan.
*/
interface WithPlan {
/**
* Specifies the plan property: The plan property..
*
* @param plan The plan property.
* @return the next definition stage.
*/
WithCreate withPlan(ResourceModelWithAllowedPropertySetPlan plan);
}
/**
* The stage of the HostPool definition allowing to specify friendlyName.
*/
interface WithFriendlyName {
/**
* Specifies the friendlyName property: Friendly name of HostPool..
*
* @param friendlyName Friendly name of HostPool.
* @return the next definition stage.
*/
WithCreate withFriendlyName(String friendlyName);
}
/**
* The stage of the HostPool definition allowing to specify description.
*/
interface WithDescription {
/**
* Specifies the description property: Description of HostPool..
*
* @param description Description of HostPool.
* @return the next definition stage.
*/
WithCreate withDescription(String description);
}
/**
* The stage of the HostPool definition allowing to specify personalDesktopAssignmentType.
*/
interface WithPersonalDesktopAssignmentType {
/**
* Specifies the personalDesktopAssignmentType property: PersonalDesktopAssignment type for HostPool..
*
* @param personalDesktopAssignmentType PersonalDesktopAssignment type for HostPool.
* @return the next definition stage.
*/
WithCreate withPersonalDesktopAssignmentType(PersonalDesktopAssignmentType personalDesktopAssignmentType);
}
/**
* The stage of the HostPool definition allowing to specify customRdpProperty.
*/
interface WithCustomRdpProperty {
/**
* Specifies the customRdpProperty property: Custom rdp property of HostPool..
*
* @param customRdpProperty Custom rdp property of HostPool.
* @return the next definition stage.
*/
WithCreate withCustomRdpProperty(String customRdpProperty);
}
/**
* The stage of the HostPool definition allowing to specify maxSessionLimit.
*/
interface WithMaxSessionLimit {
/**
* Specifies the maxSessionLimit property: The max session limit of HostPool..
*
* @param maxSessionLimit The max session limit of HostPool.
* @return the next definition stage.
*/
WithCreate withMaxSessionLimit(Integer maxSessionLimit);
}
/**
* The stage of the HostPool definition allowing to specify ring.
*/
interface WithRing {
/**
* Specifies the ring property: The ring number of HostPool..
*
* @param ring The ring number of HostPool.
* @return the next definition stage.
*/
WithCreate withRing(Integer ring);
}
/**
* The stage of the HostPool definition allowing to specify validationEnvironment.
*/
interface WithValidationEnvironment {
/**
* Specifies the validationEnvironment property: Is validation environment..
*
* @param validationEnvironment Is validation environment.
* @return the next definition stage.
*/
WithCreate withValidationEnvironment(Boolean validationEnvironment);
}
/**
* The stage of the HostPool definition allowing to specify registrationInfo.
*/
interface WithRegistrationInfo {
/**
* Specifies the registrationInfo property: The registration info of HostPool..
*
* @param registrationInfo The registration info of HostPool.
* @return the next definition stage.
*/
WithCreate withRegistrationInfo(RegistrationInfoInner registrationInfo);
}
/**
* The stage of the HostPool definition allowing to specify vmTemplate.
*/
interface WithVmTemplate {
/**
* Specifies the vmTemplate property: VM template for sessionhosts configuration within hostpool..
*
* @param vmTemplate VM template for sessionhosts configuration within hostpool.
* @return the next definition stage.
*/
WithCreate withVmTemplate(String vmTemplate);
}
/**
* The stage of the HostPool definition allowing to specify ssoadfsAuthority.
*/
interface WithSsoadfsAuthority {
/**
* Specifies the ssoadfsAuthority property: URL to customer ADFS server for signing WVD SSO certificates..
*
* @param ssoadfsAuthority URL to customer ADFS server for signing WVD SSO certificates.
* @return the next definition stage.
*/
WithCreate withSsoadfsAuthority(String ssoadfsAuthority);
}
/**
* The stage of the HostPool definition allowing to specify ssoClientId.
*/
interface WithSsoClientId {
/**
* Specifies the ssoClientId property: ClientId for the registered Relying Party used to issue WVD SSO
* certificates..
*
* @param ssoClientId ClientId for the registered Relying Party used to issue WVD SSO certificates.
* @return the next definition stage.
*/
WithCreate withSsoClientId(String ssoClientId);
}
/**
* The stage of the HostPool definition allowing to specify ssoClientSecretKeyVaultPath.
*/
interface WithSsoClientSecretKeyVaultPath {
/**
* Specifies the ssoClientSecretKeyVaultPath property: Path to Azure KeyVault storing the secret used for
* communication to ADFS..
*
* @param ssoClientSecretKeyVaultPath Path to Azure KeyVault storing the secret used for communication to
* ADFS.
* @return the next definition stage.
*/
WithCreate withSsoClientSecretKeyVaultPath(String ssoClientSecretKeyVaultPath);
}
/**
* The stage of the HostPool definition allowing to specify ssoSecretType.
*/
interface WithSsoSecretType {
/**
* Specifies the ssoSecretType property: The type of single sign on Secret Type..
*
* @param ssoSecretType The type of single sign on Secret Type.
* @return the next definition stage.
*/
WithCreate withSsoSecretType(SsoSecretType ssoSecretType);
}
/**
* The stage of the HostPool definition allowing to specify startVMOnConnect.
*/
interface WithStartVMOnConnect {
/**
* Specifies the startVMOnConnect property: The flag to turn on/off StartVMOnConnect feature..
*
* @param startVMOnConnect The flag to turn on/off StartVMOnConnect feature.
* @return the next definition stage.
*/
WithCreate withStartVMOnConnect(Boolean startVMOnConnect);
}
/**
* The stage of the HostPool definition allowing to specify publicNetworkAccess.
*/
interface WithPublicNetworkAccess {
/**
* Specifies the publicNetworkAccess property: Enabled allows this resource to be accessed from both public
* and private networks, Disabled allows this resource to only be accessed via private endpoints.
*
* @param publicNetworkAccess Enabled allows this resource to be accessed from both public and private
* networks, Disabled allows this resource to only be accessed via private endpoints.
* @return the next definition stage.
*/
WithCreate withPublicNetworkAccess(HostpoolPublicNetworkAccess publicNetworkAccess);
}
/**
* The stage of the HostPool definition allowing to specify agentUpdate.
*/
interface WithAgentUpdate {
/**
* Specifies the agentUpdate property: The session host configuration for updating agent, monitoring agent,
* and stack component..
*
* @param agentUpdate The session host configuration for updating agent, monitoring agent, and stack
* component.
* @return the next definition stage.
*/
WithCreate withAgentUpdate(AgentUpdateProperties agentUpdate);
}
}
/**
* Begins update for the HostPool resource.
*
* @return the stage of resource update.
*/
HostPool.Update update();
/**
* The template for HostPool update.
*/
interface Update extends UpdateStages.WithTags, UpdateStages.WithFriendlyName, UpdateStages.WithDescription,
UpdateStages.WithCustomRdpProperty, UpdateStages.WithMaxSessionLimit,
UpdateStages.WithPersonalDesktopAssignmentType, UpdateStages.WithLoadBalancerType, UpdateStages.WithRing,
UpdateStages.WithValidationEnvironment, UpdateStages.WithRegistrationInfo, UpdateStages.WithVmTemplate,
UpdateStages.WithSsoadfsAuthority, UpdateStages.WithSsoClientId, UpdateStages.WithSsoClientSecretKeyVaultPath,
UpdateStages.WithSsoSecretType, UpdateStages.WithPreferredAppGroupType, UpdateStages.WithStartVMOnConnect,
UpdateStages.WithPublicNetworkAccess, UpdateStages.WithAgentUpdate {
/**
* Executes the update request.
*
* @return the updated resource.
*/
HostPool apply();
/**
* Executes the update request.
*
* @param context The context to associate with this operation.
* @return the updated resource.
*/
HostPool apply(Context context);
}
/**
* The HostPool update stages.
*/
interface UpdateStages {
/**
* The stage of the HostPool update allowing to specify tags.
*/
interface WithTags {
/**
* Specifies the tags property: tags to be updated.
*
* @param tags tags to be updated.
* @return the next definition stage.
*/
Update withTags(Map tags);
}
/**
* The stage of the HostPool update allowing to specify friendlyName.
*/
interface WithFriendlyName {
/**
* Specifies the friendlyName property: Friendly name of HostPool..
*
* @param friendlyName Friendly name of HostPool.
* @return the next definition stage.
*/
Update withFriendlyName(String friendlyName);
}
/**
* The stage of the HostPool update allowing to specify description.
*/
interface WithDescription {
/**
* Specifies the description property: Description of HostPool..
*
* @param description Description of HostPool.
* @return the next definition stage.
*/
Update withDescription(String description);
}
/**
* The stage of the HostPool update allowing to specify customRdpProperty.
*/
interface WithCustomRdpProperty {
/**
* Specifies the customRdpProperty property: Custom rdp property of HostPool..
*
* @param customRdpProperty Custom rdp property of HostPool.
* @return the next definition stage.
*/
Update withCustomRdpProperty(String customRdpProperty);
}
/**
* The stage of the HostPool update allowing to specify maxSessionLimit.
*/
interface WithMaxSessionLimit {
/**
* Specifies the maxSessionLimit property: The max session limit of HostPool..
*
* @param maxSessionLimit The max session limit of HostPool.
* @return the next definition stage.
*/
Update withMaxSessionLimit(Integer maxSessionLimit);
}
/**
* The stage of the HostPool update allowing to specify personalDesktopAssignmentType.
*/
interface WithPersonalDesktopAssignmentType {
/**
* Specifies the personalDesktopAssignmentType property: PersonalDesktopAssignment type for HostPool..
*
* @param personalDesktopAssignmentType PersonalDesktopAssignment type for HostPool.
* @return the next definition stage.
*/
Update withPersonalDesktopAssignmentType(PersonalDesktopAssignmentType personalDesktopAssignmentType);
}
/**
* The stage of the HostPool update allowing to specify loadBalancerType.
*/
interface WithLoadBalancerType {
/**
* Specifies the loadBalancerType property: The type of the load balancer..
*
* @param loadBalancerType The type of the load balancer.
* @return the next definition stage.
*/
Update withLoadBalancerType(LoadBalancerType loadBalancerType);
}
/**
* The stage of the HostPool update allowing to specify ring.
*/
interface WithRing {
/**
* Specifies the ring property: The ring number of HostPool..
*
* @param ring The ring number of HostPool.
* @return the next definition stage.
*/
Update withRing(Integer ring);
}
/**
* The stage of the HostPool update allowing to specify validationEnvironment.
*/
interface WithValidationEnvironment {
/**
* Specifies the validationEnvironment property: Is validation environment..
*
* @param validationEnvironment Is validation environment.
* @return the next definition stage.
*/
Update withValidationEnvironment(Boolean validationEnvironment);
}
/**
* The stage of the HostPool update allowing to specify registrationInfo.
*/
interface WithRegistrationInfo {
/**
* Specifies the registrationInfo property: The registration info of HostPool..
*
* @param registrationInfo The registration info of HostPool.
* @return the next definition stage.
*/
Update withRegistrationInfo(RegistrationInfoPatch registrationInfo);
}
/**
* The stage of the HostPool update allowing to specify vmTemplate.
*/
interface WithVmTemplate {
/**
* Specifies the vmTemplate property: VM template for sessionhosts configuration within hostpool..
*
* @param vmTemplate VM template for sessionhosts configuration within hostpool.
* @return the next definition stage.
*/
Update withVmTemplate(String vmTemplate);
}
/**
* The stage of the HostPool update allowing to specify ssoadfsAuthority.
*/
interface WithSsoadfsAuthority {
/**
* Specifies the ssoadfsAuthority property: URL to customer ADFS server for signing WVD SSO certificates..
*
* @param ssoadfsAuthority URL to customer ADFS server for signing WVD SSO certificates.
* @return the next definition stage.
*/
Update withSsoadfsAuthority(String ssoadfsAuthority);
}
/**
* The stage of the HostPool update allowing to specify ssoClientId.
*/
interface WithSsoClientId {
/**
* Specifies the ssoClientId property: ClientId for the registered Relying Party used to issue WVD SSO
* certificates..
*
* @param ssoClientId ClientId for the registered Relying Party used to issue WVD SSO certificates.
* @return the next definition stage.
*/
Update withSsoClientId(String ssoClientId);
}
/**
* The stage of the HostPool update allowing to specify ssoClientSecretKeyVaultPath.
*/
interface WithSsoClientSecretKeyVaultPath {
/**
* Specifies the ssoClientSecretKeyVaultPath property: Path to Azure KeyVault storing the secret used for
* communication to ADFS..
*
* @param ssoClientSecretKeyVaultPath Path to Azure KeyVault storing the secret used for communication to
* ADFS.
* @return the next definition stage.
*/
Update withSsoClientSecretKeyVaultPath(String ssoClientSecretKeyVaultPath);
}
/**
* The stage of the HostPool update allowing to specify ssoSecretType.
*/
interface WithSsoSecretType {
/**
* Specifies the ssoSecretType property: The type of single sign on Secret Type..
*
* @param ssoSecretType The type of single sign on Secret Type.
* @return the next definition stage.
*/
Update withSsoSecretType(SsoSecretType ssoSecretType);
}
/**
* The stage of the HostPool update allowing to specify preferredAppGroupType.
*/
interface WithPreferredAppGroupType {
/**
* Specifies the preferredAppGroupType property: The type of preferred application group type, default to
* Desktop Application Group.
*
* @param preferredAppGroupType The type of preferred application group type, default to Desktop Application
* Group.
* @return the next definition stage.
*/
Update withPreferredAppGroupType(PreferredAppGroupType preferredAppGroupType);
}
/**
* The stage of the HostPool update allowing to specify startVMOnConnect.
*/
interface WithStartVMOnConnect {
/**
* Specifies the startVMOnConnect property: The flag to turn on/off StartVMOnConnect feature..
*
* @param startVMOnConnect The flag to turn on/off StartVMOnConnect feature.
* @return the next definition stage.
*/
Update withStartVMOnConnect(Boolean startVMOnConnect);
}
/**
* The stage of the HostPool update allowing to specify publicNetworkAccess.
*/
interface WithPublicNetworkAccess {
/**
* Specifies the publicNetworkAccess property: Enabled to allow this resource to be access from the public
* network.
*
* @param publicNetworkAccess Enabled to allow this resource to be access from the public network.
* @return the next definition stage.
*/
Update withPublicNetworkAccess(HostpoolPublicNetworkAccess publicNetworkAccess);
}
/**
* The stage of the HostPool update allowing to specify agentUpdate.
*/
interface WithAgentUpdate {
/**
* Specifies the agentUpdate property: The session host configuration for updating agent, monitoring agent,
* and stack component..
*
* @param agentUpdate The session host configuration for updating agent, monitoring agent, and stack
* component.
* @return the next definition stage.
*/
Update withAgentUpdate(AgentUpdatePatchProperties agentUpdate);
}
}
/**
* Refreshes the resource to sync with Azure.
*
* @return the refreshed resource.
*/
HostPool refresh();
/**
* Refreshes the resource to sync with Azure.
*
* @param context The context to associate with this operation.
* @return the refreshed resource.
*/
HostPool refresh(Context context);
/**
* Registration token of the host pool.
*
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return represents a RegistrationInfo definition along with {@link Response}.
*/
Response retrieveRegistrationTokenWithResponse(Context context);
/**
* Registration token of the host pool.
*
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return represents a RegistrationInfo definition.
*/
RegistrationInfo retrieveRegistrationToken();
/**
* Operation to list the RegistrationTokens associated with the HostPool.
*
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return registrationTokenList along with {@link Response}.
*/
Response listRegistrationTokensWithResponse(Context context);
/**
* Operation to list the RegistrationTokens associated with the HostPool.
*
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return registrationTokenList.
*/
RegistrationTokenList listRegistrationTokens();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy