template

package
v0.20241126.1723 Latest Latest
Warning

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

 Go to latest Published: Nov 26, 2024 License: MPL-2.0 Imports: 10 Imported by: 0

README

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

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

Client Initialization

client := template.NewTemplateClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: TemplateClient.CreateTemplate

ctx := context.TODO()

payload := template.DeviceManagementTemplate{
	// ...
}


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

Example Usage: TemplateClient.CreateTemplateInstance

ctx := context.TODO()
id := template.NewDeviceManagementTemplateID("deviceManagementTemplateId")

payload := template.CreateTemplateInstanceRequest{
	// ...
}


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

Example Usage: TemplateClient.DeleteTemplate

ctx := context.TODO()
id := template.NewDeviceManagementTemplateID("deviceManagementTemplateId")

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

Example Usage: TemplateClient.GetTemplate

ctx := context.TODO()
id := template.NewDeviceManagementTemplateID("deviceManagementTemplateId")

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

Example Usage: TemplateClient.GetTemplatesCount

ctx := context.TODO()


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

Example Usage: TemplateClient.ListTemplateImportOffice365DeviceConfigurationPolicies

ctx := context.TODO()


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

Example Usage: TemplateClient.ListTemplates

ctx := context.TODO()


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

Example Usage: TemplateClient.UpdateTemplate

ctx := context.TODO()
id := template.NewDeviceManagementTemplateID("deviceManagementTemplateId")

payload := template.DeviceManagementTemplate{
	// ...
}


read, err := client.UpdateTemplate(ctx, id, payload, template.DefaultUpdateTemplateOperationOptions())
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 CreateTemplateInstanceOperationOptions 

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

func DefaultCreateTemplateInstanceOperationOptions 

func DefaultCreateTemplateInstanceOperationOptions() CreateTemplateInstanceOperationOptions

func (CreateTemplateInstanceOperationOptions) ToHeaders 

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

func (CreateTemplateInstanceOperationOptions) ToOData 

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

func (CreateTemplateInstanceOperationOptions) ToQuery 

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

type CreateTemplateInstanceOperationResponse 

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

type CreateTemplateInstanceRequest 

type CreateTemplateInstanceRequest struct {
	Description     nullable.Type[string]                   `json:"description,omitempty"`
	DisplayName     nullable.Type[string]                   `json:"displayName,omitempty"`
	RoleScopeTagIds *[]string                               `json:"roleScopeTagIds,omitempty"`
	SettingsDelta   *[]beta.DeviceManagementSettingInstance `json:"settingsDelta,omitempty"`
}

type CreateTemplateOperationOptions 

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

func DefaultCreateTemplateOperationOptions 

func DefaultCreateTemplateOperationOptions() CreateTemplateOperationOptions

func (CreateTemplateOperationOptions) ToHeaders 

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

func (CreateTemplateOperationOptions) ToOData 

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

func (CreateTemplateOperationOptions) ToQuery 

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

type CreateTemplateOperationResponse 

type CreateTemplateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        beta.DeviceManagementTemplate
}

type DeleteTemplateOperationOptions 

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

func DefaultDeleteTemplateOperationOptions 

func DefaultDeleteTemplateOperationOptions() DeleteTemplateOperationOptions

func (DeleteTemplateOperationOptions) ToHeaders 

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

func (DeleteTemplateOperationOptions) ToOData 

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

func (DeleteTemplateOperationOptions) ToQuery 

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

type DeleteTemplateOperationResponse 

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

type DeviceManagementIntentOperationPredicate 

type DeviceManagementIntentOperationPredicate struct {
}

func (DeviceManagementIntentOperationPredicate) Matches 

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

type DeviceManagementTemplateOperationPredicate 

type DeviceManagementTemplateOperationPredicate struct {
}

func (DeviceManagementTemplateOperationPredicate) Matches 

