virtualendpointcloudpc

package
v0.20241009.1142232 Latest Latest
Warning

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

Go to latest
Published: Oct 9, 2024 License: MPL-2.0 Imports: 9 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/microsoft-graph/devicemanagement/stable/virtualendpointcloudpc Documentation

The virtualendpointcloudpc SDK allows for interaction with Microsoft Graph devicemanagement (API Version stable).

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/microsoft-graph/devicemanagement/stable/virtualendpointcloudpc"

Client Initialization

client := virtualendpointcloudpc.NewVirtualEndpointCloudPCClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: VirtualEndpointCloudPCClient.CreateVirtualEndpointCloudPC

ctx := context.TODO()

payload := virtualendpointcloudpc.CloudPC{
	// ...
}


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

Example Usage: VirtualEndpointCloudPCClient.DeleteVirtualEndpointCloudPC

ctx := context.TODO()
id := virtualendpointcloudpc.NewDeviceManagementVirtualEndpointCloudPCID("cloudPCId")

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

Example Usage: VirtualEndpointCloudPCClient.EndVirtualEndpointCloudPCGracePeriod

ctx := context.TODO()
id := virtualendpointcloudpc.NewDeviceManagementVirtualEndpointCloudPCID("cloudPCId")

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

Example Usage: VirtualEndpointCloudPCClient.GetVirtualEndpointCloudPC

ctx := context.TODO()
id := virtualendpointcloudpc.NewDeviceManagementVirtualEndpointCloudPCID("cloudPCId")

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

Example Usage: VirtualEndpointCloudPCClient.GetVirtualEndpointCloudPCsCount

ctx := context.TODO()


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

Example Usage: VirtualEndpointCloudPCClient.ListVirtualEndpointCloudPCS

ctx := context.TODO()


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

Example Usage: VirtualEndpointCloudPCClient.RebootVirtualEndpointCloudPC

ctx := context.TODO()
id := virtualendpointcloudpc.NewDeviceManagementVirtualEndpointCloudPCID("cloudPCId")

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

Example Usage: VirtualEndpointCloudPCClient.RenameVirtualEndpointCloudPC

ctx := context.TODO()
id := virtualendpointcloudpc.NewDeviceManagementVirtualEndpointCloudPCID("cloudPCId")

payload := virtualendpointcloudpc.RenameVirtualEndpointCloudPCRequest{
	// ...
}


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

Example Usage: VirtualEndpointCloudPCClient.RestoreVirtualEndpointCloudPC

ctx := context.TODO()
id := virtualendpointcloudpc.NewDeviceManagementVirtualEndpointCloudPCID("cloudPCId")

payload := virtualendpointcloudpc.RestoreVirtualEndpointCloudPCRequest{
	// ...
}


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

Example Usage: VirtualEndpointCloudPCClient.TroubleshootVirtualEndpointCloudPC

ctx := context.TODO()
id := virtualendpointcloudpc.NewDeviceManagementVirtualEndpointCloudPCID("cloudPCId")

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

Example Usage: VirtualEndpointCloudPCClient.UpdateVirtualEndpointCloudPC

ctx := context.TODO()
id := virtualendpointcloudpc.NewDeviceManagementVirtualEndpointCloudPCID("cloudPCId")

payload := virtualendpointcloudpc.CloudPC{
	// ...
}


read, err := client.UpdateVirtualEndpointCloudPC(ctx, id, payload, virtualendpointcloudpc.DefaultUpdateVirtualEndpointCloudPCOperationOptions())
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

This section is empty.

Types

type CloudPCOperationPredicate

type CloudPCOperationPredicate struct {
}

func (CloudPCOperationPredicate) Matches

func (p CloudPCOperationPredicate) Matches(input stable.CloudPC) bool

type CreateVirtualEndpointCloudPCOperationOptions

type CreateVirtualEndpointCloudPCOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultCreateVirtualEndpointCloudPCOperationOptions

