intent

package
v0.20241017.1093842 Latest Latest
Warning

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

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

README

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

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

Client Initialization

client := intent.NewIntentClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: IntentClient.AssignIntent

ctx := context.TODO()
id := intent.NewDeviceManagementIntentID("deviceManagementIntentId")

payload := intent.AssignIntentRequest{
	// ...
}


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

Example Usage: IntentClient.CreateIntent

ctx := context.TODO()

payload := intent.DeviceManagementIntent{
	// ...
}


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

Example Usage: IntentClient.CreateIntentCopy

ctx := context.TODO()
id := intent.NewDeviceManagementIntentID("deviceManagementIntentId")

payload := intent.CreateIntentCopyRequest{
	// ...
}


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

Example Usage: IntentClient.CreateIntentMigrateToTemplate

ctx := context.TODO()
id := intent.NewDeviceManagementIntentID("deviceManagementIntentId")

payload := intent.CreateIntentMigrateToTemplateRequest{
	// ...
}


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

Example Usage: IntentClient.DeleteIntent

ctx := context.TODO()
id := intent.NewDeviceManagementIntentID("deviceManagementIntentId")

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

Example Usage: IntentClient.GetIntent

ctx := context.TODO()
id := intent.NewDeviceManagementIntentID("deviceManagementIntentId")

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

Example Usage: IntentClient.GetIntentsCount

ctx := context.TODO()


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

Example Usage: IntentClient.ListIntents

ctx := context.TODO()


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

Example Usage: IntentClient.UpdateIntent

ctx := context.TODO()
id := intent.NewDeviceManagementIntentID("deviceManagementIntentId")

payload := intent.DeviceManagementIntent{
	// ...
}


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

Example Usage: IntentClient.UpdateIntentSettings

ctx := context.TODO()
id := intent.NewDeviceManagementIntentID("deviceManagementIntentId")

payload := intent.UpdateIntentSettingsRequest{
	// ...
}


read, err := client.UpdateIntentSettings(ctx, id, payload, intent.DefaultUpdateIntentSettingsOperationOptions())
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 AssignIntentOperationOptions 

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

func DefaultAssignIntentOperationOptions 

func DefaultAssignIntentOperationOptions() AssignIntentOperationOptions

func (AssignIntentOperationOptions) ToHeaders 

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

func (AssignIntentOperationOptions) ToOData 

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

func (AssignIntentOperationOptions) ToQuery 

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

type AssignIntentOperationResponse 

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

type AssignIntentRequest 

type AssignIntentRequest struct {
	Assignments *[]beta.DeviceManagementIntentAssignment `json:"assignments,omitempty"`
}

type CreateIntentCopyOperationOptions 

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

func DefaultCreateIntentCopyOperationOptions 

func DefaultCreateIntentCopyOperationOptions() CreateIntentCopyOperationOptions

func (CreateIntentCopyOperationOptions) ToHeaders 

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

func (CreateIntentCopyOperationOptions) ToOData 

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

func (CreateIntentCopyOperationOptions) ToQuery 

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

type CreateIntentCopyOperationResponse 

type CreateIntentCopyOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.DeviceManagementIntent
}

type CreateIntentCopyRequest 

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

type CreateIntentMigrateToTemplateOperationOptions 

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

func DefaultCreateIntentMigrateToTemplateOperationOptions 

func DefaultCreateIntentMigrateToTemplateOperationOptions() CreateIntentMigrateToTemplateOperationOptions

func (CreateIntentMigrateToTemplateOperationOptions) ToHeaders 

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

func (CreateIntentMigrateToTemplateOperationOptions) ToOData 

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

func (CreateIntentMigrateToTemplateOperationOptions) ToQuery 

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

type CreateIntentMigrateToTemplateOperationResponse 

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

type CreateIntentMigrateToTemplateRequest 

