sessionhostmanagements

README

github.com/hashicorp/go-azure-sdk/resource-manager/desktopvirtualization/2024-04-08-preview/sessionhostmanagements Documentation

The sessionhostmanagements SDK allows for interaction with Azure Resource Manager desktopvirtualization (API Version 2024-04-08-preview).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/desktopvirtualization/2024-04-08-preview/sessionhostmanagements"

Client Initialization

client := sessionhostmanagements.NewSessionHostManagementsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SessionHostManagementsClient.Get

ctx := context.TODO()
id := sessionhostmanagements.NewHostPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "hostPoolName")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: SessionHostManagementsClient.ListByHostPool

ctx := context.TODO()
id := sessionhostmanagements.NewHostPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "hostPoolName")

// alternatively `client.ListByHostPool(ctx, id)` can be used to do batched pagination
items, err := client.ListByHostPoolComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

• func ValidateHostPoolID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationResponse
• type HostPoolId
  • func NewHostPoolID(subscriptionId string, resourceGroupName string, hostPoolName string) HostPoolId
  • func ParseHostPoolID(input string) (*HostPoolId, error)
  • func ParseHostPoolIDInsensitively(input string) (*HostPoolId, error)
  • func (id *HostPoolId) FromParseResult(input resourceids.ParseResult) error
  • func (id HostPoolId) ID() string
  • func (id HostPoolId) Segments() []resourceids.Segment
  • func (id HostPoolId) String() string
• type HostPoolUpdateConfigurationProperties
• type ListByHostPoolCompleteResult
• type ListByHostPoolCustomPager
  • func (p *ListByHostPoolCustomPager) NextPageLink() *odata.Link
• type ListByHostPoolOperationResponse
• type SessionHostManagement
• type SessionHostManagementOperationPredicate
  • func (p SessionHostManagementOperationPredicate) Matches(input SessionHostManagement) bool
• type SessionHostManagementProperties
• type SessionHostManagementsClient
  • func NewSessionHostManagementsClientWithBaseURI(sdkApi sdkEnv.Api) (*SessionHostManagementsClient, error)
  • func (c SessionHostManagementsClient) Get(ctx context.Context, id HostPoolId) (result GetOperationResponse, err error)
  • func (c SessionHostManagementsClient) ListByHostPool(ctx context.Context, id HostPoolId) (result ListByHostPoolOperationResponse, err error)
  • func (c SessionHostManagementsClient) ListByHostPoolComplete(ctx context.Context, id HostPoolId) (ListByHostPoolCompleteResult, error)
  • func (c SessionHostManagementsClient) ListByHostPoolCompleteMatchingPredicate(ctx context.Context, id HostPoolId, ...) (result ListByHostPoolCompleteResult, err error)

Functions

func ValidateHostPoolID

func ValidateHostPoolID(input interface{}, key string) (warnings []string, errors []error)

ValidateHostPoolID checks that 'input' can be parsed as a Host Pool ID

Types

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SessionHostManagement
}

type HostPoolId

type HostPoolId struct {
	SubscriptionId    string
	ResourceGroupName string
	HostPoolName      string
}

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

func (id *HostPoolId) FromParseResult(input resourceids.ParseResult) error

func (HostPoolId) ID

func (id HostPoolId) ID() string

ID returns the formatted Host Pool ID

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 HostPoolUpdateConfigurationProperties

type HostPoolUpdateConfigurationProperties struct {
	DeleteOriginalVM   *bool   `json:"deleteOriginalVm,omitempty"`
	LogOffDelayMinutes int64   `json:"logOffDelayMinutes"`
	LogOffMessage      *string `json:"logOffMessage,omitempty"`
	MaxVMsRemoved      int64   `json:"maxVmsRemoved"`
}

type ListByHostPoolCompleteResult

type ListByHostPoolCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SessionHostManagement
}

type ListByHostPoolCustomPager

type ListByHostPoolCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*ListByHostPoolCustomPager) NextPageLink

func (p *ListByHostPoolCustomPager) NextPageLink() *odata.Link

type ListByHostPoolOperationResponse

type ListByHostPoolOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SessionHostManagement
}

type SessionHostManagement

type SessionHostManagement struct {
	Id         *string                         `json:"id,omitempty"`
	Name       *string                         `json:"name,omitempty"`
	Properties SessionHostManagementProperties `json:"properties"`
	SystemData *systemdata.SystemData          `json:"systemData,omitempty"`
	Type       *string                         `json:"type,omitempty"`
}

type SessionHostManagementOperationPredicate

type SessionHostManagementOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (SessionHostManagementOperationPredicate) Matches

func (p SessionHostManagementOperationPredicate) Matches(input SessionHostManagement) bool

type SessionHostManagementProperties

type SessionHostManagementProperties struct {
	ScheduledDateTimeZone string                                `json:"scheduledDateTimeZone"`
	Update                HostPoolUpdateConfigurationProperties `json:"update"`
}

type SessionHostManagementsClient

type SessionHostManagementsClient struct {
	Client *resourcemanager.Client
}

func NewSessionHostManagementsClientWithBaseURI

func NewSessionHostManagementsClientWithBaseURI(sdkApi sdkEnv.Api) (*SessionHostManagementsClient, error)

func (SessionHostManagementsClient) Get

func (c SessionHostManagementsClient) Get(ctx context.Context, id HostPoolId) (result GetOperationResponse, err error)

Get ...

func (SessionHostManagementsClient) ListByHostPool

func (c SessionHostManagementsClient) ListByHostPool(ctx context.Context, id HostPoolId) (result ListByHostPoolOperationResponse, err error)

ListByHostPool ...

func (SessionHostManagementsClient) ListByHostPoolComplete

func (c SessionHostManagementsClient) ListByHostPoolComplete(ctx context.Context, id HostPoolId) (ListByHostPoolCompleteResult, error)

ListByHostPoolComplete retrieves all the results into a single object

func (SessionHostManagementsClient) ListByHostPoolCompleteMatchingPredicate

func (c SessionHostManagementsClient) ListByHostPoolCompleteMatchingPredicate(ctx context.Context, id HostPoolId, predicate SessionHostManagementOperationPredicate) (result ListByHostPoolCompleteResult, err error)

ListByHostPoolCompleteMatchingPredicate retrieves all the results and then applies the predicate