applicationgroup

package
v0.20240923.1142107 Latest Latest
Warning

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

 Go to latest Published: Sep 23, 2024 License: MPL-2.0 Imports: 14 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/desktopvirtualization/2022-02-10-preview/applicationgroup Documentation

The applicationgroup SDK allows for interaction with Azure Resource Manager desktopvirtualization (API Version 2022-02-10-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/desktopvirtualization/2022-02-10-preview/applicationgroup"

Client Initialization

client := applicationgroup.NewApplicationGroupClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApplicationGroupClient.CreateOrUpdate

ctx := context.TODO()
id := applicationgroup.NewApplicationGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "applicationGroupName")

payload := applicationgroup.ApplicationGroup{
	// ...
}


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

Example Usage: ApplicationGroupClient.Delete

ctx := context.TODO()
id := applicationgroup.NewApplicationGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "applicationGroupName")

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

Example Usage: ApplicationGroupClient.Get

ctx := context.TODO()
id := applicationgroup.NewApplicationGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "applicationGroupName")

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: ApplicationGroupClient.ListByResourceGroup

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

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

Example Usage: ApplicationGroupClient.ListBySubscription

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: ApplicationGroupClient.Update

ctx := context.TODO()
id := applicationgroup.NewApplicationGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "applicationGroupName")

