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 ¶
- func PossibleValuesForDomainJoinType() []string
- func PossibleValuesForProvisioningStateSHC() []string
- func PossibleValuesForType() []string
- func PossibleValuesForVirtualMachineDiskType() []string
- func PossibleValuesForVirtualMachineSecurityType() []string
- func ValidateHostPoolID(input interface{}, key string) (warnings []string, errors []error)
- type ActiveDirectoryInfoPatchProperties
- type ActiveDirectoryInfoProperties
- type AzureActiveDirectoryInfoProperties
- type BootDiagnosticsInfoPatchProperties
- type BootDiagnosticsInfoProperties
- type CreateOrUpdateOperationResponse
- type CustomInfoPatchProperties
- type CustomInfoProperties
- type DiskInfoPatchProperties
- type DiskInfoProperties
- type DomainInfoPatchProperties
- type DomainInfoProperties
- type DomainJoinType
- type GetOperationResponse
- type HostPoolId
- type ImageInfoPatchProperties
- type ImageInfoProperties
- type KeyVaultCredentialsPatchProperties
- type KeyVaultCredentialsProperties
- type ListByHostPoolCompleteResult
- type ListByHostPoolCustomPager
- type ListByHostPoolOperationResponse
- type MarketplaceInfoPatchProperties
- type MarketplaceInfoProperties
- type NetworkInfoPatchProperties
- type NetworkInfoProperties
- type ProvisioningStateSHC
- type SecurityInfoPatchProperties
- type SecurityInfoProperties
- type SessionHostConfiguration
- type SessionHostConfigurationClient
- func (c SessionHostConfigurationClient) CreateOrUpdate(ctx context.Context, id HostPoolId, input SessionHostConfiguration) (result CreateOrUpdateOperationResponse, err error)
- func (c SessionHostConfigurationClient) CreateOrUpdateThenPoll(ctx context.Context, id HostPoolId, input SessionHostConfiguration) error
- func (c SessionHostConfigurationClient) Get(ctx context.Context, id HostPoolId) (result GetOperationResponse, err error)
- func (c SessionHostConfigurationClient) ListByHostPool(ctx context.Context, id HostPoolId) (result ListByHostPoolOperationResponse, err error)
- func (c SessionHostConfigurationClient) ListByHostPoolComplete(ctx context.Context, id HostPoolId) (ListByHostPoolCompleteResult, error)
- func (c SessionHostConfigurationClient) ListByHostPoolCompleteMatchingPredicate(ctx context.Context, id HostPoolId, ...) (result ListByHostPoolCompleteResult, err error)
- func (c SessionHostConfigurationClient) Update(ctx context.Context, id HostPoolId, input SessionHostConfigurationPatch) (result UpdateOperationResponse, err error)
- func (c SessionHostConfigurationClient) UpdateThenPoll(ctx context.Context, id HostPoolId, input SessionHostConfigurationPatch) error
- type SessionHostConfigurationOperationPredicate
- type SessionHostConfigurationPatch
- type SessionHostConfigurationPatchProperties
- type SessionHostConfigurationProperties
- type Type
- type UpdateOperationResponse
- type VirtualMachineDiskType
- type VirtualMachineSecurityType
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 ¶
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 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 ¶
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) 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 ListByHostPoolCompleteResult ¶
type ListByHostPoolCompleteResult struct { LatestHttpResponse *http.Response Items []SessionHostConfiguration }
type ListByHostPoolCustomPager ¶
func (*ListByHostPoolCustomPager) NextPageLink ¶
func (p *ListByHostPoolCustomPager) NextPageLink() *odata.Link
type ListByHostPoolOperationResponse ¶
type ListByHostPoolOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]SessionHostConfiguration }
type NetworkInfoProperties ¶
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 ¶
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 UpdateOperationResponse ¶
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
¶
- client.go
- constants.go
- id_hostpool.go
- method_createorupdate.go
- method_get.go
- method_listbyhostpool.go
- method_update.go
- model_activedirectoryinfopatchproperties.go
- model_activedirectoryinfoproperties.go
- model_azureactivedirectoryinfoproperties.go
- model_bootdiagnosticsinfopatchproperties.go
- model_bootdiagnosticsinfoproperties.go
- model_custominfopatchproperties.go
- model_custominfoproperties.go
- model_diskinfopatchproperties.go
- model_diskinfoproperties.go
- model_domaininfopatchproperties.go
- model_domaininfoproperties.go
- model_imageinfopatchproperties.go
- model_imageinfoproperties.go
- model_keyvaultcredentialspatchproperties.go
- model_keyvaultcredentialsproperties.go
- model_marketplaceinfopatchproperties.go
- model_marketplaceinfoproperties.go
- model_networkinfopatchproperties.go
- model_networkinfoproperties.go
- model_securityinfopatchproperties.go
- model_securityinfoproperties.go
- model_sessionhostconfiguration.go
- model_sessionhostconfigurationpatch.go
- model_sessionhostconfigurationpatchproperties.go
- model_sessionhostconfigurationproperties.go
- predicates.go
- version.go