Documentation ¶
Index ¶
- func PossibleValuesForDayOfWeek() []string
- func PossibleValuesForHostPoolType() []string
- func PossibleValuesForLoadBalancerType() []string
- func PossibleValuesForPersonalDesktopAssignmentType() []string
- func PossibleValuesForPreferredAppGroupType() []string
- func PossibleValuesForRegistrationTokenOperation() []string
- func PossibleValuesForSSOSecretType() []string
- func PossibleValuesForSessionHostComponentUpdateType() []string
- func PossibleValuesForSkuTier() []string
- func ValidateHostPoolID(input interface{}, key string) (warnings []string, errors []error)
- type AgentUpdatePatchProperties
- type AgentUpdateProperties
- type CreateOrUpdateOperationResponse
- type DayOfWeek
- type DeleteOperationOptions
- type DeleteOperationResponse
- type GetOperationResponse
- type HostPool
- type HostPoolClient
- func (c HostPoolClient) CreateOrUpdate(ctx context.Context, id HostPoolId, input HostPool) (result CreateOrUpdateOperationResponse, err error)
- func (c HostPoolClient) Delete(ctx context.Context, id HostPoolId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)
- func (c HostPoolClient) Get(ctx context.Context, id HostPoolId) (result GetOperationResponse, err error)
- func (c HostPoolClient) List(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions) (result ListOperationResponse, err error)
- func (c HostPoolClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId, ...) (result ListByResourceGroupOperationResponse, err error)
- func (c HostPoolClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId, ...) (ListByResourceGroupCompleteResult, error)
- func (c HostPoolClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, ...) (result ListByResourceGroupCompleteResult, err error)
- func (c HostPoolClient) ListComplete(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions) (ListCompleteResult, error)
- func (c HostPoolClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions, ...) (result ListCompleteResult, err error)
- func (c HostPoolClient) RetrieveRegistrationToken(ctx context.Context, id HostPoolId) (result RetrieveRegistrationTokenOperationResponse, err error)
- func (c HostPoolClient) Update(ctx context.Context, id HostPoolId, input HostPoolPatch) (result UpdateOperationResponse, err error)
- type HostPoolId
- type HostPoolOperationPredicate
- type HostPoolPatch
- type HostPoolPatchProperties
- type HostPoolProperties
- type HostPoolType
- type ListByResourceGroupCompleteResult
- type ListByResourceGroupOperationOptions
- type ListByResourceGroupOperationResponse
- type ListCompleteResult
- type ListOperationOptions
- type ListOperationResponse
- type LoadBalancerType
- type MaintenanceWindowPatchProperties
- type MaintenanceWindowProperties
- type PersonalDesktopAssignmentType
- type Plan
- type PreferredAppGroupType
- type RegistrationInfo
- type RegistrationInfoPatch
- type RegistrationTokenOperation
- type RetrieveRegistrationTokenOperationResponse
- type SSOSecretType
- type SessionHostComponentUpdateType
- type Sku
- type SkuTier
- type UpdateOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForDayOfWeek ¶
func PossibleValuesForDayOfWeek() []string
func PossibleValuesForHostPoolType ¶
func PossibleValuesForHostPoolType() []string
func PossibleValuesForLoadBalancerType ¶
func PossibleValuesForLoadBalancerType() []string
func PossibleValuesForPersonalDesktopAssignmentType ¶
func PossibleValuesForPersonalDesktopAssignmentType() []string
func PossibleValuesForPreferredAppGroupType ¶
func PossibleValuesForPreferredAppGroupType() []string
func PossibleValuesForRegistrationTokenOperation ¶
func PossibleValuesForRegistrationTokenOperation() []string
func PossibleValuesForSSOSecretType ¶
func PossibleValuesForSSOSecretType() []string
func PossibleValuesForSessionHostComponentUpdateType ¶
func PossibleValuesForSessionHostComponentUpdateType() []string
func PossibleValuesForSkuTier ¶
func PossibleValuesForSkuTier() []string
func ValidateHostPoolID ¶
ValidateHostPoolID checks that 'input' can be parsed as a Host Pool ID
Types ¶
type AgentUpdatePatchProperties ¶
type AgentUpdatePatchProperties struct { MaintenanceWindowTimeZone *string `json:"maintenanceWindowTimeZone,omitempty"` MaintenanceWindows *[]MaintenanceWindowPatchProperties `json:"maintenanceWindows,omitempty"` Type *SessionHostComponentUpdateType `json:"type,omitempty"` UseSessionHostLocalTime *bool `json:"useSessionHostLocalTime,omitempty"` }
type AgentUpdateProperties ¶
type AgentUpdateProperties struct { MaintenanceWindowTimeZone *string `json:"maintenanceWindowTimeZone,omitempty"` MaintenanceWindows *[]MaintenanceWindowProperties `json:"maintenanceWindows,omitempty"` Type *SessionHostComponentUpdateType `json:"type,omitempty"` UseSessionHostLocalTime *bool `json:"useSessionHostLocalTime,omitempty"` }
type DayOfWeek ¶
type DayOfWeek string
func (*DayOfWeek) UnmarshalJSON ¶ added in v0.20230420.1093529
type DeleteOperationOptions ¶
type DeleteOperationOptions struct {
Force *bool
}
func DefaultDeleteOperationOptions ¶
func DefaultDeleteOperationOptions() DeleteOperationOptions
func (DeleteOperationOptions) ToHeaders ¶ added in v0.20230420.1093529
func (o DeleteOperationOptions) ToHeaders() *client.Headers
func (DeleteOperationOptions) ToOData ¶ added in v0.20230420.1093529
func (o DeleteOperationOptions) ToOData() *odata.Query
func (DeleteOperationOptions) ToQuery ¶ added in v0.20230420.1093529
func (o DeleteOperationOptions) ToQuery() *client.QueryParams
type DeleteOperationResponse ¶
type GetOperationResponse ¶
type HostPool ¶
type HostPool struct { Etag *string `json:"etag,omitempty"` Id *string `json:"id,omitempty"` Identity *identity.SystemAssigned `json:"identity,omitempty"` Kind *string `json:"kind,omitempty"` Location *string `json:"location,omitempty"` ManagedBy *string `json:"managedBy,omitempty"` Name *string `json:"name,omitempty"` Plan *Plan `json:"plan,omitempty"` Properties HostPoolProperties `json:"properties"` Sku *Sku `json:"sku,omitempty"` SystemData *systemdata.SystemData `json:"systemData,omitempty"` Tags *map[string]string `json:"tags,omitempty"` Type *string `json:"type,omitempty"` }
type HostPoolClient ¶
type HostPoolClient struct {
Client *resourcemanager.Client
}
func NewHostPoolClientWithBaseURI ¶
func NewHostPoolClientWithBaseURI(sdkApi sdkEnv.Api) (*HostPoolClient, error)
func (HostPoolClient) CreateOrUpdate ¶
func (c HostPoolClient) CreateOrUpdate(ctx context.Context, id HostPoolId, input HostPool) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (HostPoolClient) Delete ¶
func (c HostPoolClient) Delete(ctx context.Context, id HostPoolId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)
Delete ...
func (HostPoolClient) Get ¶
func (c HostPoolClient) Get(ctx context.Context, id HostPoolId) (result GetOperationResponse, err error)
Get ...
func (HostPoolClient) List ¶
func (c HostPoolClient) List(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions) (result ListOperationResponse, err error)
List ...
func (HostPoolClient) ListByResourceGroup ¶
func (c HostPoolClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId, options ListByResourceGroupOperationOptions) (result ListByResourceGroupOperationResponse, err error)
ListByResourceGroup ...
func (HostPoolClient) ListByResourceGroupComplete ¶
func (c HostPoolClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId, options ListByResourceGroupOperationOptions) (ListByResourceGroupCompleteResult, error)
ListByResourceGroupComplete retrieves all the results into a single object
func (HostPoolClient) ListByResourceGroupCompleteMatchingPredicate ¶
func (c HostPoolClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, options ListByResourceGroupOperationOptions, predicate HostPoolOperationPredicate) (result ListByResourceGroupCompleteResult, err error)
ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (HostPoolClient) ListComplete ¶
func (c HostPoolClient) ListComplete(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions) (ListCompleteResult, error)
ListComplete retrieves all the results into a single object
func (HostPoolClient) ListCompleteMatchingPredicate ¶
func (c HostPoolClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions, predicate HostPoolOperationPredicate) (result ListCompleteResult, err error)
ListCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (HostPoolClient) RetrieveRegistrationToken ¶
func (c HostPoolClient) RetrieveRegistrationToken(ctx context.Context, id HostPoolId) (result RetrieveRegistrationTokenOperationResponse, err error)
RetrieveRegistrationToken ...
func (HostPoolClient) Update ¶
func (c HostPoolClient) Update(ctx context.Context, id HostPoolId, input HostPoolPatch) (result UpdateOperationResponse, err error)
Update ...
type HostPoolId ¶
HostPoolId is a struct representing the Resource ID for a Host Pool
func NewHostPoolID ¶
func NewHostPoolID(subscriptionId string, resourceGroupName string, hostPoolName string) HostPoolId
NewHostPoolID returns a new HostPoolId struct
func ParseHostPoolID ¶
func ParseHostPoolID(input string) (*HostPoolId, error)
ParseHostPoolID parses 'input' into a HostPoolId
func ParseHostPoolIDInsensitively ¶
func ParseHostPoolIDInsensitively(input string) (*HostPoolId, error)
ParseHostPoolIDInsensitively parses 'input' case-insensitively into a HostPoolId note: this method should only be used for API response data and not user input
func (*HostPoolId) FromParseResult ¶ added in v0.20231127.1171502
func (id *HostPoolId) FromParseResult(input resourceids.ParseResult) error
func (HostPoolId) Segments ¶
func (id HostPoolId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Host Pool ID
func (HostPoolId) String ¶
func (id HostPoolId) String() string
String returns a human-readable description of this Host Pool ID
type HostPoolOperationPredicate ¶
type HostPoolOperationPredicate struct { Etag *string Id *string Kind *string Location *string ManagedBy *string Name *string Type *string }
func (HostPoolOperationPredicate) Matches ¶
func (p HostPoolOperationPredicate) Matches(input HostPool) bool
type HostPoolPatch ¶
type HostPoolPatchProperties ¶
type HostPoolPatchProperties struct { AgentUpdate *AgentUpdatePatchProperties `json:"agentUpdate,omitempty"` CustomRdpProperty *string `json:"customRdpProperty,omitempty"` Description *string `json:"description,omitempty"` FriendlyName *string `json:"friendlyName,omitempty"` LoadBalancerType *LoadBalancerType `json:"loadBalancerType,omitempty"` MaxSessionLimit *int64 `json:"maxSessionLimit,omitempty"` PersonalDesktopAssignmentType *PersonalDesktopAssignmentType `json:"personalDesktopAssignmentType,omitempty"` PreferredAppGroupType *PreferredAppGroupType `json:"preferredAppGroupType,omitempty"` RegistrationInfo *RegistrationInfoPatch `json:"registrationInfo,omitempty"` Ring *int64 `json:"ring,omitempty"` SsoClientId *string `json:"ssoClientId,omitempty"` SsoClientSecretKeyVaultPath *string `json:"ssoClientSecretKeyVaultPath,omitempty"` SsoSecretType *SSOSecretType `json:"ssoSecretType,omitempty"` SsoadfsAuthority *string `json:"ssoadfsAuthority,omitempty"` StartVMOnConnect *bool `json:"startVMOnConnect,omitempty"` VMTemplate *string `json:"vmTemplate,omitempty"` ValidationEnvironment *bool `json:"validationEnvironment,omitempty"` }
type HostPoolProperties ¶
type HostPoolProperties struct { AgentUpdate *AgentUpdateProperties `json:"agentUpdate,omitempty"` ApplicationGroupReferences *[]string `json:"applicationGroupReferences,omitempty"` CloudPcResource *bool `json:"cloudPcResource,omitempty"` CustomRdpProperty *string `json:"customRdpProperty,omitempty"` Description *string `json:"description,omitempty"` FriendlyName *string `json:"friendlyName,omitempty"` HostPoolType HostPoolType `json:"hostPoolType"` LoadBalancerType LoadBalancerType `json:"loadBalancerType"` MaxSessionLimit *int64 `json:"maxSessionLimit,omitempty"` ObjectId *string `json:"objectId,omitempty"` PersonalDesktopAssignmentType *PersonalDesktopAssignmentType `json:"personalDesktopAssignmentType,omitempty"` PreferredAppGroupType PreferredAppGroupType `json:"preferredAppGroupType"` RegistrationInfo *RegistrationInfo `json:"registrationInfo,omitempty"` Ring *int64 `json:"ring,omitempty"` SsoClientId *string `json:"ssoClientId,omitempty"` SsoClientSecretKeyVaultPath *string `json:"ssoClientSecretKeyVaultPath,omitempty"` SsoSecretType *SSOSecretType `json:"ssoSecretType,omitempty"` SsoadfsAuthority *string `json:"ssoadfsAuthority,omitempty"` StartVMOnConnect *bool `json:"startVMOnConnect,omitempty"` VMTemplate *string `json:"vmTemplate,omitempty"` ValidationEnvironment *bool `json:"validationEnvironment,omitempty"` }
type HostPoolType ¶
type HostPoolType string
const ( HostPoolTypeBYODesktop HostPoolType = "BYODesktop" HostPoolTypePersonal HostPoolType = "Personal" HostPoolTypePooled HostPoolType = "Pooled" )
func (*HostPoolType) UnmarshalJSON ¶ added in v0.20230420.1093529
func (s *HostPoolType) UnmarshalJSON(bytes []byte) error
type ListByResourceGroupOperationOptions ¶
type ListByResourceGroupOperationOptions struct { InitialSkip *int64 IsDescending *bool PageSize *int64 }
func DefaultListByResourceGroupOperationOptions ¶
func DefaultListByResourceGroupOperationOptions() ListByResourceGroupOperationOptions
func (ListByResourceGroupOperationOptions) ToHeaders ¶ added in v0.20230420.1093529
func (o ListByResourceGroupOperationOptions) ToHeaders() *client.Headers
func (ListByResourceGroupOperationOptions) ToOData ¶ added in v0.20230420.1093529
func (o ListByResourceGroupOperationOptions) ToOData() *odata.Query
func (ListByResourceGroupOperationOptions) ToQuery ¶ added in v0.20230420.1093529
func (o ListByResourceGroupOperationOptions) ToQuery() *client.QueryParams
type ListCompleteResult ¶
type ListOperationOptions ¶
func DefaultListOperationOptions ¶
func DefaultListOperationOptions() ListOperationOptions
func (ListOperationOptions) ToHeaders ¶ added in v0.20230420.1093529
func (o ListOperationOptions) ToHeaders() *client.Headers
func (ListOperationOptions) ToOData ¶ added in v0.20230420.1093529
func (o ListOperationOptions) ToOData() *odata.Query
func (ListOperationOptions) ToQuery ¶ added in v0.20230420.1093529
func (o ListOperationOptions) ToQuery() *client.QueryParams
type ListOperationResponse ¶
type LoadBalancerType ¶
type LoadBalancerType string
const ( LoadBalancerTypeBreadthFirst LoadBalancerType = "BreadthFirst" LoadBalancerTypeDepthFirst LoadBalancerType = "DepthFirst" LoadBalancerTypePersistent LoadBalancerType = "Persistent" )
func (*LoadBalancerType) UnmarshalJSON ¶ added in v0.20230420.1093529
func (s *LoadBalancerType) UnmarshalJSON(bytes []byte) error
type PersonalDesktopAssignmentType ¶
type PersonalDesktopAssignmentType string
const ( PersonalDesktopAssignmentTypeAutomatic PersonalDesktopAssignmentType = "Automatic" PersonalDesktopAssignmentTypeDirect PersonalDesktopAssignmentType = "Direct" )
func (*PersonalDesktopAssignmentType) UnmarshalJSON ¶ added in v0.20230420.1093529
func (s *PersonalDesktopAssignmentType) UnmarshalJSON(bytes []byte) error
type PreferredAppGroupType ¶
type PreferredAppGroupType string
const ( PreferredAppGroupTypeDesktop PreferredAppGroupType = "Desktop" PreferredAppGroupTypeNone PreferredAppGroupType = "None" PreferredAppGroupTypeRailApplications PreferredAppGroupType = "RailApplications" )
func (*PreferredAppGroupType) UnmarshalJSON ¶ added in v0.20230420.1093529
func (s *PreferredAppGroupType) UnmarshalJSON(bytes []byte) error
type RegistrationInfo ¶
type RegistrationInfo struct { ExpirationTime *string `json:"expirationTime,omitempty"` RegistrationTokenOperation *RegistrationTokenOperation `json:"registrationTokenOperation,omitempty"` Token *string `json:"token,omitempty"` }
func (*RegistrationInfo) GetExpirationTimeAsTime ¶
func (o *RegistrationInfo) GetExpirationTimeAsTime() (*time.Time, error)
func (*RegistrationInfo) SetExpirationTimeAsTime ¶
func (o *RegistrationInfo) SetExpirationTimeAsTime(input time.Time)
type RegistrationInfoPatch ¶
type RegistrationInfoPatch struct { ExpirationTime *string `json:"expirationTime,omitempty"` RegistrationTokenOperation *RegistrationTokenOperation `json:"registrationTokenOperation,omitempty"` }
func (*RegistrationInfoPatch) GetExpirationTimeAsTime ¶
func (o *RegistrationInfoPatch) GetExpirationTimeAsTime() (*time.Time, error)
func (*RegistrationInfoPatch) SetExpirationTimeAsTime ¶
func (o *RegistrationInfoPatch) SetExpirationTimeAsTime(input time.Time)
type RegistrationTokenOperation ¶
type RegistrationTokenOperation string
const ( RegistrationTokenOperationDelete RegistrationTokenOperation = "Delete" RegistrationTokenOperationNone RegistrationTokenOperation = "None" RegistrationTokenOperationUpdate RegistrationTokenOperation = "Update" )
func (*RegistrationTokenOperation) UnmarshalJSON ¶ added in v0.20230420.1093529
func (s *RegistrationTokenOperation) UnmarshalJSON(bytes []byte) error
type RetrieveRegistrationTokenOperationResponse ¶
type RetrieveRegistrationTokenOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *RegistrationInfo }
type SSOSecretType ¶
type SSOSecretType string
const ( SSOSecretTypeCertificate SSOSecretType = "Certificate" SSOSecretTypeCertificateInKeyVault SSOSecretType = "CertificateInKeyVault" )
func (*SSOSecretType) UnmarshalJSON ¶ added in v0.20230420.1093529
func (s *SSOSecretType) UnmarshalJSON(bytes []byte) error
type SessionHostComponentUpdateType ¶
type SessionHostComponentUpdateType string
const ( SessionHostComponentUpdateTypeDefault SessionHostComponentUpdateType = "Default" SessionHostComponentUpdateTypeScheduled SessionHostComponentUpdateType = "Scheduled" )
func (*SessionHostComponentUpdateType) UnmarshalJSON ¶ added in v0.20230420.1093529
func (s *SessionHostComponentUpdateType) UnmarshalJSON(bytes []byte) error
Source Files ¶
- client.go
- constants.go
- id_hostpool.go
- method_createorupdate.go
- method_delete.go
- method_get.go
- method_list.go
- method_listbyresourcegroup.go
- method_retrieveregistrationtoken.go
- method_update.go
- model_agentupdatepatchproperties.go
- model_agentupdateproperties.go
- model_hostpool.go
- model_hostpoolpatch.go
- model_hostpoolpatchproperties.go
- model_hostpoolproperties.go
- model_maintenancewindowpatchproperties.go
- model_maintenancewindowproperties.go
- model_plan.go
- model_registrationinfo.go
- model_registrationinfopatch.go
- model_sku.go
- predicates.go
- version.go