payload := applicationgroup.ApplicationGroupPatch{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForApplicationGroupType 

func PossibleValuesForApplicationGroupType() []string

func PossibleValuesForOperation 

func PossibleValuesForOperation() []string

func PossibleValuesForSkuTier 

func PossibleValuesForSkuTier() []string

func ValidateApplicationGroupID 

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

ValidateApplicationGroupID checks that 'input' can be parsed as a Application Group ID

Types

type ApplicationGroup 

type ApplicationGroup 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 ApplicationGroupProperties `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 ApplicationGroupClient 

type ApplicationGroupClient struct {
	Client *resourcemanager.Client
}

func NewApplicationGroupClientWithBaseURI 

func NewApplicationGroupClientWithBaseURI(sdkApi sdkEnv.Api) (*ApplicationGroupClient, error)

func (ApplicationGroupClient) CreateOrUpdate 

func (c ApplicationGroupClient) CreateOrUpdate(ctx context.Context, id ApplicationGroupId, input ApplicationGroup) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ApplicationGroupClient) Delete 

func (c ApplicationGroupClient) Delete(ctx context.Context, id ApplicationGroupId) (result DeleteOperationResponse, err error)

Delete ...

func (ApplicationGroupClient) Get 

func (c ApplicationGroupClient) Get(ctx context.Context, id ApplicationGroupId) (result GetOperationResponse, err error)

Get ...

func (ApplicationGroupClient) ListByResourceGroup 

func (c ApplicationGroupClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId, options ListByResourceGroupOperationOptions) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (ApplicationGroupClient) ListByResourceGroupComplete 

func (c ApplicationGroupClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId, options ListByResourceGroupOperationOptions) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (ApplicationGroupClient) ListByResourceGroupCompleteMatchingPredicate 

func (c ApplicationGroupClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, options ListByResourceGroupOperationOptions, predicate ApplicationGroupOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ApplicationGroupClient) ListBySubscription 

func (c ApplicationGroupClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (ApplicationGroupClient) ListBySubscriptionComplete 

func (c ApplicationGroupClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (ApplicationGroupClient) ListBySubscriptionCompleteMatchingPredicate 

func (c ApplicationGroupClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions, predicate ApplicationGroupOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ApplicationGroupClient) Update 

func (c ApplicationGroupClient) Update(ctx context.Context, id ApplicationGroupId, input ApplicationGroupPatch) (result UpdateOperationResponse, err error)

Update ...

type ApplicationGroupId 

type ApplicationGroupId struct {
	SubscriptionId       string
	ResourceGroupName    string
	ApplicationGroupName string
}

ApplicationGroupId is a struct representing the Resource ID for a Application Group

func NewApplicationGroupID 

func NewApplicationGroupID(subscriptionId string, resourceGroupName string, applicationGroupName string) ApplicationGroupId

NewApplicationGroupID returns a new ApplicationGroupId struct

func ParseApplicationGroupID 

func ParseApplicationGroupID(input string) (*ApplicationGroupId, error)

ParseApplicationGroupID parses 'input' into a ApplicationGroupId

func ParseApplicationGroupIDInsensitively 

func ParseApplicationGroupIDInsensitively(input string) (*ApplicationGroupId, error)

ParseApplicationGroupIDInsensitively parses 'input' case-insensitively into a ApplicationGroupId note: this method should only be used for API response data and not user input

func (*ApplicationGroupId) FromParseResult 

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

func (ApplicationGroupId) ID 

func (id ApplicationGroupId) ID() string

ID returns the formatted Application Group ID

func (ApplicationGroupId) Segments 

func (id ApplicationGroupId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Application Group ID

func (ApplicationGroupId) String 

func (id ApplicationGroupId) String() string

String returns a human-readable description of this Application Group ID

type ApplicationGroupOperationPredicate 

type ApplicationGroupOperationPredicate struct {
	Etag      *string
	Id        *string
	Kind      *string
	Location  *string
	ManagedBy *string
	Name      *string
	Type      *string
}

func (ApplicationGroupOperationPredicate) Matches 

func (p ApplicationGroupOperationPredicate) Matches(input ApplicationGroup) bool

type ApplicationGroupPatch 

type ApplicationGroupPatch struct {
	Id         *string                          `json:"id,omitempty"`
	Name       *string                          `json:"name,omitempty"`
	Properties *ApplicationGroupPatchProperties `json:"properties,omitempty"`
	Tags       *map[string]string               `json:"tags,omitempty"`
	Type       *string                          `json:"type,omitempty"`
}

type ApplicationGroupPatchProperties 

type ApplicationGroupPatchProperties struct {
	Description  *string `json:"description,omitempty"`
	FriendlyName *string `json:"friendlyName,omitempty"`
}

type ApplicationGroupProperties 

type ApplicationGroupProperties struct {
	ApplicationGroupType ApplicationGroupType        `json:"applicationGroupType"`
	CloudPcResource      *bool                       `json:"cloudPcResource,omitempty"`
	Description          *string                     `json:"description,omitempty"`
	FriendlyName         *string                     `json:"friendlyName,omitempty"`
	HostPoolArmPath      string                      `json:"hostPoolArmPath"`
	MigrationRequest     *MigrationRequestProperties `json:"migrationRequest,omitempty"`
	ObjectId             *string                     `json:"objectId,omitempty"`
	WorkspaceArmPath     *string                     `json:"workspaceArmPath,omitempty"`
}

type ApplicationGroupType 

type ApplicationGroupType string
const (
	ApplicationGroupTypeDesktop   ApplicationGroupType = "Desktop"
	ApplicationGroupTypeRemoteApp ApplicationGroupType = "RemoteApp"
)

func (*ApplicationGroupType) UnmarshalJSON 

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

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApplicationGroup
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse 

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

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ApplicationGroup
}

type ListByResourceGroupCustomPager added in v0.20240628.1153531 

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

type ListByResourceGroupOperationOptions 

type ListByResourceGroupOperationOptions struct {
	Filter *string
}

func DefaultListByResourceGroupOperationOptions 

func DefaultListByResourceGroupOperationOptions() ListByResourceGroupOperationOptions

func (ListByResourceGroupOperationOptions) ToHeaders 

func (o ListByResourceGroupOperationOptions) ToHeaders() *client.Headers

func (ListByResourceGroupOperationOptions) ToOData 

func (o ListByResourceGroupOperationOptions) ToOData() *odata.Query

func (ListByResourceGroupOperationOptions) ToQuery 

func (o ListByResourceGroupOperationOptions) ToQuery() *client.QueryParams

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ApplicationGroup
}

type ListBySubscriptionCompleteResult 

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ApplicationGroup
}

type ListBySubscriptionCustomPager added in v0.20240628.1153531 

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

type ListBySubscriptionOperationOptions 

type ListBySubscriptionOperationOptions struct {
	Filter *string
}

func DefaultListBySubscriptionOperationOptions 

func DefaultListBySubscriptionOperationOptions() ListBySubscriptionOperationOptions

func (ListBySubscriptionOperationOptions) ToHeaders 

func (o ListBySubscriptionOperationOptions) ToHeaders() *client.Headers

func (ListBySubscriptionOperationOptions) ToOData 

func (o ListBySubscriptionOperationOptions) ToOData() *odata.Query

func (ListBySubscriptionOperationOptions) ToQuery 

func (o ListBySubscriptionOperationOptions) ToQuery() *client.QueryParams

type ListBySubscriptionOperationResponse 

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ApplicationGroup
}

type MigrationRequestProperties 

type MigrationRequestProperties struct {
	MigrationPath *string    `json:"migrationPath,omitempty"`
	Operation     *Operation `json:"operation,omitempty"`
}

type Operation 

type Operation string
const (
	OperationComplete Operation = "Complete"
	OperationHide     Operation = "Hide"
	OperationRevoke   Operation = "Revoke"
	OperationStart    Operation = "Start"
	OperationUnhide   Operation = "Unhide"
)

func (*Operation) UnmarshalJSON 

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

type Plan 

type Plan struct {
	Name          string  `json:"name"`
	Product       string  `json:"product"`
	PromotionCode *string `json:"promotionCode,omitempty"`
	Publisher     string  `json:"publisher"`
	Version       *string `json:"version,omitempty"`
}

type Sku 

type Sku struct {
	Capacity *int64   `json:"capacity,omitempty"`
	Family   *string  `json:"family,omitempty"`
	Name     string   `json:"name"`
	Size     *string  `json:"size,omitempty"`
	Tier     *SkuTier `json:"tier,omitempty"`
}

type SkuTier 

type SkuTier string
const (
	SkuTierBasic    SkuTier = "Basic"
	SkuTierFree     SkuTier = "Free"
	SkuTierPremium  SkuTier = "Premium"
	SkuTierStandard SkuTier = "Standard"
)

func (*SkuTier) UnmarshalJSON 

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

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApplicationGroup
}

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.