func (p DeviceManagementTemplateOperationPredicate) Matches(input beta.DeviceManagementTemplate) bool

type GetTemplateOperationOptions 

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

func DefaultGetTemplateOperationOptions 

func DefaultGetTemplateOperationOptions() GetTemplateOperationOptions

func (GetTemplateOperationOptions) ToHeaders 

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

func (GetTemplateOperationOptions) ToOData 

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

func (GetTemplateOperationOptions) ToQuery 

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

type GetTemplateOperationResponse 

type GetTemplateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        beta.DeviceManagementTemplate
}

type GetTemplatesCountOperationOptions 

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

func DefaultGetTemplatesCountOperationOptions 

func DefaultGetTemplatesCountOperationOptions() GetTemplatesCountOperationOptions

func (GetTemplatesCountOperationOptions) ToHeaders 

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

func (GetTemplatesCountOperationOptions) ToOData 

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

func (GetTemplatesCountOperationOptions) ToQuery 

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

type GetTemplatesCountOperationResponse 

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

type ListTemplateImportOffice365DeviceConfigurationPoliciesCompleteResult 

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

type ListTemplateImportOffice365DeviceConfigurationPoliciesCustomPager 

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

type ListTemplateImportOffice365DeviceConfigurationPoliciesOperationOptions 

type ListTemplateImportOffice365DeviceConfigurationPoliciesOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Skip      *int64
	Top       *int64
}

func DefaultListTemplateImportOffice365DeviceConfigurationPoliciesOperationOptions 

func DefaultListTemplateImportOffice365DeviceConfigurationPoliciesOperationOptions() ListTemplateImportOffice365DeviceConfigurationPoliciesOperationOptions

func (ListTemplateImportOffice365DeviceConfigurationPoliciesOperationOptions) ToHeaders 

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

func (ListTemplateImportOffice365DeviceConfigurationPoliciesOperationOptions) ToOData 

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

func (ListTemplateImportOffice365DeviceConfigurationPoliciesOperationOptions) ToQuery 

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

type ListTemplateImportOffice365DeviceConfigurationPoliciesOperationResponse 

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

type ListTemplatesCompleteResult 

type ListTemplatesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []beta.DeviceManagementTemplate
}

type ListTemplatesCustomPager 

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

type ListTemplatesOperationOptions 

type ListTemplatesOperationOptions 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 DefaultListTemplatesOperationOptions 

func DefaultListTemplatesOperationOptions() ListTemplatesOperationOptions

func (ListTemplatesOperationOptions) ToHeaders 

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

func (ListTemplatesOperationOptions) ToOData 

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

func (ListTemplatesOperationOptions) ToQuery 

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

type ListTemplatesOperationResponse 

type ListTemplatesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]beta.DeviceManagementTemplate
}

type TemplateClient 

type TemplateClient struct {
	Client *msgraph.Client
}

func NewTemplateClientWithBaseURI 

func NewTemplateClientWithBaseURI(sdkApi sdkEnv.Api) (*TemplateClient, error)

func (TemplateClient) CreateTemplate 

func (c TemplateClient) CreateTemplate(ctx context.Context, input beta.DeviceManagementTemplate, options CreateTemplateOperationOptions) (result CreateTemplateOperationResponse, err error)

CreateTemplate - Create new navigation property to templates for deviceManagement

func (TemplateClient) CreateTemplateInstance 

func (c TemplateClient) CreateTemplateInstance(ctx context.Context, id beta.DeviceManagementTemplateId, input CreateTemplateInstanceRequest, options CreateTemplateInstanceOperationOptions) (result CreateTemplateInstanceOperationResponse, err error)

CreateTemplateInstance - Invoke action createInstance

func (TemplateClient) DeleteTemplate 

func (c TemplateClient) DeleteTemplate(ctx context.Context, id beta.DeviceManagementTemplateId, options DeleteTemplateOperationOptions) (result DeleteTemplateOperationResponse, err error)

