sessionhostconfiguration

package
v0.20241212.1154051 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 12, 2024 License: MPL-2.0 Imports: 15 Imported by: 0

README

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

The sessionhostconfiguration 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/sessionhostconfiguration"

Client Initialization

client := sessionhostconfiguration.NewSessionHostConfigurationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SessionHostConfigurationClient.CreateOrUpdate

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

payload := sessionhostconfiguration.SessionHostConfiguration{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: SessionHostConfigurationClient.Get

ctx := context.TODO()
id := sessionhostconfiguration.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: SessionHostConfigurationClient.ListByHostPool

ctx := context.TODO()
id := sessionhostconfiguration.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
}

Example Usage: SessionHostConfigurationClient.Update

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

payload := sessionhostconfiguration.SessionHostConfigurationPatch{
	// ...
}


if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForDomainJoinType 

func PossibleValuesForDomainJoinType() []string

func PossibleValuesForProvisioningStateSHC 

func PossibleValuesForProvisioningStateSHC() []string

func PossibleValuesForType 

func PossibleValuesForType() []string

func PossibleValuesForVirtualMachineDiskType 

func PossibleValuesForVirtualMachineDiskType() []string

func PossibleValuesForVirtualMachineSecurityType 

func PossibleValuesForVirtualMachineSecurityType() []string

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 ActiveDirectoryInfoPatchProperties 

type ActiveDirectoryInfoPatchProperties struct {
	DomainCredentials *KeyVaultCredentialsPatchProperties `json:"domainCredentials,omitempty"`
}

type ActiveDirectoryInfoProperties 

type ActiveDirectoryInfoProperties struct {
	DomainCredentials KeyVaultCredentialsProperties `json:"domainCredentials"`
	DomainName        *string                       `json:"domainName,omitempty"`
	OuPath            string                        `json:"ouPath"`
}

type AzureActiveDirectoryInfoProperties 

type AzureActiveDirectoryInfoProperties struct {
	MdmProviderGuid string `json:"mdmProviderGuid"`
}

type BootDiagnosticsInfoPatchProperties 

type BootDiagnosticsInfoPatchProperties struct {
	Enabled    *bool   `json:"enabled,omitempty"`
	StorageUri *string `json:"storageUri,omitempty"`
}

type BootDiagnosticsInfoProperties 

type BootDiagnosticsInfoProperties struct {
	Enabled    *bool   `json:"enabled,omitempty"`
	StorageUri *string `json:"storageUri,omitempty"`
}

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SessionHostConfiguration
}

type CustomInfoPatchProperties 

type CustomInfoPatchProperties struct {
	ResourceId *string `json:"resourceId,omitempty"`
}

type CustomInfoProperties 

type CustomInfoProperties struct {
	ResourceId string `json:"resourceId"`
}

type DiskInfoPatchProperties 

type DiskInfoPatchProperties struct {
	Type *VirtualMachineDiskType `json:"type,omitempty"`
}

type DiskInfoProperties 

type DiskInfoProperties struct {
	Type VirtualMachineDiskType `json:"type"`
}

type DomainInfoPatchProperties 

type DomainInfoPatchProperties struct {
	ActiveDirectoryInfo *ActiveDirectoryInfoPatchProperties `json:"activeDirectoryInfo,omitempty"`
}

type DomainInfoProperties 

type DomainInfoProperties struct {
	ActiveDirectoryInfo      *ActiveDirectoryInfoProperties      `json:"activeDirectoryInfo,omitempty"`
	AzureActiveDirectoryInfo *AzureActiveDirectoryInfoProperties `json:"azureActiveDirectoryInfo,omitempty"`
	JoinType                 DomainJoinType                      `json:"joinType"`
}

type DomainJoinType 

type DomainJoinType string
const (
	DomainJoinTypeActiveDirectory      DomainJoinType = "ActiveDirectory"
	DomainJoinTypeAzureActiveDirectory DomainJoinType = "AzureActiveDirectory"
)

func (*DomainJoinType) UnmarshalJSON 

func (s *DomainJoinType) UnmarshalJSON(bytes []byte) error

type GetOperationResponse 

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

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 ImageInfoPatchProperties 

type ImageInfoPatchProperties struct {
	CustomInfo      *CustomInfoPatchProperties      `json:"customInfo,omitempty"`
	MarketplaceInfo *MarketplaceInfoPatchProperties `json:"marketplaceInfo,omitempty"`
	Type            *Type                           `json:"type,omitempty"`
}

type ImageInfoProperties 

type ImageInfoProperties struct {
	CustomInfo      *CustomInfoProperties      `json:"customInfo,omitempty"`
	MarketplaceInfo *MarketplaceInfoProperties `json:"marketplaceInfo,omitempty"`
	Type            Type                       `json:"type"`
}

type KeyVaultCredentialsPatchProperties 