type CreateIntentMigrateToTemplateRequest struct {
	NewTemplateId        nullable.Type[string] `json:"newTemplateId,omitempty"`
	PreserveCustomValues *bool                 `json:"preserveCustomValues,omitempty"`
}

type CreateIntentOperationOptions 

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

func DefaultCreateIntentOperationOptions 

func DefaultCreateIntentOperationOptions() CreateIntentOperationOptions

func (CreateIntentOperationOptions) ToHeaders 

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

func (CreateIntentOperationOptions) ToOData 

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

func (CreateIntentOperationOptions) ToQuery 

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

type CreateIntentOperationResponse 

type CreateIntentOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.DeviceManagementIntent
}

type DeleteIntentOperationOptions 

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

func DefaultDeleteIntentOperationOptions 

func DefaultDeleteIntentOperationOptions() DeleteIntentOperationOptions

func (DeleteIntentOperationOptions) ToHeaders 

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

func (DeleteIntentOperationOptions) ToOData 

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

func (DeleteIntentOperationOptions) ToQuery 

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

type DeleteIntentOperationResponse 

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

type DeviceManagementIntentOperationPredicate 

type DeviceManagementIntentOperationPredicate struct {
}

func (DeviceManagementIntentOperationPredicate) Matches 

func (p DeviceManagementIntentOperationPredicate) Matches(input beta.DeviceManagementIntent) bool

type GetIntentOperationOptions 

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

func DefaultGetIntentOperationOptions 

func DefaultGetIntentOperationOptions() GetIntentOperationOptions

func (GetIntentOperationOptions) ToHeaders 

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

func (GetIntentOperationOptions) ToOData 

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

func (GetIntentOperationOptions) ToQuery 

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

type GetIntentOperationResponse 

type GetIntentOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.DeviceManagementIntent
}

type GetIntentsCountOperationOptions 

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

func DefaultGetIntentsCountOperationOptions 

func DefaultGetIntentsCountOperationOptions() GetIntentsCountOperationOptions

func (GetIntentsCountOperationOptions) ToHeaders 

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

func (GetIntentsCountOperationOptions) ToOData 

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

func (GetIntentsCountOperationOptions) ToQuery 

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

type GetIntentsCountOperationResponse 

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

type IntentClient 

type IntentClient struct {
	Client *msgraph.Client
}

func NewIntentClientWithBaseURI 

func NewIntentClientWithBaseURI(sdkApi sdkEnv.Api) (*IntentClient, error)

func (IntentClient) AssignIntent 

func (c IntentClient) AssignIntent(ctx context.Context, id beta.DeviceManagementIntentId, input AssignIntentRequest, options AssignIntentOperationOptions) (result AssignIntentOperationResponse, err error)

AssignIntent - Invoke action assign

func (IntentClient) CreateIntent 

func (c IntentClient) CreateIntent(ctx context.Context, input beta.DeviceManagementIntent, options CreateIntentOperationOptions) (result CreateIntentOperationResponse, err error)

CreateIntent - Create new navigation property to intents for deviceManagement

func (IntentClient) CreateIntentCopy 

func (c IntentClient) CreateIntentCopy(ctx context.Context, id beta.DeviceManagementIntentId, input CreateIntentCopyRequest, options CreateIntentCopyOperationOptions) (result CreateIntentCopyOperationResponse, err error)

CreateIntentCopy - Invoke action createCopy

func (IntentClient) CreateIntentMigrateToTemplate 

func (c IntentClient) CreateIntentMigrateToTemplate(ctx context.Context, id beta.DeviceManagementIntentId, input CreateIntentMigrateToTemplateRequest, options CreateIntentMigrateToTemplateOperationOptions) (result CreateIntentMigrateToTemplateOperationResponse, err error)

CreateIntentMigrateToTemplate - Invoke action migrateToTemplate

func (IntentClient) DeleteIntent 

func (c IntentClient) DeleteIntent(ctx context.Context, id beta.DeviceManagementIntentId, options DeleteIntentOperationOptions) (result DeleteIntentOperationResponse, err error)