func DefaultCreateVirtualEndpointCloudPCOperationOptions() CreateVirtualEndpointCloudPCOperationOptions

func (CreateVirtualEndpointCloudPCOperationOptions) ToHeaders

func (CreateVirtualEndpointCloudPCOperationOptions) ToOData

func (CreateVirtualEndpointCloudPCOperationOptions) ToQuery

type CreateVirtualEndpointCloudPCOperationResponse

type CreateVirtualEndpointCloudPCOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.CloudPC
}

type DeleteVirtualEndpointCloudPCOperationOptions

type DeleteVirtualEndpointCloudPCOperationOptions struct {
	IfMatch   *string
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultDeleteVirtualEndpointCloudPCOperationOptions

func DefaultDeleteVirtualEndpointCloudPCOperationOptions() DeleteVirtualEndpointCloudPCOperationOptions

func (DeleteVirtualEndpointCloudPCOperationOptions) ToHeaders

func (DeleteVirtualEndpointCloudPCOperationOptions) ToOData

func (DeleteVirtualEndpointCloudPCOperationOptions) ToQuery

type DeleteVirtualEndpointCloudPCOperationResponse

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

type EndVirtualEndpointCloudPCGracePeriodOperationOptions

type EndVirtualEndpointCloudPCGracePeriodOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultEndVirtualEndpointCloudPCGracePeriodOperationOptions

func DefaultEndVirtualEndpointCloudPCGracePeriodOperationOptions() EndVirtualEndpointCloudPCGracePeriodOperationOptions

func (EndVirtualEndpointCloudPCGracePeriodOperationOptions) ToHeaders

func (EndVirtualEndpointCloudPCGracePeriodOperationOptions) ToOData

func (EndVirtualEndpointCloudPCGracePeriodOperationOptions) ToQuery

type EndVirtualEndpointCloudPCGracePeriodOperationResponse

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

type GetVirtualEndpointCloudPCOperationOptions

type GetVirtualEndpointCloudPCOperationOptions struct {
	Expand    *odata.Expand
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Select    *[]string
}

func DefaultGetVirtualEndpointCloudPCOperationOptions

func DefaultGetVirtualEndpointCloudPCOperationOptions() GetVirtualEndpointCloudPCOperationOptions

func (GetVirtualEndpointCloudPCOperationOptions) ToHeaders

func (GetVirtualEndpointCloudPCOperationOptions) ToOData

func (GetVirtualEndpointCloudPCOperationOptions) ToQuery

type GetVirtualEndpointCloudPCOperationResponse

type GetVirtualEndpointCloudPCOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.CloudPC
}

type GetVirtualEndpointCloudPCsCountOperationOptions

type GetVirtualEndpointCloudPCsCountOperationOptions struct {
	Filter    *string
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Search    *string
}

func DefaultGetVirtualEndpointCloudPCsCountOperationOptions

func DefaultGetVirtualEndpointCloudPCsCountOperationOptions() GetVirtualEndpointCloudPCsCountOperationOptions

func (GetVirtualEndpointCloudPCsCountOperationOptions) ToHeaders

func (GetVirtualEndpointCloudPCsCountOperationOptions) ToOData

func (GetVirtualEndpointCloudPCsCountOperationOptions) ToQuery

type GetVirtualEndpointCloudPCsCountOperationResponse

type GetVirtualEndpointCloudPCsCountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]byte
}

type ListVirtualEndpointCloudPCSCompleteResult

type ListVirtualEndpointCloudPCSCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.CloudPC
}

type ListVirtualEndpointCloudPCSCustomPager

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

type ListVirtualEndpointCloudPCSOperationOptions

type ListVirtualEndpointCloudPCSOperationOptions struct {
	Count     *bool
	Expand    *odata.Expand
	Filter    *string
	Metadata  *odata.Metadata
	OrderBy   *odata.OrderBy
	RetryFunc client.RequestRetryFunc
	Search    *string
	Select    *[]string
	Skip      *int64
	Top       *int64
}