type KeyVaultCredentialsPatchProperties struct {
	PasswordKeyVaultSecretUri *string `json:"passwordKeyVaultSecretUri,omitempty"`
	UsernameKeyVaultSecretUri *string `json:"usernameKeyVaultSecretUri,omitempty"`
}

type KeyVaultCredentialsProperties 

type KeyVaultCredentialsProperties struct {
	PasswordKeyVaultSecretUri string `json:"passwordKeyVaultSecretUri"`
	UsernameKeyVaultSecretUri string `json:"usernameKeyVaultSecretUri"`
}

type ListByHostPoolCompleteResult 

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

type ListByHostPoolCustomPager 

type ListByHostPoolCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByHostPoolCustomPager) NextPageLink() *odata.Link

type ListByHostPoolOperationResponse 

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

type MarketplaceInfoPatchProperties 

type MarketplaceInfoPatchProperties struct {
	ExactVersion *string `json:"exactVersion,omitempty"`
	Offer        *string `json:"offer,omitempty"`
	Publisher    *string `json:"publisher,omitempty"`
	Sku          *string `json:"sku,omitempty"`
}

type MarketplaceInfoProperties 

type MarketplaceInfoProperties struct {
	ExactVersion string `json:"exactVersion"`
	Offer        string `json:"offer"`
	Publisher    string `json:"publisher"`
	Sku          string `json:"sku"`
}

type NetworkInfoPatchProperties 

type NetworkInfoPatchProperties struct {
	SecurityGroupId *string `json:"securityGroupId,omitempty"`
	SubnetId        *string `json:"subnetId,omitempty"`
}

type NetworkInfoProperties 

type NetworkInfoProperties struct {
	SecurityGroupId *string `json:"securityGroupId,omitempty"`
	SubnetId        string  `json:"subnetId"`
}

type ProvisioningStateSHC 

type ProvisioningStateSHC string
const (
	ProvisioningStateSHCCanceled     ProvisioningStateSHC = "Canceled"
	ProvisioningStateSHCFailed       ProvisioningStateSHC = "Failed"
	ProvisioningStateSHCProvisioning ProvisioningStateSHC = "Provisioning"
	ProvisioningStateSHCSucceeded    ProvisioningStateSHC = "Succeeded"
)

func (*ProvisioningStateSHC) UnmarshalJSON 

func (s *ProvisioningStateSHC) UnmarshalJSON(bytes []byte) error

type SecurityInfoPatchProperties 

type SecurityInfoPatchProperties struct {
	SecureBootEnabled *bool                       `json:"secureBootEnabled,omitempty"`
	Type              *VirtualMachineSecurityType `json:"type,omitempty"`
	VTpmEnabled       *bool                       `json:"vTpmEnabled,omitempty"`
}

type SecurityInfoProperties 

type SecurityInfoProperties struct {
	SecureBootEnabled *bool                       `json:"secureBootEnabled,omitempty"`
	Type              *VirtualMachineSecurityType `json:"type,omitempty"`
	VTpmEnabled       *bool                       `json:"vTpmEnabled,omitempty"`
}

type SessionHostConfiguration 

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

type SessionHostConfigurationClient 

type SessionHostConfigurationClient struct {
	Client *resourcemanager.Client
}

func NewSessionHostConfigurationClientWithBaseURI 

func NewSessionHostConfigurationClientWithBaseURI(sdkApi sdkEnv.Api) (*SessionHostConfigurationClient, error)

func (SessionHostConfigurationClient) CreateOrUpdate 

func (c SessionHostConfigurationClient) CreateOrUpdate(ctx context.Context, id HostPoolId, input SessionHostConfiguration) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (SessionHostConfigurationClient) CreateOrUpdateThenPoll 

func (c SessionHostConfigurationClient) CreateOrUpdateThenPoll(ctx context.Context, id HostPoolId, input SessionHostConfiguration) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (SessionHostConfigurationClient) Get 

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

Get ...

func (SessionHostConfigurationClient) ListByHostPool 

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

ListByHostPool ...

func (SessionHostConfigurationClient) ListByHostPoolComplete 

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

ListByHostPoolComplete retrieves all the results into a single object

func (SessionHostConfigurationClient) ListByHostPoolCompleteMatchingPredicate 

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

ListByHostPoolCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SessionHostConfigurationClient) Update 

func (c SessionHostConfigurationClient) Update(ctx context.Context, id HostPoolId, input SessionHostConfigurationPatch) (result UpdateOperationResponse, err error)

Update ...

func (SessionHostConfigurationClient) UpdateThenPoll 

func (c SessionHostConfigurationClient) UpdateThenPoll(ctx context.Context, id HostPoolId, input SessionHostConfigurationPatch) error

UpdateThenPoll performs Update then polls until it's completed

type SessionHostConfigurationOperationPredicate 

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

func (SessionHostConfigurationOperationPredicate) Matches 

func (p SessionHostConfigurationOperationPredicate) Matches(input SessionHostConfiguration) bool

type SessionHostConfigurationPatch 