DeleteTemplate - Delete navigation property templates for deviceManagement

func (TemplateClient) GetTemplate 

func (c TemplateClient) GetTemplate(ctx context.Context, id beta.DeviceManagementTemplateId, options GetTemplateOperationOptions) (result GetTemplateOperationResponse, err error)

GetTemplate - Get templates from deviceManagement. The available templates

func (TemplateClient) GetTemplatesCount 

func (c TemplateClient) GetTemplatesCount(ctx context.Context, options GetTemplatesCountOperationOptions) (result GetTemplatesCountOperationResponse, err error)

GetTemplatesCount - Get the number of the resource

func (TemplateClient) ListTemplateImportOffice365DeviceConfigurationPolicies 

func (c TemplateClient) ListTemplateImportOffice365DeviceConfigurationPolicies(ctx context.Context, options ListTemplateImportOffice365DeviceConfigurationPoliciesOperationOptions) (result ListTemplateImportOffice365DeviceConfigurationPoliciesOperationResponse, err error)

ListTemplateImportOffice365DeviceConfigurationPolicies - Invoke action importOffice365DeviceConfigurationPolicies

func (TemplateClient) ListTemplateImportOffice365DeviceConfigurationPoliciesComplete 

func (c TemplateClient) ListTemplateImportOffice365DeviceConfigurationPoliciesComplete(ctx context.Context, options ListTemplateImportOffice365DeviceConfigurationPoliciesOperationOptions) (ListTemplateImportOffice365DeviceConfigurationPoliciesCompleteResult, error)

ListTemplateImportOffice365DeviceConfigurationPoliciesComplete retrieves all the results into a single object

func (TemplateClient) ListTemplateImportOffice365DeviceConfigurationPoliciesCompleteMatchingPredicate 

func (c TemplateClient) ListTemplateImportOffice365DeviceConfigurationPoliciesCompleteMatchingPredicate(ctx context.Context, options ListTemplateImportOffice365DeviceConfigurationPoliciesOperationOptions, predicate DeviceManagementIntentOperationPredicate) (result ListTemplateImportOffice365DeviceConfigurationPoliciesCompleteResult, err error)

ListTemplateImportOffice365DeviceConfigurationPoliciesCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (TemplateClient) ListTemplates 

func (c TemplateClient) ListTemplates(ctx context.Context, options ListTemplatesOperationOptions) (result ListTemplatesOperationResponse, err error)

ListTemplates - Get templates from deviceManagement. The available templates

func (TemplateClient) ListTemplatesComplete 

func (c TemplateClient) ListTemplatesComplete(ctx context.Context, options ListTemplatesOperationOptions) (ListTemplatesCompleteResult, error)

ListTemplatesComplete retrieves all the results into a single object

func (TemplateClient) ListTemplatesCompleteMatchingPredicate 

func (c TemplateClient) ListTemplatesCompleteMatchingPredicate(ctx context.Context, options ListTemplatesOperationOptions, predicate DeviceManagementTemplateOperationPredicate) (result ListTemplatesCompleteResult, err error)

ListTemplatesCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (TemplateClient) UpdateTemplate 

func (c TemplateClient) UpdateTemplate(ctx context.Context, id beta.DeviceManagementTemplateId, input beta.DeviceManagementTemplate, options UpdateTemplateOperationOptions) (result UpdateTemplateOperationResponse, err error)

UpdateTemplate - Update the navigation property templates in deviceManagement

type UpdateTemplateOperationOptions 

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

func DefaultUpdateTemplateOperationOptions 

func DefaultUpdateTemplateOperationOptions() UpdateTemplateOperationOptions

func (UpdateTemplateOperationOptions) ToHeaders 

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

func (UpdateTemplateOperationOptions) ToOData 

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

func (UpdateTemplateOperationOptions) ToQuery 

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

type UpdateTemplateOperationResponse 

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

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.