func DefaultListVirtualEndpointCloudPCSOperationOptions

func DefaultListVirtualEndpointCloudPCSOperationOptions() ListVirtualEndpointCloudPCSOperationOptions

func (ListVirtualEndpointCloudPCSOperationOptions) ToHeaders

func (ListVirtualEndpointCloudPCSOperationOptions) ToOData

func (ListVirtualEndpointCloudPCSOperationOptions) ToQuery

type ListVirtualEndpointCloudPCSOperationResponse

type ListVirtualEndpointCloudPCSOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.CloudPC
}

type RebootVirtualEndpointCloudPCOperationOptions

type RebootVirtualEndpointCloudPCOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultRebootVirtualEndpointCloudPCOperationOptions

func DefaultRebootVirtualEndpointCloudPCOperationOptions() RebootVirtualEndpointCloudPCOperationOptions

func (RebootVirtualEndpointCloudPCOperationOptions) ToHeaders

func (RebootVirtualEndpointCloudPCOperationOptions) ToOData

func (RebootVirtualEndpointCloudPCOperationOptions) ToQuery

type RebootVirtualEndpointCloudPCOperationResponse

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

type RenameVirtualEndpointCloudPCOperationOptions

type RenameVirtualEndpointCloudPCOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultRenameVirtualEndpointCloudPCOperationOptions

func DefaultRenameVirtualEndpointCloudPCOperationOptions() RenameVirtualEndpointCloudPCOperationOptions

func (RenameVirtualEndpointCloudPCOperationOptions) ToHeaders

func (RenameVirtualEndpointCloudPCOperationOptions) ToOData

func (RenameVirtualEndpointCloudPCOperationOptions) ToQuery

type RenameVirtualEndpointCloudPCOperationResponse

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

type RenameVirtualEndpointCloudPCRequest

type RenameVirtualEndpointCloudPCRequest struct {
	DisplayName nullable.Type[string] `json:"displayName,omitempty"`
}

type RestoreVirtualEndpointCloudPCOperationOptions

type RestoreVirtualEndpointCloudPCOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultRestoreVirtualEndpointCloudPCOperationOptions

func DefaultRestoreVirtualEndpointCloudPCOperationOptions() RestoreVirtualEndpointCloudPCOperationOptions

func (RestoreVirtualEndpointCloudPCOperationOptions) ToHeaders

func (RestoreVirtualEndpointCloudPCOperationOptions) ToOData

func (RestoreVirtualEndpointCloudPCOperationOptions) ToQuery

type RestoreVirtualEndpointCloudPCOperationResponse

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

type RestoreVirtualEndpointCloudPCRequest

type RestoreVirtualEndpointCloudPCRequest struct {
	CloudPCSnapshotId nullable.Type[string] `json:"cloudPcSnapshotId,omitempty"`
}

type TroubleshootVirtualEndpointCloudPCOperationOptions

type TroubleshootVirtualEndpointCloudPCOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultTroubleshootVirtualEndpointCloudPCOperationOptions

func DefaultTroubleshootVirtualEndpointCloudPCOperationOptions() TroubleshootVirtualEndpointCloudPCOperationOptions

func (TroubleshootVirtualEndpointCloudPCOperationOptions) ToHeaders

func (TroubleshootVirtualEndpointCloudPCOperationOptions) ToOData

func (TroubleshootVirtualEndpointCloudPCOperationOptions) ToQuery

type TroubleshootVirtualEndpointCloudPCOperationResponse

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

type UpdateVirtualEndpointCloudPCOperationOptions

type UpdateVirtualEndpointCloudPCOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultUpdateVirtualEndpointCloudPCOperationOptions

func DefaultUpdateVirtualEndpointCloudPCOperationOptions() UpdateVirtualEndpointCloudPCOperationOptions