DeleteIntent - Delete navigation property intents for deviceManagement

func (IntentClient) GetIntent 

func (c IntentClient) GetIntent(ctx context.Context, id beta.DeviceManagementIntentId, options GetIntentOperationOptions) (result GetIntentOperationResponse, err error)

GetIntent - Get intents from deviceManagement. The device management intents

func (IntentClient) GetIntentsCount 

func (c IntentClient) GetIntentsCount(ctx context.Context, options GetIntentsCountOperationOptions) (result GetIntentsCountOperationResponse, err error)

GetIntentsCount - Get the number of the resource

func (IntentClient) ListIntents 

func (c IntentClient) ListIntents(ctx context.Context, options ListIntentsOperationOptions) (result ListIntentsOperationResponse, err error)

ListIntents - Get intents from deviceManagement. The device management intents

func (IntentClient) ListIntentsComplete 

func (c IntentClient) ListIntentsComplete(ctx context.Context, options ListIntentsOperationOptions) (ListIntentsCompleteResult, error)

ListIntentsComplete retrieves all the results into a single object

func (IntentClient) ListIntentsCompleteMatchingPredicate 

func (c IntentClient) ListIntentsCompleteMatchingPredicate(ctx context.Context, options ListIntentsOperationOptions, predicate DeviceManagementIntentOperationPredicate) (result ListIntentsCompleteResult, err error)

ListIntentsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (IntentClient) UpdateIntent 

func (c IntentClient) UpdateIntent(ctx context.Context, id beta.DeviceManagementIntentId, input beta.DeviceManagementIntent, options UpdateIntentOperationOptions) (result UpdateIntentOperationResponse, err error)

UpdateIntent - Update the navigation property intents in deviceManagement

func (IntentClient) UpdateIntentSettings 

func (c IntentClient) UpdateIntentSettings(ctx context.Context, id beta.DeviceManagementIntentId, input UpdateIntentSettingsRequest, options UpdateIntentSettingsOperationOptions) (result UpdateIntentSettingsOperationResponse, err error)

UpdateIntentSettings - Invoke action updateSettings

type ListIntentsCompleteResult 

type ListIntentsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []beta.DeviceManagementIntent
}

type ListIntentsCustomPager 

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

type ListIntentsOperationOptions 

type ListIntentsOperationOptions 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 DefaultListIntentsOperationOptions 

func DefaultListIntentsOperationOptions() ListIntentsOperationOptions

func (ListIntentsOperationOptions) ToHeaders 

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

func (ListIntentsOperationOptions) ToOData 

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

func (ListIntentsOperationOptions) ToQuery 

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

type ListIntentsOperationResponse 

type ListIntentsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]beta.DeviceManagementIntent
}

type UpdateIntentOperationOptions 

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

func DefaultUpdateIntentOperationOptions 

func DefaultUpdateIntentOperationOptions() UpdateIntentOperationOptions

func (UpdateIntentOperationOptions) ToHeaders 

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

func (UpdateIntentOperationOptions) ToOData 

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

func (UpdateIntentOperationOptions) ToQuery 

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

type UpdateIntentOperationResponse 

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

type UpdateIntentSettingsOperationOptions 

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

func DefaultUpdateIntentSettingsOperationOptions 

func DefaultUpdateIntentSettingsOperationOptions() UpdateIntentSettingsOperationOptions

func (UpdateIntentSettingsOperationOptions) ToHeaders 

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

func (UpdateIntentSettingsOperationOptions) ToOData 

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

func (UpdateIntentSettingsOperationOptions) ToQuery 

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

type UpdateIntentSettingsOperationResponse 

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

type UpdateIntentSettingsRequest 

type UpdateIntentSettingsRequest struct {
	Settings *[]beta.DeviceManagementSettingInstance `json:"settings,omitempty"`
}

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.