type SessionHostConfigurationPatch struct {
	Properties *SessionHostConfigurationPatchProperties `json:"properties,omitempty"`
}

type SessionHostConfigurationPatchProperties 

type SessionHostConfigurationPatchProperties struct {
	AvailabilityZones            *[]int64                            `json:"availabilityZones,omitempty"`
	BootDiagnosticsInfo          *BootDiagnosticsInfoPatchProperties `json:"bootDiagnosticsInfo,omitempty"`
	CustomConfigurationScriptURL *string                             `json:"customConfigurationScriptUrl,omitempty"`
	DiskInfo                     *DiskInfoPatchProperties            `json:"diskInfo,omitempty"`
	DomainInfo                   *DomainInfoPatchProperties          `json:"domainInfo,omitempty"`
	FriendlyName                 *string                             `json:"friendlyName,omitempty"`
	ImageInfo                    *ImageInfoPatchProperties           `json:"imageInfo,omitempty"`
	NetworkInfo                  *NetworkInfoPatchProperties         `json:"networkInfo,omitempty"`
	SecurityInfo                 *SecurityInfoPatchProperties        `json:"securityInfo,omitempty"`
	VMAdminCredentials           *KeyVaultCredentialsPatchProperties `json:"vmAdminCredentials,omitempty"`
	VMLocation                   *string                             `json:"vmLocation,omitempty"`
	VMNamePrefix                 *string                             `json:"vmNamePrefix,omitempty"`
	VMResourceGroup              *string                             `json:"vmResourceGroup,omitempty"`
	VMSizeId                     *string                             `json:"vmSizeId,omitempty"`
	VMTags                       *map[string]string                  `json:"vmTags,omitempty"`
}

type SessionHostConfigurationProperties 

type SessionHostConfigurationProperties struct {
	AvailabilityZones            *[]int64                       `json:"availabilityZones,omitempty"`
	BootDiagnosticsInfo          *BootDiagnosticsInfoProperties `json:"bootDiagnosticsInfo,omitempty"`
	CustomConfigurationScriptURL *string                        `json:"customConfigurationScriptUrl,omitempty"`
	DiskInfo                     DiskInfoProperties             `json:"diskInfo"`
	DomainInfo                   DomainInfoProperties           `json:"domainInfo"`
	FriendlyName                 *string                        `json:"friendlyName,omitempty"`
	ImageInfo                    ImageInfoProperties            `json:"imageInfo"`
	NetworkInfo                  NetworkInfoProperties          `json:"networkInfo"`
	ProvisioningState            *ProvisioningStateSHC          `json:"provisioningState,omitempty"`
	SecurityInfo                 *SecurityInfoProperties        `json:"securityInfo,omitempty"`
	VMAdminCredentials           KeyVaultCredentialsProperties  `json:"vmAdminCredentials"`
	VMLocation                   *string                        `json:"vmLocation,omitempty"`
	VMNamePrefix                 string                         `json:"vmNamePrefix"`
	VMResourceGroup              *string                        `json:"vmResourceGroup,omitempty"`
	VMSizeId                     string                         `json:"vmSizeId"`
	VMTags                       *map[string]string             `json:"vmTags,omitempty"`
	Version                      *string                        `json:"version,omitempty"`
}

func (*SessionHostConfigurationProperties) GetVersionAsTime 

func (o *SessionHostConfigurationProperties) GetVersionAsTime() (*time.Time, error)

func (*SessionHostConfigurationProperties) SetVersionAsTime 

func (o *SessionHostConfigurationProperties) SetVersionAsTime(input time.Time)

type Type 

type Type string
const (
	TypeCustom      Type = "Custom"
	TypeMarketplace Type = "Marketplace"
)

func (*Type) UnmarshalJSON 

func (s *Type) UnmarshalJSON(bytes []byte) error

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SessionHostConfiguration
}

type VirtualMachineDiskType 

type VirtualMachineDiskType string
const (
	VirtualMachineDiskTypePremiumLRS     VirtualMachineDiskType = "Premium_LRS"
	VirtualMachineDiskTypeStandardLRS    VirtualMachineDiskType = "Standard_LRS"
	VirtualMachineDiskTypeStandardSSDLRS VirtualMachineDiskType = "StandardSSD_LRS"
)

func (*VirtualMachineDiskType) UnmarshalJSON 

func (s *VirtualMachineDiskType) UnmarshalJSON(bytes []byte) error

type VirtualMachineSecurityType 

type VirtualMachineSecurityType string
const (
	VirtualMachineSecurityTypeConfidentialVM VirtualMachineSecurityType = "ConfidentialVM"
	VirtualMachineSecurityTypeStandard       VirtualMachineSecurityType = "Standard"
	VirtualMachineSecurityTypeTrustedLaunch  VirtualMachineSecurityType = "TrustedLaunch"
)

func (*VirtualMachineSecurityType) UnmarshalJSON 

func (s *VirtualMachineSecurityType) UnmarshalJSON(bytes []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.