func (UpdateVirtualEndpointCloudPCOperationOptions) ToHeaders

func (UpdateVirtualEndpointCloudPCOperationOptions) ToOData

func (UpdateVirtualEndpointCloudPCOperationOptions) ToQuery

type UpdateVirtualEndpointCloudPCOperationResponse

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

type VirtualEndpointCloudPCClient

type VirtualEndpointCloudPCClient struct {
	Client *msgraph.Client
}

func NewVirtualEndpointCloudPCClientWithBaseURI

func NewVirtualEndpointCloudPCClientWithBaseURI(sdkApi sdkEnv.Api) (*VirtualEndpointCloudPCClient, error)

func (VirtualEndpointCloudPCClient) CreateVirtualEndpointCloudPC

CreateVirtualEndpointCloudPC - Create new navigation property to cloudPCs for deviceManagement

func (VirtualEndpointCloudPCClient) DeleteVirtualEndpointCloudPC

DeleteVirtualEndpointCloudPC - Delete navigation property cloudPCs for deviceManagement

func (VirtualEndpointCloudPCClient) EndVirtualEndpointCloudPCGracePeriod

EndVirtualEndpointCloudPCGracePeriod - Invoke action endGracePeriod. End the grace period for a specific cloudPC object. The grace period is triggered when the Cloud PC license is removed or the provisioning policy is unassigned. It allows users to access Cloud PCs for up to seven days before deprovisioning occurs. Ending the grace period immediately deprovisions the Cloud PC without waiting the seven days.

func (VirtualEndpointCloudPCClient) GetVirtualEndpointCloudPC

GetVirtualEndpointCloudPC - Get cloudPC. Read the properties and relationships of a specific cloudPC object.

func (VirtualEndpointCloudPCClient) GetVirtualEndpointCloudPCsCount

GetVirtualEndpointCloudPCsCount - Get the number of the resource

func (VirtualEndpointCloudPCClient) ListVirtualEndpointCloudPCS

ListVirtualEndpointCloudPCS - List cloudPCs. List the cloudPC devices in a tenant.

func (VirtualEndpointCloudPCClient) ListVirtualEndpointCloudPCSComplete

ListVirtualEndpointCloudPCSComplete retrieves all the results into a single object

func (VirtualEndpointCloudPCClient) ListVirtualEndpointCloudPCSCompleteMatchingPredicate

func (c VirtualEndpointCloudPCClient) ListVirtualEndpointCloudPCSCompleteMatchingPredicate(ctx context.Context, options ListVirtualEndpointCloudPCSOperationOptions, predicate CloudPCOperationPredicate) (result ListVirtualEndpointCloudPCSCompleteResult, err error)

ListVirtualEndpointCloudPCSCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (VirtualEndpointCloudPCClient) RebootVirtualEndpointCloudPC

RebootVirtualEndpointCloudPC - Invoke action reboot. Reboot a specific cloudPC object.

func (VirtualEndpointCloudPCClient) RenameVirtualEndpointCloudPC

RenameVirtualEndpointCloudPC - Invoke action rename. Rename a specific cloudPC object. Use this API to update the displayName of a Cloud PC entity.

func (VirtualEndpointCloudPCClient) RestoreVirtualEndpointCloudPC

RestoreVirtualEndpointCloudPC - Invoke action restore. Restore a specific cloudPC object to a previous state from a snapshot. Use this API to trigger a remote action that restores a Cloud PC device to a previous state.

func (VirtualEndpointCloudPCClient) TroubleshootVirtualEndpointCloudPC

TroubleshootVirtualEndpointCloudPC - Invoke action troubleshoot. Troubleshoot a specific cloudPC object. Use this API to check the health status of the Cloud PC and the session host.

func (VirtualEndpointCloudPCClient) UpdateVirtualEndpointCloudPC

UpdateVirtualEndpointCloudPC - Update the navigation property cloudPCs in deviceManagement

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL