virtualendpointonpremisesconnection

package
v0.20241029.1112340 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/microsoft-graph/devicemanagement/beta/virtualendpointonpremisesconnection Documentation

The virtualendpointonpremisesconnection SDK allows for interaction with Microsoft Graph devicemanagement (API Version beta).

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/beta/virtualendpointonpremisesconnection"

Client Initialization

client := virtualendpointonpremisesconnection.NewVirtualEndpointOnPremisesConnectionClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: VirtualEndpointOnPremisesConnectionClient.CreateVirtualEndpointOnPremisesConnection

ctx := context.TODO()

payload := virtualendpointonpremisesconnection.CloudPCOnPremisesConnection{
	// ...
}


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

Example Usage: VirtualEndpointOnPremisesConnectionClient.CreateVirtualEndpointOnPremisesConnectionRunHealthCheck

ctx := context.TODO()
id := virtualendpointonpremisesconnection.NewDeviceManagementVirtualEndpointOnPremisesConnectionID("cloudPCOnPremisesConnectionId")

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

Example Usage: VirtualEndpointOnPremisesConnectionClient.DeleteVirtualEndpointOnPremisesConnection

ctx := context.TODO()
id := virtualendpointonpremisesconnection.NewDeviceManagementVirtualEndpointOnPremisesConnectionID("cloudPCOnPremisesConnectionId")

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

Example Usage: VirtualEndpointOnPremisesConnectionClient.GetVirtualEndpointOnPremisesConnection

ctx := context.TODO()
id := virtualendpointonpremisesconnection.NewDeviceManagementVirtualEndpointOnPremisesConnectionID("cloudPCOnPremisesConnectionId")

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

Example Usage: VirtualEndpointOnPremisesConnectionClient.GetVirtualEndpointOnPremisesConnectionsCount

ctx := context.TODO()


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

Example Usage: VirtualEndpointOnPremisesConnectionClient.ListVirtualEndpointOnPremisesConnections

ctx := context.TODO()


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

Example Usage: VirtualEndpointOnPremisesConnectionClient.UpdateVirtualEndpointOnPremisesConnection

ctx := context.TODO()
id := virtualendpointonpremisesconnection.NewDeviceManagementVirtualEndpointOnPremisesConnectionID("cloudPCOnPremisesConnectionId")

payload := virtualendpointonpremisesconnection.CloudPCOnPremisesConnection{
	// ...
}


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

Example Usage: VirtualEndpointOnPremisesConnectionClient.UpdateVirtualEndpointOnPremisesConnectionAdDomainPassword

ctx := context.TODO()
id := virtualendpointonpremisesconnection.NewDeviceManagementVirtualEndpointOnPremisesConnectionID("cloudPCOnPremisesConnectionId")

payload := virtualendpointonpremisesconnection.UpdateVirtualEndpointOnPremisesConnectionAdDomainPasswordRequest{
	// ...
}


read, err := client.UpdateVirtualEndpointOnPremisesConnectionAdDomainPassword(ctx, id, payload, virtualendpointonpremisesconnection.DefaultUpdateVirtualEndpointOnPremisesConnectionAdDomainPasswordOperationOptions())
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 CloudPCOnPremisesConnectionOperationPredicate

type CloudPCOnPremisesConnectionOperationPredicate struct {
}

func (CloudPCOnPremisesConnectionOperationPredicate) Matches

type CreateVirtualEndpointOnPremisesConnectionOperationOptions

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

func (CreateVirtualEndpointOnPremisesConnectionOperationOptions) ToHeaders

func (CreateVirtualEndpointOnPremisesConnectionOperationOptions) ToOData

func (CreateVirtualEndpointOnPremisesConnectionOperationOptions) ToQuery

type CreateVirtualEndpointOnPremisesConnectionOperationResponse

type CreateVirtualEndpointOnPremisesConnectionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.CloudPCOnPremisesConnection
}

type CreateVirtualEndpointOnPremisesConnectionRunHealthCheckOperationOptions

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

func (CreateVirtualEndpointOnPremisesConnectionRunHealthCheckOperationOptions) ToHeaders

func (CreateVirtualEndpointOnPremisesConnectionRunHealthCheckOperationOptions) ToOData

func (CreateVirtualEndpointOnPremisesConnectionRunHealthCheckOperationOptions) ToQuery

type CreateVirtualEndpointOnPremisesConnectionRunHealthCheckOperationResponse

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

type DeleteVirtualEndpointOnPremisesConnectionOperationOptions

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

func (DeleteVirtualEndpointOnPremisesConnectionOperationOptions) ToHeaders

func (DeleteVirtualEndpointOnPremisesConnectionOperationOptions) ToOData

func (DeleteVirtualEndpointOnPremisesConnectionOperationOptions) ToQuery

type DeleteVirtualEndpointOnPremisesConnectionOperationResponse

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

type GetVirtualEndpointOnPremisesConnectionOperationOptions

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

func DefaultGetVirtualEndpointOnPremisesConnectionOperationOptions

func DefaultGetVirtualEndpointOnPremisesConnectionOperationOptions() GetVirtualEndpointOnPremisesConnectionOperationOptions

func (GetVirtualEndpointOnPremisesConnectionOperationOptions) ToHeaders

func (GetVirtualEndpointOnPremisesConnectionOperationOptions) ToOData

func (GetVirtualEndpointOnPremisesConnectionOperationOptions) ToQuery

type GetVirtualEndpointOnPremisesConnectionOperationResponse

type GetVirtualEndpointOnPremisesConnectionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.CloudPCOnPremisesConnection
}

type GetVirtualEndpointOnPremisesConnectionsCountOperationOptions

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

func (GetVirtualEndpointOnPremisesConnectionsCountOperationOptions) ToHeaders

func (GetVirtualEndpointOnPremisesConnectionsCountOperationOptions) ToOData

func (GetVirtualEndpointOnPremisesConnectionsCountOperationOptions) ToQuery

type GetVirtualEndpointOnPremisesConnectionsCountOperationResponse

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

type ListVirtualEndpointOnPremisesConnectionsCompleteResult

type ListVirtualEndpointOnPremisesConnectionsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []beta.CloudPCOnPremisesConnection
}

type ListVirtualEndpointOnPremisesConnectionsCustomPager

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

type ListVirtualEndpointOnPremisesConnectionsOperationOptions

type ListVirtualEndpointOnPremisesConnectionsOperationOptions 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 (ListVirtualEndpointOnPremisesConnectionsOperationOptions) ToHeaders

func (ListVirtualEndpointOnPremisesConnectionsOperationOptions) ToOData

func (ListVirtualEndpointOnPremisesConnectionsOperationOptions) ToQuery

type ListVirtualEndpointOnPremisesConnectionsOperationResponse

type ListVirtualEndpointOnPremisesConnectionsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]beta.CloudPCOnPremisesConnection
}

type UpdateVirtualEndpointOnPremisesConnectionAdDomainPasswordOperationOptions

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

func (UpdateVirtualEndpointOnPremisesConnectionAdDomainPasswordOperationOptions) ToHeaders

func (UpdateVirtualEndpointOnPremisesConnectionAdDomainPasswordOperationOptions) ToOData

func (UpdateVirtualEndpointOnPremisesConnectionAdDomainPasswordOperationOptions) ToQuery

type UpdateVirtualEndpointOnPremisesConnectionAdDomainPasswordOperationResponse

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

type UpdateVirtualEndpointOnPremisesConnectionAdDomainPasswordRequest

type UpdateVirtualEndpointOnPremisesConnectionAdDomainPasswordRequest struct {
	AdDomainPassword nullable.Type[string] `json:"adDomainPassword,omitempty"`
}

type UpdateVirtualEndpointOnPremisesConnectionOperationOptions

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

func (UpdateVirtualEndpointOnPremisesConnectionOperationOptions) ToHeaders

func (UpdateVirtualEndpointOnPremisesConnectionOperationOptions) ToOData

func (UpdateVirtualEndpointOnPremisesConnectionOperationOptions) ToQuery

type UpdateVirtualEndpointOnPremisesConnectionOperationResponse

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

type VirtualEndpointOnPremisesConnectionClient

type VirtualEndpointOnPremisesConnectionClient struct {
	Client *msgraph.Client
}

func NewVirtualEndpointOnPremisesConnectionClientWithBaseURI

func NewVirtualEndpointOnPremisesConnectionClientWithBaseURI(sdkApi sdkEnv.Api) (*VirtualEndpointOnPremisesConnectionClient, error)

func (VirtualEndpointOnPremisesConnectionClient) CreateVirtualEndpointOnPremisesConnection

CreateVirtualEndpointOnPremisesConnection - Create cloudPcOnPremisesConnection. Create a new cloudPcOnPremisesConnection object for provisioning Cloud PCs.

func (VirtualEndpointOnPremisesConnectionClient) CreateVirtualEndpointOnPremisesConnectionRunHealthCheck

CreateVirtualEndpointOnPremisesConnectionRunHealthCheck - Invoke action runHealthChecks. Run health checks on the cloudPcOnPremisesConnection object. It triggers a new health check for this cloudPcOnPremisesConnection object and change the healthCheckStatus and healthCheckStatusDetails properties when check finished.

func (VirtualEndpointOnPremisesConnectionClient) DeleteVirtualEndpointOnPremisesConnection

DeleteVirtualEndpointOnPremisesConnection - Delete cloudPcOnPremisesConnection. Delete a specific cloudPcOnPremisesConnection object. When you delete an Azure network connection, permissions to the service are removed from the specified Azure resources. You can't delete an Azure network connection when it's in use, as indicated by the inUse property.

func (VirtualEndpointOnPremisesConnectionClient) GetVirtualEndpointOnPremisesConnection

GetVirtualEndpointOnPremisesConnection - Get cloudPcOnPremisesConnection. Read the properties and relationships of the cloudPcOnPremisesConnection object.

func (VirtualEndpointOnPremisesConnectionClient) GetVirtualEndpointOnPremisesConnectionsCount

GetVirtualEndpointOnPremisesConnectionsCount - Get the number of the resource

func (VirtualEndpointOnPremisesConnectionClient) ListVirtualEndpointOnPremisesConnections

ListVirtualEndpointOnPremisesConnections - List onPremisesConnections. Get a list of the cloudPcOnPremisesConnection objects and their properties.

func (VirtualEndpointOnPremisesConnectionClient) ListVirtualEndpointOnPremisesConnectionsComplete

ListVirtualEndpointOnPremisesConnectionsComplete retrieves all the results into a single object

func (VirtualEndpointOnPremisesConnectionClient) ListVirtualEndpointOnPremisesConnectionsCompleteMatchingPredicate

ListVirtualEndpointOnPremisesConnectionsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (VirtualEndpointOnPremisesConnectionClient) UpdateVirtualEndpointOnPremisesConnection

UpdateVirtualEndpointOnPremisesConnection - Update cloudPcOnPremisesConnection. Update the properties of a cloudPcOnPremisesConnection object.

func (VirtualEndpointOnPremisesConnectionClient) UpdateVirtualEndpointOnPremisesConnectionAdDomainPassword

UpdateVirtualEndpointOnPremisesConnectionAdDomainPassword - Invoke action updateAdDomainPassword. Update the Active Directory domain password for a cloudPcOnPremisesConnection object. This API is supported when the type of the cloudPcOnPremisesConnection object is hybridAzureADJoin.

Jump to

Keyboard shortcuts

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