armdataboxedge

package module
v1.2.0 Latest Latest
Warning

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

 Go to latest Published: Nov 23, 2023 License: MIT Imports: 14 Imported by: 7

README

Azure Data Box Edge Module for Go

PkgGoDev

The armdataboxedge module provides operations for working with Azure Data Box Edge.

Source code

Getting started

Prerequisites

  • an Azure subscription
  • Go 1.18 or above (You could download and install the latest version of Go from here. It will replace the existing Go on your machine. If you want to install multiple Go versions on the same machine, you could refer this doc.)

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Data Box Edge module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Data Box Edge. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Client Factory

Azure Data Box Edge module consists of one or more clients. We provide a client factory which could be used to create any client in this module.

clientFactory, err := armdataboxedge.NewClientFactory(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options := arm.ClientOptions {
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
clientFactory, err := armdataboxedge.NewClientFactory(<subscription ID>, cred, &options)

Clients

A client groups a set of related APIs, providing access to its functionality. Create one or more clients to access the APIs you require using client factory.

client := clientFactory.NewUsersClient()

Fakes

The fake package contains types used for constructing in-memory fake servers used in unit tests. This allows writing tests to cover various success/error conditions without the need for connecting to a live service.

Please see https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/samples/fakes for details and examples on how to use fakes.

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Data Box Edge label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ARMBaseModel 

type ARMBaseModel struct {
	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

ARMBaseModel - Represents the base class for all object models.

func (ARMBaseModel) MarshalJSON 

func (a ARMBaseModel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ARMBaseModel.

func (*ARMBaseModel) UnmarshalJSON 

func (a *ARMBaseModel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ARMBaseModel.

type AccessLevel 

type AccessLevel string

AccessLevel - Access level allowed for this remote application type 

const (
	AccessLevelFullAccess AccessLevel = "FullAccess"
	AccessLevelNone       AccessLevel = "None"
	AccessLevelReadOnly   AccessLevel = "ReadOnly"
	AccessLevelReadWrite  AccessLevel = "ReadWrite"
)

func PossibleAccessLevelValues 

func PossibleAccessLevelValues() []AccessLevel

PossibleAccessLevelValues returns the possible values for the AccessLevel const type.

type AccountType 

type AccountType string

AccountType - Type of storage accessed on the storage account. 

const (
	AccountTypeBlobStorage           AccountType = "BlobStorage"
	AccountTypeGeneralPurposeStorage AccountType = "GeneralPurposeStorage"
)

func PossibleAccountTypeValues 

func PossibleAccountTypeValues() []AccountType

PossibleAccountTypeValues returns the possible values for the AccountType const type.

type Addon 

type Addon struct {
	// REQUIRED; Addon type.
	Kind *AddonType

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of Addon
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

Addon - Role Addon

func (*Addon) GetAddon 

func (a *Addon) GetAddon() *Addon

GetAddon implements the AddonClassification interface for type Addon.

func (Addon) MarshalJSON added in v1.1.0 

func (a Addon) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Addon.

func (*Addon) UnmarshalJSON 

func (a *Addon) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Addon.

type AddonClassification 

type AddonClassification interface {
	// GetAddon returns the Addon content of the underlying type.
	GetAddon() *Addon
}

AddonClassification provides polymorphic access to related types. Call the interface's GetAddon() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *Addon, *ArcAddon, *IoTAddon

type AddonList 

type AddonList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string

	// READ-ONLY; The Value.
	Value []AddonClassification
}

AddonList - Collection of all the Role addon on the Azure Stack Edge device.

func (AddonList) MarshalJSON 

func (a AddonList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AddonList.

func (*AddonList) UnmarshalJSON 

func (a *AddonList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AddonList.

type AddonState 

type AddonState string

AddonState - Addon Provisioning State 

const (
	AddonStateCreated       AddonState = "Created"
	AddonStateCreating      AddonState = "Creating"
	AddonStateDeleting      AddonState = "Deleting"
	AddonStateFailed        AddonState = "Failed"
	AddonStateInvalid       AddonState = "Invalid"
	AddonStateReconfiguring AddonState = "Reconfiguring"
	AddonStateUpdating      AddonState = "Updating"
)

func PossibleAddonStateValues 

func PossibleAddonStateValues() []AddonState

PossibleAddonStateValues returns the possible values for the AddonState const type.

type AddonType 

type AddonType string

AddonType - Addon type. 

const (
	AddonTypeArcForKubernetes AddonType = "ArcForKubernetes"
	AddonTypeIotEdge          AddonType = "IotEdge"
)

func PossibleAddonTypeValues 

func PossibleAddonTypeValues() []AddonType

PossibleAddonTypeValues returns the possible values for the AddonType const type.

type AddonsClient 

type AddonsClient struct {
	// contains filtered or unexported fields
}

AddonsClient contains the methods for the Addons group. Don't use this type directly, use NewAddonsClient() instead.

func NewAddonsClient 

func NewAddonsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*AddonsClient, error)

NewAddonsClient creates a new instance of AddonsClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*AddonsClient) BeginCreateOrUpdate 

func (client *AddonsClient) BeginCreateOrUpdate(ctx context.Context, deviceName string, roleName string, addonName string, resourceGroupName string, addon AddonClassification, options *AddonsClientBeginCreateOrUpdateOptions) (*runtime.Poller[AddonsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update a addon. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • roleName - The role name.
  • addonName - The addon name.
  • resourceGroupName - The resource group name.
  • addon - The addon properties.
  • options - AddonsClientBeginCreateOrUpdateOptions contains the optional parameters for the AddonsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/PutAddons.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewAddonsClient().BeginCreateOrUpdate(ctx, "testedgedevice", "KubernetesRole", "arcName", "GroupForEdgeAutomation", &armdataboxedge.ArcAddon{
		Kind: to.Ptr(armdataboxedge.AddonTypeArcForKubernetes),
		Properties: &armdataboxedge.ArcAddonProperties{
			ResourceGroupName: to.Ptr("GroupForEdgeAutomation"),
			ResourceLocation:  to.Ptr("EastUS"),
			ResourceName:      to.Ptr("testedgedevice"),
			SubscriptionID:    to.Ptr("4385cf00-2d3a-425a-832f-f4285b1c9dce"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdataboxedge.AddonsClientCreateOrUpdateResponse{
	// 	                            AddonClassification: &armdataboxedge.ArcAddon{
	// 		Name: to.Ptr("arcName"),
	// 		Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons"),
	// 		ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourcegroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/addonExamples/roles/kubernetesRole/addons/arcName"),
	// 		Kind: to.Ptr(armdataboxedge.AddonTypeArcForKubernetes),
	// 		Properties: &armdataboxedge.ArcAddonProperties{
	// 			HostPlatform: to.Ptr(armdataboxedge.PlatformTypeLinux),
	// 			HostPlatformType: to.Ptr(armdataboxedge.HostPlatformTypeKubernetesCluster),
	// 			ProvisioningState: to.Ptr(armdataboxedge.AddonState("Succeeded")),
	// 			ResourceGroupName: to.Ptr("GroupForEdgeAutomation"),
	// 			ResourceLocation: to.Ptr("EastUS"),
	// 			ResourceName: to.Ptr("testedgedevice"),
	// 			SubscriptionID: to.Ptr("4385cf00-2d3a-425a-832f-f4285b1c9dce"),
	// 			Version: to.Ptr("0.2.18"),
	// 		},
	// 	},
	// 	                        }
}

Output:

func (*AddonsClient) BeginDelete 

func (client *AddonsClient) BeginDelete(ctx context.Context, deviceName string, roleName string, addonName string, resourceGroupName string, options *AddonsClientBeginDeleteOptions) (*runtime.Poller[AddonsClientDeleteResponse], error)

BeginDelete - Deletes the addon on the device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • roleName - The role name.
  • addonName - The addon name.
  • resourceGroupName - The resource group name.
  • options - AddonsClientBeginDeleteOptions contains the optional parameters for the AddonsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/DeleteAddons.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewAddonsClient().BeginDelete(ctx, "testedgedevice", "KubernetesRole", "arcName", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*AddonsClient) Get 

func (client *AddonsClient) Get(ctx context.Context, deviceName string, roleName string, addonName string, resourceGroupName string, options *AddonsClientGetOptions) (AddonsClientGetResponse, error)

Get - Gets a specific addon by name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • roleName - The role name.
  • addonName - The addon name.
  • resourceGroupName - The resource group name.
  • options - AddonsClientGetOptions contains the optional parameters for the AddonsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/GetAddons.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAddonsClient().Get(ctx, "testedgedevice", "KubernetesRole", "arcName", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdataboxedge.AddonsClientGetResponse{
	// 	                            AddonClassification: &armdataboxedge.ArcAddon{
	// 		Name: to.Ptr("arcName"),
	// 		Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons"),
	// 		ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourcegroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/addonExamples/roles/kubernetesRole/addons/arcName"),
	// 		Kind: to.Ptr(armdataboxedge.AddonTypeArcForKubernetes),
	// 		Properties: &armdataboxedge.ArcAddonProperties{
	// 			HostPlatform: to.Ptr(armdataboxedge.PlatformTypeLinux),
	// 			HostPlatformType: to.Ptr(armdataboxedge.HostPlatformTypeKubernetesCluster),
	// 			ProvisioningState: to.Ptr(armdataboxedge.AddonState("Succeeded")),
	// 			ResourceGroupName: to.Ptr("GroupForEdgeAutomation"),
	// 			ResourceLocation: to.Ptr("EastUS"),
	// 			ResourceName: to.Ptr("testedgedevice"),
	// 			SubscriptionID: to.Ptr("4385cf00-2d3a-425a-832f-f4285b1c9dce"),
	// 			Version: to.Ptr("0.2.18"),
	// 		},
	// 	},
	// 	                        }
}

Output:

func (*AddonsClient) NewListByRolePager added in v0.4.0 

func (client *AddonsClient) NewListByRolePager(deviceName string, roleName string, resourceGroupName string, options *AddonsClientListByRoleOptions) *runtime.Pager[AddonsClientListByRoleResponse]

NewListByRolePager - Lists all the addons configured in the role.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • roleName - The role name.
  • resourceGroupName - The resource group name.
  • options - AddonsClientListByRoleOptions contains the optional parameters for the AddonsClient.NewListByRolePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/RoleListAddOns.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewAddonsClient().NewListByRolePager("testedgedevice", "IoTRole1", "GroupForEdgeAutomation", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AddonList = armdataboxedge.AddonList{
		// 	Value: []armdataboxedge.AddonClassification{
		// 		&armdataboxedge.ArcAddon{
		// 			Name: to.Ptr("arcName"),
		// 			Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons"),
		// 			ID: to.Ptr("/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/prpare/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/addonExamples/roles/kubernetesRole/addons/arcName"),
		// 			Kind: to.Ptr(armdataboxedge.AddonTypeArcForKubernetes),
		// 			Properties: &armdataboxedge.ArcAddonProperties{
		// 				HostPlatform: to.Ptr(armdataboxedge.PlatformTypeLinux),
		// 				HostPlatformType: to.Ptr(armdataboxedge.HostPlatformTypeKubernetesCluster),
		// 				ProvisioningState: to.Ptr(armdataboxedge.AddonState("Succeeded")),
		// 				ResourceGroupName: to.Ptr("testrg1"),
		// 				ResourceLocation: to.Ptr("EastUS"),
		// 				ResourceName: to.Ptr("testresource1"),
		// 				SubscriptionID: to.Ptr("0d44739e-0563-474f-97e7-24a0cdb23b29"),
		// 				Version: to.Ptr("0.2.18"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type AddonsClientBeginCreateOrUpdateOptions added in v0.2.0 

type AddonsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

AddonsClientBeginCreateOrUpdateOptions contains the optional parameters for the AddonsClient.BeginCreateOrUpdate method.

type AddonsClientBeginDeleteOptions added in v0.2.0 

type AddonsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

AddonsClientBeginDeleteOptions contains the optional parameters for the AddonsClient.BeginDelete method.

type AddonsClientCreateOrUpdateResponse added in v0.2.0 

type AddonsClientCreateOrUpdateResponse struct {
	// Role Addon
	AddonClassification
}

AddonsClientCreateOrUpdateResponse contains the response from method AddonsClient.BeginCreateOrUpdate.

func (AddonsClientCreateOrUpdateResponse) MarshalJSON added in v1.2.0 

func (a AddonsClientCreateOrUpdateResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AddonsClientCreateOrUpdateResponse.

func (*AddonsClientCreateOrUpdateResponse) UnmarshalJSON added in v0.3.0 

func (a *AddonsClientCreateOrUpdateResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AddonsClientCreateOrUpdateResponse.

type AddonsClientDeleteResponse added in v0.2.0 

type AddonsClientDeleteResponse struct {
}

AddonsClientDeleteResponse contains the response from method AddonsClient.BeginDelete.

type AddonsClientGetOptions added in v0.2.0 

type AddonsClientGetOptions struct {
}

AddonsClientGetOptions contains the optional parameters for the AddonsClient.Get method.

type AddonsClientGetResponse added in v0.2.0 

type AddonsClientGetResponse struct {
	// Role Addon
	AddonClassification
}

AddonsClientGetResponse contains the response from method AddonsClient.Get.

func (*AddonsClientGetResponse) UnmarshalJSON added in v0.3.0 

func (a *AddonsClientGetResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AddonsClientGetResponse.

type AddonsClientListByRoleOptions added in v0.2.0 

type AddonsClientListByRoleOptions struct {
}

AddonsClientListByRoleOptions contains the optional parameters for the AddonsClient.NewListByRolePager method.

type AddonsClientListByRoleResponse added in v0.2.0 

type AddonsClientListByRoleResponse struct {
	// Collection of all the Role addon on the Azure Stack Edge device.
	AddonList
}

AddonsClientListByRoleResponse contains the response from method AddonsClient.NewListByRolePager.

type Address 

type Address struct {
	// REQUIRED; The country name.
	Country *string

	// The address line1.
	AddressLine1 *string

	// The address line2.
	AddressLine2 *string

	// The address line3.
	AddressLine3 *string

	// The city name.
	City *string

	// The postal code.
	PostalCode *string

	// The state name.
	State *string
}

Address - The shipping address of the customer.

func (Address) MarshalJSON added in v1.1.0 

func (a Address) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Address.

func (*Address) UnmarshalJSON added in v1.1.0 

func (a *Address) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Address.

type Alert 

type Alert struct {
	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Properties of alert.
	Properties *AlertProperties

	// READ-ONLY; Metadata pertaining to creation and last modification of Alert
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

Alert on the data box edge/gateway device.

func (Alert) MarshalJSON 

func (a Alert) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Alert.

func (*Alert) UnmarshalJSON 

func (a *Alert) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Alert.

type AlertErrorDetails 

type AlertErrorDetails struct {
	// READ-ONLY; Error code.
	ErrorCode *string

	// READ-ONLY; Error Message.
	ErrorMessage *string

	// READ-ONLY; Number of occurrences.
	Occurrences *int32
}

AlertErrorDetails - Error details for the alert.

func (AlertErrorDetails) MarshalJSON added in v1.1.0 

func (a AlertErrorDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AlertErrorDetails.

func (*AlertErrorDetails) UnmarshalJSON added in v1.1.0 

func (a *AlertErrorDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AlertErrorDetails.

type AlertList 

type AlertList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string

	// READ-ONLY; The value.
	Value []*Alert
}

AlertList - Collection of alerts.

func (AlertList) MarshalJSON 

func (a AlertList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AlertList.

func (*AlertList) UnmarshalJSON added in v1.1.0 

func (a *AlertList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AlertList.

type AlertProperties 

type AlertProperties struct {
	// READ-ONLY; Alert type.
	AlertType *string

	// READ-ONLY; UTC time when the alert appeared.
	AppearedAtDateTime *time.Time

	// READ-ONLY; Alert details.
	DetailedInformation map[string]*string

	// READ-ONLY; Error details of the alert.
	ErrorDetails *AlertErrorDetails

	// READ-ONLY; Alert recommendation.
	Recommendation *string

	// READ-ONLY; Severity of the alert.
	Severity *AlertSeverity

	// READ-ONLY; Alert title.
	Title *string
}

AlertProperties - Properties of alert.

func (AlertProperties) MarshalJSON 

func (a AlertProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AlertProperties.

func (*AlertProperties) UnmarshalJSON 

func (a *AlertProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AlertProperties.

type AlertSeverity 

type AlertSeverity string

AlertSeverity - Severity of the alert. 

const (
	AlertSeverityCritical      AlertSeverity = "Critical"
	AlertSeverityInformational AlertSeverity = "Informational"
	AlertSeverityWarning       AlertSeverity = "Warning"
)

func PossibleAlertSeverityValues 

func PossibleAlertSeverityValues() []AlertSeverity

PossibleAlertSeverityValues returns the possible values for the AlertSeverity const type.

type AlertsClient 

type AlertsClient struct {
	// contains filtered or unexported fields
}

AlertsClient contains the methods for the Alerts group. Don't use this type directly, use NewAlertsClient() instead.

func NewAlertsClient 

func NewAlertsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*AlertsClient, error)

NewAlertsClient creates a new instance of AlertsClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*AlertsClient) Get 

func (client *AlertsClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string, options *AlertsClientGetOptions) (AlertsClientGetResponse, error)

Get - Gets an alert by name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • name - The alert name.
  • resourceGroupName - The resource group name.
  • options - AlertsClientGetOptions contains the optional parameters for the AlertsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/AlertGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAlertsClient().Get(ctx, "testedgedevice", "159a00c7-8543-4343-9435-263ac87df3bb", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Alert = armdataboxedge.Alert{
	// 	Name: to.Ptr("159a00c7-8543-4343-9435-263ac87df3bb"),
	// 	Type: to.Ptr("dataBoxEdgeDevices/alerts"),
	// 	ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/159a00c7-8543-4343-9435-263ac87df3bb"),
	// 	Properties: &armdataboxedge.AlertProperties{
	// 		AlertType: to.Ptr("UpdateScanFailedEvent"),
	// 		AppearedAtDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-18T02:18:51.427Z"); return t}()),
	// 		DetailedInformation: map[string]*string{
	// 		},
	// 		ErrorDetails: &armdataboxedge.AlertErrorDetails{
	// 			ErrorCode: to.Ptr(""),
	// 			ErrorMessage: to.Ptr(""),
	// 			Occurrences: to.Ptr[int32](1),
	// 		},
	// 		Recommendation: to.Ptr("Resolve the error : An internal error has occurred. Please contact Microsoft Support."),
	// 		Severity: to.Ptr(armdataboxedge.AlertSeverityCritical),
	// 		Title: to.Ptr("Could not scan for updates. Error message : 'An internal error has occurred. Please contact Microsoft Support.'."),
	// 	},
	// }
}

Output:

func (*AlertsClient) NewListByDataBoxEdgeDevicePager added in v0.4.0 

func (client *AlertsClient) NewListByDataBoxEdgeDevicePager(deviceName string, resourceGroupName string, options *AlertsClientListByDataBoxEdgeDeviceOptions) *runtime.Pager[AlertsClientListByDataBoxEdgeDeviceResponse]

NewListByDataBoxEdgeDevicePager - Gets all the alerts for a Data Box Edge/Data Box Gateway device.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - AlertsClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the AlertsClient.NewListByDataBoxEdgeDevicePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/AlertGetAllInDevice.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewAlertsClient().NewListByDataBoxEdgeDevicePager("testedgedevice", "GroupForEdgeAutomation", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AlertList = armdataboxedge.AlertList{
		// 	Value: []*armdataboxedge.Alert{
		// 		{
		// 			Name: to.Ptr("83eccd0b-134b-40b0-ad62-b5f124d03790"),
		// 			Type: to.Ptr("dataBoxEdgeDevices/alerts"),
		// 			ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/83eccd0b-134b-40b0-ad62-b5f124d03790"),
		// 			Properties: &armdataboxedge.AlertProperties{
		// 				AlertType: to.Ptr("PasswordChangedEvent"),
		// 				AppearedAtDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-18T02:29:15.232Z"); return t}()),
		// 				DetailedInformation: map[string]*string{
		// 				},
		// 				ErrorDetails: &armdataboxedge.AlertErrorDetails{
		// 					ErrorCode: to.Ptr(""),
		// 					ErrorMessage: to.Ptr(""),
		// 					Occurrences: to.Ptr[int32](2),
		// 				},
		// 				Recommendation: to.Ptr("The device administrator password has changed. This is a required action as part of the first time device setup or regular password reset. No further action is required."),
		// 				Severity: to.Ptr(armdataboxedge.AlertSeverityInformational),
		// 				Title: to.Ptr("Device password has changed"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("159a00c7-8543-4343-9435-263ac87df3bb"),
		// 			Type: to.Ptr("dataBoxEdgeDevices/alerts"),
		// 			ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/159a00c7-8543-4343-9435-263ac87df3bb"),
		// 			Properties: &armdataboxedge.AlertProperties{
		// 				AlertType: to.Ptr("UpdateScanFailedEvent"),
		// 				AppearedAtDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-18T02:18:51.427Z"); return t}()),
		// 				DetailedInformation: map[string]*string{
		// 				},
		// 				ErrorDetails: &armdataboxedge.AlertErrorDetails{
		// 					ErrorCode: to.Ptr(""),
		// 					ErrorMessage: to.Ptr(""),
		// 					Occurrences: to.Ptr[int32](1),
		// 				},
		// 				Recommendation: to.Ptr("Resolve the error : An internal error has occurred. Please contact Microsoft Support."),
		// 				Severity: to.Ptr(armdataboxedge.AlertSeverityCritical),
		// 				Title: to.Ptr("Could not scan for updates. Error message : 'An internal error has occurred. Please contact Microsoft Support.'."),
		// 			},
		// 	}},
		// }
	}
}

Output:

type AlertsClientGetOptions added in v0.2.0 

type AlertsClientGetOptions struct {
}

AlertsClientGetOptions contains the optional parameters for the AlertsClient.Get method.

type AlertsClientGetResponse added in v0.2.0 

type AlertsClientGetResponse struct {
	// Alert on the data box edge/gateway device.
	Alert
}

AlertsClientGetResponse contains the response from method AlertsClient.Get.

type AlertsClientListByDataBoxEdgeDeviceOptions added in v0.2.0 

type AlertsClientListByDataBoxEdgeDeviceOptions struct {
}

AlertsClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the AlertsClient.NewListByDataBoxEdgeDevicePager method.

type AlertsClientListByDataBoxEdgeDeviceResponse added in v0.2.0 

type AlertsClientListByDataBoxEdgeDeviceResponse struct {
	// Collection of alerts.
	AlertList
}

AlertsClientListByDataBoxEdgeDeviceResponse contains the response from method AlertsClient.NewListByDataBoxEdgeDevicePager.

type ArcAddon 

type ArcAddon struct {
	// REQUIRED; Addon type.
	Kind *AddonType

	// REQUIRED; Properties specific to Arc addon.
	Properties *ArcAddonProperties

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of Addon
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

ArcAddon - Arc Addon.

func (*ArcAddon) GetAddon added in v0.2.0 

func (a *ArcAddon) GetAddon() *Addon

GetAddon implements the AddonClassification interface for type ArcAddon.

func (ArcAddon) MarshalJSON 

func (a ArcAddon) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ArcAddon.

func (*ArcAddon) UnmarshalJSON 

func (a *ArcAddon) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ArcAddon.

type ArcAddonProperties 

type ArcAddonProperties struct {
	// REQUIRED; Arc resource group name
	ResourceGroupName *string

	// REQUIRED; Arc resource location
	ResourceLocation *string

	// REQUIRED; Arc resource Name
	ResourceName *string

	// REQUIRED; Arc resource subscription Id
	SubscriptionID *string

	// READ-ONLY; Host OS supported by the Arc addon.
	HostPlatform *PlatformType

	// READ-ONLY; Platform where the runtime is hosted.
	HostPlatformType *HostPlatformType

	// READ-ONLY; Addon Provisioning State
	ProvisioningState *AddonState

	// READ-ONLY; Arc resource version
	Version *string
}

ArcAddonProperties - Arc addon properties.

func (ArcAddonProperties) MarshalJSON added in v1.1.0 

func (a ArcAddonProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ArcAddonProperties.

func (*ArcAddonProperties) UnmarshalJSON added in v1.1.0 

func (a *ArcAddonProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ArcAddonProperties.

type AsymmetricEncryptedSecret 

type AsymmetricEncryptedSecret struct {
	// REQUIRED; The algorithm used to encrypt "Value".
	EncryptionAlgorithm *EncryptionAlgorithm

	// REQUIRED; The value of the secret.
	Value *string

	// Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null.
	EncryptionCertThumbprint *string
}

AsymmetricEncryptedSecret - Represent the secrets intended for encryption with asymmetric key pair.

func (AsymmetricEncryptedSecret) MarshalJSON added in v1.1.0 

func (a AsymmetricEncryptedSecret) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AsymmetricEncryptedSecret.

func (*AsymmetricEncryptedSecret) UnmarshalJSON added in v1.1.0 

func (a *AsymmetricEncryptedSecret) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AsymmetricEncryptedSecret.

type Authentication 

type Authentication struct {
	// Symmetric key for authentication.
	SymmetricKey *SymmetricKey
}

Authentication mechanism for IoT devices.

func (Authentication) MarshalJSON added in v1.1.0 

func (a Authentication) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Authentication.

func (*Authentication) UnmarshalJSON added in v1.1.0 

func (a *Authentication) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Authentication.

type AuthenticationType 

type AuthenticationType string

AuthenticationType - The authentication type. 

const (
	AuthenticationTypeAzureActiveDirectory AuthenticationType = "AzureActiveDirectory"
	AuthenticationTypeInvalid              AuthenticationType = "Invalid"
)

func PossibleAuthenticationTypeValues 

func PossibleAuthenticationTypeValues() []AuthenticationType

PossibleAuthenticationTypeValues returns the possible values for the AuthenticationType const type.

type AvailableSKUsClient 

type AvailableSKUsClient struct {
	// contains filtered or unexported fields
}

AvailableSKUsClient contains the methods for the AvailableSKUs group. Don't use this type directly, use NewAvailableSKUsClient() instead.

func NewAvailableSKUsClient 

func NewAvailableSKUsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*AvailableSKUsClient, error)

NewAvailableSKUsClient creates a new instance of AvailableSKUsClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*AvailableSKUsClient) NewListPager added in v0.4.0 

func (client *AvailableSKUsClient) NewListPager(options *AvailableSKUsClientListOptions) *runtime.Pager[AvailableSKUsClientListResponse]

NewListPager - List all the available Skus and information related to them.

Generated from API version 2022-03-01

  • options - AvailableSKUsClientListOptions contains the optional parameters for the AvailableSKUsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/AvailableSkusList.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewAvailableSKUsClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SKUList = armdataboxedge.SKUList{
		// 	Value: []*armdataboxedge.SKU{
		// 		{
		// 			Name: to.Ptr(armdataboxedge.SKUNameGateway),
		// 			Availability: to.Ptr(armdataboxedge.SKUAvailabilityAvailable),
		// 			Kind: to.Ptr("AzureDataBoxGateway"),
		// 			LocationInfo: []*armdataboxedge.SKULocationInfo{
		// 				{
		// 					Location: to.Ptr("West US"),
		// 			}},
		// 			Locations: []*string{
		// 				to.Ptr("West US")},
		// 				ResourceType: to.Ptr("dataBoxEdgeDevices"),
		// 				SignupOption: to.Ptr(armdataboxedge.SKUSignupOptionAvailable),
		// 				Tier: to.Ptr(armdataboxedge.SKUTierStandard),
		// 				Version: to.Ptr(armdataboxedge.SKUVersionStable),
		// 		}},
		// 	}
	}
}

Output:

type AvailableSKUsClientListOptions added in v0.2.0 

type AvailableSKUsClientListOptions struct {
}

AvailableSKUsClientListOptions contains the optional parameters for the AvailableSKUsClient.NewListPager method.

type AvailableSKUsClientListResponse added in v0.2.0 

type AvailableSKUsClientListResponse struct {
	// List of SKU Information objects.
	SKUList
}

AvailableSKUsClientListResponse contains the response from method AvailableSKUsClient.NewListPager.

type AzureContainerDataFormat 

type AzureContainerDataFormat string

AzureContainerDataFormat - Storage format used for the file represented by the share. 

const (
	AzureContainerDataFormatAzureFile AzureContainerDataFormat = "AzureFile"
	AzureContainerDataFormatBlockBlob AzureContainerDataFormat = "BlockBlob"
	AzureContainerDataFormatPageBlob  AzureContainerDataFormat = "PageBlob"
)

func PossibleAzureContainerDataFormatValues 

func PossibleAzureContainerDataFormatValues() []AzureContainerDataFormat

PossibleAzureContainerDataFormatValues returns the possible values for the AzureContainerDataFormat const type.

type AzureContainerInfo 

type AzureContainerInfo struct {
	// REQUIRED; Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob).
	ContainerName *string

	// REQUIRED; Storage format used for the file represented by the share.
	DataFormat *AzureContainerDataFormat

	// REQUIRED; ID of the storage account credential used to access storage.
	StorageAccountCredentialID *string
}

AzureContainerInfo - Azure container mapping of the endpoint.

func (AzureContainerInfo) MarshalJSON added in v1.1.0 

func (a AzureContainerInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureContainerInfo.

func (*AzureContainerInfo) UnmarshalJSON added in v1.1.0 

func (a *AzureContainerInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureContainerInfo.

type BandwidthSchedule 

type BandwidthSchedule struct {
	// REQUIRED; The properties of the bandwidth schedule.
	Properties *BandwidthScheduleProperties

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of BandwidthSchedule
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

BandwidthSchedule - The bandwidth schedule details.

func (BandwidthSchedule) MarshalJSON 

func (b BandwidthSchedule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BandwidthSchedule.

func (*BandwidthSchedule) UnmarshalJSON 

func (b *BandwidthSchedule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BandwidthSchedule.

type BandwidthScheduleProperties 

type BandwidthScheduleProperties struct {
	// REQUIRED; The days of the week when this schedule is applicable.
	Days []*DayOfWeek

	// REQUIRED; The bandwidth rate in Mbps.
	RateInMbps *int32

	// REQUIRED; The start time of the schedule in UTC.
	Start *string

	// REQUIRED; The stop time of the schedule in UTC.
	Stop *string
}

BandwidthScheduleProperties - The properties of the bandwidth schedule.

func (BandwidthScheduleProperties) MarshalJSON 

func (b BandwidthScheduleProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BandwidthScheduleProperties.

func (*BandwidthScheduleProperties) UnmarshalJSON added in v1.1.0 

func (b *BandwidthScheduleProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BandwidthScheduleProperties.

type BandwidthSchedulesClient 

type BandwidthSchedulesClient struct {
	// contains filtered or unexported fields
}

BandwidthSchedulesClient contains the methods for the BandwidthSchedules group. Don't use this type directly, use NewBandwidthSchedulesClient() instead.

func NewBandwidthSchedulesClient 

func NewBandwidthSchedulesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*BandwidthSchedulesClient, error)

NewBandwidthSchedulesClient creates a new instance of BandwidthSchedulesClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*BandwidthSchedulesClient) BeginCreateOrUpdate 

func (client *BandwidthSchedulesClient) BeginCreateOrUpdate(ctx context.Context, deviceName string, name string, resourceGroupName string, parameters BandwidthSchedule, options *BandwidthSchedulesClientBeginCreateOrUpdateOptions) (*runtime.Poller[BandwidthSchedulesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a bandwidth schedule. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • name - The bandwidth schedule name which needs to be added/updated.
  • resourceGroupName - The resource group name.
  • parameters - The bandwidth schedule to be added or updated.
  • options - BandwidthSchedulesClientBeginCreateOrUpdateOptions contains the optional parameters for the BandwidthSchedulesClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/BandwidthSchedulePut.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewBandwidthSchedulesClient().BeginCreateOrUpdate(ctx, "testedgedevice", "bandwidth-1", "GroupForEdgeAutomation", armdataboxedge.BandwidthSchedule{
		Properties: &armdataboxedge.BandwidthScheduleProperties{
			Days: []*armdataboxedge.DayOfWeek{
				to.Ptr(armdataboxedge.DayOfWeekSunday),
				to.Ptr(armdataboxedge.DayOfWeekMonday)},
			RateInMbps: to.Ptr[int32](100),
			Start:      to.Ptr("0:0:0"),
			Stop:       to.Ptr("13:59:0"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.BandwidthSchedule = armdataboxedge.BandwidthSchedule{
	// 	Name: to.Ptr("bandwidth-1"),
	// 	Type: to.Ptr("dataBoxEdgeDevices/bandwidthSchedules"),
	// 	ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1"),
	// 	Properties: &armdataboxedge.BandwidthScheduleProperties{
	// 		Days: []*armdataboxedge.DayOfWeek{
	// 			to.Ptr(armdataboxedge.DayOfWeekSunday),
	// 			to.Ptr(armdataboxedge.DayOfWeekMonday)},
	// 			RateInMbps: to.Ptr[int32](100),
	// 			Start: to.Ptr("00:00:00"),
	// 			Stop: to.Ptr("13:59:00"),
	// 		},
	// 	}
}

Output:

func (*BandwidthSchedulesClient) BeginDelete 

func (client *BandwidthSchedulesClient) BeginDelete(ctx context.Context, deviceName string, name string, resourceGroupName string, options *BandwidthSchedulesClientBeginDeleteOptions) (*runtime.Poller[BandwidthSchedulesClientDeleteResponse], error)

BeginDelete - Deletes the specified bandwidth schedule. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • name - The bandwidth schedule name.
  • resourceGroupName - The resource group name.
  • options - BandwidthSchedulesClientBeginDeleteOptions contains the optional parameters for the BandwidthSchedulesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/BandwidthScheduleDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewBandwidthSchedulesClient().BeginDelete(ctx, "testedgedevice", "bandwidth-1", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*BandwidthSchedulesClient) Get 

func (client *BandwidthSchedulesClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string, options *BandwidthSchedulesClientGetOptions) (BandwidthSchedulesClientGetResponse, error)

Get - Gets the properties of the specified bandwidth schedule. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • name - The bandwidth schedule name.
  • resourceGroupName - The resource group name.
  • options - BandwidthSchedulesClientGetOptions contains the optional parameters for the BandwidthSchedulesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/BandwidthScheduleGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewBandwidthSchedulesClient().Get(ctx, "testedgedevice", "bandwidth-1", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.BandwidthSchedule = armdataboxedge.BandwidthSchedule{
	// 	Name: to.Ptr("bandwidth-1"),
	// 	Type: to.Ptr("dataBoxEdgeDevices/bandwidthSchedules"),
	// 	ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1"),
	// 	Properties: &armdataboxedge.BandwidthScheduleProperties{
	// 		Days: []*armdataboxedge.DayOfWeek{
	// 			to.Ptr(armdataboxedge.DayOfWeekSunday),
	// 			to.Ptr(armdataboxedge.DayOfWeekMonday)},
	// 			RateInMbps: to.Ptr[int32](100),
	// 			Start: to.Ptr("00:00:00"),
	// 			Stop: to.Ptr("13:59:00"),
	// 		},
	// 	}
}

Output:

func (*BandwidthSchedulesClient) NewListByDataBoxEdgeDevicePager added in v0.4.0 

func (client *BandwidthSchedulesClient) NewListByDataBoxEdgeDevicePager(deviceName string, resourceGroupName string, options *BandwidthSchedulesClientListByDataBoxEdgeDeviceOptions) *runtime.Pager[BandwidthSchedulesClientListByDataBoxEdgeDeviceResponse]

NewListByDataBoxEdgeDevicePager - Gets all the bandwidth schedules for a Data Box Edge/Data Box Gateway device.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - BandwidthSchedulesClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the BandwidthSchedulesClient.NewListByDataBoxEdgeDevicePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/BandwidthScheduleGetAllInDevice.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewBandwidthSchedulesClient().NewListByDataBoxEdgeDevicePager("testedgedevice", "GroupForEdgeAutomation", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.BandwidthSchedulesList = armdataboxedge.BandwidthSchedulesList{
		// 	Value: []*armdataboxedge.BandwidthSchedule{
		// 		{
		// 			Name: to.Ptr("bandwidth-1"),
		// 			Type: to.Ptr("dataBoxEdgeDevices/bandwidthSchedules"),
		// 			ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1"),
		// 			Properties: &armdataboxedge.BandwidthScheduleProperties{
		// 				Days: []*armdataboxedge.DayOfWeek{
		// 					to.Ptr(armdataboxedge.DayOfWeekSunday),
		// 					to.Ptr(armdataboxedge.DayOfWeekMonday)},
		// 					RateInMbps: to.Ptr[int32](100),
		// 					Start: to.Ptr("00:00:00"),
		// 					Stop: to.Ptr("13:59:00"),
		// 				},
		// 		}},
		// 	}
	}
}

Output:

type BandwidthSchedulesClientBeginCreateOrUpdateOptions added in v0.2.0 

type BandwidthSchedulesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

BandwidthSchedulesClientBeginCreateOrUpdateOptions contains the optional parameters for the BandwidthSchedulesClient.BeginCreateOrUpdate method.

type BandwidthSchedulesClientBeginDeleteOptions added in v0.2.0 

type BandwidthSchedulesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

BandwidthSchedulesClientBeginDeleteOptions contains the optional parameters for the BandwidthSchedulesClient.BeginDelete method.

type BandwidthSchedulesClientCreateOrUpdateResponse added in v0.2.0 

type BandwidthSchedulesClientCreateOrUpdateResponse struct {
	// The bandwidth schedule details.
	BandwidthSchedule
}

BandwidthSchedulesClientCreateOrUpdateResponse contains the response from method BandwidthSchedulesClient.BeginCreateOrUpdate.

type BandwidthSchedulesClientDeleteResponse added in v0.2.0 

type BandwidthSchedulesClientDeleteResponse struct {
}

BandwidthSchedulesClientDeleteResponse contains the response from method BandwidthSchedulesClient.BeginDelete.

type BandwidthSchedulesClientGetOptions added in v0.2.0 

type BandwidthSchedulesClientGetOptions struct {
}

BandwidthSchedulesClientGetOptions contains the optional parameters for the BandwidthSchedulesClient.Get method.

type BandwidthSchedulesClientGetResponse added in v0.2.0 

type BandwidthSchedulesClientGetResponse struct {
	// The bandwidth schedule details.
	BandwidthSchedule
}

BandwidthSchedulesClientGetResponse contains the response from method BandwidthSchedulesClient.Get.

type BandwidthSchedulesClientListByDataBoxEdgeDeviceOptions added in v0.2.0 

type BandwidthSchedulesClientListByDataBoxEdgeDeviceOptions struct {
}

BandwidthSchedulesClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the BandwidthSchedulesClient.NewListByDataBoxEdgeDevicePager method.

type BandwidthSchedulesClientListByDataBoxEdgeDeviceResponse added in v0.2.0 

type BandwidthSchedulesClientListByDataBoxEdgeDeviceResponse struct {
	// The collection of bandwidth schedules.
	BandwidthSchedulesList
}

BandwidthSchedulesClientListByDataBoxEdgeDeviceResponse contains the response from method BandwidthSchedulesClient.NewListByDataBoxEdgeDevicePager.

type BandwidthSchedulesList 

type BandwidthSchedulesList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string

	// READ-ONLY; The list of bandwidth schedules.
	Value []*BandwidthSchedule
}

BandwidthSchedulesList - The collection of bandwidth schedules.

func (BandwidthSchedulesList) MarshalJSON 

func (b BandwidthSchedulesList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BandwidthSchedulesList.

func (*BandwidthSchedulesList) UnmarshalJSON added in v1.1.0 

func (b *BandwidthSchedulesList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BandwidthSchedulesList.

type ClientAccessRight 

type ClientAccessRight struct {
	// REQUIRED; Type of access to be allowed for the client.
	AccessPermission *ClientPermissionType

	// REQUIRED; IP of the client.
	Client *string
}

ClientAccessRight - The mapping between a particular client IP and the type of access client has on the NFS share.

func (ClientAccessRight) MarshalJSON added in v1.1.0 

func (c ClientAccessRight) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClientAccessRight.

func (*ClientAccessRight) UnmarshalJSON added in v1.1.0 

func (c *ClientAccessRight) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClientAccessRight.

type ClientFactory added in v1.1.0 

type ClientFactory struct {
	// contains filtered or unexported fields
}

ClientFactory is a client factory used to create any client in this module. Don't use this type directly, use NewClientFactory instead.

func NewClientFactory added in v1.1.0 

func NewClientFactory(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ClientFactory, error)

NewClientFactory creates a new instance of ClientFactory with the specified values. The parameter values will be propagated to any client created from this factory.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClientFactory) NewAddonsClient added in v1.1.0 

func (c *ClientFactory) NewAddonsClient() *AddonsClient

NewAddonsClient creates a new instance of AddonsClient.

func (*ClientFactory) NewAlertsClient added in v1.1.0 

func (c *ClientFactory) NewAlertsClient() *AlertsClient

NewAlertsClient creates a new instance of AlertsClient.

func (*ClientFactory) NewAvailableSKUsClient added in v1.1.0 

func (c *ClientFactory) NewAvailableSKUsClient() *AvailableSKUsClient

NewAvailableSKUsClient creates a new instance of AvailableSKUsClient.

func (*ClientFactory) NewBandwidthSchedulesClient added in v1.1.0 

func (c *ClientFactory) NewBandwidthSchedulesClient() *BandwidthSchedulesClient

NewBandwidthSchedulesClient creates a new instance of BandwidthSchedulesClient.

func (*ClientFactory) NewContainersClient added in v1.1.0 

func (c *ClientFactory) NewContainersClient() *ContainersClient

NewContainersClient creates a new instance of ContainersClient.

func (*ClientFactory) NewDeviceCapacityCheckClient added in v1.1.0 

func (c *ClientFactory) NewDeviceCapacityCheckClient() *DeviceCapacityCheckClient

NewDeviceCapacityCheckClient creates a new instance of DeviceCapacityCheckClient.

func (*ClientFactory) NewDeviceCapacityInfoClient added in v1.1.0 

func (c *ClientFactory) NewDeviceCapacityInfoClient() *DeviceCapacityInfoClient

NewDeviceCapacityInfoClient creates a new instance of DeviceCapacityInfoClient.

func (*ClientFactory) NewDevicesClient added in v1.1.0 

func (c *ClientFactory) NewDevicesClient() *DevicesClient

NewDevicesClient creates a new instance of DevicesClient.

func (*ClientFactory) NewDiagnosticSettingsClient added in v1.1.0 

func (c *ClientFactory) NewDiagnosticSettingsClient() *DiagnosticSettingsClient

NewDiagnosticSettingsClient creates a new instance of DiagnosticSettingsClient.

func (*ClientFactory) NewJobsClient added in v1.1.0 

func (c *ClientFactory) NewJobsClient() *JobsClient

NewJobsClient creates a new instance of JobsClient.

func (*ClientFactory) NewMonitoringConfigClient added in v1.1.0 

func (c *ClientFactory) NewMonitoringConfigClient() *MonitoringConfigClient

NewMonitoringConfigClient creates a new instance of MonitoringConfigClient.

func (*ClientFactory) NewNodesClient added in v1.1.0 

func (c *ClientFactory) NewNodesClient() *NodesClient

NewNodesClient creates a new instance of NodesClient.

func (*ClientFactory) NewOperationsClient added in v1.1.0 

func (c *ClientFactory) NewOperationsClient() *OperationsClient

NewOperationsClient creates a new instance of OperationsClient.

func (*ClientFactory) NewOperationsStatusClient added in v1.1.0 

func (c *ClientFactory) NewOperationsStatusClient() *OperationsStatusClient

NewOperationsStatusClient creates a new instance of OperationsStatusClient.

func (*ClientFactory) NewOrdersClient added in v1.1.0 

func (c *ClientFactory) NewOrdersClient() *OrdersClient

NewOrdersClient creates a new instance of OrdersClient.

func (*ClientFactory) NewRolesClient added in v1.1.0 

func (c *ClientFactory) NewRolesClient() *RolesClient

NewRolesClient creates a new instance of RolesClient.

func (*ClientFactory) NewSharesClient added in v1.1.0 

func (c *ClientFactory) NewSharesClient() *SharesClient

NewSharesClient creates a new instance of SharesClient.

func (*ClientFactory) NewStorageAccountCredentialsClient added in v1.1.0 

func (c *ClientFactory) NewStorageAccountCredentialsClient() *StorageAccountCredentialsClient

NewStorageAccountCredentialsClient creates a new instance of StorageAccountCredentialsClient.

func (*ClientFactory) NewStorageAccountsClient added in v1.1.0 

func (c *ClientFactory) NewStorageAccountsClient() *StorageAccountsClient

NewStorageAccountsClient creates a new instance of StorageAccountsClient.

func (*ClientFactory) NewSupportPackagesClient added in v1.1.0 

func (c *ClientFactory) NewSupportPackagesClient() *SupportPackagesClient

NewSupportPackagesClient creates a new instance of SupportPackagesClient.

func (*ClientFactory) NewTriggersClient added in v1.1.0 

func (c *ClientFactory) NewTriggersClient() *TriggersClient

NewTriggersClient creates a new instance of TriggersClient.

func (*ClientFactory) NewUsersClient added in v1.1.0 

func (c *ClientFactory) NewUsersClient() *UsersClient

NewUsersClient creates a new instance of UsersClient.

type ClientPermissionType 

type ClientPermissionType string

ClientPermissionType - Type of access to be allowed for the client. 

const (
	ClientPermissionTypeNoAccess  ClientPermissionType = "NoAccess"
	ClientPermissionTypeReadOnly  ClientPermissionType = "ReadOnly"
	ClientPermissionTypeReadWrite ClientPermissionType = "ReadWrite"
)

func PossibleClientPermissionTypeValues 

func PossibleClientPermissionTypeValues() []ClientPermissionType

PossibleClientPermissionTypeValues returns the possible values for the ClientPermissionType const type.

type CloudEdgeManagementRole 

type CloudEdgeManagementRole struct {
	// REQUIRED; Role type.
	Kind *RoleTypes

	// Properties specific to CloudEdgeManagementRole role.
	Properties *CloudEdgeManagementRoleProperties

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of Role
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

CloudEdgeManagementRole - The preview of Virtual Machine Cloud Management from the Azure supports deploying and managing VMs on your Azure Stack Edge device from Azure Portal. For more information, refer to: https://docs.microsoft.com/en-us/azure/databox-online/azure-stack-edge-gpu-virtual-machine-overview By using this feature, you agree to the preview legal terms. See the https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/ for additional details.

func (*CloudEdgeManagementRole) GetRole added in v0.2.0 

func (c *CloudEdgeManagementRole) GetRole() *Role

GetRole implements the RoleClassification interface for type CloudEdgeManagementRole.

func (CloudEdgeManagementRole) MarshalJSON 

func (c CloudEdgeManagementRole) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CloudEdgeManagementRole.

func (*CloudEdgeManagementRole) UnmarshalJSON 

func (c *CloudEdgeManagementRole) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CloudEdgeManagementRole.

type CloudEdgeManagementRoleProperties 

type CloudEdgeManagementRoleProperties struct {
	// REQUIRED; Role status.
	RoleStatus *RoleStatus

	// READ-ONLY; Edge Profile of the resource
	EdgeProfile *EdgeProfile

	// READ-ONLY; Local Edge Management Status
	LocalManagementStatus *RoleStatus
}

CloudEdgeManagementRoleProperties - CloudEdgeManagement Role properties.

func (CloudEdgeManagementRoleProperties) MarshalJSON added in v1.1.0 

func (c CloudEdgeManagementRoleProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CloudEdgeManagementRoleProperties.

func (*CloudEdgeManagementRoleProperties) UnmarshalJSON added in v1.1.0 

func (c *CloudEdgeManagementRoleProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CloudEdgeManagementRoleProperties.

type ClusterCapacityViewData added in v0.3.0 

type ClusterCapacityViewData struct {
	// The FQDN of the cluster.
	Fqdn *string

	// The cluster's GPU capacity.
	GpuCapacity *ClusterGpuCapacity

	// The last time at which the ClusterCapacityViewData was set.
	LastRefreshedTime *time.Time

	// The cluster's memory capacity.
	MemoryCapacity *ClusterMemoryCapacity

	// The total # of vCPUs provisioned by non-HPN VM per appliance.
	TotalProvisionedNonHpnCores *int64
}

ClusterCapacityViewData - Cluster Compute Data.

func (ClusterCapacityViewData) MarshalJSON added in v0.3.0 

func (c ClusterCapacityViewData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClusterCapacityViewData.

func (*ClusterCapacityViewData) UnmarshalJSON added in v0.3.0 

func (c *ClusterCapacityViewData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterCapacityViewData.

type ClusterGpuCapacity added in v0.3.0 

type ClusterGpuCapacity struct {
	// The free GPU units count in the cluster.
	GpuFreeUnitsCount *int32

	// The GPU units count reserved for failover in the cluster.
	GpuReservedForFailoverUnitsCount *int32

	// The total GPU units count in the cluster.
	GpuTotalUnitsCount *int32

	// The cluster GPU Type.
	GpuType *string

	// The used GPU units count in the cluster.
	GpuUsedUnitsCount *int32
}

ClusterGpuCapacity - Cluster GPU Data.

func (ClusterGpuCapacity) MarshalJSON added in v1.1.0 

func (c ClusterGpuCapacity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClusterGpuCapacity.

func (*ClusterGpuCapacity) UnmarshalJSON added in v1.1.0 

func (c *ClusterGpuCapacity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterGpuCapacity.

type ClusterMemoryCapacity added in v0.3.0 

type ClusterMemoryCapacity struct {
	// The failover memory in the cluster in MB.
	ClusterFailoverMemoryMb *float64

	// The fragmentation memory in the cluster in MB.
	ClusterFragmentationMemoryMb *float64

	// The free memory in the cluster in MB.
	ClusterFreeMemoryMb *float64

	// The memory reserved for Hyper-V in the cluster in MB.
	ClusterHypervReserveMemoryMb *float64

	// The memory of the Infra VM in the cluster in MB.
	ClusterInfraVMMemoryMb *float64

	// The memory used by VMs in the cluster in MB.
	ClusterMemoryUsedByVMsMb *float64

	// The non-failover memory in the cluster in MB.
	ClusterNonFailoverVMMb *float64

	// The total memory in the cluster in MB.
	ClusterTotalMemoryMb *float64

	// The used memory in the cluster in MB.
	ClusterUsedMemoryMb *float64
}

ClusterMemoryCapacity - NodeCapacityInfo defines the required information to determine the placement of a VM.

func (ClusterMemoryCapacity) MarshalJSON added in v1.1.0 

func (c ClusterMemoryCapacity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClusterMemoryCapacity.

func (*ClusterMemoryCapacity) UnmarshalJSON added in v1.1.0 

func (c *ClusterMemoryCapacity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterMemoryCapacity.

type ClusterStorageViewData added in v0.3.0 

type ClusterStorageViewData struct {
	// The available or free storage on the cluster in MB.
	ClusterFreeStorageMb *float64

	// Total storage on the cluster in MB.
	ClusterTotalStorageMb *float64
}

ClusterStorageViewData - Cluster Storage Data.

func (ClusterStorageViewData) MarshalJSON added in v1.1.0 

func (c ClusterStorageViewData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClusterStorageViewData.

func (*ClusterStorageViewData) UnmarshalJSON added in v1.1.0 

func (c *ClusterStorageViewData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterStorageViewData.

type ClusterWitnessType added in v0.3.0 

type ClusterWitnessType string

ClusterWitnessType - Cluster Witness Type 

const (
	ClusterWitnessTypeCloud     ClusterWitnessType = "Cloud"
	ClusterWitnessTypeFileShare ClusterWitnessType = "FileShare"
	ClusterWitnessTypeNone      ClusterWitnessType = "None"
)

func PossibleClusterWitnessTypeValues added in v0.3.0 

func PossibleClusterWitnessTypeValues() []ClusterWitnessType

PossibleClusterWitnessTypeValues returns the possible values for the ClusterWitnessType const type.

type CniConfig 

type CniConfig struct {
	// READ-ONLY; Pod Subnet
	PodSubnet *string

	// READ-ONLY; Service subnet
	ServiceSubnet *string

	// READ-ONLY; Cni type
	Type *string

	// READ-ONLY; Cni version
	Version *string
}

CniConfig - Cni configuration

func (CniConfig) MarshalJSON added in v1.1.0 

func (c CniConfig) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CniConfig.

func (*CniConfig) UnmarshalJSON added in v1.1.0 

func (c *CniConfig) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CniConfig.

type ComputeResource 

type ComputeResource struct {
	// REQUIRED; Memory in GB
	MemoryInGB *int64

	// REQUIRED; Processor count
	ProcessorCount *int32
}

ComputeResource - Compute infrastructure Resource

func (ComputeResource) MarshalJSON added in v1.1.0 

func (c ComputeResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ComputeResource.

func (*ComputeResource) UnmarshalJSON added in v1.1.0 

func (c *ComputeResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ComputeResource.

type ContactDetails 

type ContactDetails struct {
	// REQUIRED; The name of the company.
	CompanyName *string

	// REQUIRED; The contact person name.
	ContactPerson *string

	// REQUIRED; The email list.
	EmailList []*string

	// REQUIRED; The phone number.
	Phone *string
}

ContactDetails - Contains all the contact details of the customer.

func (ContactDetails) MarshalJSON 

func (c ContactDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContactDetails.

func (*ContactDetails) UnmarshalJSON added in v1.1.0 

func (c *ContactDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContactDetails.

type Container 

type Container struct {
	// REQUIRED; The container properties.
	Properties *ContainerProperties

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of Container
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

Container - Represents a container on the Data Box Edge/Gateway device.

func (Container) MarshalJSON 

func (c Container) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Container.

func (*Container) UnmarshalJSON 

func (c *Container) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Container.

type ContainerList 

type ContainerList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string

	// READ-ONLY; The list of containers.
	Value []*Container
}

ContainerList - Collection of all the containers on the Data Box Edge/Gateway device.

func (ContainerList) MarshalJSON 

func (c ContainerList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerList.

func (*ContainerList) UnmarshalJSON added in v1.1.0 

func (c *ContainerList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerList.

type ContainerProperties 

type ContainerProperties struct {
	// REQUIRED; DataFormat for Container
	DataFormat *AzureContainerDataFormat

	// READ-ONLY; Current status of the container.
	ContainerStatus *ContainerStatus

	// READ-ONLY; The UTC time when container got created.
	CreatedDateTime *time.Time

	// READ-ONLY; Details of the refresh job on this container.
	RefreshDetails *RefreshDetails
}

ContainerProperties - The container properties.

func (ContainerProperties) MarshalJSON 

func (c ContainerProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerProperties.

func (*ContainerProperties) UnmarshalJSON 

func (c *ContainerProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerProperties.

type ContainerStatus 

type ContainerStatus string

ContainerStatus - Current status of the container. 

const (
	ContainerStatusNeedsAttention ContainerStatus = "NeedsAttention"
	ContainerStatusOK             ContainerStatus = "OK"
	ContainerStatusOffline        ContainerStatus = "Offline"
	ContainerStatusUnknown        ContainerStatus = "Unknown"
	ContainerStatusUpdating       ContainerStatus = "Updating"
)

func PossibleContainerStatusValues 

func PossibleContainerStatusValues() []ContainerStatus

PossibleContainerStatusValues returns the possible values for the ContainerStatus const type.

type ContainersClient 

type ContainersClient struct {
	// contains filtered or unexported fields
}

ContainersClient contains the methods for the Containers group. Don't use this type directly, use NewContainersClient() instead.

func NewContainersClient 

func NewContainersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ContainersClient, error)

NewContainersClient creates a new instance of ContainersClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ContainersClient) BeginCreateOrUpdate 

func (client *ContainersClient) BeginCreateOrUpdate(ctx context.Context, deviceName string, storageAccountName string, containerName string, resourceGroupName string, containerParam Container, options *ContainersClientBeginCreateOrUpdateOptions) (*runtime.Poller[ContainersClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a new container or updates an existing container on the device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • storageAccountName - The Storage Account Name
  • containerName - The container name.
  • resourceGroupName - The resource group name.
  • containerParam - The container properties.
  • options - ContainersClientBeginCreateOrUpdateOptions contains the optional parameters for the ContainersClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/ContainerPut.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewContainersClient().BeginCreateOrUpdate(ctx, "testedgedevice", "storageaccount1", "blobcontainer1", "GroupForEdgeAutomation", armdataboxedge.Container{
		Properties: &armdataboxedge.ContainerProperties{
			DataFormat: to.Ptr(armdataboxedge.AzureContainerDataFormatBlockBlob),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Container = armdataboxedge.Container{
	// 	Name: to.Ptr("blobcontainer-5e155efe"),
	// 	Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers"),
	// 	ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/storageaccount1/containers/blobcontainer1"),
	// 	Properties: &armdataboxedge.ContainerProperties{
	// 		ContainerStatus: to.Ptr(armdataboxedge.ContainerStatusOK),
	// 		CreatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-10-20T23:13:27.854Z"); return t}()),
	// 		DataFormat: to.Ptr(armdataboxedge.AzureContainerDataFormatBlockBlob),
	// 		RefreshDetails: &armdataboxedge.RefreshDetails{
	// 		},
	// 	},
	// }
}

Output:

func (*ContainersClient) BeginDelete 

func (client *ContainersClient) BeginDelete(ctx context.Context, deviceName string, storageAccountName string, containerName string, resourceGroupName string, options *ContainersClientBeginDeleteOptions) (*runtime.Poller[ContainersClientDeleteResponse], error)

BeginDelete - Deletes the container on the Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • storageAccountName - The Storage Account Name
  • containerName - The container name.
  • resourceGroupName - The resource group name.
  • options - ContainersClientBeginDeleteOptions contains the optional parameters for the ContainersClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/ContainerDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewContainersClient().BeginDelete(ctx, "testedgedevice", "storageaccount1", "blobcontainer1", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*ContainersClient) BeginRefresh 

func (client *ContainersClient) BeginRefresh(ctx context.Context, deviceName string, storageAccountName string, containerName string, resourceGroupName string, options *ContainersClientBeginRefreshOptions) (*runtime.Poller[ContainersClientRefreshResponse], error)

BeginRefresh - Refreshes the container metadata with the data from the cloud. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • storageAccountName - The Storage Account Name
  • containerName - The container name.
  • resourceGroupName - The resource group name.
  • options - ContainersClientBeginRefreshOptions contains the optional parameters for the ContainersClient.BeginRefresh method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/ContainerRefresh.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewContainersClient().BeginRefresh(ctx, "testedgedevice", "storageaccount1", "blobcontainer1", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*ContainersClient) Get 

func (client *ContainersClient) Get(ctx context.Context, deviceName string, storageAccountName string, containerName string, resourceGroupName string, options *ContainersClientGetOptions) (ContainersClientGetResponse, error)

Get - Gets a container by name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • storageAccountName - The Storage Account Name
  • containerName - The container Name
  • resourceGroupName - The resource group name.
  • options - ContainersClientGetOptions contains the optional parameters for the ContainersClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/ContainerGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewContainersClient().Get(ctx, "testedgedevice", "storageaccount1", "blobcontainer1", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Container = armdataboxedge.Container{
	// 	Name: to.Ptr("blobcontainer1"),
	// 	Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers"),
	// 	ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/storageaccount1/containers/blobcontainer1"),
	// 	Properties: &armdataboxedge.ContainerProperties{
	// 		ContainerStatus: to.Ptr(armdataboxedge.ContainerStatusOK),
	// 		CreatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-10-20T23:13:27.854Z"); return t}()),
	// 		DataFormat: to.Ptr(armdataboxedge.AzureContainerDataFormatBlockBlob),
	// 		RefreshDetails: &armdataboxedge.RefreshDetails{
	// 		},
	// 	},
	// }
}

Output:

func (*ContainersClient) NewListByStorageAccountPager added in v0.4.0 

func (client *ContainersClient) NewListByStorageAccountPager(deviceName string, storageAccountName string, resourceGroupName string, options *ContainersClientListByStorageAccountOptions) *runtime.Pager[ContainersClientListByStorageAccountResponse]

NewListByStorageAccountPager - Lists all the containers of a storage Account in a Data Box Edge/Data Box Gateway device.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • storageAccountName - The storage Account name.
  • resourceGroupName - The resource group name.
  • options - ContainersClientListByStorageAccountOptions contains the optional parameters for the ContainersClient.NewListByStorageAccountPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/ContainerListAllInDevice.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewContainersClient().NewListByStorageAccountPager("testedgedevice", "storageaccount1", "GroupForEdgeAutomation", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ContainerList = armdataboxedge.ContainerList{
		// 	Value: []*armdataboxedge.Container{
		// 		{
		// 			Name: to.Ptr("blobcontainer1"),
		// 			Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers"),
		// 			ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-6LJVNIFFB411021190437191/storageAccounts/storageaccount1/containers/blobcontainer1"),
		// 			Properties: &armdataboxedge.ContainerProperties{
		// 				ContainerStatus: to.Ptr(armdataboxedge.ContainerStatusOK),
		// 				CreatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-10-20T23:14:32.301Z"); return t}()),
		// 				DataFormat: to.Ptr(armdataboxedge.AzureContainerDataFormatBlockBlob),
		// 				RefreshDetails: &armdataboxedge.RefreshDetails{
		// 				},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("blobcontainer2"),
		// 			Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers"),
		// 			ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-6LJVNIFFB411021190437191/storageAccounts/storageaccount1/containers/blobcontainer2"),
		// 			Properties: &armdataboxedge.ContainerProperties{
		// 				ContainerStatus: to.Ptr(armdataboxedge.ContainerStatusOK),
		// 				CreatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-10-20T23:15:38.007Z"); return t}()),
		// 				DataFormat: to.Ptr(armdataboxedge.AzureContainerDataFormatBlockBlob),
		// 				RefreshDetails: &armdataboxedge.RefreshDetails{
		// 				},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("blobcontainer3"),
		// 			Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers"),
		// 			ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-6LJVNIFFB411021190437191/storageAccounts/storageaccount1/containers/blobcontainer3"),
		// 			Properties: &armdataboxedge.ContainerProperties{
		// 				ContainerStatus: to.Ptr(armdataboxedge.ContainerStatusOK),
		// 				CreatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-10-20T23:13:27.854Z"); return t}()),
		// 				DataFormat: to.Ptr(armdataboxedge.AzureContainerDataFormatBlockBlob),
		// 				RefreshDetails: &armdataboxedge.RefreshDetails{
		// 				},
		// 			},
		// 	}},
		// }
	}
}

Output:

type ContainersClientBeginCreateOrUpdateOptions added in v0.2.0 

type ContainersClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ContainersClientBeginCreateOrUpdateOptions contains the optional parameters for the ContainersClient.BeginCreateOrUpdate method.

type ContainersClientBeginDeleteOptions added in v0.2.0 

type ContainersClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ContainersClientBeginDeleteOptions contains the optional parameters for the ContainersClient.BeginDelete method.

type ContainersClientBeginRefreshOptions added in v0.2.0 

type ContainersClientBeginRefreshOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ContainersClientBeginRefreshOptions contains the optional parameters for the ContainersClient.BeginRefresh method.

type ContainersClientCreateOrUpdateResponse added in v0.2.0 

type ContainersClientCreateOrUpdateResponse struct {
	// Represents a container on the Data Box Edge/Gateway device.
	Container
}

ContainersClientCreateOrUpdateResponse contains the response from method ContainersClient.BeginCreateOrUpdate.

type ContainersClientDeleteResponse added in v0.2.0 

type ContainersClientDeleteResponse struct {
}

ContainersClientDeleteResponse contains the response from method ContainersClient.BeginDelete.

type ContainersClientGetOptions added in v0.2.0 

type ContainersClientGetOptions struct {
}

ContainersClientGetOptions contains the optional parameters for the ContainersClient.Get method.

type ContainersClientGetResponse added in v0.2.0 

type ContainersClientGetResponse struct {
	// Represents a container on the Data Box Edge/Gateway device.
	Container
}

ContainersClientGetResponse contains the response from method ContainersClient.Get.

type ContainersClientListByStorageAccountOptions added in v0.2.0 

type ContainersClientListByStorageAccountOptions struct {
}

ContainersClientListByStorageAccountOptions contains the optional parameters for the ContainersClient.NewListByStorageAccountPager method.

type ContainersClientListByStorageAccountResponse added in v0.2.0 

type ContainersClientListByStorageAccountResponse struct {
	// Collection of all the containers on the Data Box Edge/Gateway device.
	ContainerList
}

ContainersClientListByStorageAccountResponse contains the response from method ContainersClient.NewListByStorageAccountPager.

type ContainersClientRefreshResponse added in v0.2.0 

type ContainersClientRefreshResponse struct {
}

ContainersClientRefreshResponse contains the response from method ContainersClient.BeginRefresh.

type CreatedByType 

type CreatedByType string

CreatedByType - The type of identity that created the resource. 

const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

type DCAccessCode 

type DCAccessCode struct {
	// DCAccessCode properties.
	Properties *DCAccessCodeProperties
}

DCAccessCode - DC Access code in the case of Self Managed Shipping.

func (DCAccessCode) MarshalJSON added in v1.1.0 

func (d DCAccessCode) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DCAccessCode.

func (*DCAccessCode) UnmarshalJSON added in v1.1.0 

func (d *DCAccessCode) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DCAccessCode.

type DCAccessCodeProperties 

type DCAccessCodeProperties struct {
	// DCAccess Code for the Self Managed shipment.
	AuthCode *string
}

DCAccessCodeProperties - DCAccessCode Properties.

func (DCAccessCodeProperties) MarshalJSON added in v1.1.0 

func (d DCAccessCodeProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DCAccessCodeProperties.

func (*DCAccessCodeProperties) UnmarshalJSON added in v1.1.0 

func (d *DCAccessCodeProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DCAccessCodeProperties.

type DataBoxEdgeDeviceKind 

type DataBoxEdgeDeviceKind string

DataBoxEdgeDeviceKind - The kind of the device. 

const (
	DataBoxEdgeDeviceKindAzureDataBoxGateway    DataBoxEdgeDeviceKind = "AzureDataBoxGateway"
	DataBoxEdgeDeviceKindAzureModularDataCentre DataBoxEdgeDeviceKind = "AzureModularDataCentre"
	DataBoxEdgeDeviceKindAzureStackEdge         DataBoxEdgeDeviceKind = "AzureStackEdge"
	DataBoxEdgeDeviceKindAzureStackHub          DataBoxEdgeDeviceKind = "AzureStackHub"
)

func PossibleDataBoxEdgeDeviceKindValues 

func PossibleDataBoxEdgeDeviceKindValues() []DataBoxEdgeDeviceKind

PossibleDataBoxEdgeDeviceKindValues returns the possible values for the DataBoxEdgeDeviceKind const type.

type DataBoxEdgeDeviceStatus 

type DataBoxEdgeDeviceStatus string

DataBoxEdgeDeviceStatus - The status of the Data Box Edge/Gateway device. 

const (
	DataBoxEdgeDeviceStatusDisconnected          DataBoxEdgeDeviceStatus = "Disconnected"
	DataBoxEdgeDeviceStatusMaintenance           DataBoxEdgeDeviceStatus = "Maintenance"
	DataBoxEdgeDeviceStatusNeedsAttention        DataBoxEdgeDeviceStatus = "NeedsAttention"
	DataBoxEdgeDeviceStatusOffline               DataBoxEdgeDeviceStatus = "Offline"
	DataBoxEdgeDeviceStatusOnline                DataBoxEdgeDeviceStatus = "Online"
	DataBoxEdgeDeviceStatusPartiallyDisconnected DataBoxEdgeDeviceStatus = "PartiallyDisconnected"
	DataBoxEdgeDeviceStatusReadyToSetup          DataBoxEdgeDeviceStatus = "ReadyToSetup"
)

func PossibleDataBoxEdgeDeviceStatusValues 

func PossibleDataBoxEdgeDeviceStatusValues() []DataBoxEdgeDeviceStatus

PossibleDataBoxEdgeDeviceStatusValues returns the possible values for the DataBoxEdgeDeviceStatus const type.

type DataPolicy 

type DataPolicy string

DataPolicy - Data policy of the share. 

const (
	DataPolicyCloud DataPolicy = "Cloud"
	DataPolicyLocal DataPolicy = "Local"
)

func PossibleDataPolicyValues 

func PossibleDataPolicyValues() []DataPolicy

PossibleDataPolicyValues returns the possible values for the DataPolicy const type.

type DataResidency 

type DataResidency struct {
	// DataResidencyType enum
	Type *DataResidencyType
}

DataResidency - Wraps data-residency related information for edge-resource and this should be used with ARM layer.

func (DataResidency) MarshalJSON added in v1.1.0 

func (d DataResidency) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataResidency.

func (*DataResidency) UnmarshalJSON added in v1.1.0 

func (d *DataResidency) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataResidency.

type DataResidencyType 

type DataResidencyType string

DataResidencyType - DataResidencyType enum 

const (
	DataResidencyTypeGeoZoneReplication DataResidencyType = "GeoZoneReplication"
	DataResidencyTypeZoneReplication    DataResidencyType = "ZoneReplication"
)

func PossibleDataResidencyTypeValues 

func PossibleDataResidencyTypeValues() []DataResidencyType

PossibleDataResidencyTypeValues returns the possible values for the DataResidencyType const type.

type DayOfWeek 

type DayOfWeek string
const (
	DayOfWeekFriday    DayOfWeek = "Friday"
	DayOfWeekMonday    DayOfWeek = "Monday"
	DayOfWeekSaturday  DayOfWeek = "Saturday"
	DayOfWeekSunday    DayOfWeek = "Sunday"
	DayOfWeekThursday  DayOfWeek = "Thursday"
	DayOfWeekTuesday   DayOfWeek = "Tuesday"
	DayOfWeekWednesday DayOfWeek = "Wednesday"
)

func PossibleDayOfWeekValues 

func PossibleDayOfWeekValues() []DayOfWeek

PossibleDayOfWeekValues returns the possible values for the DayOfWeek const type.

type Device added in v0.2.0 

type Device struct {
	// REQUIRED; The location of the device. This is a supported and registered Azure geographical region (for example, West US,
	// East US, or Southeast Asia). The geographical region of a device cannot be changed once
	// it is created, but if an identical geographical region is specified on update, the request will succeed.
	Location *string

	// The etag for the devices.
	Etag *string

	// Msi identity of the resource
	Identity *ResourceIdentity

	// The properties of the Data Box Edge/Gateway device.
	Properties *DeviceProperties

	// The SKU type.
	SKU *SKUInfo

	// The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).
	Tags map[string]*string

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The kind of the device.
	Kind *DataBoxEdgeDeviceKind

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; DataBoxEdge Resource
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

Device - The Data Box Edge/Gateway device.

func (Device) MarshalJSON added in v0.2.0 

func (d Device) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Device.

func (*Device) UnmarshalJSON added in v1.1.0 

func (d *Device) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Device.

type DeviceCapacityCheckClient added in v0.3.0 

type DeviceCapacityCheckClient struct {
	// contains filtered or unexported fields
}

DeviceCapacityCheckClient contains the methods for the DeviceCapacityCheck group. Don't use this type directly, use NewDeviceCapacityCheckClient() instead.

func NewDeviceCapacityCheckClient added in v0.3.0 

func NewDeviceCapacityCheckClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DeviceCapacityCheckClient, error)

NewDeviceCapacityCheckClient creates a new instance of DeviceCapacityCheckClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*DeviceCapacityCheckClient) BeginCheckResourceCreationFeasibility added in v0.3.0 

func (client *DeviceCapacityCheckClient) BeginCheckResourceCreationFeasibility(ctx context.Context, resourceGroupName string, deviceName string, deviceCapacityRequestInfo DeviceCapacityRequestInfo, options *DeviceCapacityCheckClientBeginCheckResourceCreationFeasibilityOptions) (*runtime.Poller[DeviceCapacityCheckClientCheckResourceCreationFeasibilityResponse], error)

BeginCheckResourceCreationFeasibility - Posts the device capacity request info to check feasibility. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The resource group name.
  • deviceName - The device name.
  • deviceCapacityRequestInfo - The device capacity request info.
  • options - DeviceCapacityCheckClientBeginCheckResourceCreationFeasibilityOptions contains the optional parameters for the DeviceCapacityCheckClient.BeginCheckResourceCreationFeasibility method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/DeviceCapacityRequestPost.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDeviceCapacityCheckClient().BeginCheckResourceCreationFeasibility(ctx, "GroupForEdgeAutomation", "testedgedevice", armdataboxedge.DeviceCapacityRequestInfo{
		Properties: &armdataboxedge.DeviceCapacityRequestInfoProperties{
			VMPlacementQuery: [][]*string{
				{
					to.Ptr("Standard_D2_v2")}},
		},
	}, &armdataboxedge.DeviceCapacityCheckClientBeginCheckResourceCreationFeasibilityOptions{CapacityName: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

type DeviceCapacityCheckClientBeginCheckResourceCreationFeasibilityOptions added in v0.3.0 

type DeviceCapacityCheckClientBeginCheckResourceCreationFeasibilityOptions struct {
	// The capacity name.
	CapacityName *string

	// Resumes the LRO from the provided token.
	ResumeToken string
}

DeviceCapacityCheckClientBeginCheckResourceCreationFeasibilityOptions contains the optional parameters for the DeviceCapacityCheckClient.BeginCheckResourceCreationFeasibility method.

type DeviceCapacityCheckClientCheckResourceCreationFeasibilityResponse added in v0.3.0 

type DeviceCapacityCheckClientCheckResourceCreationFeasibilityResponse struct {
}

DeviceCapacityCheckClientCheckResourceCreationFeasibilityResponse contains the response from method DeviceCapacityCheckClient.BeginCheckResourceCreationFeasibility.

type DeviceCapacityInfo added in v0.3.0 

type DeviceCapacityInfo struct {
	// The device capacity properties.
	Properties *DeviceCapacityInfoProperties

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Metadata pertaining to device capacity info.
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

DeviceCapacityInfo - Object for Capturing DeviceCapacityInfo

func (DeviceCapacityInfo) MarshalJSON added in v1.1.0 

func (d DeviceCapacityInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeviceCapacityInfo.

func (*DeviceCapacityInfo) UnmarshalJSON added in v1.1.0 

func (d *DeviceCapacityInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeviceCapacityInfo.

type DeviceCapacityInfoClient added in v0.3.0 

type DeviceCapacityInfoClient struct {
	// contains filtered or unexported fields
}

DeviceCapacityInfoClient contains the methods for the DeviceCapacityInfo group. Don't use this type directly, use NewDeviceCapacityInfoClient() instead.

func NewDeviceCapacityInfoClient added in v0.3.0 

func NewDeviceCapacityInfoClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DeviceCapacityInfoClient, error)

NewDeviceCapacityInfoClient creates a new instance of DeviceCapacityInfoClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*DeviceCapacityInfoClient) GetDeviceCapacityInfo added in v0.3.0 

func (client *DeviceCapacityInfoClient) GetDeviceCapacityInfo(ctx context.Context, resourceGroupName string, deviceName string, options *DeviceCapacityInfoClientGetDeviceCapacityInfoOptions) (DeviceCapacityInfoClientGetDeviceCapacityInfoResponse, error)

GetDeviceCapacityInfo - Gets the properties of the specified device capacity info. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The resource group name.
  • deviceName - The device name.
  • options - DeviceCapacityInfoClientGetDeviceCapacityInfoOptions contains the optional parameters for the DeviceCapacityInfoClient.GetDeviceCapacityInfo method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/DeviceCapacityGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDeviceCapacityInfoClient().GetDeviceCapacityInfo(ctx, "GroupForEdgeAutomation", "testedgedevice", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DeviceCapacityInfo = armdataboxedge.DeviceCapacityInfo{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/deviceCapacityInfo"),
	// 	ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/deviceCapacityInfo/default"),
	// 	Properties: &armdataboxedge.DeviceCapacityInfoProperties{
	// 		ClusterComputeCapacityInfo: &armdataboxedge.ClusterCapacityViewData{
	// 			Fqdn: to.Ptr("3V78B03CL"),
	// 			GpuCapacity: &armdataboxedge.ClusterGpuCapacity{
	// 				GpuFreeUnitsCount: to.Ptr[int32](1),
	// 				GpuReservedForFailoverUnitsCount: to.Ptr[int32](0),
	// 				GpuTotalUnitsCount: to.Ptr[int32](1),
	// 				GpuType: to.Ptr("NvidiaTeslaT4"),
	// 				GpuUsedUnitsCount: to.Ptr[int32](0),
	// 			},
	// 			LastRefreshedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-28T19:35:23.820Z"); return t}()),
	// 			MemoryCapacity: &armdataboxedge.ClusterMemoryCapacity{
	// 				ClusterFailoverMemoryMb: to.Ptr[float64](0),
	// 				ClusterFragmentationMemoryMb: to.Ptr[float64](0),
	// 				ClusterFreeMemoryMb: to.Ptr[float64](20978.64),
	// 				ClusterHypervReserveMemoryMb: to.Ptr[float64](19599.36),
	// 				ClusterInfraVMMemoryMb: to.Ptr[float64](0),
	// 				ClusterMemoryUsedByVMsMb: to.Ptr[float64](90112),
	// 				ClusterNonFailoverVMMb: to.Ptr[float64](0),
	// 				ClusterTotalMemoryMb: to.Ptr[float64](130690),
	// 				ClusterUsedMemoryMb: to.Ptr[float64](109711.36),
	// 			},
	// 			TotalProvisionedNonHpnCores: to.Ptr[int64](5),
	// 		},
	// 		ClusterStorageCapacityInfo: &armdataboxedge.ClusterStorageViewData{
	// 			ClusterFreeStorageMb: to.Ptr[float64](5284151),
	// 			ClusterTotalStorageMb: to.Ptr[float64](5368642),
	// 		},
	// 		NodeCapacityInfos: map[string]*armdataboxedge.HostCapacity{
	// 			"3V78B03": &armdataboxedge.HostCapacity{
	// 				AvailableGpuCount: to.Ptr[int32](1),
	// 				EffectiveAvailableMemoryMbOnHost: to.Ptr[int64](45818),
	// 				GpuType: to.Ptr("NvidiaTeslaT4"),
	// 				HostName: to.Ptr("3V78B03"),
	// 				NumaNodesData: []*armdataboxedge.NumaNodeData{
	// 					{
	// 						EffectiveAvailableMemoryInMb: to.Ptr[int64](30182),
	// 						FreeVCPUIndexesForHpn: []*int32{
	// 						},
	// 						LogicalCoreCountPerCore: to.Ptr[int32](2),
	// 						NumaNodeIndex: to.Ptr[int32](0),
	// 						TotalMemoryInMb: to.Ptr[int64](65154),
	// 						VCPUIndexesForHpn: []*int32{
	// 						},
	// 						VCPUIndexesForRoot: []*int32{
	// 							to.Ptr[int32](0),
	// 							to.Ptr[int32](1),
	// 							to.Ptr[int32](2),
	// 							to.Ptr[int32](3),
	// 							to.Ptr[int32](4),
	// 							to.Ptr[int32](5),
	// 							to.Ptr[int32](6),
	// 							to.Ptr[int32](7),
	// 							to.Ptr[int32](8),
	// 							to.Ptr[int32](9),
	// 							to.Ptr[int32](10),
	// 							to.Ptr[int32](11),
	// 							to.Ptr[int32](12),
	// 							to.Ptr[int32](13),
	// 							to.Ptr[int32](14),
	// 							to.Ptr[int32](15),
	// 							to.Ptr[int32](16),
	// 							to.Ptr[int32](17),
	// 							to.Ptr[int32](18),
	// 							to.Ptr[int32](19)},
	// 						},
	// 						{
	// 							EffectiveAvailableMemoryInMb: to.Ptr[int64](19493),
	// 							FreeVCPUIndexesForHpn: []*int32{
	// 							},
	// 							LogicalCoreCountPerCore: to.Ptr[int32](2),
	// 							NumaNodeIndex: to.Ptr[int32](1),
	// 							TotalMemoryInMb: to.Ptr[int64](65536),
	// 							VCPUIndexesForHpn: []*int32{
	// 							},
	// 							VCPUIndexesForRoot: []*int32{
	// 								to.Ptr[int32](20),
	// 								to.Ptr[int32](21),
	// 								to.Ptr[int32](22),
	// 								to.Ptr[int32](23),
	// 								to.Ptr[int32](24),
	// 								to.Ptr[int32](25),
	// 								to.Ptr[int32](26),
	// 								to.Ptr[int32](27),
	// 								to.Ptr[int32](28),
	// 								to.Ptr[int32](29),
	// 								to.Ptr[int32](30),
	// 								to.Ptr[int32](31),
	// 								to.Ptr[int32](32),
	// 								to.Ptr[int32](33),
	// 								to.Ptr[int32](34),
	// 								to.Ptr[int32](35),
	// 								to.Ptr[int32](36),
	// 								to.Ptr[int32](37),
	// 								to.Ptr[int32](38),
	// 								to.Ptr[int32](39)},
	// 						}},
	// 						VMUsedMemory: map[string]*armdataboxedge.VMMemory{
	// 							"23ddd5ea-bda9-467a-803f-1a7e2888d1fa": &armdataboxedge.VMMemory{
	// 								CurrentMemoryUsageMB: to.Ptr[int64](24576),
	// 								StartupMemoryMB: to.Ptr[int64](24576),
	// 							},
	// 							"2e867196-e44b-49b7-9cb3-46c25973b762": &armdataboxedge.VMMemory{
	// 								CurrentMemoryUsageMB: to.Ptr[int64](3584),
	// 								StartupMemoryMB: to.Ptr[int64](3584),
	// 							},
	// 							"48034ac1-04ce-48e1-89fd-15a6d71fd623": &armdataboxedge.VMMemory{
	// 								CurrentMemoryUsageMB: to.Ptr[int64](2048),
	// 								StartupMemoryMB: to.Ptr[int64](2048),
	// 							},
	// 							"4c4261f0-eac5-4ff6-95ef-2cb70e09d3f6": &armdataboxedge.VMMemory{
	// 								CurrentMemoryUsageMB: to.Ptr[int64](3584),
	// 								StartupMemoryMB: to.Ptr[int64](3584),
	// 							},
	// 							"6b1817d5-4003-4f17-8423-51c33d9de88c": &armdataboxedge.VMMemory{
	// 								CurrentMemoryUsageMB: to.Ptr[int64](0),
	// 								StartupMemoryMB: to.Ptr[int64](24576),
	// 							},
	// 							"853efe82-58f1-4f94-8f9c-7752dab6767c": &armdataboxedge.VMMemory{
	// 								CurrentMemoryUsageMB: to.Ptr[int64](24576),
	// 								StartupMemoryMB: to.Ptr[int64](24576),
	// 							},
	// 							"c1023a57-d6a0-4a77-9308-48b320bfedbd": &armdataboxedge.VMMemory{
	// 								CurrentMemoryUsageMB: to.Ptr[int64](3584),
	// 								StartupMemoryMB: to.Ptr[int64](3584),
	// 							},
	// 							"dc3d20b2-8581-41cb-9ca3-1bbc1a8a2fe4": &armdataboxedge.VMMemory{
	// 								CurrentMemoryUsageMB: to.Ptr[int64](3584),
	// 								StartupMemoryMB: to.Ptr[int64](3584),
	// 							},
	// 						},
	// 					},
	// 				},
	// 				TimeStamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-28T19:35:34.558Z"); return t}()),
	// 			},
	// 		}
}

Output:

type DeviceCapacityInfoClientGetDeviceCapacityInfoOptions added in v0.3.0 

type DeviceCapacityInfoClientGetDeviceCapacityInfoOptions struct {
}

DeviceCapacityInfoClientGetDeviceCapacityInfoOptions contains the optional parameters for the DeviceCapacityInfoClient.GetDeviceCapacityInfo method.

type DeviceCapacityInfoClientGetDeviceCapacityInfoResponse added in v0.3.0 

type DeviceCapacityInfoClientGetDeviceCapacityInfoResponse struct {
	// Object for Capturing DeviceCapacityInfo
	DeviceCapacityInfo
}

DeviceCapacityInfoClientGetDeviceCapacityInfoResponse contains the response from method DeviceCapacityInfoClient.GetDeviceCapacityInfo.

type DeviceCapacityInfoProperties added in v0.3.0 

type DeviceCapacityInfoProperties struct {
	// Cluster capacity data for compute resources (Memory and GPU).
	ClusterComputeCapacityInfo *ClusterCapacityViewData

	// Cluster capacity data for storage resources (CSV).
	ClusterStorageCapacityInfo *ClusterStorageViewData

	// The dictionary of individual node names and node capacities in the cluster.
	NodeCapacityInfos map[string]*HostCapacity

	// Timestamp of request in UTC
	TimeStamp *time.Time
}

DeviceCapacityInfoProperties - The properties of Device Capacity Info

func (DeviceCapacityInfoProperties) MarshalJSON added in v0.3.0 

func (d DeviceCapacityInfoProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeviceCapacityInfoProperties.

func (*DeviceCapacityInfoProperties) UnmarshalJSON added in v0.3.0 

func (d *DeviceCapacityInfoProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeviceCapacityInfoProperties.

type DeviceCapacityRequestInfo added in v0.3.0 

type DeviceCapacityRequestInfo struct {
	// REQUIRED; The properties of the Device Capacity Request.
	Properties *DeviceCapacityRequestInfoProperties
}

DeviceCapacityRequestInfo - Object for Capturing DeviceCapacityRequestInfo

func (DeviceCapacityRequestInfo) MarshalJSON added in v1.1.0 

func (d DeviceCapacityRequestInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeviceCapacityRequestInfo.

func (*DeviceCapacityRequestInfo) UnmarshalJSON added in v1.1.0 

func (d *DeviceCapacityRequestInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeviceCapacityRequestInfo.

type DeviceCapacityRequestInfoProperties added in v0.3.0 

type DeviceCapacityRequestInfoProperties struct {
	// REQUIRED; Array containing the sizes of the VMs for checking if its feasible to create them on the appliance.
	VMPlacementQuery [][]*string

	// Array of the VMs of the sizes in VmSizes can be provisioned on the appliance.
	VMPlacementResults []*VMPlacementRequestResult
}

DeviceCapacityRequestInfoProperties - Properties of Device Capacity Request Info containing VM's to be checked and their corresponding results.

func (DeviceCapacityRequestInfoProperties) MarshalJSON added in v0.3.0 

func (d DeviceCapacityRequestInfoProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeviceCapacityRequestInfoProperties.

func (*DeviceCapacityRequestInfoProperties) UnmarshalJSON added in v1.1.0 

func (d *DeviceCapacityRequestInfoProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeviceCapacityRequestInfoProperties.

type DeviceExtendedInfo added in v0.2.0 

type DeviceExtendedInfo struct {
	// The extended info properties.
	Properties *DeviceExtendedInfoProperties

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of DataBoxEdgeDevice
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

DeviceExtendedInfo - The extended Info of the Data Box Edge/Gateway device.

func (DeviceExtendedInfo) MarshalJSON added in v1.1.0 

func (d DeviceExtendedInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeviceExtendedInfo.

func (*DeviceExtendedInfo) UnmarshalJSON added in v1.1.0 

func (d *DeviceExtendedInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeviceExtendedInfo.

type DeviceExtendedInfoPatch added in v0.2.0 

type DeviceExtendedInfoPatch struct {
	// The name for Channel Integrity Key stored in the Client Key Vault
	ChannelIntegrityKeyName *string

	// The version of Channel Integrity Key stored in the Client Key Vault
	ChannelIntegrityKeyVersion *string

	// The Key Vault ARM Id for client secrets
	ClientSecretStoreID *string

	// The url to access the Client Key Vault
	ClientSecretStoreURL *string

	// For changing or to initiate the resync to key-vault set the status to KeyVaultSyncPending, rest of the status will not
	// be applicable.
	SyncStatus *KeyVaultSyncStatus
}

DeviceExtendedInfoPatch - The Data Box Edge/Gateway device extended info patch.

func (DeviceExtendedInfoPatch) MarshalJSON added in v1.1.0 

func (d DeviceExtendedInfoPatch) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeviceExtendedInfoPatch.

func (*DeviceExtendedInfoPatch) UnmarshalJSON added in v1.1.0 

func (d *DeviceExtendedInfoPatch) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeviceExtendedInfoPatch.

type DeviceExtendedInfoProperties added in v0.2.0 

type DeviceExtendedInfoProperties struct {
	// The name of Channel Integrity Key stored in the Client Key Vault
	ChannelIntegrityKeyName *string

	// The version of Channel Integrity Key stored in the Client Key Vault
	ChannelIntegrityKeyVersion *string

	// The Key Vault ARM Id for client secrets
	ClientSecretStoreID *string

	// The url to access the Client Key Vault
	ClientSecretStoreURL *string

	// The public part of the encryption certificate. Client uses this to encrypt any secret.
	EncryptionKey *string

	// The digital signature of encrypted certificate.
	EncryptionKeyThumbprint *string

	// Key vault sync status
	KeyVaultSyncStatus *KeyVaultSyncStatus

	// READ-ONLY; The Container for cloud witness in the storage account.
	CloudWitnessContainerName *string

	// READ-ONLY; The Cloud Witness Storage account name.
	CloudWitnessStorageAccountName *string

	// READ-ONLY; The Azure service endpoint of the cloud witness storage account.
	CloudWitnessStorageEndpoint *string

	// READ-ONLY; Cluster Witness Type
	ClusterWitnessType *ClusterWitnessType

	// READ-ONLY; Device secrets, will be returned only with ODataFilter $expand=deviceSecrets
	DeviceSecrets map[string]*Secret

	// READ-ONLY; The witness location of file share.
	FileShareWitnessLocation *string

	// READ-ONLY; The username of file share.
	FileShareWitnessUsername *string

	// READ-ONLY; The Resource ID of the Resource.
	ResourceKey *string
}

DeviceExtendedInfoProperties - The properties of the Data Box Edge/Gateway device extended info.

func (DeviceExtendedInfoProperties) MarshalJSON added in v0.2.0 

func (d DeviceExtendedInfoProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeviceExtendedInfoProperties.

func (*DeviceExtendedInfoProperties) UnmarshalJSON added in v1.1.0 

func (d *DeviceExtendedInfoProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeviceExtendedInfoProperties.

type DeviceList added in v0.2.0 

type DeviceList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string

	// READ-ONLY; The list of Data Box Edge/Gateway devices.
	Value []*Device
}

DeviceList - The collection of Data Box Edge/Gateway devices.

func (DeviceList) MarshalJSON added in v0.2.0 

func (d DeviceList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeviceList.

func (*DeviceList) UnmarshalJSON added in v1.1.0 

func (d *DeviceList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeviceList.

type DevicePatch added in v0.2.0 

type DevicePatch struct {
	// Msi identity of the resource
	Identity *ResourceIdentity

	// The properties associated with the Data Box Edge/Gateway resource
	Properties *DevicePropertiesPatch

	// The tags attached to the Data Box Edge/Gateway resource.
	Tags map[string]*string
}

DevicePatch - The Data Box Edge/Gateway device patch.

func (DevicePatch) MarshalJSON added in v0.2.0 

func (d DevicePatch) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DevicePatch.

func (*DevicePatch) UnmarshalJSON added in v1.1.0 

func (d *DevicePatch) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DevicePatch.

type DeviceProperties added in v0.2.0 

type DeviceProperties struct {
	// The details of data-residency related properties for this resource
	DataResidency *DataResidency

	// READ-ONLY; Type of compute roles configured.
	ConfiguredRoleTypes []*RoleTypes

	// READ-ONLY; The Data Box Edge/Gateway device culture.
	Culture *string

	// READ-ONLY; The status of the Data Box Edge/Gateway device.
	DataBoxEdgeDeviceStatus *DataBoxEdgeDeviceStatus

	// READ-ONLY; The Description of the Data Box Edge/Gateway device.
	Description *string

	// READ-ONLY; The device software version number of the device (eg: 1.2.18105.6).
	DeviceHcsVersion *string

	// READ-ONLY; The Data Box Edge/Gateway device local capacity in MB.
	DeviceLocalCapacity *int64

	// READ-ONLY; The Data Box Edge/Gateway device model.
	DeviceModel *string

	// READ-ONLY; The Data Box Edge/Gateway device software version.
	DeviceSoftwareVersion *string

	// READ-ONLY; The type of the Data Box Edge/Gateway device.
	DeviceType *DeviceType

	// READ-ONLY; The details of Edge Profile for this resource
	EdgeProfile *EdgeProfile

	// READ-ONLY; The Data Box Edge/Gateway device name.
	FriendlyName *string

	// READ-ONLY; The description of the Data Box Edge/Gateway device model.
	ModelDescription *string

	// READ-ONLY; The number of nodes in the cluster.
	NodeCount *int32

	// READ-ONLY; The details of the move operation on this resource.
	ResourceMoveDetails *ResourceMoveDetails

	// READ-ONLY; The Serial Number of Data Box Edge/Gateway device.
	SerialNumber *string

	// READ-ONLY; DataBoxEdge Device Properties
	SystemData *SystemData

	// READ-ONLY; The Data Box Edge/Gateway device timezone.
	TimeZone *string
}

DeviceProperties - The properties of the Data Box Edge/Gateway device.

func (DeviceProperties) MarshalJSON added in v0.2.0 

func (d DeviceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeviceProperties.

func (*DeviceProperties) UnmarshalJSON added in v1.1.0 

func (d *DeviceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeviceProperties.

type DevicePropertiesPatch added in v0.2.0 

type DevicePropertiesPatch struct {
	// Edge Profile property of the Data Box Edge/Gateway device
	EdgeProfile *EdgeProfilePatch
}

DevicePropertiesPatch - The Data Box Edge/Gateway device properties patch.

func (DevicePropertiesPatch) MarshalJSON added in v1.1.0 

func (d DevicePropertiesPatch) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DevicePropertiesPatch.

func (*DevicePropertiesPatch) UnmarshalJSON added in v1.1.0 

func (d *DevicePropertiesPatch) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DevicePropertiesPatch.

type DeviceType 

type DeviceType string

DeviceType - The type of the Data Box Edge/Gateway device. 

const (
	DeviceTypeDataBoxEdgeDevice DeviceType = "DataBoxEdgeDevice"
)

func PossibleDeviceTypeValues 

func PossibleDeviceTypeValues() []DeviceType

PossibleDeviceTypeValues returns the possible values for the DeviceType const type.

type DevicesClient 

type DevicesClient struct {
	// contains filtered or unexported fields
}

DevicesClient contains the methods for the Devices group. Don't use this type directly, use NewDevicesClient() instead.

func NewDevicesClient 

func NewDevicesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DevicesClient, error)

NewDevicesClient creates a new instance of DevicesClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*DevicesClient) BeginCreateOrUpdateSecuritySettings 

func (client *DevicesClient) BeginCreateOrUpdateSecuritySettings(ctx context.Context, deviceName string, resourceGroupName string, securitySettings SecuritySettings, options *DevicesClientBeginCreateOrUpdateSecuritySettingsOptions) (*runtime.Poller[DevicesClientCreateOrUpdateSecuritySettingsResponse], error)

BeginCreateOrUpdateSecuritySettings - Updates the security settings on a Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • securitySettings - The security settings.
  • options - DevicesClientBeginCreateOrUpdateSecuritySettingsOptions contains the optional parameters for the DevicesClient.BeginCreateOrUpdateSecuritySettings method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/SecuritySettingsUpdatePost.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDevicesClient().BeginCreateOrUpdateSecuritySettings(ctx, "testedgedevice", "AzureVM", armdataboxedge.SecuritySettings{
		Properties: &armdataboxedge.SecuritySettingsProperties{
			DeviceAdminPassword: &armdataboxedge.AsymmetricEncryptedSecret{
				EncryptionAlgorithm:      to.Ptr(armdataboxedge.EncryptionAlgorithmAES256),
				EncryptionCertThumbprint: to.Ptr("<encryptionThumprint>"),
				Value:                    to.Ptr("<deviceAdminPassword>"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*DevicesClient) BeginDelete 

func (client *DevicesClient) BeginDelete(ctx context.Context, deviceName string, resourceGroupName string, options *DevicesClientBeginDeleteOptions) (*runtime.Poller[DevicesClientDeleteResponse], error)

BeginDelete - Deletes the Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - DevicesClientBeginDeleteOptions contains the optional parameters for the DevicesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/DataBoxEdgeDeviceDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDevicesClient().BeginDelete(ctx, "testedgedevice", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*DevicesClient) BeginDownloadUpdates 

func (client *DevicesClient) BeginDownloadUpdates(ctx context.Context, deviceName string, resourceGroupName string, options *DevicesClientBeginDownloadUpdatesOptions) (*runtime.Poller[DevicesClientDownloadUpdatesResponse], error)

BeginDownloadUpdates - Downloads the updates on a Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - DevicesClientBeginDownloadUpdatesOptions contains the optional parameters for the DevicesClient.BeginDownloadUpdates method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/DownloadUpdatesPost.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDevicesClient().BeginDownloadUpdates(ctx, "testedgedevice", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*DevicesClient) BeginInstallUpdates 

func (client *DevicesClient) BeginInstallUpdates(ctx context.Context, deviceName string, resourceGroupName string, options *DevicesClientBeginInstallUpdatesOptions) (*runtime.Poller[DevicesClientInstallUpdatesResponse], error)

BeginInstallUpdates - Installs the updates on the Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - DevicesClientBeginInstallUpdatesOptions contains the optional parameters for the DevicesClient.BeginInstallUpdates method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/InstallUpdatesPost.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDevicesClient().BeginInstallUpdates(ctx, "testedgedevice", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*DevicesClient) BeginScanForUpdates 

func (client *DevicesClient) BeginScanForUpdates(ctx context.Context, deviceName string, resourceGroupName string, options *DevicesClientBeginScanForUpdatesOptions) (*runtime.Poller[DevicesClientScanForUpdatesResponse], error)

BeginScanForUpdates - Scans for updates on a Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - DevicesClientBeginScanForUpdatesOptions contains the optional parameters for the DevicesClient.BeginScanForUpdates method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/ScanForUpdatesPost.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDevicesClient().BeginScanForUpdates(ctx, "testedgedevice", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*DevicesClient) CreateOrUpdate 

func (client *DevicesClient) CreateOrUpdate(ctx context.Context, deviceName string, resourceGroupName string, dataBoxEdgeDevice Device, options *DevicesClientCreateOrUpdateOptions) (DevicesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates a Data Box Edge/Data Box Gateway resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • dataBoxEdgeDevice - The resource object.
  • options - DevicesClientCreateOrUpdateOptions contains the optional parameters for the DevicesClient.CreateOrUpdate method.
Example (DataBoxEdgeDevicePut)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/DataBoxEdgeDevicePut.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDevicesClient().CreateOrUpdate(ctx, "testedgedevice", "GroupForEdgeAutomation", armdataboxedge.Device{
		Location: to.Ptr("WUS"),
		SKU: &armdataboxedge.SKUInfo{
			Name: to.Ptr(armdataboxedge.SKUNameEdge),
			Tier: to.Ptr(armdataboxedge.SKUTierStandard),
		},
		Tags: map[string]*string{},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Device = armdataboxedge.Device{
	// 	Name: to.Ptr("testedgedevice"),
	// 	Location: to.Ptr("WUS"),
	// 	SKU: &armdataboxedge.SKUInfo{
	// 		Name: to.Ptr(armdataboxedge.SKUNameEdge),
	// 		Tier: to.Ptr(armdataboxedge.SKUTierStandard),
	// 	},
	// 	Tags: map[string]*string{
	// 	},
	// }
}

Output:
Example (DataBoxEdgeDevicePutWithDataResidency)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/DataBoxEdgeDevicePutWithDataResidency.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDevicesClient().CreateOrUpdate(ctx, "testedgedevice", "GroupForEdgeAutomation", armdataboxedge.Device{
		Location: to.Ptr("WUS"),
		Properties: &armdataboxedge.DeviceProperties{
			DataResidency: &armdataboxedge.DataResidency{
				Type: to.Ptr(armdataboxedge.DataResidencyTypeZoneReplication),
			},
		},
		SKU: &armdataboxedge.SKUInfo{
			Name: to.Ptr(armdataboxedge.SKUNameEdge),
			Tier: to.Ptr(armdataboxedge.SKUTierStandard),
		},
		Tags: map[string]*string{},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Device = armdataboxedge.Device{
	// 	Name: to.Ptr("testedgedevice"),
	// 	Location: to.Ptr("WUS"),
	// 	Properties: &armdataboxedge.DeviceProperties{
	// 		DataResidency: &armdataboxedge.DataResidency{
	// 			Type: to.Ptr(armdataboxedge.DataResidencyTypeZoneReplication),
	// 		},
	// 	},
	// 	SKU: &armdataboxedge.SKUInfo{
	// 		Name: to.Ptr(armdataboxedge.SKUNameEdge),
	// 		Tier: to.Ptr(armdataboxedge.SKUTierStandard),
	// 	},
	// 	Tags: map[string]*string{
	// 	},
	// }
}

Output:

func (*DevicesClient) GenerateCertificate 

func (client *DevicesClient) GenerateCertificate(ctx context.Context, deviceName string, resourceGroupName string, options *DevicesClientGenerateCertificateOptions) (DevicesClientGenerateCertificateResponse, error)

GenerateCertificate - Generates certificate for activation key. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - DevicesClientGenerateCertificateOptions contains the optional parameters for the DevicesClient.GenerateCertificate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/GenerateCertificate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDevicesClient().GenerateCertificate(ctx, "testedgedevice", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.GenerateCertResponse = armdataboxedge.GenerateCertResponse{
	// 	ExpiryTimeInUTC: to.Ptr("2020-11-22T05:06:20.000Z"),
	// 	PublicKey: to.Ptr("MIIEDjCCAnagAwIBAgIQEW4wrxj9+JdA4kFLDgegTTANBgkqhkiG9w0BAQUFADBDMUEwPwYDVQQDHjgAQwBCAF8AUABvAHIAdABhAGwAXwA2ADMANwA0ADEAMwA1ADkAMQA4ADAAMAA3ADAAOQAxADcANTAeFw0yMDExMTkwNDU2MjBaFw0yMDExMjIwNTA2MjBaMEMxQTA/BgNVBAMeOABDAEIAXwBQAG8AcgB0AGEAbABfADYAMwA3ADQAMQAzADUAOQAxADgAMAAwADcAMAA5ADEANwA1MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAqG617KAUc4gOoht527o6FGE/c97W/wZIXqKbx4G8vifljXWw3NGDDuSQfidE3MqSMMJ/AAlDhBH/Deo/PAgUWuWB2WgM+KFWrDS0oDBvLVeIIeiMx4LOsbz4J8IbcKrGWf+ulQyum7dE/yBLzPXcPTjhJP0oMfhGOMlVVWbiKaP78/WZk2PmBQaVv7PxAQnJAPqETH2qAyuc9bd0TaMlIER56WhX9+nzsoI0u7RmBEs8+BaudVroiiK/GpEczy73TCRlpVXGChdBHg+NvYRYz91ltCV9Ijo1bdvcUjdgDJZ4Tz7G8XVCQmxbd9ml6OBLgxQUpd9HSGTcIfFiv+rTUwHR7YkY+1UGHsDPOYnBVDTXs3RFm+c5uNnCKvtyTExDJgabT+FTNb3eyD/BSYsy6b/YZBRqPiO8BRFUsIhWhXtPaUjWOEx6XMeZRnGeF4Hi8iH8TR79kEJhfYy3piSPAc3JrhgoglpyyfZOgyPOje+8tAWS9FHUNyVXKKeksDoZAgMBAAEwDQYJKoZIhvcNAQEFBQADggGBACpfQt34mgr+WlFtY0tqaPAoF6XnVzyKB6XsVAoj1uKFTSCQnr0mWvUMWKSRFTu1bV1VdDokV5I+h92kBcO4ddtHhWtkt16j9XFDsGdDvoUWJeqecZVr9fBPC69wF/9R/2E6iJporR46Pui7gcilYGqb3IjJlh8RT/XBPamQrfDbS7G8eTe91ST5cHr89R6EtDwfyhyTZr2sRrvQrxY2AjEmdH5Zcl9q2Xf8DholZhZ9vwnuYBFfl6VCXWaDAzQWiPdxo1wgXxEpNNDstGFWJKnsnz9UCohNAiPf47B+csPqxjcTLVMhcGLdU/lwpzzkEOciijpYILscvPoU3IM6DmFROgU2z6CForpgwHPDJktyWU1MC7lFdfrSzwu/5b3ZAEQhnJf7rvrybULoYBQWJEuj26Is1S6kXpNUaHAc5HIyIoc2V2eRjasbPIqsU0smjPLS/1egjHxtw9u+v4qDDvDuOjhFJtC3NkPl06TfNgO9+5LgiB1JppXnkLyCQ9RQgw=="),
	// }
}

Output:

func (*DevicesClient) Get 

func (client *DevicesClient) Get(ctx context.Context, deviceName string, resourceGroupName string, options *DevicesClientGetOptions) (DevicesClientGetResponse, error)

Get - Gets the properties of the Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - DevicesClientGetOptions contains the optional parameters for the DevicesClient.Get method.
Example (DataBoxEdgeDeviceGetByName)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/DataBoxEdgeDeviceGetByName.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDevicesClient().Get(ctx, "testedgedevice", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Device = armdataboxedge.Device{
	// 	Name: to.Ptr("EdgeTestPassResource"),
	// 	Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices"),
	// 	ID: to.Ptr("/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EdgeTestPassResource"),
	// 	Etag: to.Ptr("W/\"datetime'2020-09-29T18%3A50%3A31.1203818Z'\"_W/\"datetime'2020-09-29T18%3A50%3A31.1343914Z'\""),
	// 	Identity: &armdataboxedge.ResourceIdentity{
	// 		Type: to.Ptr(armdataboxedge.MsiIdentityTypeSystemAssigned),
	// 		PrincipalID: to.Ptr("b3e34fcc-ab02-4ca4-9d22-5de115419091"),
	// 		TenantID: to.Ptr("72f988bf-86f1-41af-91ab-2d7cd011db47"),
	// 	},
	// 	Kind: to.Ptr(armdataboxedge.DataBoxEdgeDeviceKindAzureStackEdge),
	// 	Location: to.Ptr("eastus2euap"),
	// 	Properties: &armdataboxedge.DeviceProperties{
	// 		ConfiguredRoleTypes: []*armdataboxedge.RoleTypes{
	// 			to.Ptr(armdataboxedge.RoleTypesCloudEdgeManagement)},
	// 			DataBoxEdgeDeviceStatus: to.Ptr(armdataboxedge.DataBoxEdgeDeviceStatusOffline),
	// 			DeviceHcsVersion: to.Ptr("2.1.1361.23408"),
	// 			DeviceLocalCapacity: to.Ptr[int64](8042259),
	// 			DeviceModel: to.Ptr("Physical"),
	// 			DeviceSoftwareVersion: to.Ptr("Azure Stack Edge 2009"),
	// 			DeviceType: to.Ptr(armdataboxedge.DeviceTypeDataBoxEdgeDevice),
	// 			EdgeProfile: &armdataboxedge.EdgeProfile{
	// 				Subscription: &armdataboxedge.EdgeProfileSubscription{
	// 					ID: to.Ptr("/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/VmMgmtTestPass/providers/Microsoft.AzureStack/edgeSubscriptions/daaac4b0-35c4-4008-bdc6-b72ca5890f16"),
	// 					RegistrationID: to.Ptr("91d8753b-af42-4908-9a5e-2a61f08b20de"),
	// 					State: to.Ptr(armdataboxedge.SubscriptionStateRegistered),
	// 				},
	// 			},
	// 			FriendlyName: to.Ptr("DBE-1D6QHQ2"),
	// 			NodeCount: to.Ptr[int32](1),
	// 			SerialNumber: to.Ptr("1D6QHQ2"),
	// 			TimeZone: to.Ptr("Pacific Standard Time"),
	// 		},
	// 		SKU: &armdataboxedge.SKUInfo{
	// 			Name: to.Ptr(armdataboxedge.SKUNameEdge),
	// 			Tier: to.Ptr(armdataboxedge.SKUTierStandard),
	// 		},
	// 		Tags: map[string]*string{
	// 		},
	// 	}
}

Output:
Example (DataBoxEdgeDeviceGetByNameWithDataResidency)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/DataBoxEdgeDeviceGetByNameWithDataResidency.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDevicesClient().Get(ctx, "testedgedevice", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Device = armdataboxedge.Device{
	// 	Name: to.Ptr("EdgeTestPassResource"),
	// 	Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices"),
	// 	ID: to.Ptr("/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EdgeTestPassResource"),
	// 	Etag: to.Ptr("W/\"datetime'2020-09-29T18%3A50%3A31.1203818Z'\"_W/\"datetime'2020-09-29T18%3A50%3A31.1343914Z'\""),
	// 	Identity: &armdataboxedge.ResourceIdentity{
	// 		Type: to.Ptr(armdataboxedge.MsiIdentityTypeSystemAssigned),
	// 		PrincipalID: to.Ptr("b3e34fcc-ab02-4ca4-9d22-5de115419091"),
	// 		TenantID: to.Ptr("72f988bf-86f1-41af-91ab-2d7cd011db47"),
	// 	},
	// 	Kind: to.Ptr(armdataboxedge.DataBoxEdgeDeviceKindAzureStackEdge),
	// 	Location: to.Ptr("eastus2euap"),
	// 	Properties: &armdataboxedge.DeviceProperties{
	// 		ConfiguredRoleTypes: []*armdataboxedge.RoleTypes{
	// 			to.Ptr(armdataboxedge.RoleTypesCloudEdgeManagement)},
	// 			DataBoxEdgeDeviceStatus: to.Ptr(armdataboxedge.DataBoxEdgeDeviceStatusOffline),
	// 			DataResidency: &armdataboxedge.DataResidency{
	// 				Type: to.Ptr(armdataboxedge.DataResidencyTypeZoneReplication),
	// 			},
	// 			DeviceHcsVersion: to.Ptr("2.1.1361.23408"),
	// 			DeviceLocalCapacity: to.Ptr[int64](8042259),
	// 			DeviceModel: to.Ptr("Physical"),
	// 			DeviceSoftwareVersion: to.Ptr("Azure Stack Edge 2009"),
	// 			DeviceType: to.Ptr(armdataboxedge.DeviceTypeDataBoxEdgeDevice),
	// 			EdgeProfile: &armdataboxedge.EdgeProfile{
	// 				Subscription: &armdataboxedge.EdgeProfileSubscription{
	// 					ID: to.Ptr("/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/VmMgmtTestPass/providers/Microsoft.AzureStack/edgeSubscriptions/daaac4b0-35c4-4008-bdc6-b72ca5890f16"),
	// 					RegistrationID: to.Ptr("91d8753b-af42-4908-9a5e-2a61f08b20de"),
	// 					State: to.Ptr(armdataboxedge.SubscriptionStateRegistered),
	// 				},
	// 			},
	// 			FriendlyName: to.Ptr("DBE-1D6QHQ2"),
	// 			NodeCount: to.Ptr[int32](1),
	// 			SerialNumber: to.Ptr("1D6QHQ2"),
	// 			TimeZone: to.Ptr("Pacific Standard Time"),
	// 		},
	// 		SKU: &armdataboxedge.SKUInfo{
	// 			Name: to.Ptr(armdataboxedge.SKUNameEdge),
	// 			Tier: to.Ptr(armdataboxedge.SKUTierStandard),
	// 		},
	// 		Tags: map[string]*string{
	// 		},
	// 	}
}

Output:

func (*DevicesClient) GetExtendedInformation 

func (client *DevicesClient) GetExtendedInformation(ctx context.Context, deviceName string, resourceGroupName string, options *DevicesClientGetExtendedInformationOptions) (DevicesClientGetExtendedInformationResponse, error)

GetExtendedInformation - Gets additional information for the specified Azure Stack Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - DevicesClientGetExtendedInformationOptions contains the optional parameters for the DevicesClient.GetExtendedInformation method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/ExtendedInfoPost.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDevicesClient().GetExtendedInformation(ctx, "testedgedevice", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DeviceExtendedInfo = armdataboxedge.DeviceExtendedInfo{
	// 	Name: to.Ptr("testedgedevice"),
	// 	Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices"),
	// 	ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice"),
	// 	Properties: &armdataboxedge.DeviceExtendedInfoProperties{
	// 		EncryptionKey: to.Ptr("<encryptionkey>"),
	// 		EncryptionKeyThumbprint: to.Ptr("<encryptionthumbprint>"),
	// 		ResourceKey: to.Ptr("3482840729935603111"),
	// 	},
	// }
}

Output:

func (*DevicesClient) GetNetworkSettings 

func (client *DevicesClient) GetNetworkSettings(ctx context.Context, deviceName string, resourceGroupName string, options *DevicesClientGetNetworkSettingsOptions) (DevicesClientGetNetworkSettingsResponse, error)

GetNetworkSettings - Gets the network settings of the specified Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - DevicesClientGetNetworkSettingsOptions contains the optional parameters for the DevicesClient.GetNetworkSettings method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/NetworkSettingsGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDevicesClient().GetNetworkSettings(ctx, "testedgedevice", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.NetworkSettings = armdataboxedge.NetworkSettings{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/networkSettings"),
	// 	ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/networkSettings/default"),
	// 	Properties: &armdataboxedge.NetworkSettingsProperties{
	// 		NetworkAdapters: []*armdataboxedge.NetworkAdapter{
	// 			{
	// 				AdapterID: to.Ptr("{47D0D0EC-AA8A-4221-AA2A-355B58082BA5}"),
	// 				AdapterPosition: &armdataboxedge.NetworkAdapterPosition{
	// 					NetworkGroup: to.Ptr(armdataboxedge.NetworkGroupNonRDMA),
	// 					Port: to.Ptr[int32](0),
	// 				},
	// 				DhcpStatus: to.Ptr(armdataboxedge.NetworkAdapterDHCPStatusDisabled),
	// 				DNSServers: []*string{
	// 					to.Ptr("10.50.50.50"),
	// 					to.Ptr("10.50.10.50")},
	// 					Index: to.Ptr[int32](1),
	// 					IPv4Configuration: &armdataboxedge.IPv4Config{
	// 						Gateway: to.Ptr("10.150.76.1"),
	// 						IPAddress: to.Ptr("10.150.78.56"),
	// 						Subnet: to.Ptr("255.255.252.0"),
	// 					},
	// 					IPv6Configuration: &armdataboxedge.IPv6Config{
	// 						Gateway: to.Ptr("fe80::12f3:11ff:fe36:994b%5"),
	// 						IPAddress: to.Ptr("2404:f801:4800:1e:d5c6:50a1:465b:1bbf"),
	// 						PrefixLength: to.Ptr[int32](64),
	// 					},
	// 					IPv6LinkLocalAddress: to.Ptr("fe80::d5c6:50a1:465b:1bbf%5"),
	// 					Label: to.Ptr("DATA1"),
	// 					LinkSpeed: to.Ptr[int64](10000000000),
	// 					MacAddress: to.Ptr("00155D4E265B"),
	// 					NetworkAdapterName: to.Ptr("DATA1"),
	// 					NodeID: to.Ptr("3fd54d9e-f7a0-45bf-bdf1-39b0977d1984"),
	// 					RdmaStatus: to.Ptr(armdataboxedge.NetworkAdapterRDMAStatusIncapable),
	// 					Status: to.Ptr(armdataboxedge.NetworkAdapterStatusInactive),
	// 			}},
	// 		},
	// 	}
}

Output:

func (*DevicesClient) GetUpdateSummary 

func (client *DevicesClient) GetUpdateSummary(ctx context.Context, deviceName string, resourceGroupName string, options *DevicesClientGetUpdateSummaryOptions) (DevicesClientGetUpdateSummaryResponse, error)

GetUpdateSummary - Gets information about the availability of updates based on the last scan of the device. It also gets information about any ongoing download or install jobs on the device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - DevicesClientGetUpdateSummaryOptions contains the optional parameters for the DevicesClient.GetUpdateSummary method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/UpdateSummaryGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDevicesClient().GetUpdateSummary(ctx, "testedgedevice", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.UpdateSummary = armdataboxedge.UpdateSummary{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/updateSummary"),
	// 	ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/updateSummary/default"),
	// 	Properties: &armdataboxedge.UpdateSummaryProperties{
	// 		DeviceLastScannedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-17T19:51:51.786Z"); return t}()),
	// 		DeviceVersionNumber: to.Ptr("2.1.1377.2170"),
	// 		FriendlyDeviceVersionName: to.Ptr("Azure Stack Edge 2010"),
	// 		LastCompletedScanJobDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-17T19:47:46.159Z"); return t}()),
	// 		LastDownloadJobStatus: to.Ptr(armdataboxedge.JobStatusInvalid),
	// 		LastInstallJobStatus: to.Ptr(armdataboxedge.JobStatusInvalid),
	// 		OngoingUpdateOperation: to.Ptr(armdataboxedge.UpdateOperationInstall),
	// 		RebootBehavior: to.Ptr(armdataboxedge.InstallRebootBehaviorNeverReboots),
	// 		TotalNumberOfUpdatesAvailable: to.Ptr[int32](1),
	// 		TotalNumberOfUpdatesPendingDownload: to.Ptr[int32](1),
	// 		TotalNumberOfUpdatesPendingInstall: to.Ptr[int32](1),
	// 		TotalUpdateSizeInBytes: to.Ptr[float64](4260898192),
	// 		UpdateTitles: []*string{
	// 			to.Ptr("Azure Stack Edge Update 2101 Package 1 of 2 for Pro-GPU, Pro R, Mini R")},
	// 		},
	// 	}
}

Output:

func (*DevicesClient) NewListByResourceGroupPager added in v0.4.0 

func (client *DevicesClient) NewListByResourceGroupPager(resourceGroupName string, options *DevicesClientListByResourceGroupOptions) *runtime.Pager[DevicesClientListByResourceGroupResponse]

NewListByResourceGroupPager - Gets all the Data Box Edge/Data Box Gateway devices in a resource group.

Generated from API version 2022-03-01

  • resourceGroupName - The resource group name.
  • options - DevicesClientListByResourceGroupOptions contains the optional parameters for the DevicesClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/DataBoxEdgeDeviceGetByResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewDevicesClient().NewListByResourceGroupPager("GroupForEdgeAutomation", &armdataboxedge.DevicesClientListByResourceGroupOptions{Expand: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DeviceList = armdataboxedge.DeviceList{
		// 	Value: []*armdataboxedge.Device{
		// 		{
		// 			Name: to.Ptr("EdgeTestPassResource"),
		// 			Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices"),
		// 			ID: to.Ptr("/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EdgeTestPassResource"),
		// 			Etag: to.Ptr("W/\"datetime'2020-09-29T18%3A50%3A31.1203818Z'\"_W/\"datetime'2020-09-29T18%3A50%3A31.1343914Z'\""),
		// 			Identity: &armdataboxedge.ResourceIdentity{
		// 				Type: to.Ptr(armdataboxedge.MsiIdentityTypeSystemAssigned),
		// 				PrincipalID: to.Ptr("b3e34fcc-ab02-4ca4-9d22-5de115419091"),
		// 				TenantID: to.Ptr("72f988bf-86f1-41af-91ab-2d7cd011db47"),
		// 			},
		// 			Kind: to.Ptr(armdataboxedge.DataBoxEdgeDeviceKindAzureStackEdge),
		// 			Location: to.Ptr("eastus2euap"),
		// 			SKU: &armdataboxedge.SKUInfo{
		// 				Name: to.Ptr(armdataboxedge.SKUNameEdge),
		// 				Tier: to.Ptr(armdataboxedge.SKUTierStandard),
		// 			},
		// 			Tags: map[string]*string{
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("FPGAResource"),
		// 			Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices"),
		// 			ID: to.Ptr("/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/FPGAResource"),
		// 			Etag: to.Ptr("W/\"datetime'2020-11-18T23%3A31%3A30.3266766Z'\"_W/\"datetime'2020-11-18T23%3A31%3A30.3326804Z'\""),
		// 			Identity: &armdataboxedge.ResourceIdentity{
		// 				Type: to.Ptr(armdataboxedge.MsiIdentityTypeSystemAssigned),
		// 				PrincipalID: to.Ptr("d97a6de5-f5c0-485a-8f5e-b7f705d2dbc4"),
		// 				TenantID: to.Ptr("72f988bf-86f1-41af-91ab-2d7cd011db47"),
		// 			},
		// 			Kind: to.Ptr(armdataboxedge.DataBoxEdgeDeviceKindAzureStackEdge),
		// 			Location: to.Ptr("centraluseuap"),
		// 			SKU: &armdataboxedge.SKUInfo{
		// 				Name: to.Ptr(armdataboxedge.SKUNameEdge),
		// 				Tier: to.Ptr(armdataboxedge.SKUTierStandard),
		// 			},
		// 			Tags: map[string]*string{
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("TestVMEdgeResource"),
		// 			Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices"),
		// 			ID: to.Ptr("/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/TestVMEdgeResource"),
		// 			Etag: to.Ptr("W/\"datetime'2020-11-18T23%3A31%3A23.1715672Z'\"_W/\"datetime'2020-11-18T23%3A31%3A23.2396152Z'\""),
		// 			Identity: &armdataboxedge.ResourceIdentity{
		// 				Type: to.Ptr(armdataboxedge.MsiIdentityTypeSystemAssigned),
		// 				PrincipalID: to.Ptr("6f2b341b-aded-4ec2-a1bd-d09438d6cc8f"),
		// 				TenantID: to.Ptr("72f988bf-86f1-41af-91ab-2d7cd011db47"),
		// 			},
		// 			Kind: to.Ptr(armdataboxedge.DataBoxEdgeDeviceKindAzureStackEdge),
		// 			Location: to.Ptr("centraluseuap"),
		// 			SKU: &armdataboxedge.SKUInfo{
		// 				Name: to.Ptr(armdataboxedge.SKUNameEdge),
		// 				Tier: to.Ptr(armdataboxedge.SKUTierStandard),
		// 			},
		// 			Tags: map[string]*string{
		// 			},
		// 	}},
		// }
	}
}

Output:

func (*DevicesClient) NewListBySubscriptionPager added in v0.4.0 

func (client *DevicesClient) NewListBySubscriptionPager(options *DevicesClientListBySubscriptionOptions) *runtime.Pager[DevicesClientListBySubscriptionResponse]

NewListBySubscriptionPager - Gets all the Data Box Edge/Data Box Gateway devices in a subscription.

Generated from API version 2022-03-01

  • options - DevicesClientListBySubscriptionOptions contains the optional parameters for the DevicesClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/DataBoxEdgeDeviceGetBySubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewDevicesClient().NewListBySubscriptionPager(&armdataboxedge.DevicesClientListBySubscriptionOptions{Expand: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DeviceList = armdataboxedge.DeviceList{
		// 	Value: []*armdataboxedge.Device{
		// 		{
		// 			Name: to.Ptr("linksub01"),
		// 			Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices"),
		// 			ID: to.Ptr("/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/abhudeda-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/linksub01"),
		// 			Etag: to.Ptr("W/\"datetime'2020-11-19T01%3A39%3A55.1270082Z'\"_W/\"datetime'2020-11-19T01%3A39%3A55.1320118Z'\""),
		// 			Identity: &armdataboxedge.ResourceIdentity{
		// 				Type: to.Ptr(armdataboxedge.MsiIdentityTypeSystemAssigned),
		// 				PrincipalID: to.Ptr("083df009-06d9-4e3c-ae72-f9249a814334"),
		// 				TenantID: to.Ptr("72f988bf-86f1-41af-91ab-2d7cd011db47"),
		// 			},
		// 			Kind: to.Ptr(armdataboxedge.DataBoxEdgeDeviceKindAzureDataBoxGateway),
		// 			Location: to.Ptr("eastus2euap"),
		// 			SKU: &armdataboxedge.SKUInfo{
		// 				Name: to.Ptr(armdataboxedge.SKUNameGateway),
		// 				Tier: to.Ptr(armdataboxedge.SKUTierStandard),
		// 			},
		// 			Tags: map[string]*string{
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("mergeazstest"),
		// 			Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices"),
		// 			ID: to.Ptr("/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/abhudeda-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/mergeazstest"),
		// 			Etag: to.Ptr("W/\"datetime'2020-11-19T01%3A40%3A05.9246966Z'\"_W/\"datetime'2020-11-19T01%3A40%3A05.9317011Z'\""),
		// 			Identity: &armdataboxedge.ResourceIdentity{
		// 				Type: to.Ptr(armdataboxedge.MsiIdentityTypeSystemAssigned),
		// 				PrincipalID: to.Ptr("8536db30-78d2-4759-95b7-896a66e14c24"),
		// 				TenantID: to.Ptr("72f988bf-86f1-41af-91ab-2d7cd011db47"),
		// 			},
		// 			Kind: to.Ptr(armdataboxedge.DataBoxEdgeDeviceKindAzureDataBoxGateway),
		// 			Location: to.Ptr("eastus2euap"),
		// 			SKU: &armdataboxedge.SKUInfo{
		// 				Name: to.Ptr(armdataboxedge.SKUNameGateway),
		// 				Tier: to.Ptr(armdataboxedge.SKUTierStandard),
		// 			},
		// 			Tags: map[string]*string{
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("mergeazstest2"),
		// 			Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices"),
		// 			ID: to.Ptr("/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/abhudeda-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/mergeazstest2"),
		// 			Etag: to.Ptr("W/\"datetime'2020-11-19T01%3A40%3A06.496102Z'\"_W/\"datetime'2020-11-19T01%3A40%3A06.503107Z'\""),
		// 			Identity: &armdataboxedge.ResourceIdentity{
		// 				Type: to.Ptr(armdataboxedge.MsiIdentityTypeSystemAssigned),
		// 				PrincipalID: to.Ptr("fc4c1205-35c8-4f35-abc7-f5a78945f676"),
		// 				TenantID: to.Ptr("72f988bf-86f1-41af-91ab-2d7cd011db47"),
		// 			},
		// 			Kind: to.Ptr(armdataboxedge.DataBoxEdgeDeviceKindAzureDataBoxGateway),
		// 			Location: to.Ptr("eastus2euap"),
		// 			SKU: &armdataboxedge.SKUInfo{
		// 				Name: to.Ptr(armdataboxedge.SKUNameGateway),
		// 				Tier: to.Ptr(armdataboxedge.SKUTierStandard),
		// 			},
		// 			Tags: map[string]*string{
		// 			},
		// 	}},
		// }
	}
}

Output:

func (*DevicesClient) Update 

func (client *DevicesClient) Update(ctx context.Context, deviceName string, resourceGroupName string, parameters DevicePatch, options *DevicesClientUpdateOptions) (DevicesClientUpdateResponse, error)

Update - Modifies a Data Box Edge/Data Box Gateway resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • parameters - The resource parameters.
  • options - DevicesClientUpdateOptions contains the optional parameters for the DevicesClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/DataBoxEdgeDevicePatch.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDevicesClient().Update(ctx, "testedgedevice", "GroupForEdgeAutomation", armdataboxedge.DevicePatch{
		Properties: &armdataboxedge.DevicePropertiesPatch{
			EdgeProfile: &armdataboxedge.EdgeProfilePatch{
				Subscription: &armdataboxedge.EdgeProfileSubscriptionPatch{
					ID: to.Ptr("/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/rapvs-rg/providers/Microsoft.AzureStack/linkedSubscriptions/ca014ddc-5cf2-45f8-b390-e901e4a0ae87"),
				},
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Device = armdataboxedge.Device{
	// 	Name: to.Ptr("testedgedevice"),
	// 	Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices"),
	// 	ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice"),
	// 	Etag: to.Ptr("W/\"datetime'2020-11-19T04%3A43%3A38.6457308Z'\"_W/\"datetime'2020-11-19T04%3A43%3A38.6507339Z'\""),
	// 	Identity: &armdataboxedge.ResourceIdentity{
	// 		Type: to.Ptr(armdataboxedge.MsiIdentityTypeSystemAssigned),
	// 		PrincipalID: to.Ptr("b3e34fcc-ab02-4ca4-9d22-5de115419091"),
	// 		TenantID: to.Ptr("72f988bf-86f1-41af-91ab-2d7cd011db47"),
	// 	},
	// 	Kind: to.Ptr(armdataboxedge.DataBoxEdgeDeviceKindAzureStackEdge),
	// 	Location: to.Ptr("eastus2euap"),
	// 	Properties: &armdataboxedge.DeviceProperties{
	// 		DataBoxEdgeDeviceStatus: to.Ptr(armdataboxedge.DataBoxEdgeDeviceStatusReadyToSetup),
	// 		DeviceLocalCapacity: to.Ptr[int64](0),
	// 		DeviceType: to.Ptr(armdataboxedge.DeviceTypeDataBoxEdgeDevice),
	// 		EdgeProfile: &armdataboxedge.EdgeProfile{
	// 			Subscription: &armdataboxedge.EdgeProfileSubscription{
	// 				ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/VmMgmtTestPass/providers/Microsoft.AzureStack/edgeSubscriptions/daaac4b0-35c4-4008-bdc6-b72ca5890f16"),
	// 				RegistrationID: to.Ptr("91d8753b-af42-4908-9a5e-2a61f08b20de"),
	// 				State: to.Ptr(armdataboxedge.SubscriptionStateRegistered),
	// 			},
	// 		},
	// 		NodeCount: to.Ptr[int32](0),
	// 		ResourceMoveDetails: &armdataboxedge.ResourceMoveDetails{
	// 			OperationInProgress: to.Ptr(armdataboxedge.ResourceMoveStatusNone),
	// 		},
	// 		TimeZone: to.Ptr("Pacific Standard Time"),
	// 	},
	// 	SKU: &armdataboxedge.SKUInfo{
	// 		Name: to.Ptr(armdataboxedge.SKUNameEdge),
	// 		Tier: to.Ptr(armdataboxedge.SKUTierStandard),
	// 	},
	// 	Tags: map[string]*string{
	// 	},
	// }
}

Output:

func (*DevicesClient) UpdateExtendedInformation 

func (client *DevicesClient) UpdateExtendedInformation(ctx context.Context, deviceName string, resourceGroupName string, parameters DeviceExtendedInfoPatch, options *DevicesClientUpdateExtendedInformationOptions) (DevicesClientUpdateExtendedInformationResponse, error)

UpdateExtendedInformation - Gets additional information for the specified Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • parameters - The patch object.
  • options - DevicesClientUpdateExtendedInformationOptions contains the optional parameters for the DevicesClient.UpdateExtendedInformation method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/GetUpdateExtendedInfo.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDevicesClient().UpdateExtendedInformation(ctx, "testedgedevice", "GroupForEdgeAutomation", armdataboxedge.DeviceExtendedInfoPatch{}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DeviceExtendedInfo = armdataboxedge.DeviceExtendedInfo{
	// 	Properties: &armdataboxedge.DeviceExtendedInfoProperties{
	// 		ChannelIntegrityKeyName: to.Ptr("ase-cik-ab861822-21ea-4d31-96ec-89aa066f9a59"),
	// 		ChannelIntegrityKeyVersion: to.Ptr("95e9b619e65f433d82c9e1ead48214b9"),
	// 		ClientSecretStoreID: to.Ptr("/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/arja-rg/providers/Microsoft.KeyVault/vaults/test-keyvault-ccy-523"),
	// 		ClientSecretStoreURL: to.Ptr("https://test-keyvault-ccy-523.vault.azure.net"),
	// 		DeviceSecrets: map[string]*armdataboxedge.Secret{
	// 			"BMCDefaultUserPassword": &armdataboxedge.Secret{
	// 			},
	// 			"HcsDataVolumeBitLockerExternalKey": &armdataboxedge.Secret{
	// 				KeyVaultID: to.Ptr("Id"),
	// 			},
	// 			"HcsInternalVolumeBitLockerExternalKey": &armdataboxedge.Secret{
	// 				KeyVaultID: to.Ptr("Id"),
	// 			},
	// 			"RotateKeyForDataVolumeBitlocker": &armdataboxedge.Secret{
	// 			},
	// 			"RotateKeysForSedDrivesSerialized": &armdataboxedge.Secret{
	// 			},
	// 			"SEDEncryptionExternalKey": &armdataboxedge.Secret{
	// 			},
	// 			"SEDEncryptionExternalKeyId": &armdataboxedge.Secret{
	// 			},
	// 			"SystemVolumeBitLockerRecoveryKey": &armdataboxedge.Secret{
	// 				KeyVaultID: to.Ptr("Id"),
	// 			},
	// 		},
	// 		KeyVaultSyncStatus: to.Ptr(armdataboxedge.KeyVaultSyncStatusKeyVaultSynced),
	// 	},
	// }
}

Output:

func (*DevicesClient) UploadCertificate 

func (client *DevicesClient) UploadCertificate(ctx context.Context, deviceName string, resourceGroupName string, parameters UploadCertificateRequest, options *DevicesClientUploadCertificateOptions) (DevicesClientUploadCertificateResponse, error)

UploadCertificate - Uploads registration certificate for the device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • parameters - The upload certificate request.
  • options - DevicesClientUploadCertificateOptions contains the optional parameters for the DevicesClient.UploadCertificate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/UploadCertificatePost.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDevicesClient().UploadCertificate(ctx, "testedgedevice", "GroupForEdgeAutomation", armdataboxedge.UploadCertificateRequest{
		Properties: &armdataboxedge.RawCertificateData{
			Certificate: to.Ptr("MIIC9DCCAdygAwIBAgIQWJae7GNjiI9Mcv/gJyrOPTANBgkqhkiG9w0BAQUFADASMRAwDgYDVQQDDAdXaW5kb3dzMB4XDTE4MTEyNzAwMTA0NVoXDTIxMTEyODAwMTA0NVowEjEQMA4GA1UEAwwHV2luZG93czCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKxkRExqxf0qH1avnyORptIbRC2yQwqe3EIbJ2FPKr5jtAppGeX/dGKrFSnX+7/0HFr77aJHafdpEAtOiLyJ4zCAVs0obZCCIq4qJdmjYUTU0UXH/w/YzXfQA0d9Zh9AN+NJBX9xj05NzgsT24fkgsK2v6mWJQXT7YcWAsl5sEYPnx1e+MrupNyVSL/RUJmrS+etJSysHtFeWRhsUhVAs1DD5ExJvBLU3WH0IsojEvpXcjrutB5/MDQNrd/StGI6WovoSSPH7FyT9tgERx+q+Yg3YUGzfaIPCctlrRGehcdtzdNoKd0rsX62yCq0U6POoSfwe22NJu41oAUMd7e6R8cCAwEAAaNGMEQwEwYDVR0lBAwwCgYIKwYBBQUHAwIwHQYDVR0OBBYEFDd0VxnS3LnMIfwc7xW4b4IZWG5GMA4GA1UdDwEB/wQEAwIFIDANBgkqhkiG9w0BAQUFAAOCAQEAPQRby2u9celvtvL/DLEb5Vt3/tPStRQC5MyTD62L5RT/q8E6EMCXVZNkXF5WlWucLJi/18tY+9PNgP9xWLJh7kpSWlWdi9KPtwMqKDlEH8L2TnQdjimt9XuiCrTnoFy/1X2BGLY/rCaUJNSd15QCkz2xeW+Z+YSk2GwAc/A/4YfNpqSIMfNuPrT76o02VdD9WmJUA3fS/HY0sU9qgQRS/3F5/0EPS+HYQ0SvXCK9tggcCd4O050ytNBMJC9qMOJ7yE0iOrFfOJSCfDAuPhn/rHFh79Kn1moF+/CE+nc0/2RPiLC8r54/rt5dYyyxJDfXg0a3VrrX39W69WZGW5OXiw=="),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.UploadCertificateResponse = armdataboxedge.UploadCertificateResponse{
	// 	AADAuthority: to.Ptr("https://login.windows.net"),
	// 	AADTenantID: to.Ptr("100b019d-4626-4a9e-a83c-9cff8fe41909"),
	// 	AuthType: to.Ptr(armdataboxedge.AuthenticationTypeAzureActiveDirectory),
	// 	AzureManagementEndpointAudience: to.Ptr("https://wus-bvtgateway.ext.trafficmanager.net/"),
	// 	ResourceID: to.Ptr("392799901267771"),
	// 	ServicePrincipalClientID: to.Ptr("ffd8a688-82b1-4e5a-a4c1-7ede8c928e68"),
	// 	ServicePrincipalObjectID: to.Ptr("cef6d40c-24e6-4a6f-bb9e-3ec60b4adec4"),
	// }
}

Output:

type DevicesClientBeginCreateOrUpdateSecuritySettingsOptions added in v0.2.0 

type DevicesClientBeginCreateOrUpdateSecuritySettingsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DevicesClientBeginCreateOrUpdateSecuritySettingsOptions contains the optional parameters for the DevicesClient.BeginCreateOrUpdateSecuritySettings method.

type DevicesClientBeginDeleteOptions added in v0.2.0 

type DevicesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DevicesClientBeginDeleteOptions contains the optional parameters for the DevicesClient.BeginDelete method.

type DevicesClientBeginDownloadUpdatesOptions added in v0.2.0 

type DevicesClientBeginDownloadUpdatesOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DevicesClientBeginDownloadUpdatesOptions contains the optional parameters for the DevicesClient.BeginDownloadUpdates method.

type DevicesClientBeginInstallUpdatesOptions added in v0.2.0 

type DevicesClientBeginInstallUpdatesOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DevicesClientBeginInstallUpdatesOptions contains the optional parameters for the DevicesClient.BeginInstallUpdates method.

type DevicesClientBeginScanForUpdatesOptions added in v0.2.0 

type DevicesClientBeginScanForUpdatesOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DevicesClientBeginScanForUpdatesOptions contains the optional parameters for the DevicesClient.BeginScanForUpdates method.

type DevicesClientCreateOrUpdateOptions added in v0.2.0 

type DevicesClientCreateOrUpdateOptions struct {
}

DevicesClientCreateOrUpdateOptions contains the optional parameters for the DevicesClient.CreateOrUpdate method.

type DevicesClientCreateOrUpdateResponse added in v0.2.0 

type DevicesClientCreateOrUpdateResponse struct {
	// The Data Box Edge/Gateway device.
	Device
}

DevicesClientCreateOrUpdateResponse contains the response from method DevicesClient.CreateOrUpdate.

type DevicesClientCreateOrUpdateSecuritySettingsResponse added in v0.2.0 

type DevicesClientCreateOrUpdateSecuritySettingsResponse struct {
}

DevicesClientCreateOrUpdateSecuritySettingsResponse contains the response from method DevicesClient.BeginCreateOrUpdateSecuritySettings.

type DevicesClientDeleteResponse added in v0.2.0 

type DevicesClientDeleteResponse struct {
}

DevicesClientDeleteResponse contains the response from method DevicesClient.BeginDelete.

type DevicesClientDownloadUpdatesResponse added in v0.2.0 

type DevicesClientDownloadUpdatesResponse struct {
}

DevicesClientDownloadUpdatesResponse contains the response from method DevicesClient.BeginDownloadUpdates.

type DevicesClientGenerateCertificateOptions added in v0.2.0 

type DevicesClientGenerateCertificateOptions struct {
}

DevicesClientGenerateCertificateOptions contains the optional parameters for the DevicesClient.GenerateCertificate method.

type DevicesClientGenerateCertificateResponse added in v0.2.0 

type DevicesClientGenerateCertificateResponse struct {
	// Used in activation key generation flow.
	GenerateCertResponse
}

DevicesClientGenerateCertificateResponse contains the response from method DevicesClient.GenerateCertificate.

type DevicesClientGetExtendedInformationOptions added in v0.2.0 

type DevicesClientGetExtendedInformationOptions struct {
}

DevicesClientGetExtendedInformationOptions contains the optional parameters for the DevicesClient.GetExtendedInformation method.

type DevicesClientGetExtendedInformationResponse added in v0.2.0 

type DevicesClientGetExtendedInformationResponse struct {
	// The extended Info of the Data Box Edge/Gateway device.
	DeviceExtendedInfo
}

DevicesClientGetExtendedInformationResponse contains the response from method DevicesClient.GetExtendedInformation.

type DevicesClientGetNetworkSettingsOptions added in v0.2.0 

type DevicesClientGetNetworkSettingsOptions struct {
}

DevicesClientGetNetworkSettingsOptions contains the optional parameters for the DevicesClient.GetNetworkSettings method.

type DevicesClientGetNetworkSettingsResponse added in v0.2.0 

type DevicesClientGetNetworkSettingsResponse struct {
	// The network settings of a device.
	NetworkSettings
}

DevicesClientGetNetworkSettingsResponse contains the response from method DevicesClient.GetNetworkSettings.

type DevicesClientGetOptions added in v0.2.0 

type DevicesClientGetOptions struct {
}

DevicesClientGetOptions contains the optional parameters for the DevicesClient.Get method.

type DevicesClientGetResponse added in v0.2.0 

type DevicesClientGetResponse struct {
	// The Data Box Edge/Gateway device.
	Device
}

DevicesClientGetResponse contains the response from method DevicesClient.Get.

type DevicesClientGetUpdateSummaryOptions added in v0.2.0 

type DevicesClientGetUpdateSummaryOptions struct {
}

DevicesClientGetUpdateSummaryOptions contains the optional parameters for the DevicesClient.GetUpdateSummary method.

type DevicesClientGetUpdateSummaryResponse added in v0.2.0 

type DevicesClientGetUpdateSummaryResponse struct {
	// Details about ongoing updates and availability of updates on the device.
	UpdateSummary
}

DevicesClientGetUpdateSummaryResponse contains the response from method DevicesClient.GetUpdateSummary.

type DevicesClientInstallUpdatesResponse added in v0.2.0 

type DevicesClientInstallUpdatesResponse struct {
}

DevicesClientInstallUpdatesResponse contains the response from method DevicesClient.BeginInstallUpdates.

type DevicesClientListByResourceGroupOptions added in v0.2.0 

type DevicesClientListByResourceGroupOptions struct {
	// Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next
	// page in the list.
	Expand *string
}

DevicesClientListByResourceGroupOptions contains the optional parameters for the DevicesClient.NewListByResourceGroupPager method.

type DevicesClientListByResourceGroupResponse added in v0.2.0 

type DevicesClientListByResourceGroupResponse struct {
	// The collection of Data Box Edge/Gateway devices.
	DeviceList
}

DevicesClientListByResourceGroupResponse contains the response from method DevicesClient.NewListByResourceGroupPager.

type DevicesClientListBySubscriptionOptions added in v0.2.0 

type DevicesClientListBySubscriptionOptions struct {
	// Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next
	// page in the list.
	Expand *string
}

DevicesClientListBySubscriptionOptions contains the optional parameters for the DevicesClient.NewListBySubscriptionPager method.

type DevicesClientListBySubscriptionResponse added in v0.2.0 

type DevicesClientListBySubscriptionResponse struct {
	// The collection of Data Box Edge/Gateway devices.
	DeviceList
}

DevicesClientListBySubscriptionResponse contains the response from method DevicesClient.NewListBySubscriptionPager.

type DevicesClientScanForUpdatesResponse added in v0.2.0 

type DevicesClientScanForUpdatesResponse struct {
}

DevicesClientScanForUpdatesResponse contains the response from method DevicesClient.BeginScanForUpdates.

type DevicesClientUpdateExtendedInformationOptions added in v0.2.0 

type DevicesClientUpdateExtendedInformationOptions struct {
}

DevicesClientUpdateExtendedInformationOptions contains the optional parameters for the DevicesClient.UpdateExtendedInformation method.

type DevicesClientUpdateExtendedInformationResponse added in v0.2.0 

type DevicesClientUpdateExtendedInformationResponse struct {
	// The extended Info of the Data Box Edge/Gateway device.
	DeviceExtendedInfo
}

DevicesClientUpdateExtendedInformationResponse contains the response from method DevicesClient.UpdateExtendedInformation.

type DevicesClientUpdateOptions added in v0.2.0 

type DevicesClientUpdateOptions struct {
}

DevicesClientUpdateOptions contains the optional parameters for the DevicesClient.Update method.

type DevicesClientUpdateResponse added in v0.2.0 

type DevicesClientUpdateResponse struct {
	// The Data Box Edge/Gateway device.
	Device
}

DevicesClientUpdateResponse contains the response from method DevicesClient.Update.

type DevicesClientUploadCertificateOptions added in v0.2.0 

type DevicesClientUploadCertificateOptions struct {
}

DevicesClientUploadCertificateOptions contains the optional parameters for the DevicesClient.UploadCertificate method.

type DevicesClientUploadCertificateResponse added in v0.2.0 

type DevicesClientUploadCertificateResponse struct {
	// The upload registration certificate response.
	UploadCertificateResponse
}

DevicesClientUploadCertificateResponse contains the response from method DevicesClient.UploadCertificate.

type DiagnosticProactiveLogCollectionSettings 

type DiagnosticProactiveLogCollectionSettings struct {
	// REQUIRED; Properties of the diagnostic proactive log collection settings.
	Properties *ProactiveLogCollectionSettingsProperties

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of DiagnosticProactiveLogCollectionSettings
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

DiagnosticProactiveLogCollectionSettings - The diagnostic proactive log collection settings of a device.

func (DiagnosticProactiveLogCollectionSettings) MarshalJSON 

func (d DiagnosticProactiveLogCollectionSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DiagnosticProactiveLogCollectionSettings.

func (*DiagnosticProactiveLogCollectionSettings) UnmarshalJSON 

func (d *DiagnosticProactiveLogCollectionSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DiagnosticProactiveLogCollectionSettings.

type DiagnosticRemoteSupportSettings 

type DiagnosticRemoteSupportSettings struct {
	// REQUIRED; Properties of the remote support settings.
	Properties *DiagnosticRemoteSupportSettingsProperties

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Represents resource creation and updation time
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

DiagnosticRemoteSupportSettings - The remote support settings of a device.

func (DiagnosticRemoteSupportSettings) MarshalJSON 

func (d DiagnosticRemoteSupportSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DiagnosticRemoteSupportSettings.

func (*DiagnosticRemoteSupportSettings) UnmarshalJSON 

func (d *DiagnosticRemoteSupportSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DiagnosticRemoteSupportSettings.

type DiagnosticRemoteSupportSettingsProperties 

type DiagnosticRemoteSupportSettingsProperties struct {
	// Remote support settings list according to the RemoteApplicationType
	RemoteSupportSettingsList []*RemoteSupportSettings
}

DiagnosticRemoteSupportSettingsProperties - The properties of remote support settings.

func (DiagnosticRemoteSupportSettingsProperties) MarshalJSON 

func (d DiagnosticRemoteSupportSettingsProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DiagnosticRemoteSupportSettingsProperties.

func (*DiagnosticRemoteSupportSettingsProperties) UnmarshalJSON added in v1.1.0 

func (d *DiagnosticRemoteSupportSettingsProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DiagnosticRemoteSupportSettingsProperties.

type DiagnosticSettingsClient 

type DiagnosticSettingsClient struct {
	// contains filtered or unexported fields
}

DiagnosticSettingsClient contains the methods for the DiagnosticSettings group. Don't use this type directly, use NewDiagnosticSettingsClient() instead.

func NewDiagnosticSettingsClient 

func NewDiagnosticSettingsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DiagnosticSettingsClient, error)

NewDiagnosticSettingsClient creates a new instance of DiagnosticSettingsClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*DiagnosticSettingsClient) BeginUpdateDiagnosticProactiveLogCollectionSettings 

func (client *DiagnosticSettingsClient) BeginUpdateDiagnosticProactiveLogCollectionSettings(ctx context.Context, deviceName string, resourceGroupName string, proactiveLogCollectionSettings DiagnosticProactiveLogCollectionSettings, options *DiagnosticSettingsClientBeginUpdateDiagnosticProactiveLogCollectionSettingsOptions) (*runtime.Poller[DiagnosticSettingsClientUpdateDiagnosticProactiveLogCollectionSettingsResponse], error)

BeginUpdateDiagnosticProactiveLogCollectionSettings - Updates the proactive log collection settings on a Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • proactiveLogCollectionSettings - The proactive log collection settings.
  • options - DiagnosticSettingsClientBeginUpdateDiagnosticProactiveLogCollectionSettingsOptions contains the optional parameters for the DiagnosticSettingsClient.BeginUpdateDiagnosticProactiveLogCollectionSettings method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/UpdateDiagnosticProactiveLogCollectionSettings.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDiagnosticSettingsClient().BeginUpdateDiagnosticProactiveLogCollectionSettings(ctx, "testedgedevice", "GroupForEdgeAutomation", armdataboxedge.DiagnosticProactiveLogCollectionSettings{
		Properties: &armdataboxedge.ProactiveLogCollectionSettingsProperties{
			UserConsent: to.Ptr(armdataboxedge.ProactiveDiagnosticsConsentEnabled),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DiagnosticProactiveLogCollectionSettings = armdataboxedge.DiagnosticProactiveLogCollectionSettings{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticSettings"),
	// 	ID: to.Ptr("/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/dbe-autobot-5428209/diagnosticProactiveLogCollectionSettings/default"),
	// 	Properties: &armdataboxedge.ProactiveLogCollectionSettingsProperties{
	// 		UserConsent: to.Ptr(armdataboxedge.ProactiveDiagnosticsConsentDisabled),
	// 	},
	// }
}

Output:

func (*DiagnosticSettingsClient) BeginUpdateDiagnosticRemoteSupportSettings 

func (client *DiagnosticSettingsClient) BeginUpdateDiagnosticRemoteSupportSettings(ctx context.Context, deviceName string, resourceGroupName string, diagnosticRemoteSupportSettings DiagnosticRemoteSupportSettings, options *DiagnosticSettingsClientBeginUpdateDiagnosticRemoteSupportSettingsOptions) (*runtime.Poller[DiagnosticSettingsClientUpdateDiagnosticRemoteSupportSettingsResponse], error)

BeginUpdateDiagnosticRemoteSupportSettings - Updates the diagnostic remote support settings on a Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • diagnosticRemoteSupportSettings - The diagnostic remote support settings.
  • options - DiagnosticSettingsClientBeginUpdateDiagnosticRemoteSupportSettingsOptions contains the optional parameters for the DiagnosticSettingsClient.BeginUpdateDiagnosticRemoteSupportSettings method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/UpdateDiagnosticRemoteSupportSettings.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDiagnosticSettingsClient().BeginUpdateDiagnosticRemoteSupportSettings(ctx, "testedgedevice", "GroupForEdgeAutomation", armdataboxedge.DiagnosticRemoteSupportSettings{
		Properties: &armdataboxedge.DiagnosticRemoteSupportSettingsProperties{
			RemoteSupportSettingsList: []*armdataboxedge.RemoteSupportSettings{
				{
					AccessLevel:              to.Ptr(armdataboxedge.AccessLevelReadWrite),
					ExpirationTimeStampInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-07-07T00:00:00.000Z"); return t }()),
					RemoteApplicationType:    to.Ptr(armdataboxedge.RemoteApplicationTypePowershell),
				}},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DiagnosticRemoteSupportSettings = armdataboxedge.DiagnosticRemoteSupportSettings{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticSettings"),
	// 	ID: to.Ptr("/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/dbe-autobot-154c8a4/diagnosticRemoteSupportSettings/default"),
	// 	Properties: &armdataboxedge.DiagnosticRemoteSupportSettingsProperties{
	// 		RemoteSupportSettingsList: []*armdataboxedge.RemoteSupportSettings{
	// 			{
	// 				AccessLevel: to.Ptr(armdataboxedge.AccessLevelReadWrite),
	// 				ExpirationTimeStampInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2500-09-14T00:00:00.000Z"); return t}()),
	// 				RemoteApplicationType: to.Ptr(armdataboxedge.RemoteApplicationTypePowershell),
	// 		}},
	// 	},
	// }
}

Output:

func (*DiagnosticSettingsClient) GetDiagnosticProactiveLogCollectionSettings 

func (client *DiagnosticSettingsClient) GetDiagnosticProactiveLogCollectionSettings(ctx context.Context, deviceName string, resourceGroupName string, options *DiagnosticSettingsClientGetDiagnosticProactiveLogCollectionSettingsOptions) (DiagnosticSettingsClientGetDiagnosticProactiveLogCollectionSettingsResponse, error)

GetDiagnosticProactiveLogCollectionSettings - Gets the proactive log collection settings of the specified Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - DiagnosticSettingsClientGetDiagnosticProactiveLogCollectionSettingsOptions contains the optional parameters for the DiagnosticSettingsClient.GetDiagnosticProactiveLogCollectionSettings method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/GetDiagnosticProactiveLogCollectionSettings.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDiagnosticSettingsClient().GetDiagnosticProactiveLogCollectionSettings(ctx, "testedgedevice", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DiagnosticProactiveLogCollectionSettings = armdataboxedge.DiagnosticProactiveLogCollectionSettings{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("dataBoxEdgeDevices/diagnosticSettings"),
	// 	ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/diagnosticProactiveLogCollectionSettings/default"),
	// 	Properties: &armdataboxedge.ProactiveLogCollectionSettingsProperties{
	// 		UserConsent: to.Ptr(armdataboxedge.ProactiveDiagnosticsConsentEnabled),
	// 	},
	// }
}

Output:

func (*DiagnosticSettingsClient) GetDiagnosticRemoteSupportSettings 

func (client *DiagnosticSettingsClient) GetDiagnosticRemoteSupportSettings(ctx context.Context, deviceName string, resourceGroupName string, options *DiagnosticSettingsClientGetDiagnosticRemoteSupportSettingsOptions) (DiagnosticSettingsClientGetDiagnosticRemoteSupportSettingsResponse, error)

GetDiagnosticRemoteSupportSettings - Gets the diagnostic remote support settings of the specified Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - DiagnosticSettingsClientGetDiagnosticRemoteSupportSettingsOptions contains the optional parameters for the DiagnosticSettingsClient.GetDiagnosticRemoteSupportSettings method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/GetDiagnosticRemoteSupportSettings.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDiagnosticSettingsClient().GetDiagnosticRemoteSupportSettings(ctx, "testedgedevice", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DiagnosticRemoteSupportSettings = armdataboxedge.DiagnosticRemoteSupportSettings{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("dataBoxEdgeDevices/diagnosticSettings"),
	// 	ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/diagnosticRemoteSupportSettings/default"),
	// 	Properties: &armdataboxedge.DiagnosticRemoteSupportSettingsProperties{
	// 		RemoteSupportSettingsList: []*armdataboxedge.RemoteSupportSettings{
	// 			{
	// 				AccessLevel: to.Ptr(armdataboxedge.AccessLevelReadWrite),
	// 				ExpirationTimeStampInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-07-07T00:00:00.000Z"); return t}()),
	// 				RemoteApplicationType: to.Ptr(armdataboxedge.RemoteApplicationTypeLocalUI),
	// 		}},
	// 	},
	// }
}

Output:

type DiagnosticSettingsClientBeginUpdateDiagnosticProactiveLogCollectionSettingsOptions added in v0.2.0 

type DiagnosticSettingsClientBeginUpdateDiagnosticProactiveLogCollectionSettingsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DiagnosticSettingsClientBeginUpdateDiagnosticProactiveLogCollectionSettingsOptions contains the optional parameters for the DiagnosticSettingsClient.BeginUpdateDiagnosticProactiveLogCollectionSettings method.

type DiagnosticSettingsClientBeginUpdateDiagnosticRemoteSupportSettingsOptions added in v0.2.0 

type DiagnosticSettingsClientBeginUpdateDiagnosticRemoteSupportSettingsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DiagnosticSettingsClientBeginUpdateDiagnosticRemoteSupportSettingsOptions contains the optional parameters for the DiagnosticSettingsClient.BeginUpdateDiagnosticRemoteSupportSettings method.

type DiagnosticSettingsClientGetDiagnosticProactiveLogCollectionSettingsOptions added in v0.2.0 

type DiagnosticSettingsClientGetDiagnosticProactiveLogCollectionSettingsOptions struct {
}

DiagnosticSettingsClientGetDiagnosticProactiveLogCollectionSettingsOptions contains the optional parameters for the DiagnosticSettingsClient.GetDiagnosticProactiveLogCollectionSettings method.

type DiagnosticSettingsClientGetDiagnosticProactiveLogCollectionSettingsResponse added in v0.2.0 

type DiagnosticSettingsClientGetDiagnosticProactiveLogCollectionSettingsResponse struct {
	// The diagnostic proactive log collection settings of a device.
	DiagnosticProactiveLogCollectionSettings
}

DiagnosticSettingsClientGetDiagnosticProactiveLogCollectionSettingsResponse contains the response from method DiagnosticSettingsClient.GetDiagnosticProactiveLogCollectionSettings.

type DiagnosticSettingsClientGetDiagnosticRemoteSupportSettingsOptions added in v0.2.0 

type DiagnosticSettingsClientGetDiagnosticRemoteSupportSettingsOptions struct {
}

DiagnosticSettingsClientGetDiagnosticRemoteSupportSettingsOptions contains the optional parameters for the DiagnosticSettingsClient.GetDiagnosticRemoteSupportSettings method.

type DiagnosticSettingsClientGetDiagnosticRemoteSupportSettingsResponse added in v0.2.0 

type DiagnosticSettingsClientGetDiagnosticRemoteSupportSettingsResponse struct {
	// The remote support settings of a device.
	DiagnosticRemoteSupportSettings
}

DiagnosticSettingsClientGetDiagnosticRemoteSupportSettingsResponse contains the response from method DiagnosticSettingsClient.GetDiagnosticRemoteSupportSettings.

type DiagnosticSettingsClientUpdateDiagnosticProactiveLogCollectionSettingsResponse added in v0.2.0 

type DiagnosticSettingsClientUpdateDiagnosticProactiveLogCollectionSettingsResponse struct {
	// The diagnostic proactive log collection settings of a device.
	DiagnosticProactiveLogCollectionSettings
}

DiagnosticSettingsClientUpdateDiagnosticProactiveLogCollectionSettingsResponse contains the response from method DiagnosticSettingsClient.BeginUpdateDiagnosticProactiveLogCollectionSettings.

type DiagnosticSettingsClientUpdateDiagnosticRemoteSupportSettingsResponse added in v0.2.0 

type DiagnosticSettingsClientUpdateDiagnosticRemoteSupportSettingsResponse struct {
	// The remote support settings of a device.
	DiagnosticRemoteSupportSettings
}

DiagnosticSettingsClientUpdateDiagnosticRemoteSupportSettingsResponse contains the response from method DiagnosticSettingsClient.BeginUpdateDiagnosticRemoteSupportSettings.

type DownloadPhase 

type DownloadPhase string

DownloadPhase - The download phase. 

const (
	DownloadPhaseDownloading  DownloadPhase = "Downloading"
	DownloadPhaseInitializing DownloadPhase = "Initializing"
	DownloadPhaseUnknown      DownloadPhase = "Unknown"
	DownloadPhaseVerifying    DownloadPhase = "Verifying"
)

func PossibleDownloadPhaseValues 

func PossibleDownloadPhaseValues() []DownloadPhase

PossibleDownloadPhaseValues returns the possible values for the DownloadPhase const type.

type EdgeProfile 

type EdgeProfile struct {
	// Edge Profile Subscription
	Subscription *EdgeProfileSubscription
}

EdgeProfile - Details about Edge Profile for the resource

func (EdgeProfile) MarshalJSON added in v1.1.0 

func (e EdgeProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EdgeProfile.

func (*EdgeProfile) UnmarshalJSON added in v1.1.0 

func (e *EdgeProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EdgeProfile.

type EdgeProfilePatch 

type EdgeProfilePatch struct {
	// The Data Box Edge/Gateway Edge Profile Subscription patch
	Subscription *EdgeProfileSubscriptionPatch
}

EdgeProfilePatch - The Data Box Edge/Gateway Edge Profile patch.

func (EdgeProfilePatch) MarshalJSON added in v1.1.0 

func (e EdgeProfilePatch) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EdgeProfilePatch.

func (*EdgeProfilePatch) UnmarshalJSON added in v1.1.0 

func (e *EdgeProfilePatch) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EdgeProfilePatch.

type EdgeProfileSubscription 

type EdgeProfileSubscription struct {
	// ARM ID of the subscription
	ID               *string
	Properties       *SubscriptionProperties
	RegistrationDate *string

	// Edge Subscription Registration ID
	RegistrationID *string
	State          *SubscriptionState
	SubscriptionID *string
}

EdgeProfileSubscription - Subscription details for the Edge Profile

func (EdgeProfileSubscription) MarshalJSON added in v1.1.0 

func (e EdgeProfileSubscription) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EdgeProfileSubscription.

func (*EdgeProfileSubscription) UnmarshalJSON added in v1.1.0 

func (e *EdgeProfileSubscription) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EdgeProfileSubscription.

type EdgeProfileSubscriptionPatch 

type EdgeProfileSubscriptionPatch struct {
	// The path ID that uniquely identifies the subscription of the edge profile.
	ID *string
}

EdgeProfileSubscriptionPatch - The Data Box Edge/Gateway Edge Profile Subscription patch.

func (EdgeProfileSubscriptionPatch) MarshalJSON added in v1.1.0 

func (e EdgeProfileSubscriptionPatch) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EdgeProfileSubscriptionPatch.

func (*EdgeProfileSubscriptionPatch) UnmarshalJSON added in v1.1.0 

func (e *EdgeProfileSubscriptionPatch) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EdgeProfileSubscriptionPatch.

type EncryptionAlgorithm 

type EncryptionAlgorithm string

EncryptionAlgorithm - The algorithm used to encrypt "Value". 

const (
	EncryptionAlgorithmAES256        EncryptionAlgorithm = "AES256"
	EncryptionAlgorithmNone          EncryptionAlgorithm = "None"
	EncryptionAlgorithmRSAESPKCS1V15 EncryptionAlgorithm = "RSAES_PKCS1_v_1_5"
)

func PossibleEncryptionAlgorithmValues 

func PossibleEncryptionAlgorithmValues() []EncryptionAlgorithm

PossibleEncryptionAlgorithmValues returns the possible values for the EncryptionAlgorithm const type.

type EtcdInfo 

type EtcdInfo struct {
	// READ-ONLY; Etcd type
	Type *string

	// READ-ONLY; Etcd version
	Version *string
}

EtcdInfo - Etcd configuration

func (EtcdInfo) MarshalJSON added in v1.1.0 

func (e EtcdInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EtcdInfo.

func (*EtcdInfo) UnmarshalJSON added in v1.1.0 

func (e *EtcdInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EtcdInfo.

type FileEventTrigger 

type FileEventTrigger struct {
	// REQUIRED; Trigger Kind.
	Kind *TriggerEventType

	// REQUIRED; File trigger properties.
	Properties *FileTriggerProperties

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of Trigger
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

FileEventTrigger - Trigger details.

func (*FileEventTrigger) GetTrigger added in v0.2.0 

func (f *FileEventTrigger) GetTrigger() *Trigger

GetTrigger implements the TriggerClassification interface for type FileEventTrigger.

func (FileEventTrigger) MarshalJSON 

func (f FileEventTrigger) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FileEventTrigger.

func (*FileEventTrigger) UnmarshalJSON 

func (f *FileEventTrigger) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FileEventTrigger.

type FileSourceInfo 

type FileSourceInfo struct {
	// REQUIRED; File share ID.
	ShareID *string
}

FileSourceInfo - File source details.

func (FileSourceInfo) MarshalJSON added in v1.1.0 

func (f FileSourceInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FileSourceInfo.

func (*FileSourceInfo) UnmarshalJSON added in v1.1.0 

func (f *FileSourceInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FileSourceInfo.

type FileTriggerProperties 

type FileTriggerProperties struct {
	// REQUIRED; Role sink info.
	SinkInfo *RoleSinkInfo

	// REQUIRED; File event source details.
	SourceInfo *FileSourceInfo

	// A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger
	// is intended for certain specific IoT modules in the device, the tag can be the
	// name or the image URL of the module.
	CustomContextTag *string
}

FileTriggerProperties - File trigger properties.

func (FileTriggerProperties) MarshalJSON added in v1.1.0 

func (f FileTriggerProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FileTriggerProperties.

func (*FileTriggerProperties) UnmarshalJSON added in v1.1.0 

func (f *FileTriggerProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FileTriggerProperties.

type GenerateCertResponse 

type GenerateCertResponse struct {
	// Gets or sets expiry time in UTC
	ExpiryTimeInUTC *string

	// Gets or sets base64 encoded private part of the certificate, needed to form the activation key
	PrivateKey *string

	// Gets or sets base64 encoded certificate raw data, this is the public part needed to be uploaded to cert vault
	PublicKey *string
}

GenerateCertResponse - Used in activation key generation flow.

func (GenerateCertResponse) MarshalJSON added in v1.1.0 

func (g GenerateCertResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GenerateCertResponse.

func (*GenerateCertResponse) UnmarshalJSON added in v1.1.0 

func (g *GenerateCertResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GenerateCertResponse.

type HostCapacity added in v0.3.0 

type HostCapacity struct {
	// The available amount of GPUs on the host to use after accounting for GPUS used by reservations on the host.
	AvailableGpuCount *int32

	// The available memory on the host accounting for VM placement size and any host VM reservations.
	EffectiveAvailableMemoryMbOnHost *int64

	// The GPU type of the VM.
	GpuType *string

	// The name of the host.
	HostName *string

	// The numa nodes information for Hpn VMs.
	NumaNodesData []*NumaNodeData

	// The VM used memory per VmId.
	VMUsedMemory map[string]*VMMemory
}

HostCapacity - Host Capacity Data.

func (HostCapacity) MarshalJSON added in v0.3.0 

func (h HostCapacity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HostCapacity.

func (*HostCapacity) UnmarshalJSON added in v1.1.0 

func (h *HostCapacity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HostCapacity.

type HostPlatformType 

type HostPlatformType string

HostPlatformType - Platform where the runtime is hosted. 

const (
	HostPlatformTypeKubernetesCluster HostPlatformType = "KubernetesCluster"
	HostPlatformTypeLinuxVM           HostPlatformType = "LinuxVM"
)

func PossibleHostPlatformTypeValues 

func PossibleHostPlatformTypeValues() []HostPlatformType

PossibleHostPlatformTypeValues returns the possible values for the HostPlatformType const type.

type IPv4Config 

type IPv4Config struct {
	// READ-ONLY; The IPv4 gateway of the network adapter.
	Gateway *string

	// READ-ONLY; The IPv4 address of the network adapter.
	IPAddress *string

	// READ-ONLY; The IPv4 subnet of the network adapter.
	Subnet *string
}

IPv4Config - Details related to the IPv4 address configuration.

func (IPv4Config) MarshalJSON added in v1.1.0 

func (i IPv4Config) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPv4Config.

func (*IPv4Config) UnmarshalJSON added in v1.1.0 

func (i *IPv4Config) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IPv4Config.

type IPv6Config 

type IPv6Config struct {
	// READ-ONLY; The IPv6 gateway of the network adapter.
	Gateway *string

	// READ-ONLY; The IPv6 address of the network adapter.
	IPAddress *string

	// READ-ONLY; The IPv6 prefix of the network adapter.
	PrefixLength *int32
}

IPv6Config - Details related to the IPv6 address configuration.

func (IPv6Config) MarshalJSON added in v1.1.0 

func (i IPv6Config) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPv6Config.

func (*IPv6Config) UnmarshalJSON added in v1.1.0 

func (i *IPv6Config) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IPv6Config.

type ImageRepositoryCredential 

type ImageRepositoryCredential struct {
	// REQUIRED; Image repository url (e.g.: mcr.microsoft.com).
	ImageRepositoryURL *string

	// REQUIRED; Repository user name.
	UserName *string

	// Repository user password.
	Password *AsymmetricEncryptedSecret
}

ImageRepositoryCredential - Image repository credential.

func (ImageRepositoryCredential) MarshalJSON added in v1.1.0 

func (i ImageRepositoryCredential) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ImageRepositoryCredential.

func (*ImageRepositoryCredential) UnmarshalJSON added in v1.1.0 

func (i *ImageRepositoryCredential) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ImageRepositoryCredential.

type InstallRebootBehavior 

type InstallRebootBehavior string

InstallRebootBehavior - Indicates if updates are available and at least one of the updates needs a reboot. 

const (
	InstallRebootBehaviorNeverReboots   InstallRebootBehavior = "NeverReboots"
	InstallRebootBehaviorRequestReboot  InstallRebootBehavior = "RequestReboot"
	InstallRebootBehaviorRequiresReboot InstallRebootBehavior = "RequiresReboot"
)

func PossibleInstallRebootBehaviorValues 

func PossibleInstallRebootBehaviorValues() []InstallRebootBehavior

PossibleInstallRebootBehaviorValues returns the possible values for the InstallRebootBehavior const type.

type InstallationImpact 

type InstallationImpact string

InstallationImpact - Impact of Installing an updateType 

const (
	InstallationImpactDeviceRebooted          InstallationImpact = "DeviceRebooted"
	InstallationImpactKubernetesWorkloadsDown InstallationImpact = "KubernetesWorkloadsDown"
	InstallationImpactNone                    InstallationImpact = "None"
)

func PossibleInstallationImpactValues 

func PossibleInstallationImpactValues() []InstallationImpact

PossibleInstallationImpactValues returns the possible values for the InstallationImpact const type.

type IoTAddon 

type IoTAddon struct {
	// REQUIRED; Addon type.
	Kind *AddonType

	// REQUIRED; Properties specific to IOT addon.
	Properties *IoTAddonProperties

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of Addon
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

IoTAddon - IoT Addon.

func (*IoTAddon) GetAddon added in v0.2.0 

func (i *IoTAddon) GetAddon() *Addon

GetAddon implements the AddonClassification interface for type IoTAddon.

func (IoTAddon) MarshalJSON 

func (i IoTAddon) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IoTAddon.

func (*IoTAddon) UnmarshalJSON 

func (i *IoTAddon) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IoTAddon.

type IoTAddonProperties 

type IoTAddonProperties struct {
	// REQUIRED; IoT device metadata to which appliance needs to be connected.
	IoTDeviceDetails *IoTDeviceInfo

	// REQUIRED; IoT edge device to which the IoT Addon needs to be configured.
	IoTEdgeDeviceDetails *IoTDeviceInfo

	// READ-ONLY; Host OS supported by the IoT addon.
	HostPlatform *PlatformType

	// READ-ONLY; Platform where the runtime is hosted.
	HostPlatformType *HostPlatformType

	// READ-ONLY; Addon Provisioning State
	ProvisioningState *AddonState

	// READ-ONLY; Version of IoT running on the appliance.
	Version *string
}

IoTAddonProperties - IoT addon properties.

func (IoTAddonProperties) MarshalJSON added in v1.1.0 

func (i IoTAddonProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IoTAddonProperties.

func (*IoTAddonProperties) UnmarshalJSON added in v1.1.0 

func (i *IoTAddonProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IoTAddonProperties.

type IoTDeviceInfo 

type IoTDeviceInfo struct {
	// REQUIRED; ID of the IoT device/edge device.
	DeviceID *string

	// REQUIRED; Host name for the IoT hub associated to the device.
	IoTHostHub *string

	// Encrypted IoT device/IoT edge device connection string.
	Authentication *Authentication

	// Id for the IoT hub associated to the device.
	IoTHostHubID *string
}

IoTDeviceInfo - Metadata of IoT device/IoT Edge device to be configured.

func (IoTDeviceInfo) MarshalJSON added in v1.1.0 

func (i IoTDeviceInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IoTDeviceInfo.

func (*IoTDeviceInfo) UnmarshalJSON added in v1.1.0 

func (i *IoTDeviceInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IoTDeviceInfo.

type IoTEdgeAgentInfo 

type IoTEdgeAgentInfo struct {
	// REQUIRED; Name of the IoT edge agent image.
	ImageName *string

	// REQUIRED; Image Tag.
	Tag *string

	// Image repository details.
	ImageRepository *ImageRepositoryCredential
}

IoTEdgeAgentInfo - IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified.

func (IoTEdgeAgentInfo) MarshalJSON added in v1.1.0 

func (i IoTEdgeAgentInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IoTEdgeAgentInfo.

func (*IoTEdgeAgentInfo) UnmarshalJSON added in v1.1.0 

func (i *IoTEdgeAgentInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IoTEdgeAgentInfo.

type IoTRole 

type IoTRole struct {
	// REQUIRED; Role type.
	Kind *RoleTypes

	// Properties specific to IoT role.
	Properties *IoTRoleProperties

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of Role
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

IoTRole - Compute role.

func (*IoTRole) GetRole added in v0.2.0 

func (i *IoTRole) GetRole() *Role

GetRole implements the RoleClassification interface for type IoTRole.

func (IoTRole) MarshalJSON 

func (i IoTRole) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IoTRole.

func (*IoTRole) UnmarshalJSON 

func (i *IoTRole) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IoTRole.

type IoTRoleProperties 

type IoTRoleProperties struct {
	// REQUIRED; Host OS supported by the IoT role.
	HostPlatform *PlatformType

	// REQUIRED; IoT device metadata to which data box edge device needs to be connected.
	IoTDeviceDetails *IoTDeviceInfo

	// REQUIRED; IoT edge device to which the IoT role needs to be configured.
	IoTEdgeDeviceDetails *IoTDeviceInfo

	// REQUIRED; Role status.
	RoleStatus *RoleStatus

	// Resource allocation
	ComputeResource *ComputeResource

	// Iot edge agent details to download the agent and bootstrap iot runtime.
	IoTEdgeAgentInfo *IoTEdgeAgentInfo

	// Mount points of shares in role(s).
	ShareMappings []*MountPointMap

	// READ-ONLY; Platform where the Iot runtime is hosted.
	HostPlatformType *HostPlatformType
}

IoTRoleProperties - IoT role properties.

func (IoTRoleProperties) MarshalJSON 

func (i IoTRoleProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IoTRoleProperties.

func (*IoTRoleProperties) UnmarshalJSON added in v1.1.0 

func (i *IoTRoleProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IoTRoleProperties.

type Job 

type Job struct {
	// READ-ONLY; The UTC date and time at which the job completed.
	EndTime *time.Time

	// READ-ONLY; The error details.
	Error *JobErrorDetails

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The name of the object.
	Name *string

	// READ-ONLY; The percentage of the job that is complete.
	PercentComplete *int32

	// READ-ONLY; The properties of the job.
	Properties *JobProperties

	// READ-ONLY; The UTC date and time at which the job started.
	StartTime *time.Time

	// READ-ONLY; The current status of the job.
	Status *JobStatus

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

Job - A device job.

func (Job) MarshalJSON 

func (j Job) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Job.

func (*Job) UnmarshalJSON 

func (j *Job) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Job.

type JobErrorDetails 

type JobErrorDetails struct {
	// READ-ONLY; The code intended for programmatic access.
	Code *string

	// READ-ONLY; The error details.
	ErrorDetails []*JobErrorItem

	// READ-ONLY; The message that describes the error in detail.
	Message *string
}

JobErrorDetails - The job error information containing the list of job errors.

func (JobErrorDetails) MarshalJSON 

func (j JobErrorDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobErrorDetails.

func (*JobErrorDetails) UnmarshalJSON added in v1.1.0 

func (j *JobErrorDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobErrorDetails.

type JobErrorItem 

type JobErrorItem struct {
	// READ-ONLY; The code intended for programmatic access.
	Code *string

	// READ-ONLY; The message that describes the error in detail.
	Message *string

	// READ-ONLY; The recommended actions.
	Recommendations []*string
}

JobErrorItem - The job error items.

func (JobErrorItem) MarshalJSON 

func (j JobErrorItem) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobErrorItem.

func (*JobErrorItem) UnmarshalJSON added in v1.1.0 

func (j *JobErrorItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobErrorItem.

type JobProperties 

type JobProperties struct {
	// If only subfolders need to be refreshed, then the subfolder path inside the share or container. (The path is empty if there
	// are no subfolders.)
	Folder *string

	// READ-ONLY; Current stage of the update operation.
	CurrentStage *UpdateOperationStage

	// READ-ONLY; The download progress.
	DownloadProgress *UpdateDownloadProgress

	// READ-ONLY; Local share/remote container relative path to the error manifest file of the refresh.
	ErrorManifestFile *string

	// READ-ONLY; The install progress.
	InstallProgress *UpdateInstallProgress

	// READ-ONLY; The type of the job.
	JobType *JobType

	// READ-ONLY; ARM ID of the entity that was refreshed.
	RefreshedEntityID *string

	// READ-ONLY; Total number of errors encountered during the refresh process.
	TotalRefreshErrors *int32
}

JobProperties - The properties for the job.

func (JobProperties) MarshalJSON added in v1.1.0 

func (j JobProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobProperties.

func (*JobProperties) UnmarshalJSON added in v1.1.0 

func (j *JobProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobProperties.

type JobStatus 

type JobStatus string

JobStatus - The current status of the job. 

const (
	JobStatusCanceled  JobStatus = "Canceled"
	JobStatusFailed    JobStatus = "Failed"
	JobStatusInvalid   JobStatus = "Invalid"
	JobStatusPaused    JobStatus = "Paused"
	JobStatusRunning   JobStatus = "Running"
	JobStatusScheduled JobStatus = "Scheduled"
	JobStatusSucceeded JobStatus = "Succeeded"
)

func PossibleJobStatusValues 

func PossibleJobStatusValues() []JobStatus

PossibleJobStatusValues returns the possible values for the JobStatus const type.

type JobType 

type JobType string

JobType - The type of the job. 

const (
	JobTypeBackup                JobType = "Backup"
	JobTypeDownloadUpdates       JobType = "DownloadUpdates"
	JobTypeInstallUpdates        JobType = "InstallUpdates"
	JobTypeInvalid               JobType = "Invalid"
	JobTypeRefreshContainer      JobType = "RefreshContainer"
	JobTypeRefreshShare          JobType = "RefreshShare"
	JobTypeRestore               JobType = "Restore"
	JobTypeScanForUpdates        JobType = "ScanForUpdates"
	JobTypeTriggerSupportPackage JobType = "TriggerSupportPackage"
)

func PossibleJobTypeValues 

func PossibleJobTypeValues() []JobType

PossibleJobTypeValues returns the possible values for the JobType const type.

type JobsClient 

type JobsClient struct {
	// contains filtered or unexported fields
}

JobsClient contains the methods for the Jobs group. Don't use this type directly, use NewJobsClient() instead.

func NewJobsClient 

func NewJobsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*JobsClient, error)

NewJobsClient creates a new instance of JobsClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*JobsClient) Get 

func (client *JobsClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string, options *JobsClientGetOptions) (JobsClientGetResponse, error)

Get - Gets the details of a specified job on a Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • name - The job name.
  • resourceGroupName - The resource group name.
  • options - JobsClientGetOptions contains the optional parameters for the JobsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/JobsGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewJobsClient().Get(ctx, "testedgedevice", "159a00c7-8543-4343-9435-263ac87df3bb", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Job = armdataboxedge.Job{
	// 	Name: to.Ptr("159a00c7-8543-4343-9435-263ac87df3bb"),
	// 	EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-18T03:18:51.427Z"); return t}()),
	// 	ID: to.Ptr("/subscriptions/id/locations/westus/jobs/159a00c7-8543-4343-9435-263ac87df3bb"),
	// 	PercentComplete: to.Ptr[int32](100),
	// 	Properties: &armdataboxedge.JobProperties{
	// 		CurrentStage: to.Ptr(armdataboxedge.UpdateOperationStageSuccess),
	// 		JobType: to.Ptr(armdataboxedge.JobTypeDownloadUpdates),
	// 	},
	// 	StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-18T02:18:51.427Z"); return t}()),
	// 	Status: to.Ptr(armdataboxedge.JobStatusSucceeded),
	// }
}

Output:

type JobsClientGetOptions added in v0.2.0 

type JobsClientGetOptions struct {
}

JobsClientGetOptions contains the optional parameters for the JobsClient.Get method.

type JobsClientGetResponse added in v0.2.0 

type JobsClientGetResponse struct {
	// A device job.
	Job
}

JobsClientGetResponse contains the response from method JobsClient.Get.

type KeyVaultSyncStatus 

type KeyVaultSyncStatus string

KeyVaultSyncStatus - For changing or to initiate the resync to key-vault set the status to KeyVaultSyncPending, rest of the status will not be applicable. 

const (
	KeyVaultSyncStatusKeyVaultNotConfigured KeyVaultSyncStatus = "KeyVaultNotConfigured"
	KeyVaultSyncStatusKeyVaultNotSynced     KeyVaultSyncStatus = "KeyVaultNotSynced"
	KeyVaultSyncStatusKeyVaultSyncFailed    KeyVaultSyncStatus = "KeyVaultSyncFailed"
	KeyVaultSyncStatusKeyVaultSyncPending   KeyVaultSyncStatus = "KeyVaultSyncPending"
	KeyVaultSyncStatusKeyVaultSynced        KeyVaultSyncStatus = "KeyVaultSynced"
	KeyVaultSyncStatusKeyVaultSyncing       KeyVaultSyncStatus = "KeyVaultSyncing"
)

func PossibleKeyVaultSyncStatusValues 

func PossibleKeyVaultSyncStatusValues() []KeyVaultSyncStatus

PossibleKeyVaultSyncStatusValues returns the possible values for the KeyVaultSyncStatus const type.

type KubernetesClusterInfo 

type KubernetesClusterInfo struct {
	// REQUIRED; Kubernetes cluster version
	Version *string

	// READ-ONLY; Etcd configuration
	EtcdInfo *EtcdInfo

	// READ-ONLY; Kubernetes cluster nodes
	Nodes []*NodeInfo
}

KubernetesClusterInfo - Kubernetes cluster configuration

func (KubernetesClusterInfo) MarshalJSON 

func (k KubernetesClusterInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KubernetesClusterInfo.

func (*KubernetesClusterInfo) UnmarshalJSON added in v1.1.0 

func (k *KubernetesClusterInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KubernetesClusterInfo.

type KubernetesIPConfiguration 

type KubernetesIPConfiguration struct {
	// IP address of the Kubernetes node.
	IPAddress *string

	// READ-ONLY; Port of the Kubernetes node.
	Port *string
}

KubernetesIPConfiguration - Kubernetes node IP configuration

func (KubernetesIPConfiguration) MarshalJSON added in v1.1.0 

func (k KubernetesIPConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KubernetesIPConfiguration.

func (*KubernetesIPConfiguration) UnmarshalJSON added in v1.1.0 

func (k *KubernetesIPConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KubernetesIPConfiguration.

type KubernetesNodeType 

type KubernetesNodeType string

KubernetesNodeType - Node type - Master/Worker 

const (
	KubernetesNodeTypeInvalid KubernetesNodeType = "Invalid"
	KubernetesNodeTypeMaster  KubernetesNodeType = "Master"
	KubernetesNodeTypeWorker  KubernetesNodeType = "Worker"
)

func PossibleKubernetesNodeTypeValues 

func PossibleKubernetesNodeTypeValues() []KubernetesNodeType

PossibleKubernetesNodeTypeValues returns the possible values for the KubernetesNodeType const type.

type KubernetesRole 

type KubernetesRole struct {
	// REQUIRED; Role type.
	Kind *RoleTypes

	// Properties specific to Kubernetes role.
	Properties *KubernetesRoleProperties

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of Role
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

KubernetesRole - The limited preview of Kubernetes Cluster Management from the Azure supports: 1. Using a simple turn-key option in Azure Portal, deploy a Kubernetes cluster on your Azure Stack Edge device. 2. Configure Kubernetes cluster running on your device with Arc enabled Kubernetes with a click of a button in the Azure Portal. Azure Arc enables organizations to view, manage, and govern their on-premises Kubernetes clusters using the Azure Portal, command line tools, and APIs. 3. Easily configure Persistent Volumes using SMB and NFS shares for storing container data. For more information, refer to the document here: https://databoxupdatepackages.blob.core.windows.net/documentation/Microsoft-Azure-Stack-Edge-K8-Cloud-Management-20210323.pdf Or Demo: https://databoxupdatepackages.blob.core.windows.net/documentation/Microsoft-Azure-Stack-Edge-K8S-Cloud-Management-20210323.mp4 By using this feature, you agree to the preview legal terms. See the https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/

func (*KubernetesRole) GetRole added in v0.2.0 

func (k *KubernetesRole) GetRole() *Role

GetRole implements the RoleClassification interface for type KubernetesRole.

func (KubernetesRole) MarshalJSON 

func (k KubernetesRole) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KubernetesRole.

func (*KubernetesRole) UnmarshalJSON 

func (k *KubernetesRole) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KubernetesRole.

type KubernetesRoleCompute 

type KubernetesRoleCompute struct {
	// REQUIRED; VM profile
	VMProfile *string

	// READ-ONLY; Memory in bytes
	MemoryInBytes *int64

	// READ-ONLY; Processor count
	ProcessorCount *int32
}

KubernetesRoleCompute - Kubernetes role compute resource

func (KubernetesRoleCompute) MarshalJSON added in v1.1.0 

func (k KubernetesRoleCompute) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KubernetesRoleCompute.

func (*KubernetesRoleCompute) UnmarshalJSON added in v1.1.0 

func (k *KubernetesRoleCompute) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KubernetesRoleCompute.

type KubernetesRoleNetwork 

type KubernetesRoleNetwork struct {
	// READ-ONLY; Cni configuration
	CniConfig *CniConfig

	// READ-ONLY; Load balancer configuration
	LoadBalancerConfig *LoadBalancerConfig
}

KubernetesRoleNetwork - Kubernetes role network resource

func (KubernetesRoleNetwork) MarshalJSON added in v1.1.0 

func (k KubernetesRoleNetwork) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KubernetesRoleNetwork.

func (*KubernetesRoleNetwork) UnmarshalJSON added in v1.1.0 

func (k *KubernetesRoleNetwork) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KubernetesRoleNetwork.

type KubernetesRoleProperties 

type KubernetesRoleProperties struct {
	// REQUIRED; Host OS supported by the Kubernetes role.
	HostPlatform *PlatformType

	// REQUIRED; Kubernetes cluster configuration
	KubernetesClusterInfo *KubernetesClusterInfo

	// REQUIRED; Kubernetes role resources
	KubernetesRoleResources *KubernetesRoleResources

	// REQUIRED; Role status.
	RoleStatus *RoleStatus

	// READ-ONLY; Platform where the runtime is hosted.
	HostPlatformType *HostPlatformType

	// READ-ONLY; State of Kubernetes deployment
	ProvisioningState *KubernetesState
}

KubernetesRoleProperties - Kubernetes role properties.

func (KubernetesRoleProperties) MarshalJSON added in v1.1.0 

func (k KubernetesRoleProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KubernetesRoleProperties.

func (*KubernetesRoleProperties) UnmarshalJSON added in v1.1.0 

func (k *KubernetesRoleProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KubernetesRoleProperties.

type KubernetesRoleResources 

type KubernetesRoleResources struct {
	// REQUIRED; Kubernetes role compute resource
	Compute *KubernetesRoleCompute

	// Kubernetes role storage resource
	Storage *KubernetesRoleStorage

	// READ-ONLY; Kubernetes role network resource
	Network *KubernetesRoleNetwork
}

KubernetesRoleResources - Kubernetes role resources

func (KubernetesRoleResources) MarshalJSON added in v1.1.0 

func (k KubernetesRoleResources) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KubernetesRoleResources.

func (*KubernetesRoleResources) UnmarshalJSON added in v1.1.0 

func (k *KubernetesRoleResources) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KubernetesRoleResources.

type KubernetesRoleStorage 

type KubernetesRoleStorage struct {
	// Mount points of shares in role(s).
	Endpoints []*MountPointMap

	// READ-ONLY; Kubernetes storage class info.
	StorageClasses []*KubernetesRoleStorageClassInfo
}

KubernetesRoleStorage - Kubernetes role storage resource

func (KubernetesRoleStorage) MarshalJSON 

func (k KubernetesRoleStorage) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KubernetesRoleStorage.

func (*KubernetesRoleStorage) UnmarshalJSON added in v1.1.0 

func (k *KubernetesRoleStorage) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KubernetesRoleStorage.

type KubernetesRoleStorageClassInfo 

type KubernetesRoleStorageClassInfo struct {
	// READ-ONLY; Storage class name.
	Name *string

	// READ-ONLY; If provisioned storage is posix compliant.
	PosixCompliant *PosixComplianceStatus

	// READ-ONLY; Storage class type.
	Type *string
}

KubernetesRoleStorageClassInfo - Kubernetes storage class info.

func (KubernetesRoleStorageClassInfo) MarshalJSON added in v1.1.0 

func (k KubernetesRoleStorageClassInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KubernetesRoleStorageClassInfo.

func (*KubernetesRoleStorageClassInfo) UnmarshalJSON added in v1.1.0 

func (k *KubernetesRoleStorageClassInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KubernetesRoleStorageClassInfo.

type KubernetesState 

type KubernetesState string

KubernetesState - State of Kubernetes deployment 

const (
	KubernetesStateCreated       KubernetesState = "Created"
	KubernetesStateCreating      KubernetesState = "Creating"
	KubernetesStateDeleting      KubernetesState = "Deleting"
	KubernetesStateFailed        KubernetesState = "Failed"
	KubernetesStateInvalid       KubernetesState = "Invalid"
	KubernetesStateReconfiguring KubernetesState = "Reconfiguring"
	KubernetesStateUpdating      KubernetesState = "Updating"
)

func PossibleKubernetesStateValues 

func PossibleKubernetesStateValues() []KubernetesState

PossibleKubernetesStateValues returns the possible values for the KubernetesState const type.

type LoadBalancerConfig 

type LoadBalancerConfig struct {
	// READ-ONLY; Load balancer type
	Type *string

	// READ-ONLY; Load balancer version
	Version *string
}

LoadBalancerConfig - Load balancer configuration

func (LoadBalancerConfig) MarshalJSON added in v1.1.0 

func (l LoadBalancerConfig) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoadBalancerConfig.

func (*LoadBalancerConfig) UnmarshalJSON added in v1.1.0 

func (l *LoadBalancerConfig) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LoadBalancerConfig.

type MECRole 

type MECRole struct {
	// REQUIRED; Role type.
	Kind *RoleTypes

	// Properties specific to MEC role.
	Properties *MECRoleProperties

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of Role
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

MECRole - MEC role.

func (*MECRole) GetRole added in v0.2.0 

func (m *MECRole) GetRole() *Role

GetRole implements the RoleClassification interface for type MECRole.

func (MECRole) MarshalJSON 

func (m MECRole) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MECRole.

func (*MECRole) UnmarshalJSON 

func (m *MECRole) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MECRole.

type MECRoleProperties 

type MECRoleProperties struct {
	// REQUIRED; Role status.
	RoleStatus *RoleStatus

	// Activation key of the MEC.
	ConnectionString *AsymmetricEncryptedSecret

	// Controller Endpoint.
	ControllerEndpoint *string

	// Unique Id of the Resource.
	ResourceUniqueID *string
}

MECRoleProperties - MEC role properties.

func (MECRoleProperties) MarshalJSON added in v1.1.0 

func (m MECRoleProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MECRoleProperties.

func (*MECRoleProperties) UnmarshalJSON added in v1.1.0 

func (m *MECRoleProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MECRoleProperties.

type MetricAggregationType 

type MetricAggregationType string

MetricAggregationType - Metric aggregation type. 

const (
	MetricAggregationTypeAverage      MetricAggregationType = "Average"
	MetricAggregationTypeCount        MetricAggregationType = "Count"
	MetricAggregationTypeMaximum      MetricAggregationType = "Maximum"
	MetricAggregationTypeMinimum      MetricAggregationType = "Minimum"
	MetricAggregationTypeNone         MetricAggregationType = "None"
	MetricAggregationTypeNotSpecified MetricAggregationType = "NotSpecified"
	MetricAggregationTypeTotal        MetricAggregationType = "Total"
)

func PossibleMetricAggregationTypeValues 

func PossibleMetricAggregationTypeValues() []MetricAggregationType

PossibleMetricAggregationTypeValues returns the possible values for the MetricAggregationType const type.

type MetricCategory 

type MetricCategory string

MetricCategory - Metric category. 

const (
	MetricCategoryCapacity    MetricCategory = "Capacity"
	MetricCategoryTransaction MetricCategory = "Transaction"
)

func PossibleMetricCategoryValues 

func PossibleMetricCategoryValues() []MetricCategory

PossibleMetricCategoryValues returns the possible values for the MetricCategory const type.

type MetricConfiguration 

type MetricConfiguration struct {
	// REQUIRED; Host name for the IoT hub associated to the device.
	CounterSets []*MetricCounterSet

	// REQUIRED; The Resource ID on which the metrics should be pushed.
	ResourceID *string

	// The MDM account to which the counters should be pushed.
	MdmAccount *string

	// The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified
	MetricNameSpace *string
}

MetricConfiguration - Metric configuration.

func (MetricConfiguration) MarshalJSON 

func (m MetricConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MetricConfiguration.

func (*MetricConfiguration) UnmarshalJSON added in v1.1.0 

func (m *MetricConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MetricConfiguration.

type MetricCounter 

type MetricCounter struct {
	// REQUIRED; The counter name.
	Name *string

	// The additional dimensions to be added to metric.
	AdditionalDimensions []*MetricDimension

	// The dimension filter.
	DimensionFilter []*MetricDimension

	// The instance from which counter should be collected.
	Instance *string
}

MetricCounter - The metric counter

func (MetricCounter) MarshalJSON 

func (m MetricCounter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MetricCounter.

func (*MetricCounter) UnmarshalJSON added in v1.1.0 

func (m *MetricCounter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MetricCounter.

type MetricCounterSet 

type MetricCounterSet struct {
	// REQUIRED; The counters that should be collected in this set.
	Counters []*MetricCounter
}

MetricCounterSet - The metric counter set

func (MetricCounterSet) MarshalJSON 

func (m MetricCounterSet) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MetricCounterSet.

func (*MetricCounterSet) UnmarshalJSON added in v1.1.0 

func (m *MetricCounterSet) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MetricCounterSet.

type MetricDimension 

type MetricDimension struct {
	// REQUIRED; The dimension value.
	SourceName *string

	// REQUIRED; The dimension type.
	SourceType *string
}

MetricDimension - The metric dimension

func (MetricDimension) MarshalJSON added in v1.1.0 

func (m MetricDimension) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MetricDimension.

func (*MetricDimension) UnmarshalJSON added in v1.1.0 

func (m *MetricDimension) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MetricDimension.

type MetricDimensionV1 

type MetricDimensionV1 struct {
	// Display name of the metrics dimension.
	DisplayName *string

	// Name of the metrics dimension.
	Name *string

	// To be exported to shoe box.
	ToBeExportedForShoebox *bool
}

MetricDimensionV1 - Metric Dimension v1.

func (MetricDimensionV1) MarshalJSON added in v1.1.0 

func (m MetricDimensionV1) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MetricDimensionV1.

func (*MetricDimensionV1) UnmarshalJSON added in v1.1.0 

func (m *MetricDimensionV1) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MetricDimensionV1.

type MetricSpecificationV1 

type MetricSpecificationV1 struct {
	// Metric aggregation type.
	AggregationType *MetricAggregationType

	// Metric category.
	Category *MetricCategory

	// Metric dimensions, other than default dimension which is resource.
	Dimensions []*MetricDimensionV1

	// Description of the metric to be displayed.
	DisplayDescription *string

	// Display name of the metric.
	DisplayName *string

	// Set true to fill the gaps with zero.
	FillGapWithZero *bool

	// Name of the metric.
	Name *string

	// Resource name override.
	ResourceIDDimensionNameOverride *string

	// Support metric aggregation type.
	SupportedAggregationTypes []*MetricAggregationType

	// Support granularity of metrics.
	SupportedTimeGrainTypes []*TimeGrain

	// Metric units.
	Unit *MetricUnit
}

MetricSpecificationV1 - Metric specification version 1.

func (MetricSpecificationV1) MarshalJSON 

func (m MetricSpecificationV1) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MetricSpecificationV1.

func (*MetricSpecificationV1) UnmarshalJSON added in v1.1.0 

func (m *MetricSpecificationV1) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MetricSpecificationV1.

type MetricUnit 

type MetricUnit string

MetricUnit - Metric units. 

const (
	MetricUnitBytes          MetricUnit = "Bytes"
	MetricUnitBytesPerSecond MetricUnit = "BytesPerSecond"
	MetricUnitCount          MetricUnit = "Count"
	MetricUnitCountPerSecond MetricUnit = "CountPerSecond"
	MetricUnitMilliseconds   MetricUnit = "Milliseconds"
	MetricUnitNotSpecified   MetricUnit = "NotSpecified"
	MetricUnitPercent        MetricUnit = "Percent"
	MetricUnitSeconds        MetricUnit = "Seconds"
)

func PossibleMetricUnitValues 

func PossibleMetricUnitValues() []MetricUnit

PossibleMetricUnitValues returns the possible values for the MetricUnit const type.

type MonitoringConfigClient 

type MonitoringConfigClient struct {
	// contains filtered or unexported fields
}

MonitoringConfigClient contains the methods for the MonitoringConfig group. Don't use this type directly, use NewMonitoringConfigClient() instead.

func NewMonitoringConfigClient 

func NewMonitoringConfigClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*MonitoringConfigClient, error)

NewMonitoringConfigClient creates a new instance of MonitoringConfigClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*MonitoringConfigClient) BeginCreateOrUpdate 

func (client *MonitoringConfigClient) BeginCreateOrUpdate(ctx context.Context, deviceName string, roleName string, resourceGroupName string, monitoringMetricConfiguration MonitoringMetricConfiguration, options *MonitoringConfigClientBeginCreateOrUpdateOptions) (*runtime.Poller[MonitoringConfigClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a new metric configuration or updates an existing one for a role. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • roleName - The role name.
  • resourceGroupName - The resource group name.
  • monitoringMetricConfiguration - The metric configuration.
  • options - MonitoringConfigClientBeginCreateOrUpdateOptions contains the optional parameters for the MonitoringConfigClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/PutMonitoringConfig.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewMonitoringConfigClient().BeginCreateOrUpdate(ctx, "testedgedevice", "testrole", "GroupForEdgeAutomation", armdataboxedge.MonitoringMetricConfiguration{
		Properties: &armdataboxedge.MonitoringMetricConfigurationProperties{
			MetricConfigurations: []*armdataboxedge.MetricConfiguration{
				{
					CounterSets: []*armdataboxedge.MetricCounterSet{
						{
							Counters: []*armdataboxedge.MetricCounter{
								{
									Name: to.Ptr("test"),
								}},
						}},
					MdmAccount:      to.Ptr("test"),
					MetricNameSpace: to.Ptr("test"),
					ResourceID:      to.Ptr("test"),
				}},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.MonitoringMetricConfiguration = armdataboxedge.MonitoringMetricConfiguration{
	// 	Properties: &armdataboxedge.MonitoringMetricConfigurationProperties{
	// 		MetricConfigurations: []*armdataboxedge.MetricConfiguration{
	// 			{
	// 				CounterSets: []*armdataboxedge.MetricCounterSet{
	// 					{
	// 						Counters: []*armdataboxedge.MetricCounter{
	// 							{
	// 								Name: to.Ptr("test"),
	// 						}},
	// 				}},
	// 				MdmAccount: to.Ptr("test"),
	// 				MetricNameSpace: to.Ptr("test"),
	// 				ResourceID: to.Ptr("test"),
	// 		}},
	// 	},
	// }
}

Output:

func (*MonitoringConfigClient) BeginDelete 

func (client *MonitoringConfigClient) BeginDelete(ctx context.Context, deviceName string, roleName string, resourceGroupName string, options *MonitoringConfigClientBeginDeleteOptions) (*runtime.Poller[MonitoringConfigClientDeleteResponse], error)

BeginDelete - deletes a new metric configuration for a role. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • roleName - The role name.
  • resourceGroupName - The resource group name.
  • options - MonitoringConfigClientBeginDeleteOptions contains the optional parameters for the MonitoringConfigClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/DeleteMonitoringConfig.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewMonitoringConfigClient().BeginDelete(ctx, "testedgedevice", "testrole", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*MonitoringConfigClient) Get 

func (client *MonitoringConfigClient) Get(ctx context.Context, deviceName string, roleName string, resourceGroupName string, options *MonitoringConfigClientGetOptions) (MonitoringConfigClientGetResponse, error)

Get - Gets a metric configuration of a role. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • roleName - The role name.
  • resourceGroupName - The resource group name.
  • options - MonitoringConfigClientGetOptions contains the optional parameters for the MonitoringConfigClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/GetMonitoringConfig.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewMonitoringConfigClient().Get(ctx, "testedgedevice", "testrole", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.MonitoringMetricConfiguration = armdataboxedge.MonitoringMetricConfiguration{
	// 	Properties: &armdataboxedge.MonitoringMetricConfigurationProperties{
	// 		MetricConfigurations: []*armdataboxedge.MetricConfiguration{
	// 			{
	// 				CounterSets: []*armdataboxedge.MetricCounterSet{
	// 					{
	// 						Counters: []*armdataboxedge.MetricCounter{
	// 							{
	// 								Name: to.Ptr("test"),
	// 						}},
	// 				}},
	// 				MdmAccount: to.Ptr("test"),
	// 				MetricNameSpace: to.Ptr("test"),
	// 				ResourceID: to.Ptr("test"),
	// 		}},
	// 	},
	// }
}

Output:

func (*MonitoringConfigClient) NewListPager added in v0.4.0 

func (client *MonitoringConfigClient) NewListPager(deviceName string, roleName string, resourceGroupName string, options *MonitoringConfigClientListOptions) *runtime.Pager[MonitoringConfigClientListResponse]

NewListPager - Lists metric configurations in a role.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • roleName - The role name.
  • resourceGroupName - The resource group name.
  • options - MonitoringConfigClientListOptions contains the optional parameters for the MonitoringConfigClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/ListMonitoringConfig.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewMonitoringConfigClient().NewListPager("testedgedevice", "testrole", "GroupForEdgeAutomation", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.MonitoringMetricConfigurationList = armdataboxedge.MonitoringMetricConfigurationList{
		// 	Value: []*armdataboxedge.MonitoringMetricConfiguration{
		// 		{
		// 			Properties: &armdataboxedge.MonitoringMetricConfigurationProperties{
		// 				MetricConfigurations: []*armdataboxedge.MetricConfiguration{
		// 					{
		// 						CounterSets: []*armdataboxedge.MetricCounterSet{
		// 							{
		// 								Counters: []*armdataboxedge.MetricCounter{
		// 									{
		// 										Name: to.Ptr("test"),
		// 								}},
		// 						}},
		// 						MdmAccount: to.Ptr("test"),
		// 						MetricNameSpace: to.Ptr("test"),
		// 						ResourceID: to.Ptr("test"),
		// 				}},
		// 			},
		// 	}},
		// }
	}
}

Output:

type MonitoringConfigClientBeginCreateOrUpdateOptions added in v0.2.0 

type MonitoringConfigClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

MonitoringConfigClientBeginCreateOrUpdateOptions contains the optional parameters for the MonitoringConfigClient.BeginCreateOrUpdate method.

type MonitoringConfigClientBeginDeleteOptions added in v0.2.0 

type MonitoringConfigClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

MonitoringConfigClientBeginDeleteOptions contains the optional parameters for the MonitoringConfigClient.BeginDelete method.

type MonitoringConfigClientCreateOrUpdateResponse added in v0.2.0 

type MonitoringConfigClientCreateOrUpdateResponse struct {
	// The metric setting details for the role
	MonitoringMetricConfiguration
}

MonitoringConfigClientCreateOrUpdateResponse contains the response from method MonitoringConfigClient.BeginCreateOrUpdate.

type MonitoringConfigClientDeleteResponse added in v0.2.0 

type MonitoringConfigClientDeleteResponse struct {
}

MonitoringConfigClientDeleteResponse contains the response from method MonitoringConfigClient.BeginDelete.

type MonitoringConfigClientGetOptions added in v0.2.0 

type MonitoringConfigClientGetOptions struct {
}

MonitoringConfigClientGetOptions contains the optional parameters for the MonitoringConfigClient.Get method.

type MonitoringConfigClientGetResponse added in v0.2.0 

type MonitoringConfigClientGetResponse struct {
	// The metric setting details for the role
	MonitoringMetricConfiguration
}

MonitoringConfigClientGetResponse contains the response from method MonitoringConfigClient.Get.

type MonitoringConfigClientListOptions added in v0.2.0 

type MonitoringConfigClientListOptions struct {
}

MonitoringConfigClientListOptions contains the optional parameters for the MonitoringConfigClient.NewListPager method.

type MonitoringConfigClientListResponse added in v0.2.0 

type MonitoringConfigClientListResponse struct {
	// Collection of metric configurations.
	MonitoringMetricConfigurationList
}

MonitoringConfigClientListResponse contains the response from method MonitoringConfigClient.NewListPager.

type MonitoringMetricConfiguration 

type MonitoringMetricConfiguration struct {
	// REQUIRED; The metric setting properties.
	Properties *MonitoringMetricConfigurationProperties

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of MonitoringConfiguration
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

MonitoringMetricConfiguration - The metric setting details for the role

func (MonitoringMetricConfiguration) MarshalJSON 

func (m MonitoringMetricConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MonitoringMetricConfiguration.

func (*MonitoringMetricConfiguration) UnmarshalJSON 

func (m *MonitoringMetricConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MonitoringMetricConfiguration.

type MonitoringMetricConfigurationList 

type MonitoringMetricConfigurationList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string

	// READ-ONLY; The list of metric configurations.
	Value []*MonitoringMetricConfiguration
}

MonitoringMetricConfigurationList - Collection of metric configurations.

func (MonitoringMetricConfigurationList) MarshalJSON 

func (m MonitoringMetricConfigurationList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MonitoringMetricConfigurationList.

func (*MonitoringMetricConfigurationList) UnmarshalJSON added in v1.1.0 

func (m *MonitoringMetricConfigurationList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MonitoringMetricConfigurationList.

type MonitoringMetricConfigurationProperties 

type MonitoringMetricConfigurationProperties struct {
	// REQUIRED; The metrics configuration details
	MetricConfigurations []*MetricConfiguration
}

MonitoringMetricConfigurationProperties - Metrics properties

func (MonitoringMetricConfigurationProperties) MarshalJSON 

func (m MonitoringMetricConfigurationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MonitoringMetricConfigurationProperties.

func (*MonitoringMetricConfigurationProperties) UnmarshalJSON added in v1.1.0 

func (m *MonitoringMetricConfigurationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MonitoringMetricConfigurationProperties.

type MonitoringStatus 

type MonitoringStatus string

MonitoringStatus - Current monitoring status of the share. 

const (
	MonitoringStatusDisabled MonitoringStatus = "Disabled"
	MonitoringStatusEnabled  MonitoringStatus = "Enabled"
)

func PossibleMonitoringStatusValues 

func PossibleMonitoringStatusValues() []MonitoringStatus

PossibleMonitoringStatusValues returns the possible values for the MonitoringStatus const type.

type MountPointMap 

type MountPointMap struct {
	// REQUIRED; ID of the share mounted to the role VM.
	ShareID *string

	// READ-ONLY; Mount point for the share.
	MountPoint *string

	// READ-ONLY; Mounting type.
	MountType *MountType

	// READ-ONLY; ID of the role to which share is mounted.
	RoleID *string

	// READ-ONLY; Role type.
	RoleType *RoleTypes
}

MountPointMap - The share mount point.

func (MountPointMap) MarshalJSON added in v1.1.0 

func (m MountPointMap) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MountPointMap.

func (*MountPointMap) UnmarshalJSON added in v1.1.0 

func (m *MountPointMap) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MountPointMap.

type MountType 

type MountType string

MountType - Mounting type. 

const (
	MountTypeHostPath MountType = "HostPath"
	MountTypeVolume   MountType = "Volume"
)

func PossibleMountTypeValues 

func PossibleMountTypeValues() []MountType

PossibleMountTypeValues returns the possible values for the MountType const type.

type MoveRequest added in v0.3.0 

type MoveRequest struct {
	// REQUIRED; List of resources to be moved
	Resources []*string

	// REQUIRED; Target resource group ARMId
	TargetResourceGroup *string
}

MoveRequest - Resource Move details

func (MoveRequest) MarshalJSON added in v0.3.0 

func (m MoveRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MoveRequest.

func (*MoveRequest) UnmarshalJSON added in v1.1.0 

func (m *MoveRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MoveRequest.

type MsiIdentityType 

type MsiIdentityType string

MsiIdentityType - Identity type 

const (
	MsiIdentityTypeNone           MsiIdentityType = "None"
	MsiIdentityTypeSystemAssigned MsiIdentityType = "SystemAssigned"
	MsiIdentityTypeUserAssigned   MsiIdentityType = "UserAssigned"
)

func PossibleMsiIdentityTypeValues 

func PossibleMsiIdentityTypeValues() []MsiIdentityType

PossibleMsiIdentityTypeValues returns the possible values for the MsiIdentityType const type.

type NetworkAdapter 

type NetworkAdapter struct {
	// Value indicating whether this adapter has DHCP enabled.
	DhcpStatus *NetworkAdapterDHCPStatus

	// Value indicating whether this adapter is RDMA capable.
	RdmaStatus *NetworkAdapterRDMAStatus

	// READ-ONLY; Instance ID of network adapter.
	AdapterID *string

	// READ-ONLY; Hardware position of network adapter.
	AdapterPosition *NetworkAdapterPosition

	// READ-ONLY; The list of DNS Servers of the device.
	DNSServers []*string

	// READ-ONLY; The IPv4 configuration of the network adapter.
	IPv4Configuration *IPv4Config

	// READ-ONLY; The IPv6 configuration of the network adapter.
	IPv6Configuration *IPv6Config

	// READ-ONLY; The IPv6 local address.
	IPv6LinkLocalAddress *string

	// READ-ONLY; Logical index of the adapter.
	Index *int32

	// READ-ONLY; Hardware label for the adapter.
	Label *string

	// READ-ONLY; Link speed.
	LinkSpeed *int64

	// READ-ONLY; MAC address.
	MacAddress *string

	// READ-ONLY; Network adapter name.
	NetworkAdapterName *string

	// READ-ONLY; Node ID of the network adapter.
	NodeID *string

	// READ-ONLY; Value indicating whether this adapter is valid.
	Status *NetworkAdapterStatus
}

NetworkAdapter - Represents the networkAdapter on a device.

func (NetworkAdapter) MarshalJSON 

func (n NetworkAdapter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkAdapter.

func (*NetworkAdapter) UnmarshalJSON added in v1.1.0 

func (n *NetworkAdapter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkAdapter.

type NetworkAdapterDHCPStatus 

type NetworkAdapterDHCPStatus string

NetworkAdapterDHCPStatus - Value indicating whether this adapter has DHCP enabled. 

const (
	NetworkAdapterDHCPStatusDisabled NetworkAdapterDHCPStatus = "Disabled"
	NetworkAdapterDHCPStatusEnabled  NetworkAdapterDHCPStatus = "Enabled"
)

func PossibleNetworkAdapterDHCPStatusValues 

func PossibleNetworkAdapterDHCPStatusValues() []NetworkAdapterDHCPStatus

PossibleNetworkAdapterDHCPStatusValues returns the possible values for the NetworkAdapterDHCPStatus const type.

type NetworkAdapterPosition 

type NetworkAdapterPosition struct {
	// READ-ONLY; The network group.
	NetworkGroup *NetworkGroup

	// READ-ONLY; The port.
	Port *int32
}

NetworkAdapterPosition - The network adapter position.

func (NetworkAdapterPosition) MarshalJSON added in v1.1.0 

func (n NetworkAdapterPosition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkAdapterPosition.

func (*NetworkAdapterPosition) UnmarshalJSON added in v1.1.0 

func (n *NetworkAdapterPosition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkAdapterPosition.

type NetworkAdapterRDMAStatus 

type NetworkAdapterRDMAStatus string

NetworkAdapterRDMAStatus - Value indicating whether this adapter is RDMA capable. 

const (
	NetworkAdapterRDMAStatusCapable   NetworkAdapterRDMAStatus = "Capable"
	NetworkAdapterRDMAStatusIncapable NetworkAdapterRDMAStatus = "Incapable"
)

func PossibleNetworkAdapterRDMAStatusValues 

func PossibleNetworkAdapterRDMAStatusValues() []NetworkAdapterRDMAStatus

PossibleNetworkAdapterRDMAStatusValues returns the possible values for the NetworkAdapterRDMAStatus const type.

type NetworkAdapterStatus 

type NetworkAdapterStatus string

NetworkAdapterStatus - Value indicating whether this adapter is valid. 

const (
	NetworkAdapterStatusActive   NetworkAdapterStatus = "Active"
	NetworkAdapterStatusInactive NetworkAdapterStatus = "Inactive"
)

func PossibleNetworkAdapterStatusValues 

func PossibleNetworkAdapterStatusValues() []NetworkAdapterStatus

PossibleNetworkAdapterStatusValues returns the possible values for the NetworkAdapterStatus const type.

type NetworkGroup 

type NetworkGroup string

NetworkGroup - The network group. 

const (
	NetworkGroupNonRDMA NetworkGroup = "NonRDMA"
	NetworkGroupNone    NetworkGroup = "None"
	NetworkGroupRDMA    NetworkGroup = "RDMA"
)

func PossibleNetworkGroupValues 

func PossibleNetworkGroupValues() []NetworkGroup

PossibleNetworkGroupValues returns the possible values for the NetworkGroup const type.

type NetworkSettings 

type NetworkSettings struct {
	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; The properties of network settings of a device.
	Properties *NetworkSettingsProperties

	// READ-ONLY; Metadata pertaining to creation and last modification of NetworkSettings
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

NetworkSettings - The network settings of a device.

func (NetworkSettings) MarshalJSON 

func (n NetworkSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkSettings.

func (*NetworkSettings) UnmarshalJSON 

func (n *NetworkSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkSettings.

type NetworkSettingsProperties 

type NetworkSettingsProperties struct {
	// READ-ONLY; The network adapter list on the device.
	NetworkAdapters []*NetworkAdapter
}

NetworkSettingsProperties - The properties of network settings.

func (NetworkSettingsProperties) MarshalJSON 

func (n NetworkSettingsProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkSettingsProperties.

func (*NetworkSettingsProperties) UnmarshalJSON added in v1.1.0 

func (n *NetworkSettingsProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkSettingsProperties.

type Node 

type Node struct {
	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; The properties of the node
	Properties *NodeProperties

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

Node - Represents a single node in a Data box Edge/Gateway device Gateway devices, standalone Edge devices and a single node cluster Edge device will all have 1 node Multi-node Edge devices will have more than 1 nodes

func (Node) MarshalJSON 

func (n Node) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Node.

func (*Node) UnmarshalJSON 

func (n *Node) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Node.

type NodeInfo 

type NodeInfo struct {
	// IP Configuration of the Kubernetes node.
	IPConfiguration []*KubernetesIPConfiguration

	// READ-ONLY; Node name.
	Name *string

	// READ-ONLY; Node type - Master/Worker
	Type *KubernetesNodeType
}

NodeInfo - Kubernetes node info

func (NodeInfo) MarshalJSON 

func (n NodeInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NodeInfo.

func (*NodeInfo) UnmarshalJSON added in v1.1.0 

func (n *NodeInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NodeInfo.

type NodeList 

type NodeList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string

	// READ-ONLY; The list of Nodes.
	Value []*Node
}

NodeList - Collection of Nodes.

func (NodeList) MarshalJSON 

func (n NodeList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NodeList.

func (*NodeList) UnmarshalJSON added in v1.1.0 

func (n *NodeList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NodeList.

type NodeProperties 

type NodeProperties struct {
	// READ-ONLY; Serial number of the Chassis
	NodeChassisSerialNumber *string

	// READ-ONLY; Display Name of the individual node
	NodeDisplayName *string

	// READ-ONLY; Friendly software version name that is currently installed on the node
	NodeFriendlySoftwareVersion *string

	// READ-ONLY; HCS version that is currently installed on the node
	NodeHcsVersion *string

	// READ-ONLY; Guid instance id of the node
	NodeInstanceID *string

	// READ-ONLY; Serial number of the individual node
	NodeSerialNumber *string

	// READ-ONLY; The current status of the individual node
	NodeStatus *NodeStatus
}

NodeProperties - This class represents the nodes in a highly available cluster

func (NodeProperties) MarshalJSON added in v1.1.0 

func (n NodeProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NodeProperties.

func (*NodeProperties) UnmarshalJSON added in v1.1.0 

func (n *NodeProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NodeProperties.

type NodeStatus 

type NodeStatus string

NodeStatus - The current status of the individual node 

const (
	NodeStatusDown         NodeStatus = "Down"
	NodeStatusRebooting    NodeStatus = "Rebooting"
	NodeStatusShuttingDown NodeStatus = "ShuttingDown"
	NodeStatusUnknown      NodeStatus = "Unknown"
	NodeStatusUp           NodeStatus = "Up"
)

func PossibleNodeStatusValues 

func PossibleNodeStatusValues() []NodeStatus

PossibleNodeStatusValues returns the possible values for the NodeStatus const type.

type NodesClient 

type NodesClient struct {
	// contains filtered or unexported fields
}

NodesClient contains the methods for the Nodes group. Don't use this type directly, use NewNodesClient() instead.

func NewNodesClient 

func NewNodesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*NodesClient, error)

NewNodesClient creates a new instance of NodesClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*NodesClient) NewListByDataBoxEdgeDevicePager added in v0.4.0 

func (client *NodesClient) NewListByDataBoxEdgeDevicePager(deviceName string, resourceGroupName string, options *NodesClientListByDataBoxEdgeDeviceOptions) *runtime.Pager[NodesClientListByDataBoxEdgeDeviceResponse]

NewListByDataBoxEdgeDevicePager - Gets all the nodes currently configured under this Data Box Edge device

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - NodesClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the NodesClient.NewListByDataBoxEdgeDevicePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/NodeGetAllInDevice.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewNodesClient().NewListByDataBoxEdgeDevicePager("testedgedevice", "GroupForEdgeAutomation", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.NodeList = armdataboxedge.NodeList{
		// 	Value: []*armdataboxedge.Node{
		// 		{
		// 			Name: to.Ptr("1D6QHQ2"),
		// 			Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/nodes"),
		// 			ID: to.Ptr("/subscriptions/db4e2fdb-6d80-4e6e-b7cd-736098270664/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/testedgedevice/nodes/1D6QHQ2"),
		// 			Properties: &armdataboxedge.NodeProperties{
		// 				NodeChassisSerialNumber: to.Ptr("1D6QHQ2"),
		// 				NodeDisplayName: to.Ptr("Controller 1"),
		// 				NodeFriendlySoftwareVersion: to.Ptr("Data Box Edge 1908"),
		// 				NodeHcsVersion: to.Ptr("1.6.961.8307"),
		// 				NodeInstanceID: to.Ptr("ad051874-7d27-4ac4-a7b1-b6f231d8a035"),
		// 				NodeSerialNumber: to.Ptr("1D6QHQ2"),
		// 				NodeStatus: to.Ptr(armdataboxedge.NodeStatusUnknown),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("1DCNHQ2"),
		// 			Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/nodes"),
		// 			ID: to.Ptr("/subscriptions/db4e2fdb-6d80-4e6e-b7cd-736098270664/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/testedgedevice/nodes/1DCNHQ2"),
		// 			Properties: &armdataboxedge.NodeProperties{
		// 				NodeChassisSerialNumber: to.Ptr("1D6QHQ2"),
		// 				NodeDisplayName: to.Ptr("Controller 1"),
		// 				NodeFriendlySoftwareVersion: to.Ptr("Data Box Edge 1908"),
		// 				NodeHcsVersion: to.Ptr("1.6.961.8307"),
		// 				NodeInstanceID: to.Ptr("ddf3a76d-ada4-44af-99c6-a69a0e21bcb6"),
		// 				NodeSerialNumber: to.Ptr("1DCNHQ2"),
		// 				NodeStatus: to.Ptr(armdataboxedge.NodeStatusUnknown),
		// 			},
		// 	}},
		// }
	}
}

Output:

type NodesClientListByDataBoxEdgeDeviceOptions added in v0.2.0 

type NodesClientListByDataBoxEdgeDeviceOptions struct {
}

NodesClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the NodesClient.NewListByDataBoxEdgeDevicePager method.

type NodesClientListByDataBoxEdgeDeviceResponse added in v0.2.0 

type NodesClientListByDataBoxEdgeDeviceResponse struct {
	// Collection of Nodes.
	NodeList
}

NodesClientListByDataBoxEdgeDeviceResponse contains the response from method NodesClient.NewListByDataBoxEdgeDevicePager.

type NumaNodeData added in v0.3.0 

type NumaNodeData struct {
	// The effective available memory on the NUMA node in MB.
	EffectiveAvailableMemoryInMb *int64

	// The free VCPU indices for the Hpn VMs.
	FreeVCPUIndexesForHpn []*int32

	// The logical cores per core count.
	LogicalCoreCountPerCore *int32

	// The NUMA node index.
	NumaNodeIndex *int32

	// The total memory on the NUMA node.
	TotalMemoryInMb *int64

	// The VCPU indices for Hpn VMs
	VCPUIndexesForHpn []*int32

	// The VCPU indices for the root.
	VCPUIndexesForRoot []*int32
}

NumaNodeData - NUMA node data.

func (NumaNodeData) MarshalJSON added in v0.3.0 

func (n NumaNodeData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NumaNodeData.

func (*NumaNodeData) UnmarshalJSON added in v1.1.0 

func (n *NumaNodeData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NumaNodeData.

type Operation 

type Operation struct {
	// Properties displayed for the operation.
	Display *OperationDisplay

	// Is data action.
	IsDataAction *bool

	// Name of the operation.
	Name *string

	// Origin of the operation.
	Origin *string

	// Operation properties.
	Properties *OperationProperties
}

Operations.

func (Operation) MarshalJSON added in v1.1.0 

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Operation.

func (*Operation) UnmarshalJSON added in v1.1.0 

func (o *Operation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Operation.

type OperationDisplay 

type OperationDisplay struct {
	// Description of the operation to be performed.
	Description *string

	// Operation to be performed on the resource.
	Operation *string

	// Provider name.
	Provider *string

	// The type of resource in which the operation is performed.
	Resource *string
}

OperationDisplay - Operation display properties.

func (OperationDisplay) MarshalJSON added in v1.1.0 

func (o OperationDisplay) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationDisplay.

func (*OperationDisplay) UnmarshalJSON added in v1.1.0 

func (o *OperationDisplay) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationDisplay.

type OperationProperties 

type OperationProperties struct {
	// Service specification.
	ServiceSpecification *ServiceSpecification
}

OperationProperties - Operation properties.

func (OperationProperties) MarshalJSON added in v1.1.0 

func (o OperationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationProperties.

func (*OperationProperties) UnmarshalJSON added in v1.1.0 

func (o *OperationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationProperties.

type OperationsClient 

type OperationsClient struct {
	// contains filtered or unexported fields
}

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

NewOperationsClient creates a new instance of OperationsClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*OperationsClient) NewListPager added in v0.4.0 

func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]

NewListPager - List all the supported operations.

Generated from API version 2022-03-01

  • options - OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/OperationsGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewOperationsClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.OperationsList = armdataboxedge.OperationsList{
		// 	Value: []*armdataboxedge.Operation{
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/read"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Lists or gets the share users"),
		// 				Operation: to.Ptr("List share users"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("share users"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/read"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Lists or gets the share users"),
		// 				Operation: to.Ptr("List share users"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("share users"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/write"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Creates or updates the share users"),
		// 				Operation: to.Ptr("Creates or updates share users"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("share users"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/delete"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Deletes the share users"),
		// 				Operation: to.Ptr("Delete share users"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("share users"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/read"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Lists or gets the bandwidth schedules"),
		// 				Operation: to.Ptr("List bandwidth schedules"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("bandwidth schedules"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/read"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Lists or gets the bandwidth schedules"),
		// 				Operation: to.Ptr("List bandwidth schedules"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("bandwidth schedules"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/write"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Creates or updates the bandwidth schedules"),
		// 				Operation: to.Ptr("Creates or updates bandwidth schedules"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("bandwidth schedules"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/delete"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Deletes the bandwidth schedules"),
		// 				Operation: to.Ptr("Delete bandwidth schedules"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("bandwidth schedules"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/read"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Lists or gets the ArmApiRes_roles"),
		// 				Operation: to.Ptr("List ArmApiRes_roles"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("ArmApiRes_roles"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/read"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Lists or gets the ArmApiRes_roles"),
		// 				Operation: to.Ptr("List ArmApiRes_roles"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("ArmApiRes_roles"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/write"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Creates or updates the ArmApiRes_roles"),
		// 				Operation: to.Ptr("Creates or updates ArmApiRes_roles"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("ArmApiRes_roles"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/delete"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Deletes the ArmApiRes_roles"),
		// 				Operation: to.Ptr("Delete ArmApiRes_roles"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("ArmApiRes_roles"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/read"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Lists or gets the shares"),
		// 				Operation: to.Ptr("List shares"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("shares"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/read"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Lists or gets the shares"),
		// 				Operation: to.Ptr("List shares"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("shares"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/write"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Creates or updates the shares"),
		// 				Operation: to.Ptr("Creates or updates shares"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("shares"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/refresh/action"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("ArmApiDesc_action_refresh_shares"),
		// 				Operation: to.Ptr("ArmApiOp_action_refresh_shares"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("shares"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/delete"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Deletes the shares"),
		// 				Operation: to.Ptr("Delete shares"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("shares"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/uploadCertificate/action"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Upload certificate for device registration"),
		// 				Operation: to.Ptr("Upload certificates"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("Data Box Edge devices"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/write"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Creates or updates the Data Box Edge devices"),
		// 				Operation: to.Ptr("Creates or updates Data Box Edge devices"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("Data Box Edge devices"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/read"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Lists or gets the Data Box Edge devices"),
		// 				Operation: to.Ptr("List Data Box Edge devices"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("Data Box Edge devices"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/delete"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Deletes the Data Box Edge devices"),
		// 				Operation: to.Ptr("Delete Data Box Edge devices"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("Data Box Edge devices"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/read"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Lists or gets the Data Box Edge devices"),
		// 				Operation: to.Ptr("List Data Box Edge devices"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("Data Box Edge devices"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/read"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Lists or gets the Data Box Edge devices"),
		// 				Operation: to.Ptr("List Data Box Edge devices"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("Data Box Edge devices"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/write"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Creates or updates the Data Box Edge devices"),
		// 				Operation: to.Ptr("Creates or updates Data Box Edge devices"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("Data Box Edge devices"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/getExtendedInformation/action"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("ArmApiDesc_action_getExtendedInformation_dataBoxEdgeDevices"),
		// 				Operation: to.Ptr("ArmApiOp_action_getExtendedInformation_dataBoxEdgeDevices"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("Data Box Edge devices"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/extendedInformation/action"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Retrieves resource extended information"),
		// 				Operation: to.Ptr("Gets resource extended information"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("Data Box Edge devices"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/networkSettings/read"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Lists or gets the Device network settings"),
		// 				Operation: to.Ptr("List Device network settings"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("Device network settings"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/securitySettings/update/action"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Update security settings"),
		// 				Operation: to.Ptr("Update security settings"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("Device security settings"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/updateSummary/read"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Lists or gets the update summary"),
		// 				Operation: to.Ptr("List update summary"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("update summary"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/scanForUpdates/action"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Scan for updates"),
		// 				Operation: to.Ptr("Scan for updates"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("Data Box Edge devices"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/downloadUpdates/action"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Download Updates in device"),
		// 				Operation: to.Ptr("Download Updates"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("Data Box Edge devices"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/installUpdates/action"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Install Updates on device"),
		// 				Operation: to.Ptr("Install Updates"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("Data Box Edge devices"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/jobs/read"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Lists or gets the jobs"),
		// 				Operation: to.Ptr("List jobs"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("jobs"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/write"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Creates or updates the storage account credentials"),
		// 				Operation: to.Ptr("Creates or updates storage account credentials"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("storage account credentials"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/read"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Lists or gets the storage account credentials"),
		// 				Operation: to.Ptr("List storage account credentials"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("storage account credentials"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/read"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Lists or gets the storage account credentials"),
		// 				Operation: to.Ptr("List storage account credentials"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("storage account credentials"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/delete"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Deletes the storage account credentials"),
		// 				Operation: to.Ptr("Delete storage account credentials"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("storage account credentials"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/alerts/read"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Lists or gets the alerts"),
		// 				Operation: to.Ptr("List alerts"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("alerts"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/alerts/read"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Lists or gets the alerts"),
		// 				Operation: to.Ptr("List alerts"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("alerts"),
		// 			},
		// 			Origin: to.Ptr("user"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/metricDefinitions/read"),
		// 			Display: &armdataboxedge.OperationDisplay{
		// 				Description: to.Ptr("Gets the available Data Box Edge device level metrics"),
		// 				Operation: to.Ptr("Read Data Box Edge device metric definition"),
		// 				Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 				Resource: to.Ptr("Data Box Edge device"),
		// 			},
		// 			Origin: to.Ptr("system"),
		// 			Properties: &armdataboxedge.OperationProperties{
		// 				ServiceSpecification: &armdataboxedge.ServiceSpecification{
		// 					MetricSpecifications: []*armdataboxedge.MetricSpecificationV1{
		// 						{
		// 							Name: to.Ptr("NICReadThroughput"),
		// 							AggregationType: to.Ptr(armdataboxedge.MetricAggregationTypeAverage),
		// 							Category: to.Ptr(armdataboxedge.MetricCategoryTransaction),
		// 							Dimensions: []*armdataboxedge.MetricDimensionV1{
		// 								{
		// 									Name: to.Ptr("InstanceName"),
		// 									DisplayName: to.Ptr("Name"),
		// 									ToBeExportedForShoebox: to.Ptr(true),
		// 							}},
		// 							DisplayDescription: to.Ptr("The read throughput of the network interface on the device in the reporting period for all volumes in the gateway."),
		// 							DisplayName: to.Ptr("Read Throughput (Network)"),
		// 							FillGapWithZero: to.Ptr(false),
		// 							SupportedAggregationTypes: []*armdataboxedge.MetricAggregationType{
		// 								to.Ptr(armdataboxedge.MetricAggregationTypeAverage),
		// 								to.Ptr(armdataboxedge.MetricAggregationTypeMinimum),
		// 								to.Ptr(armdataboxedge.MetricAggregationTypeMaximum)},
		// 								SupportedTimeGrainTypes: []*armdataboxedge.TimeGrain{
		// 									to.Ptr(armdataboxedge.TimeGrainPT1M),
		// 									to.Ptr(armdataboxedge.TimeGrainPT15M),
		// 									to.Ptr(armdataboxedge.TimeGrainPT1H)},
		// 									Unit: to.Ptr(armdataboxedge.MetricUnitBytesPerSecond),
		// 								},
		// 								{
		// 									Name: to.Ptr("NICWriteThroughput"),
		// 									AggregationType: to.Ptr(armdataboxedge.MetricAggregationTypeAverage),
		// 									Category: to.Ptr(armdataboxedge.MetricCategoryTransaction),
		// 									Dimensions: []*armdataboxedge.MetricDimensionV1{
		// 										{
		// 											Name: to.Ptr("InstanceName"),
		// 											DisplayName: to.Ptr("Name"),
		// 											ToBeExportedForShoebox: to.Ptr(true),
		// 									}},
		// 									DisplayDescription: to.Ptr("The write throughput of the network interface on the device in the reporting period for all volumes in the gateway."),
		// 									DisplayName: to.Ptr("Write Throughput (Network)"),
		// 									FillGapWithZero: to.Ptr(false),
		// 									SupportedAggregationTypes: []*armdataboxedge.MetricAggregationType{
		// 										to.Ptr(armdataboxedge.MetricAggregationTypeAverage),
		// 										to.Ptr(armdataboxedge.MetricAggregationTypeMinimum),
		// 										to.Ptr(armdataboxedge.MetricAggregationTypeMaximum)},
		// 										SupportedTimeGrainTypes: []*armdataboxedge.TimeGrain{
		// 											to.Ptr(armdataboxedge.TimeGrainPT1M),
		// 											to.Ptr(armdataboxedge.TimeGrainPT15M),
		// 											to.Ptr(armdataboxedge.TimeGrainPT1H)},
		// 											Unit: to.Ptr(armdataboxedge.MetricUnitBytesPerSecond),
		// 										},
		// 										{
		// 											Name: to.Ptr("CloudReadThroughputPerShare"),
		// 											AggregationType: to.Ptr(armdataboxedge.MetricAggregationTypeAverage),
		// 											Category: to.Ptr(armdataboxedge.MetricCategoryTransaction),
		// 											Dimensions: []*armdataboxedge.MetricDimensionV1{
		// 												{
		// 													Name: to.Ptr("Share"),
		// 													DisplayName: to.Ptr("Share"),
		// 													ToBeExportedForShoebox: to.Ptr(true),
		// 											}},
		// 											DisplayDescription: to.Ptr("The download throughput to Azure from a share during the reporting period."),
		// 											DisplayName: to.Ptr("Cloud Download Throughput (Share)"),
		// 											FillGapWithZero: to.Ptr(false),
		// 											SupportedAggregationTypes: []*armdataboxedge.MetricAggregationType{
		// 												to.Ptr(armdataboxedge.MetricAggregationTypeAverage),
		// 												to.Ptr(armdataboxedge.MetricAggregationTypeMinimum),
		// 												to.Ptr(armdataboxedge.MetricAggregationTypeMaximum)},
		// 												SupportedTimeGrainTypes: []*armdataboxedge.TimeGrain{
		// 													to.Ptr(armdataboxedge.TimeGrainPT1M),
		// 													to.Ptr(armdataboxedge.TimeGrainPT15M),
		// 													to.Ptr(armdataboxedge.TimeGrainPT1H)},
		// 													Unit: to.Ptr(armdataboxedge.MetricUnitBytesPerSecond),
		// 												},
		// 												{
		// 													Name: to.Ptr("CloudUploadThroughputPerShare"),
		// 													AggregationType: to.Ptr(armdataboxedge.MetricAggregationTypeAverage),
		// 													Category: to.Ptr(armdataboxedge.MetricCategoryTransaction),
		// 													Dimensions: []*armdataboxedge.MetricDimensionV1{
		// 														{
		// 															Name: to.Ptr("Share"),
		// 															DisplayName: to.Ptr("Share"),
		// 															ToBeExportedForShoebox: to.Ptr(true),
		// 													}},
		// 													DisplayDescription: to.Ptr("The upload throughput to Azure from a share during the reporting period."),
		// 													DisplayName: to.Ptr("Cloud Upload Throughput (Share)"),
		// 													FillGapWithZero: to.Ptr(false),
		// 													SupportedAggregationTypes: []*armdataboxedge.MetricAggregationType{
		// 														to.Ptr(armdataboxedge.MetricAggregationTypeAverage),
		// 														to.Ptr(armdataboxedge.MetricAggregationTypeMinimum),
		// 														to.Ptr(armdataboxedge.MetricAggregationTypeMaximum)},
		// 														SupportedTimeGrainTypes: []*armdataboxedge.TimeGrain{
		// 															to.Ptr(armdataboxedge.TimeGrainPT1M),
		// 															to.Ptr(armdataboxedge.TimeGrainPT15M),
		// 															to.Ptr(armdataboxedge.TimeGrainPT1H)},
		// 															Unit: to.Ptr(armdataboxedge.MetricUnitBytesPerSecond),
		// 														},
		// 														{
		// 															Name: to.Ptr("BytesUploadedToCloudPerShare"),
		// 															AggregationType: to.Ptr(armdataboxedge.MetricAggregationTypeAverage),
		// 															Category: to.Ptr(armdataboxedge.MetricCategoryTransaction),
		// 															Dimensions: []*armdataboxedge.MetricDimensionV1{
		// 																{
		// 																	Name: to.Ptr("Share"),
		// 																	DisplayName: to.Ptr("Share"),
		// 																	ToBeExportedForShoebox: to.Ptr(true),
		// 															}},
		// 															DisplayDescription: to.Ptr("The total number of bytes that is uploaded to Azure from a share during the reporting period."),
		// 															DisplayName: to.Ptr("Cloud Bytes Uploaded (Share)"),
		// 															FillGapWithZero: to.Ptr(false),
		// 															SupportedAggregationTypes: []*armdataboxedge.MetricAggregationType{
		// 																to.Ptr(armdataboxedge.MetricAggregationTypeAverage),
		// 																to.Ptr(armdataboxedge.MetricAggregationTypeMinimum),
		// 																to.Ptr(armdataboxedge.MetricAggregationTypeMaximum)},
		// 																SupportedTimeGrainTypes: []*armdataboxedge.TimeGrain{
		// 																	to.Ptr(armdataboxedge.TimeGrainPT1M),
		// 																	to.Ptr(armdataboxedge.TimeGrainPT15M),
		// 																	to.Ptr(armdataboxedge.TimeGrainPT1H)},
		// 																	Unit: to.Ptr(armdataboxedge.MetricUnitBytes),
		// 																},
		// 																{
		// 																	Name: to.Ptr("TotalCapacity"),
		// 																	AggregationType: to.Ptr(armdataboxedge.MetricAggregationTypeAverage),
		// 																	Category: to.Ptr(armdataboxedge.MetricCategoryCapacity),
		// 																	Dimensions: []*armdataboxedge.MetricDimensionV1{
		// 																	},
		// 																	DisplayDescription: to.Ptr("Total Capacity"),
		// 																	DisplayName: to.Ptr("Total Capacity"),
		// 																	FillGapWithZero: to.Ptr(false),
		// 																	SupportedAggregationTypes: []*armdataboxedge.MetricAggregationType{
		// 																		to.Ptr(armdataboxedge.MetricAggregationTypeAverage),
		// 																		to.Ptr(armdataboxedge.MetricAggregationTypeMinimum),
		// 																		to.Ptr(armdataboxedge.MetricAggregationTypeMaximum)},
		// 																		SupportedTimeGrainTypes: []*armdataboxedge.TimeGrain{
		// 																			to.Ptr(armdataboxedge.TimeGrainPT5M),
		// 																			to.Ptr(armdataboxedge.TimeGrainPT15M),
		// 																			to.Ptr(armdataboxedge.TimeGrainPT1H)},
		// 																			Unit: to.Ptr(armdataboxedge.MetricUnitBytes),
		// 																		},
		// 																		{
		// 																			Name: to.Ptr("AvailableCapacity"),
		// 																			AggregationType: to.Ptr(armdataboxedge.MetricAggregationTypeAverage),
		// 																			Category: to.Ptr(armdataboxedge.MetricCategoryCapacity),
		// 																			Dimensions: []*armdataboxedge.MetricDimensionV1{
		// 																			},
		// 																			DisplayDescription: to.Ptr("The available capacity in bytes during the reporting period."),
		// 																			DisplayName: to.Ptr("Available Capacity"),
		// 																			FillGapWithZero: to.Ptr(false),
		// 																			SupportedAggregationTypes: []*armdataboxedge.MetricAggregationType{
		// 																				to.Ptr(armdataboxedge.MetricAggregationTypeAverage),
		// 																				to.Ptr(armdataboxedge.MetricAggregationTypeMinimum),
		// 																				to.Ptr(armdataboxedge.MetricAggregationTypeMaximum)},
		// 																				SupportedTimeGrainTypes: []*armdataboxedge.TimeGrain{
		// 																					to.Ptr(armdataboxedge.TimeGrainPT5M),
		// 																					to.Ptr(armdataboxedge.TimeGrainPT15M),
		// 																					to.Ptr(armdataboxedge.TimeGrainPT1H)},
		// 																					Unit: to.Ptr(armdataboxedge.MetricUnitBytes),
		// 																				},
		// 																				{
		// 																					Name: to.Ptr("CloudUploadThroughput"),
		// 																					AggregationType: to.Ptr(armdataboxedge.MetricAggregationTypeAverage),
		// 																					Category: to.Ptr(armdataboxedge.MetricCategoryTransaction),
		// 																					Dimensions: []*armdataboxedge.MetricDimensionV1{
		// 																					},
		// 																					DisplayDescription: to.Ptr("The cloud upload throughput during the reporting period."),
		// 																					DisplayName: to.Ptr("Cloud Upload Throughput"),
		// 																					FillGapWithZero: to.Ptr(false),
		// 																					SupportedAggregationTypes: []*armdataboxedge.MetricAggregationType{
		// 																						to.Ptr(armdataboxedge.MetricAggregationTypeAverage),
		// 																						to.Ptr(armdataboxedge.MetricAggregationTypeMinimum),
		// 																						to.Ptr(armdataboxedge.MetricAggregationTypeMaximum)},
		// 																						SupportedTimeGrainTypes: []*armdataboxedge.TimeGrain{
		// 																							to.Ptr(armdataboxedge.TimeGrainPT5M),
		// 																							to.Ptr(armdataboxedge.TimeGrainPT15M),
		// 																							to.Ptr(armdataboxedge.TimeGrainPT1H)},
		// 																							Unit: to.Ptr(armdataboxedge.MetricUnitBytesPerSecond),
		// 																						},
		// 																						{
		// 																							Name: to.Ptr("CloudReadThroughput"),
		// 																							AggregationType: to.Ptr(armdataboxedge.MetricAggregationTypeAverage),
		// 																							Category: to.Ptr(armdataboxedge.MetricCategoryTransaction),
		// 																							Dimensions: []*armdataboxedge.MetricDimensionV1{
		// 																							},
		// 																							DisplayDescription: to.Ptr("The cloud download throughput during the reporting period."),
		// 																							DisplayName: to.Ptr("Cloud Read Throughput"),
		// 																							FillGapWithZero: to.Ptr(false),
		// 																							SupportedAggregationTypes: []*armdataboxedge.MetricAggregationType{
		// 																								to.Ptr(armdataboxedge.MetricAggregationTypeAverage),
		// 																								to.Ptr(armdataboxedge.MetricAggregationTypeMinimum),
		// 																								to.Ptr(armdataboxedge.MetricAggregationTypeMaximum)},
		// 																								SupportedTimeGrainTypes: []*armdataboxedge.TimeGrain{
		// 																									to.Ptr(armdataboxedge.TimeGrainPT5M),
		// 																									to.Ptr(armdataboxedge.TimeGrainPT15M),
		// 																									to.Ptr(armdataboxedge.TimeGrainPT1H)},
		// 																									Unit: to.Ptr(armdataboxedge.MetricUnitBytesPerSecond),
		// 																								},
		// 																								{
		// 																									Name: to.Ptr("BytesUploadedToCloud"),
		// 																									AggregationType: to.Ptr(armdataboxedge.MetricAggregationTypeAverage),
		// 																									Category: to.Ptr(armdataboxedge.MetricCategoryTransaction),
		// 																									Dimensions: []*armdataboxedge.MetricDimensionV1{
		// 																									},
		// 																									DisplayDescription: to.Ptr("The total number of bytes that is uploaded to Azure from a device during the reporting period."),
		// 																									DisplayName: to.Ptr("Cloud Bytes Uploaded (Device)"),
		// 																									FillGapWithZero: to.Ptr(false),
		// 																									SupportedAggregationTypes: []*armdataboxedge.MetricAggregationType{
		// 																										to.Ptr(armdataboxedge.MetricAggregationTypeAverage),
		// 																										to.Ptr(armdataboxedge.MetricAggregationTypeMinimum),
		// 																										to.Ptr(armdataboxedge.MetricAggregationTypeMaximum)},
		// 																										SupportedTimeGrainTypes: []*armdataboxedge.TimeGrain{
		// 																											to.Ptr(armdataboxedge.TimeGrainPT5M),
		// 																											to.Ptr(armdataboxedge.TimeGrainPT15M),
		// 																											to.Ptr(armdataboxedge.TimeGrainPT1H)},
		// 																											Unit: to.Ptr(armdataboxedge.MetricUnitBytes),
		// 																									}},
		// 																								},
		// 																							},
		// 																						},
		// 																						{
		// 																							Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/diagnosticSettings/write"),
		// 																							Display: &armdataboxedge.OperationDisplay{
		// 																								Description: to.Ptr("Creates or updates the diagnostics setting for the resource"),
		// 																								Operation: to.Ptr("Write diagnostics setting"),
		// 																								Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 																								Resource: to.Ptr("Data Box Edge device"),
		// 																							},
		// 																							Origin: to.Ptr("system"),
		// 																						},
		// 																						{
		// 																							Name: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/diagnosticSettings/read"),
		// 																							Display: &armdataboxedge.OperationDisplay{
		// 																								Description: to.Ptr("Gets the diagnostic setting for the resource"),
		// 																								Operation: to.Ptr("Read diagnostics setting"),
		// 																								Provider: to.Ptr("Microsoft.DataBoxEdge"),
		// 																								Resource: to.Ptr("Data Box Edge device"),
		// 																							},
		// 																							Origin: to.Ptr("system"),
		// 																					}},
		// 																				}
	}
}

Output:

type OperationsClientListOptions added in v0.2.0 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.

type OperationsClientListResponse added in v0.2.0 

type OperationsClientListResponse struct {
	// The list of operations used for the discovery of available provider operations.
	OperationsList
}

OperationsClientListResponse contains the response from method OperationsClient.NewListPager.

type OperationsList 

type OperationsList struct {
	// REQUIRED; The value.
	Value []*Operation

	// Link to the next set of results.
	NextLink *string
}

OperationsList - The list of operations used for the discovery of available provider operations.

func (OperationsList) MarshalJSON 

func (o OperationsList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationsList.

func (*OperationsList) UnmarshalJSON added in v1.1.0 

func (o *OperationsList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationsList.

type OperationsStatusClient 

type OperationsStatusClient struct {
	// contains filtered or unexported fields
}

OperationsStatusClient contains the methods for the OperationsStatus group. Don't use this type directly, use NewOperationsStatusClient() instead.

func NewOperationsStatusClient 

func NewOperationsStatusClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsStatusClient, error)

NewOperationsStatusClient creates a new instance of OperationsStatusClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*OperationsStatusClient) Get 

func (client *OperationsStatusClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string, options *OperationsStatusClientGetOptions) (OperationsStatusClientGetResponse, error)

Get - Gets the details of a specified job on a Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • name - The job name.
  • resourceGroupName - The resource group name.
  • options - OperationsStatusClientGetOptions contains the optional parameters for the OperationsStatusClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/OperationsStatusGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewOperationsStatusClient().Get(ctx, "testedgedevice", "159a00c7-8543-4343-9435-263ac87df3bb", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Job = armdataboxedge.Job{
	// 	Name: to.Ptr("159a00c7-8543-4343-9435-263ac87df3bb"),
	// 	EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-18T03:18:51.427Z"); return t}()),
	// 	ID: to.Ptr("/subscriptions/id/locations/westus/operationsStatus/159a00c7-8543-4343-9435-263ac87df3bb"),
	// 	PercentComplete: to.Ptr[int32](100),
	// 	Properties: &armdataboxedge.JobProperties{
	// 		CurrentStage: to.Ptr(armdataboxedge.UpdateOperationStageSuccess),
	// 		JobType: to.Ptr(armdataboxedge.JobTypeDownloadUpdates),
	// 	},
	// 	StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-18T02:18:51.427Z"); return t}()),
	// 	Status: to.Ptr(armdataboxedge.JobStatusSucceeded),
	// }
}

Output:

type OperationsStatusClientGetOptions added in v0.2.0 

type OperationsStatusClientGetOptions struct {
}

OperationsStatusClientGetOptions contains the optional parameters for the OperationsStatusClient.Get method.

type OperationsStatusClientGetResponse added in v0.2.0 

type OperationsStatusClientGetResponse struct {
	// A device job.
	Job
}

OperationsStatusClientGetResponse contains the response from method OperationsStatusClient.Get.

type Order 

type Order struct {
	// The order properties.
	Properties *OrderProperties

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; It specify the order api version.
	Kind *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of Order
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

Order - The order details.

func (Order) MarshalJSON 

func (o Order) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Order.

func (*Order) UnmarshalJSON 

func (o *Order) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Order.

type OrderList 

type OrderList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string

	// READ-ONLY; The list of orders.
	Value []*Order
}

OrderList - List of order entities.

func (OrderList) MarshalJSON 

func (o OrderList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OrderList.

func (*OrderList) UnmarshalJSON added in v1.1.0 

func (o *OrderList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OrderList.

type OrderProperties 

type OrderProperties struct {
	// REQUIRED; The contact details.
	ContactInformation *ContactDetails

	// ShipmentType of the order
	ShipmentType *ShipmentType

	// The shipping address.
	ShippingAddress *Address

	// READ-ONLY; Current status of the order.
	CurrentStatus *OrderStatus

	// READ-ONLY; Tracking information for the package delivered to the customer whether it has an original or a replacement device.
	DeliveryTrackingInfo []*TrackingInfo

	// READ-ONLY; List of status changes in the order.
	OrderHistory []*OrderStatus

	// READ-ONLY; It specify the order resource id.
	OrderID *string

	// READ-ONLY; Tracking information for the package returned from the customer whether it has an original or a replacement
	// device.
	ReturnTrackingInfo []*TrackingInfo

	// READ-ONLY; Serial number of the device.
	SerialNumber *string
}

OrderProperties - Order properties.

func (OrderProperties) MarshalJSON 

func (o OrderProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OrderProperties.

func (*OrderProperties) UnmarshalJSON added in v1.1.0 

func (o *OrderProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OrderProperties.

type OrderState 

type OrderState string

OrderState - Status of the order as per the allowed status types. 

const (
	OrderStateArriving               OrderState = "Arriving"
	OrderStateAwaitingDrop           OrderState = "AwaitingDrop"
	OrderStateAwaitingFulfillment    OrderState = "AwaitingFulfillment"
	OrderStateAwaitingPickup         OrderState = "AwaitingPickup"
	OrderStateAwaitingPreparation    OrderState = "AwaitingPreparation"
	OrderStateAwaitingReturnShipment OrderState = "AwaitingReturnShipment"
	OrderStateAwaitingShipment       OrderState = "AwaitingShipment"
	OrderStateCollectedAtMicrosoft   OrderState = "CollectedAtMicrosoft"
	OrderStateDeclined               OrderState = "Declined"
	OrderStateDelivered              OrderState = "Delivered"
	OrderStateLostDevice             OrderState = "LostDevice"
	OrderStatePickupCompleted        OrderState = "PickupCompleted"
	OrderStateReplacementRequested   OrderState = "ReplacementRequested"
	OrderStateReturnInitiated        OrderState = "ReturnInitiated"
	OrderStateShipped                OrderState = "Shipped"
	OrderStateShippedBack            OrderState = "ShippedBack"
	OrderStateUntracked              OrderState = "Untracked"
)

func PossibleOrderStateValues 

func PossibleOrderStateValues() []OrderState

PossibleOrderStateValues returns the possible values for the OrderState const type.

type OrderStatus 

type OrderStatus struct {
	// REQUIRED; Status of the order as per the allowed status types.
	Status *OrderState

	// Comments related to this status change.
	Comments *string

	// READ-ONLY; Dictionary to hold generic information which is not stored by the already existing properties
	AdditionalOrderDetails map[string]*string

	// READ-ONLY; Tracking information related to the state in the ordering flow
	TrackingInformation *TrackingInfo

	// READ-ONLY; Time of status update.
	UpdateDateTime *time.Time
}

OrderStatus - Represents a single status change.

func (OrderStatus) MarshalJSON 

func (o OrderStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OrderStatus.

func (*OrderStatus) UnmarshalJSON 

func (o *OrderStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OrderStatus.

type OrdersClient 

type OrdersClient struct {
	// contains filtered or unexported fields
}

OrdersClient contains the methods for the Orders group. Don't use this type directly, use NewOrdersClient() instead.

func NewOrdersClient 

func NewOrdersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*OrdersClient, error)

NewOrdersClient creates a new instance of OrdersClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*OrdersClient) BeginCreateOrUpdate 

func (client *OrdersClient) BeginCreateOrUpdate(ctx context.Context, deviceName string, resourceGroupName string, order Order, options *OrdersClientBeginCreateOrUpdateOptions) (*runtime.Poller[OrdersClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates an order. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The order details of a device.
  • resourceGroupName - The resource group name.
  • order - The order to be created or updated.
  • options - OrdersClientBeginCreateOrUpdateOptions contains the optional parameters for the OrdersClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/OrderPut.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewOrdersClient().BeginCreateOrUpdate(ctx, "testedgedevice", "GroupForEdgeAutomation", armdataboxedge.Order{
		Properties: &armdataboxedge.OrderProperties{
			ContactInformation: &armdataboxedge.ContactDetails{
				CompanyName:   to.Ptr("Microsoft"),
				ContactPerson: to.Ptr("John Mcclane"),
				EmailList: []*string{
					to.Ptr("john@microsoft.com")},
				Phone: to.Ptr("(800) 426-9400"),
			},
			ShippingAddress: &armdataboxedge.Address{
				AddressLine1: to.Ptr("Microsoft Corporation"),
				AddressLine2: to.Ptr("One Microsoft Way"),
				AddressLine3: to.Ptr("Redmond"),
				City:         to.Ptr("WA"),
				Country:      to.Ptr("USA"),
				PostalCode:   to.Ptr("98052"),
				State:        to.Ptr("WA"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Order = armdataboxedge.Order{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("dataBoxEdgeDevices/orders"),
	// 	ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default"),
	// 	Properties: &armdataboxedge.OrderProperties{
	// 		ContactInformation: &armdataboxedge.ContactDetails{
	// 			CompanyName: to.Ptr("Microsoft"),
	// 			ContactPerson: to.Ptr("John Mcclane"),
	// 			EmailList: []*string{
	// 				to.Ptr("john@microsoft.com")},
	// 				Phone: to.Ptr("(800) 426-9400"),
	// 			},
	// 			CurrentStatus: &armdataboxedge.OrderStatus{
	// 				Comments: to.Ptr(""),
	// 				Status: to.Ptr(armdataboxedge.OrderStateUntracked),
	// 				UpdateDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-10T07:59:05.847Z"); return t}()),
	// 			},
	// 			DeliveryTrackingInfo: []*armdataboxedge.TrackingInfo{
	// 			},
	// 			OrderHistory: []*armdataboxedge.OrderStatus{
	// 				{
	// 					Comments: to.Ptr("lorem ipsum"),
	// 					Status: to.Ptr(armdataboxedge.OrderStateUntracked),
	// 					UpdateDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-10T07:59:05.847Z"); return t}()),
	// 			}},
	// 			ReturnTrackingInfo: []*armdataboxedge.TrackingInfo{
	// 			},
	// 			SerialNumber: to.Ptr("UDS123NSDA123"),
	// 			ShippingAddress: &armdataboxedge.Address{
	// 				AddressLine1: to.Ptr("Microsoft Corporation"),
	// 				AddressLine2: to.Ptr("One Microsoft Way"),
	// 				AddressLine3: to.Ptr("Redmond"),
	// 				City: to.Ptr("WA"),
	// 				Country: to.Ptr("USA"),
	// 				PostalCode: to.Ptr("98052"),
	// 				State: to.Ptr("WA"),
	// 			},
	// 		},
	// 	}
}

Output:

func (*OrdersClient) BeginDelete 

func (client *OrdersClient) BeginDelete(ctx context.Context, deviceName string, resourceGroupName string, options *OrdersClientBeginDeleteOptions) (*runtime.Poller[OrdersClientDeleteResponse], error)

BeginDelete - Deletes the order related to the device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - OrdersClientBeginDeleteOptions contains the optional parameters for the OrdersClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/OrderDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewOrdersClient().BeginDelete(ctx, "testedgedevice", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*OrdersClient) Get 

func (client *OrdersClient) Get(ctx context.Context, deviceName string, resourceGroupName string, options *OrdersClientGetOptions) (OrdersClientGetResponse, error)

Get - Gets a specific order by name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - OrdersClientGetOptions contains the optional parameters for the OrdersClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/OrderGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewOrdersClient().Get(ctx, "testedgedevice", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Order = armdataboxedge.Order{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("dataBoxEdgeDevices/orders"),
	// 	ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default"),
	// 	Properties: &armdataboxedge.OrderProperties{
	// 		ContactInformation: &armdataboxedge.ContactDetails{
	// 			CompanyName: to.Ptr("Microsoft"),
	// 			ContactPerson: to.Ptr("John Mcclane"),
	// 			EmailList: []*string{
	// 				to.Ptr("john@microsoft.com")},
	// 				Phone: to.Ptr("(800) 426-9400"),
	// 			},
	// 			CurrentStatus: &armdataboxedge.OrderStatus{
	// 				Comments: to.Ptr(""),
	// 				Status: to.Ptr(armdataboxedge.OrderStateUntracked),
	// 				UpdateDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-10T07:59:05.847Z"); return t}()),
	// 			},
	// 			DeliveryTrackingInfo: []*armdataboxedge.TrackingInfo{
	// 			},
	// 			OrderHistory: []*armdataboxedge.OrderStatus{
	// 				{
	// 					Comments: to.Ptr("lorem ipsum"),
	// 					Status: to.Ptr(armdataboxedge.OrderStateUntracked),
	// 					UpdateDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-10T07:59:05.847Z"); return t}()),
	// 			}},
	// 			ReturnTrackingInfo: []*armdataboxedge.TrackingInfo{
	// 			},
	// 			SerialNumber: to.Ptr("UDS123NSDA123"),
	// 			ShippingAddress: &armdataboxedge.Address{
	// 				AddressLine1: to.Ptr("Microsoft Corporation"),
	// 				AddressLine2: to.Ptr("One Microsoft Way"),
	// 				AddressLine3: to.Ptr("Redmond"),
	// 				City: to.Ptr("WA"),
	// 				Country: to.Ptr("USA"),
	// 				PostalCode: to.Ptr("98052"),
	// 				State: to.Ptr("WA"),
	// 			},
	// 		},
	// 	}
}

Output:

func (*OrdersClient) ListDCAccessCode 

func (client *OrdersClient) ListDCAccessCode(ctx context.Context, deviceName string, resourceGroupName string, options *OrdersClientListDCAccessCodeOptions) (OrdersClientListDCAccessCodeResponse, error)

ListDCAccessCode - Gets the DCAccess Code If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name
  • resourceGroupName - The resource group name.
  • options - OrdersClientListDCAccessCodeOptions contains the optional parameters for the OrdersClient.ListDCAccessCode method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/GetDCAccessCode.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewOrdersClient().ListDCAccessCode(ctx, "testedgedevice", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DCAccessCode = armdataboxedge.DCAccessCode{
	// 	Properties: &armdataboxedge.DCAccessCodeProperties{
	// 		AuthCode: to.Ptr("_sv7-NY2"),
	// 	},
	// }
}

Output:

func (*OrdersClient) NewListByDataBoxEdgeDevicePager added in v0.4.0 

func (client *OrdersClient) NewListByDataBoxEdgeDevicePager(deviceName string, resourceGroupName string, options *OrdersClientListByDataBoxEdgeDeviceOptions) *runtime.Pager[OrdersClientListByDataBoxEdgeDeviceResponse]

NewListByDataBoxEdgeDevicePager - Lists all the orders related to a Data Box Edge/Data Box Gateway device.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - OrdersClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the OrdersClient.NewListByDataBoxEdgeDevicePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/OrderGetAllInDevice.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewOrdersClient().NewListByDataBoxEdgeDevicePager("testedgedevice", "GroupForEdgeAutomation", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.OrderList = armdataboxedge.OrderList{
		// 	Value: []*armdataboxedge.Order{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("dataBoxEdgeDevices/orders"),
		// 			ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default"),
		// 			Properties: &armdataboxedge.OrderProperties{
		// 				ContactInformation: &armdataboxedge.ContactDetails{
		// 					CompanyName: to.Ptr("Microsoft"),
		// 					ContactPerson: to.Ptr("John Mcclane"),
		// 					EmailList: []*string{
		// 						to.Ptr("john@microsoft.com")},
		// 						Phone: to.Ptr("(800) 426-9400"),
		// 					},
		// 					CurrentStatus: &armdataboxedge.OrderStatus{
		// 						Comments: to.Ptr(""),
		// 						Status: to.Ptr(armdataboxedge.OrderStateUntracked),
		// 						UpdateDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-10T07:59:05.847Z"); return t}()),
		// 					},
		// 					DeliveryTrackingInfo: []*armdataboxedge.TrackingInfo{
		// 					},
		// 					OrderHistory: []*armdataboxedge.OrderStatus{
		// 						{
		// 							Comments: to.Ptr("lorem ipsum"),
		// 							Status: to.Ptr(armdataboxedge.OrderStateUntracked),
		// 							UpdateDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-10T07:59:05.847Z"); return t}()),
		// 					}},
		// 					ReturnTrackingInfo: []*armdataboxedge.TrackingInfo{
		// 					},
		// 					SerialNumber: to.Ptr("UDS123NSDA123"),
		// 					ShippingAddress: &armdataboxedge.Address{
		// 						AddressLine1: to.Ptr("Microsoft Corporation"),
		// 						AddressLine2: to.Ptr("One Microsoft Way"),
		// 						AddressLine3: to.Ptr("Redmond"),
		// 						City: to.Ptr("WA"),
		// 						Country: to.Ptr("USA"),
		// 						PostalCode: to.Ptr("98052"),
		// 						State: to.Ptr("WA"),
		// 					},
		// 				},
		// 		}},
		// 	}
	}
}

Output:

type OrdersClientBeginCreateOrUpdateOptions added in v0.2.0 

type OrdersClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

OrdersClientBeginCreateOrUpdateOptions contains the optional parameters for the OrdersClient.BeginCreateOrUpdate method.

type OrdersClientBeginDeleteOptions added in v0.2.0 

type OrdersClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

OrdersClientBeginDeleteOptions contains the optional parameters for the OrdersClient.BeginDelete method.

type OrdersClientCreateOrUpdateResponse added in v0.2.0 

type OrdersClientCreateOrUpdateResponse struct {
	// The order details.
	Order
}

OrdersClientCreateOrUpdateResponse contains the response from method OrdersClient.BeginCreateOrUpdate.

type OrdersClientDeleteResponse added in v0.2.0 

type OrdersClientDeleteResponse struct {
}

OrdersClientDeleteResponse contains the response from method OrdersClient.BeginDelete.

type OrdersClientGetOptions added in v0.2.0 

type OrdersClientGetOptions struct {
}

OrdersClientGetOptions contains the optional parameters for the OrdersClient.Get method.

type OrdersClientGetResponse added in v0.2.0 

type OrdersClientGetResponse struct {
	// The order details.
	Order
}

OrdersClientGetResponse contains the response from method OrdersClient.Get.

type OrdersClientListByDataBoxEdgeDeviceOptions added in v0.2.0 

type OrdersClientListByDataBoxEdgeDeviceOptions struct {
}

OrdersClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the OrdersClient.NewListByDataBoxEdgeDevicePager method.

type OrdersClientListByDataBoxEdgeDeviceResponse added in v0.2.0 

type OrdersClientListByDataBoxEdgeDeviceResponse struct {
	// List of order entities.
	OrderList
}

OrdersClientListByDataBoxEdgeDeviceResponse contains the response from method OrdersClient.NewListByDataBoxEdgeDevicePager.

type OrdersClientListDCAccessCodeOptions added in v0.2.0 

type OrdersClientListDCAccessCodeOptions struct {
}

OrdersClientListDCAccessCodeOptions contains the optional parameters for the OrdersClient.ListDCAccessCode method.

type OrdersClientListDCAccessCodeResponse added in v0.2.0 

type OrdersClientListDCAccessCodeResponse struct {
	// DC Access code in the case of Self Managed Shipping.
	DCAccessCode
}

OrdersClientListDCAccessCodeResponse contains the response from method OrdersClient.ListDCAccessCode.

type PeriodicTimerEventTrigger 

type PeriodicTimerEventTrigger struct {
	// REQUIRED; Trigger Kind.
	Kind *TriggerEventType

	// REQUIRED; Periodic timer trigger properties.
	Properties *PeriodicTimerProperties

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of Trigger
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

PeriodicTimerEventTrigger - Trigger details.

func (*PeriodicTimerEventTrigger) GetTrigger added in v0.2.0 

func (p *PeriodicTimerEventTrigger) GetTrigger() *Trigger

GetTrigger implements the TriggerClassification interface for type PeriodicTimerEventTrigger.

func (PeriodicTimerEventTrigger) MarshalJSON 

func (p PeriodicTimerEventTrigger) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeriodicTimerEventTrigger.

func (*PeriodicTimerEventTrigger) UnmarshalJSON 

func (p *PeriodicTimerEventTrigger) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PeriodicTimerEventTrigger.

type PeriodicTimerProperties 

type PeriodicTimerProperties struct {
	// REQUIRED; Role Sink information.
	SinkInfo *RoleSinkInfo

	// REQUIRED; Periodic timer details.
	SourceInfo *PeriodicTimerSourceInfo

	// A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger
	// is intended for certain specific IoT modules in the device, the tag can be the
	// name or the image URL of the module.
	CustomContextTag *string
}

PeriodicTimerProperties - Periodic timer trigger properties.

func (PeriodicTimerProperties) MarshalJSON added in v1.1.0 

func (p PeriodicTimerProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeriodicTimerProperties.

func (*PeriodicTimerProperties) UnmarshalJSON added in v1.1.0 

func (p *PeriodicTimerProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PeriodicTimerProperties.

type PeriodicTimerSourceInfo 

type PeriodicTimerSourceInfo struct {
	// REQUIRED; Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds.
	Schedule *string

	// REQUIRED; The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified
	// upto seconds. If timezone is not specified the time will considered to be in device
	// timezone. The value will always be returned as UTC time.
	StartTime *time.Time

	// Topic where periodic events are published to IoT device.
	Topic *string
}

PeriodicTimerSourceInfo - Periodic timer event source.

func (PeriodicTimerSourceInfo) MarshalJSON 

func (p PeriodicTimerSourceInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeriodicTimerSourceInfo.

func (*PeriodicTimerSourceInfo) UnmarshalJSON 

func (p *PeriodicTimerSourceInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PeriodicTimerSourceInfo.

type PlatformType 

type PlatformType string

PlatformType - Host OS supported by the Arc addon. 

const (
	PlatformTypeLinux   PlatformType = "Linux"
	PlatformTypeWindows PlatformType = "Windows"
)

func PossiblePlatformTypeValues 

func PossiblePlatformTypeValues() []PlatformType

PossiblePlatformTypeValues returns the possible values for the PlatformType const type.

type PosixComplianceStatus 

type PosixComplianceStatus string

PosixComplianceStatus - If provisioned storage is posix compliant. 

const (
	PosixComplianceStatusDisabled PosixComplianceStatus = "Disabled"
	PosixComplianceStatusEnabled  PosixComplianceStatus = "Enabled"
	PosixComplianceStatusInvalid  PosixComplianceStatus = "Invalid"
)

func PossiblePosixComplianceStatusValues 

func PossiblePosixComplianceStatusValues() []PosixComplianceStatus

PossiblePosixComplianceStatusValues returns the possible values for the PosixComplianceStatus const type.

type ProactiveDiagnosticsConsent 

type ProactiveDiagnosticsConsent string

ProactiveDiagnosticsConsent - Proactive diagnostic collection consent flag 

const (
	ProactiveDiagnosticsConsentDisabled ProactiveDiagnosticsConsent = "Disabled"
	ProactiveDiagnosticsConsentEnabled  ProactiveDiagnosticsConsent = "Enabled"
)

func PossibleProactiveDiagnosticsConsentValues 

func PossibleProactiveDiagnosticsConsentValues() []ProactiveDiagnosticsConsent

PossibleProactiveDiagnosticsConsentValues returns the possible values for the ProactiveDiagnosticsConsent const type.

type ProactiveLogCollectionSettingsProperties 

type ProactiveLogCollectionSettingsProperties struct {
	// REQUIRED; Proactive diagnostic collection consent flag
	UserConsent *ProactiveDiagnosticsConsent
}

ProactiveLogCollectionSettingsProperties - The properties of proactive log collection settings.

func (ProactiveLogCollectionSettingsProperties) MarshalJSON added in v1.1.0 

func (p ProactiveLogCollectionSettingsProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProactiveLogCollectionSettingsProperties.

func (*ProactiveLogCollectionSettingsProperties) UnmarshalJSON added in v1.1.0 

func (p *ProactiveLogCollectionSettingsProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProactiveLogCollectionSettingsProperties.

type RawCertificateData 

type RawCertificateData struct {
	// REQUIRED; The base64 encoded certificate raw data.
	Certificate *string

	// The authentication type.
	AuthenticationType *AuthenticationType
}

RawCertificateData - Raw Certificate Data.

func (RawCertificateData) MarshalJSON added in v1.1.0 

func (r RawCertificateData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RawCertificateData.

func (*RawCertificateData) UnmarshalJSON added in v1.1.0 

func (r *RawCertificateData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RawCertificateData.

type RefreshDetails 

type RefreshDetails struct {
	// Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This
	// could be a failed job or a successful job.
	ErrorManifestFile *string

	// If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that
	// job. The field is empty if no job is in progress.
	InProgressRefreshJobID *string

	// Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed
	// job or a successful job.
	LastCompletedRefreshJobTimeInUTC *time.Time

	// Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a
	// successful job.
	LastJob *string
}

RefreshDetails - Fields for tracking refresh job on the share or container.

func (RefreshDetails) MarshalJSON 

func (r RefreshDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RefreshDetails.

func (*RefreshDetails) UnmarshalJSON 

func (r *RefreshDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RefreshDetails.

type RemoteApplicationType 

type RemoteApplicationType string

RemoteApplicationType - Remote application type 

const (
	RemoteApplicationTypeAllApplications RemoteApplicationType = "AllApplications"
	RemoteApplicationTypeLocalUI         RemoteApplicationType = "LocalUI"
	RemoteApplicationTypePowershell      RemoteApplicationType = "Powershell"
	RemoteApplicationTypeWAC             RemoteApplicationType = "WAC"
)

func PossibleRemoteApplicationTypeValues 

func PossibleRemoteApplicationTypeValues() []RemoteApplicationType

PossibleRemoteApplicationTypeValues returns the possible values for the RemoteApplicationType const type.

type RemoteSupportSettings 

type RemoteSupportSettings struct {
	// Access level allowed for this remote application type
	AccessLevel *AccessLevel

	// Expiration time stamp
	ExpirationTimeStampInUTC *time.Time

	// Remote application type
	RemoteApplicationType *RemoteApplicationType
}

RemoteSupportSettings - RemoteApplicationType for which remote support settings is being modified

func (RemoteSupportSettings) MarshalJSON 

func (r RemoteSupportSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RemoteSupportSettings.

func (*RemoteSupportSettings) UnmarshalJSON 

func (r *RemoteSupportSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RemoteSupportSettings.

type ResourceIdentity 

type ResourceIdentity struct {
	// Identity type
	Type *MsiIdentityType

	// READ-ONLY; Service Principal Id backing the Msi
	PrincipalID *string

	// READ-ONLY; Home Tenant Id
	TenantID *string
}

ResourceIdentity - Msi identity details of the resource

func (ResourceIdentity) MarshalJSON added in v1.1.0 

func (r ResourceIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceIdentity.

func (*ResourceIdentity) UnmarshalJSON added in v1.1.0 

func (r *ResourceIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceIdentity.

type ResourceMoveDetails 

type ResourceMoveDetails struct {
	// Denotes whether move operation is in progress
	OperationInProgress *ResourceMoveStatus

	// Denotes the timeout of the operation to finish
	OperationInProgressLockTimeoutInUTC *time.Time
}

ResourceMoveDetails - Fields for tracking resource move

func (ResourceMoveDetails) MarshalJSON 

func (r ResourceMoveDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceMoveDetails.

func (*ResourceMoveDetails) UnmarshalJSON 

func (r *ResourceMoveDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceMoveDetails.

type ResourceMoveStatus 

type ResourceMoveStatus string

ResourceMoveStatus - Denotes whether move operation is in progress 

const (
	ResourceMoveStatusNone                   ResourceMoveStatus = "None"
	ResourceMoveStatusResourceMoveFailed     ResourceMoveStatus = "ResourceMoveFailed"
	ResourceMoveStatusResourceMoveInProgress ResourceMoveStatus = "ResourceMoveInProgress"
)

func PossibleResourceMoveStatusValues 

func PossibleResourceMoveStatusValues() []ResourceMoveStatus

PossibleResourceMoveStatusValues returns the possible values for the ResourceMoveStatus const type.

type Role 

type Role struct {
	// REQUIRED; Role type.
	Kind *RoleTypes

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of Role
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

Role - Compute role.

func (*Role) GetRole 

func (r *Role) GetRole() *Role

GetRole implements the RoleClassification interface for type Role.

func (Role) MarshalJSON added in v1.1.0 

func (r Role) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Role.

func (*Role) UnmarshalJSON 

func (r *Role) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Role.

type RoleClassification 

type RoleClassification interface {
	// GetRole returns the Role content of the underlying type.
	GetRole() *Role
}

RoleClassification provides polymorphic access to related types. Call the interface's GetRole() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *CloudEdgeManagementRole, *IoTRole, *KubernetesRole, *MECRole, *Role

type RoleList 

type RoleList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string

	// READ-ONLY; The Value.
	Value []RoleClassification
}

RoleList - Collection of all the roles on the Data Box Edge device.

func (RoleList) MarshalJSON 

func (r RoleList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RoleList.

func (*RoleList) UnmarshalJSON 

func (r *RoleList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleList.

type RoleSinkInfo 

type RoleSinkInfo struct {
	// REQUIRED; Compute role ID.
	RoleID *string
}

RoleSinkInfo - Compute role against which events will be raised.

func (RoleSinkInfo) MarshalJSON added in v1.1.0 

func (r RoleSinkInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RoleSinkInfo.

func (*RoleSinkInfo) UnmarshalJSON added in v1.1.0 

func (r *RoleSinkInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleSinkInfo.

type RoleStatus 

type RoleStatus string

RoleStatus - Local Edge Management Status 

const (
	RoleStatusDisabled RoleStatus = "Disabled"
	RoleStatusEnabled  RoleStatus = "Enabled"
)

func PossibleRoleStatusValues 

func PossibleRoleStatusValues() []RoleStatus

PossibleRoleStatusValues returns the possible values for the RoleStatus const type.

type RoleTypes 

type RoleTypes string
const (
	RoleTypesASA                 RoleTypes = "ASA"
	RoleTypesCloudEdgeManagement RoleTypes = "CloudEdgeManagement"
	RoleTypesCognitive           RoleTypes = "Cognitive"
	RoleTypesFunctions           RoleTypes = "Functions"
	RoleTypesIOT                 RoleTypes = "IOT"
	RoleTypesKubernetes          RoleTypes = "Kubernetes"
	RoleTypesMEC                 RoleTypes = "MEC"
)

func PossibleRoleTypesValues 

func PossibleRoleTypesValues() []RoleTypes

PossibleRoleTypesValues returns the possible values for the RoleTypes const type.

type RolesClient 

type RolesClient struct {
	// contains filtered or unexported fields
}

RolesClient contains the methods for the Roles group. Don't use this type directly, use NewRolesClient() instead.

func NewRolesClient 

func NewRolesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*RolesClient, error)

NewRolesClient creates a new instance of RolesClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*RolesClient) BeginCreateOrUpdate 

func (client *RolesClient) BeginCreateOrUpdate(ctx context.Context, deviceName string, name string, resourceGroupName string, role RoleClassification, options *RolesClientBeginCreateOrUpdateOptions) (*runtime.Poller[RolesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update a role. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • name - The role name.
  • resourceGroupName - The resource group name.
  • role - The role properties.
  • options - RolesClientBeginCreateOrUpdateOptions contains the optional parameters for the RolesClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/RolePut.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewRolesClient().BeginCreateOrUpdate(ctx, "testedgedevice", "IoTRole1", "GroupForEdgeAutomation", &armdataboxedge.IoTRole{
		Kind: to.Ptr(armdataboxedge.RoleTypesIOT),
		Properties: &armdataboxedge.IoTRoleProperties{
			HostPlatform: to.Ptr(armdataboxedge.PlatformTypeLinux),
			IoTDeviceDetails: &armdataboxedge.IoTDeviceInfo{
				Authentication: &armdataboxedge.Authentication{
					SymmetricKey: &armdataboxedge.SymmetricKey{
						ConnectionString: &armdataboxedge.AsymmetricEncryptedSecret{
							EncryptionAlgorithm:      to.Ptr(armdataboxedge.EncryptionAlgorithmAES256),
							EncryptionCertThumbprint: to.Ptr("348586569999244"),
							Value:                    to.Ptr("Encrypted<<HostName=iothub.azure-devices.net;DeviceId=iotDevice;SharedAccessKey=2C750FscEas3JmQ8Bnui5yQWZPyml0/UiRt1bQwd8=>>"),
						},
					},
				},
				DeviceID:   to.Ptr("iotdevice"),
				IoTHostHub: to.Ptr("iothub.azure-devices.net"),
			},
			IoTEdgeDeviceDetails: &armdataboxedge.IoTDeviceInfo{
				Authentication: &armdataboxedge.Authentication{
					SymmetricKey: &armdataboxedge.SymmetricKey{
						ConnectionString: &armdataboxedge.AsymmetricEncryptedSecret{
							EncryptionAlgorithm:      to.Ptr(armdataboxedge.EncryptionAlgorithmAES256),
							EncryptionCertThumbprint: to.Ptr("1245475856069999244"),
							Value:                    to.Ptr("Encrypted<<HostName=iothub.azure-devices.net;DeviceId=iotEdge;SharedAccessKey=2C750FscEas3JmQ8Bnui5yQWZPyml0/UiRt1bQwd8=>>"),
						},
					},
				},
				DeviceID:   to.Ptr("iotEdge"),
				IoTHostHub: to.Ptr("iothub.azure-devices.net"),
			},
			RoleStatus:    to.Ptr(armdataboxedge.RoleStatusEnabled),
			ShareMappings: []*armdataboxedge.MountPointMap{},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdataboxedge.RolesClientCreateOrUpdateResponse{
	// 	                            RoleClassification: &armdataboxedge.IoTRole{
	// 		Name: to.Ptr("IoTRole1"),
	// 		Type: to.Ptr("dataBoxEdgeDevices/roles"),
	// 		ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1"),
	// 		Kind: to.Ptr(armdataboxedge.RoleTypesIOT),
	// 		Properties: &armdataboxedge.IoTRoleProperties{
	// 			HostPlatform: to.Ptr(armdataboxedge.PlatformTypeLinux),
	// 			IoTDeviceDetails: &armdataboxedge.IoTDeviceInfo{
	// 				Authentication: &armdataboxedge.Authentication{
	// 					SymmetricKey: &armdataboxedge.SymmetricKey{
	// 					},
	// 				},
	// 				DeviceID: to.Ptr("iotdevice"),
	// 				IoTHostHub: to.Ptr("iothub.azure-devices.net"),
	// 			},
	// 			IoTEdgeDeviceDetails: &armdataboxedge.IoTDeviceInfo{
	// 				Authentication: &armdataboxedge.Authentication{
	// 					SymmetricKey: &armdataboxedge.SymmetricKey{
	// 					},
	// 				},
	// 				DeviceID: to.Ptr("iotEdge"),
	// 				IoTHostHub: to.Ptr("iothub.azure-devices.net"),
	// 			},
	// 			RoleStatus: to.Ptr(armdataboxedge.RoleStatusEnabled),
	// 			ShareMappings: []*armdataboxedge.MountPointMap{
	// 			},
	// 		},
	// 	},
	// 	                        }
}

Output:

func (*RolesClient) BeginDelete 

func (client *RolesClient) BeginDelete(ctx context.Context, deviceName string, name string, resourceGroupName string, options *RolesClientBeginDeleteOptions) (*runtime.Poller[RolesClientDeleteResponse], error)

BeginDelete - Deletes the role on the device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • name - The role name.
  • resourceGroupName - The resource group name.
  • options - RolesClientBeginDeleteOptions contains the optional parameters for the RolesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/RoleDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewRolesClient().BeginDelete(ctx, "testedgedevice", "IoTRole1", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*RolesClient) Get 

func (client *RolesClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string, options *RolesClientGetOptions) (RolesClientGetResponse, error)

Get - Gets a specific role by name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • name - The role name.
  • resourceGroupName - The resource group name.
  • options - RolesClientGetOptions contains the optional parameters for the RolesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/RoleGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewRolesClient().Get(ctx, "testedgedevice", "IoTRole1", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdataboxedge.RolesClientGetResponse{
	// 	                            RoleClassification: &armdataboxedge.IoTRole{
	// 		Name: to.Ptr("IoTRole1"),
	// 		Type: to.Ptr("dataBoxEdgeDevices/roles"),
	// 		ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1"),
	// 		Kind: to.Ptr(armdataboxedge.RoleTypesIOT),
	// 		Properties: &armdataboxedge.IoTRoleProperties{
	// 			HostPlatform: to.Ptr(armdataboxedge.PlatformTypeLinux),
	// 			IoTDeviceDetails: &armdataboxedge.IoTDeviceInfo{
	// 				Authentication: &armdataboxedge.Authentication{
	// 					SymmetricKey: &armdataboxedge.SymmetricKey{
	// 					},
	// 				},
	// 				DeviceID: to.Ptr("iotdevice"),
	// 				IoTHostHub: to.Ptr("iothub.azure-devices.net"),
	// 			},
	// 			IoTEdgeDeviceDetails: &armdataboxedge.IoTDeviceInfo{
	// 				Authentication: &armdataboxedge.Authentication{
	// 					SymmetricKey: &armdataboxedge.SymmetricKey{
	// 					},
	// 				},
	// 				DeviceID: to.Ptr("iotEdge"),
	// 				IoTHostHub: to.Ptr("iothub.azure-devices.net"),
	// 			},
	// 			RoleStatus: to.Ptr(armdataboxedge.RoleStatusEnabled),
	// 			ShareMappings: []*armdataboxedge.MountPointMap{
	// 			},
	// 		},
	// 	},
	// 	                        }
}

Output:

func (*RolesClient) NewListByDataBoxEdgeDevicePager added in v0.4.0 

func (client *RolesClient) NewListByDataBoxEdgeDevicePager(deviceName string, resourceGroupName string, options *RolesClientListByDataBoxEdgeDeviceOptions) *runtime.Pager[RolesClientListByDataBoxEdgeDeviceResponse]

NewListByDataBoxEdgeDevicePager - Lists all the roles configured in a Data Box Edge/Data Box Gateway device.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - RolesClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the RolesClient.NewListByDataBoxEdgeDevicePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/RoleGetAllInDevice.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewRolesClient().NewListByDataBoxEdgeDevicePager("testedgedevice", "GroupForEdgeAutomation", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.RoleList = armdataboxedge.RoleList{
		// 	Value: []armdataboxedge.RoleClassification{
		// 		&armdataboxedge.IoTRole{
		// 			Name: to.Ptr("IoTRole1"),
		// 			Type: to.Ptr("dataBoxEdgeDevices/roles"),
		// 			ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1"),
		// 			Kind: to.Ptr(armdataboxedge.RoleTypesIOT),
		// 			Properties: &armdataboxedge.IoTRoleProperties{
		// 				HostPlatform: to.Ptr(armdataboxedge.PlatformTypeLinux),
		// 				IoTDeviceDetails: &armdataboxedge.IoTDeviceInfo{
		// 					Authentication: &armdataboxedge.Authentication{
		// 						SymmetricKey: &armdataboxedge.SymmetricKey{
		// 						},
		// 					},
		// 					DeviceID: to.Ptr("iotdevice"),
		// 					IoTHostHub: to.Ptr("iothub.azure-devices.net"),
		// 				},
		// 				IoTEdgeDeviceDetails: &armdataboxedge.IoTDeviceInfo{
		// 					Authentication: &armdataboxedge.Authentication{
		// 						SymmetricKey: &armdataboxedge.SymmetricKey{
		// 						},
		// 					},
		// 					DeviceID: to.Ptr("iotEdge"),
		// 					IoTHostHub: to.Ptr("iothub.azure-devices.net"),
		// 				},
		// 				RoleStatus: to.Ptr(armdataboxedge.RoleStatusEnabled),
		// 				ShareMappings: []*armdataboxedge.MountPointMap{
		// 				},
		// 			},
		// 	}},
		// }
	}
}

Output:

type RolesClientBeginCreateOrUpdateOptions added in v0.2.0 

type RolesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RolesClientBeginCreateOrUpdateOptions contains the optional parameters for the RolesClient.BeginCreateOrUpdate method.

type RolesClientBeginDeleteOptions added in v0.2.0 

type RolesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RolesClientBeginDeleteOptions contains the optional parameters for the RolesClient.BeginDelete method.

type RolesClientCreateOrUpdateResponse added in v0.2.0 

type RolesClientCreateOrUpdateResponse struct {
	// Compute role.
	RoleClassification
}

RolesClientCreateOrUpdateResponse contains the response from method RolesClient.BeginCreateOrUpdate.

func (RolesClientCreateOrUpdateResponse) MarshalJSON added in v1.2.0 

func (r RolesClientCreateOrUpdateResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RolesClientCreateOrUpdateResponse.

func (*RolesClientCreateOrUpdateResponse) UnmarshalJSON added in v0.3.0 

func (r *RolesClientCreateOrUpdateResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RolesClientCreateOrUpdateResponse.

type RolesClientDeleteResponse added in v0.2.0 

type RolesClientDeleteResponse struct {
}

RolesClientDeleteResponse contains the response from method RolesClient.BeginDelete.

type RolesClientGetOptions added in v0.2.0 

type RolesClientGetOptions struct {
}

RolesClientGetOptions contains the optional parameters for the RolesClient.Get method.

type RolesClientGetResponse added in v0.2.0 

type RolesClientGetResponse struct {
	// Compute role.
	RoleClassification
}

RolesClientGetResponse contains the response from method RolesClient.Get.

func (*RolesClientGetResponse) UnmarshalJSON added in v0.3.0 

func (r *RolesClientGetResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RolesClientGetResponse.

type RolesClientListByDataBoxEdgeDeviceOptions added in v0.2.0 

type RolesClientListByDataBoxEdgeDeviceOptions struct {
}

RolesClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the RolesClient.NewListByDataBoxEdgeDevicePager method.

type RolesClientListByDataBoxEdgeDeviceResponse added in v0.2.0 

type RolesClientListByDataBoxEdgeDeviceResponse struct {
	// Collection of all the roles on the Data Box Edge device.
	RoleList
}

RolesClientListByDataBoxEdgeDeviceResponse contains the response from method RolesClient.NewListByDataBoxEdgeDevicePager.

type SKU 

type SKU struct {
	// READ-ONLY; The API versions in which Sku is available.
	APIVersions []*string

	// READ-ONLY; Links to the next set of results
	Availability *SKUAvailability

	// READ-ONLY; The capability info of the SKU.
	Capabilities []*SKUCapability

	// READ-ONLY; The pricing info of the Sku.
	Costs []*SKUCost

	// READ-ONLY; The Sku family.
	Family *string

	// READ-ONLY; The Sku kind.
	Kind *string

	// READ-ONLY; Availability of the Sku for the location/zone/site.
	LocationInfo []*SKULocationInfo

	// READ-ONLY; Availability of the Sku for the region.
	Locations []*string

	// READ-ONLY; The Sku name.
	Name *SKUName

	// READ-ONLY; The type of the resource.
	ResourceType *string

	// READ-ONLY; List of Shipment Types supported by this SKU
	ShipmentTypes []*ShipmentType

	// READ-ONLY; Sku can be signed up by customer or not.
	SignupOption *SKUSignupOption

	// READ-ONLY; The Sku kind.
	Size *string

	// READ-ONLY; The Sku tier.
	Tier *SKUTier

	// READ-ONLY; Availability of the Sku as preview/stable.
	Version *SKUVersion
}

SKU - The Sku information.

func (SKU) MarshalJSON added in v0.2.0 

func (s SKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SKU.

func (*SKU) UnmarshalJSON added in v1.1.0 

func (s *SKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKU.

type SKUAvailability 

type SKUAvailability string

SKUAvailability - Links to the next set of results 

const (
	SKUAvailabilityAvailable   SKUAvailability = "Available"
	SKUAvailabilityUnavailable SKUAvailability = "Unavailable"
)

func PossibleSKUAvailabilityValues 

func PossibleSKUAvailabilityValues() []SKUAvailability

PossibleSKUAvailabilityValues returns the possible values for the SKUAvailability const type.

type SKUCapability 

type SKUCapability struct {
	// READ-ONLY; An invariant to describe the feature.
	Name *string

	// READ-ONLY; An invariant if the feature is measured by quantity.
	Value *string
}

SKUCapability - The metadata to describe the capability.

func (SKUCapability) MarshalJSON added in v1.1.0 

func (s SKUCapability) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SKUCapability.

func (*SKUCapability) UnmarshalJSON added in v1.1.0 

func (s *SKUCapability) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKUCapability.

type SKUCost 

type SKUCost struct {
	// READ-ONLY; The extended unit.
	ExtendedUnit *string

	// READ-ONLY; Used for querying price from commerce.
	MeterID *string

	// READ-ONLY; The cost quantity.
	Quantity *int64
}

SKUCost - The metadata for retrieving price info.

func (SKUCost) MarshalJSON added in v1.1.0 

func (s SKUCost) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SKUCost.

func (*SKUCost) UnmarshalJSON added in v1.1.0 

func (s *SKUCost) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKUCost.

type SKUInfo added in v0.2.0 

type SKUInfo struct {
	// SKU name.
	Name *SKUName

	// The SKU tier. This is based on the SKU name.
	Tier *SKUTier
}

SKUInfo - The SKU type.

func (SKUInfo) MarshalJSON added in v1.1.0 

func (s SKUInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SKUInfo.

func (*SKUInfo) UnmarshalJSON added in v1.1.0 

func (s *SKUInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKUInfo.

type SKUList added in v0.2.0 

type SKUList struct {
	// READ-ONLY; Links to the next set of results
	NextLink *string

	// READ-ONLY; List of ResourceType Sku
	Value []*SKU
}

SKUList - List of SKU Information objects.

func (SKUList) MarshalJSON added in v0.2.0 

func (s SKUList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SKUList.

func (*SKUList) UnmarshalJSON added in v1.1.0 

func (s *SKUList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKUList.

type SKULocationInfo 

type SKULocationInfo struct {
	// READ-ONLY; The location.
	Location *string

	// READ-ONLY; The sites.
	Sites []*string

	// READ-ONLY; The zones.
	Zones []*string
}

SKULocationInfo - The location info.

func (SKULocationInfo) MarshalJSON 

func (s SKULocationInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SKULocationInfo.

func (*SKULocationInfo) UnmarshalJSON added in v1.1.0 

func (s *SKULocationInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKULocationInfo.

type SKUName 

type SKUName string

SKUName - The Sku name. 

const (
	SKUNameEP21281T4Mx1W     SKUName = "EP2_128_1T4_Mx1_W"
	SKUNameEP2128GPU1Mx1W    SKUName = "EP2_128_GPU1_Mx1_W"
	SKUNameEP22562T4W        SKUName = "EP2_256_2T4_W"
	SKUNameEP2256GPU2Mx1     SKUName = "EP2_256_GPU2_Mx1"
	SKUNameEP2641VPUW        SKUName = "EP2_64_1VPU_W"
	SKUNameEP264Mx1W         SKUName = "EP2_64_Mx1_W"
	SKUNameEdge              SKUName = "Edge"
	SKUNameEdgeMRMini        SKUName = "EdgeMR_Mini"
	SKUNameEdgeMRTCP         SKUName = "EdgeMR_TCP"
	SKUNameEdgePBase         SKUName = "EdgeP_Base"
	SKUNameEdgePHigh         SKUName = "EdgeP_High"
	SKUNameEdgePRBase        SKUName = "EdgePR_Base"
	SKUNameEdgePRBaseUPS     SKUName = "EdgePR_Base_UPS"
	SKUNameGPU               SKUName = "GPU"
	SKUNameGateway           SKUName = "Gateway"
	SKUNameManagement        SKUName = "Management"
	SKUNameRCALarge          SKUName = "RCA_Large"
	SKUNameRCASmall          SKUName = "RCA_Small"
	SKUNameRDC               SKUName = "RDC"
	SKUNameTCALarge          SKUName = "TCA_Large"
	SKUNameTCASmall          SKUName = "TCA_Small"
	SKUNameTDC               SKUName = "TDC"
	SKUNameTEA1Node          SKUName = "TEA_1Node"
	SKUNameTEA1NodeHeater    SKUName = "TEA_1Node_Heater"
	SKUNameTEA1NodeUPS       SKUName = "TEA_1Node_UPS"
	SKUNameTEA1NodeUPSHeater SKUName = "TEA_1Node_UPS_Heater"
	SKUNameTEA4NodeHeater    SKUName = "TEA_4Node_Heater"
	SKUNameTEA4NodeUPSHeater SKUName = "TEA_4Node_UPS_Heater"
	SKUNameTMA               SKUName = "TMA"
)

func PossibleSKUNameValues 

func PossibleSKUNameValues() []SKUName

PossibleSKUNameValues returns the possible values for the SKUName const type.

type SKUSignupOption 

type SKUSignupOption string

SKUSignupOption - Sku can be signed up by customer or not. 

const (
	SKUSignupOptionAvailable SKUSignupOption = "Available"
	SKUSignupOptionNone      SKUSignupOption = "None"
)

func PossibleSKUSignupOptionValues 

func PossibleSKUSignupOptionValues() []SKUSignupOption

PossibleSKUSignupOptionValues returns the possible values for the SKUSignupOption const type.

type SKUTier 

type SKUTier string

SKUTier - The Sku tier. 

const (
	SKUTierStandard SKUTier = "Standard"
)

func PossibleSKUTierValues 

func PossibleSKUTierValues() []SKUTier

PossibleSKUTierValues returns the possible values for the SKUTier const type.

type SKUVersion 

type SKUVersion string

SKUVersion - Availability of the Sku as preview/stable. 

const (
	SKUVersionPreview SKUVersion = "Preview"
	SKUVersionStable  SKUVersion = "Stable"
)

func PossibleSKUVersionValues 

func PossibleSKUVersionValues() []SKUVersion

PossibleSKUVersionValues returns the possible values for the SKUVersion const type.

type SSLStatus 

type SSLStatus string

SSLStatus - Signifies whether SSL needs to be enabled or not. 

const (
	SSLStatusDisabled SSLStatus = "Disabled"
	SSLStatusEnabled  SSLStatus = "Enabled"
)

func PossibleSSLStatusValues 

func PossibleSSLStatusValues() []SSLStatus

PossibleSSLStatusValues returns the possible values for the SSLStatus const type.

type Secret 

type Secret struct {
	// Encrypted (using device public key) secret value.
	EncryptedSecret *AsymmetricEncryptedSecret

	// Id of the Key-Vault where secret is stored (ex: secrets/AuthClientSecret/82ef4346187a4033a10d629cde07d740).
	KeyVaultID *string
}

Secret - Holds device secret either as a KeyVault reference or as an encrypted value.

func (Secret) MarshalJSON added in v1.1.0 

func (s Secret) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Secret.

func (*Secret) UnmarshalJSON added in v1.1.0 

func (s *Secret) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Secret.

type SecuritySettings 

type SecuritySettings struct {
	// REQUIRED; Properties of the security settings.
	Properties *SecuritySettingsProperties

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

SecuritySettings - The security settings of a device.

func (SecuritySettings) MarshalJSON 

func (s SecuritySettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecuritySettings.

func (*SecuritySettings) UnmarshalJSON 

func (s *SecuritySettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecuritySettings.

type SecuritySettingsProperties 

type SecuritySettingsProperties struct {
	// REQUIRED; Device administrator password as an encrypted string (encrypted using RSA PKCS #1) is used to sign into the local
	// web UI of the device. The Actual password should have at least 8 characters that are a
	// combination of uppercase, lowercase, numeric, and special characters.
	DeviceAdminPassword *AsymmetricEncryptedSecret
}

SecuritySettingsProperties - The properties of security settings.

func (SecuritySettingsProperties) MarshalJSON added in v1.1.0 

func (s SecuritySettingsProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecuritySettingsProperties.

func (*SecuritySettingsProperties) UnmarshalJSON added in v1.1.0 

func (s *SecuritySettingsProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecuritySettingsProperties.

type ServiceSpecification 

type ServiceSpecification struct {
	// Metric specification as defined by shoebox.
	MetricSpecifications []*MetricSpecificationV1
}

ServiceSpecification - Service specification.

func (ServiceSpecification) MarshalJSON 

func (s ServiceSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceSpecification.

func (*ServiceSpecification) UnmarshalJSON added in v1.1.0 

func (s *ServiceSpecification) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceSpecification.

type Share 

type Share struct {
	// REQUIRED; The share properties.
	Properties *ShareProperties

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of Share
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

Share - Represents a share on the Data Box Edge/Gateway device.

func (Share) MarshalJSON 

func (s Share) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Share.

func (*Share) UnmarshalJSON 

func (s *Share) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Share.

type ShareAccessProtocol 

type ShareAccessProtocol string

ShareAccessProtocol - Access protocol to be used by the share. 

const (
	ShareAccessProtocolNFS ShareAccessProtocol = "NFS"
	ShareAccessProtocolSMB ShareAccessProtocol = "SMB"
)

func PossibleShareAccessProtocolValues 

func PossibleShareAccessProtocolValues() []ShareAccessProtocol

PossibleShareAccessProtocolValues returns the possible values for the ShareAccessProtocol const type.

type ShareAccessRight 

type ShareAccessRight struct {
	// REQUIRED; Type of access to be allowed on the share for this user.
	AccessType *ShareAccessType

	// REQUIRED; The share ID.
	ShareID *string
}

ShareAccessRight - Specifies the mapping between this particular user and the type of access he has on shares on this device.

func (ShareAccessRight) MarshalJSON added in v1.1.0 

func (s ShareAccessRight) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ShareAccessRight.

func (*ShareAccessRight) UnmarshalJSON added in v1.1.0 

func (s *ShareAccessRight) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ShareAccessRight.

type ShareAccessType 

type ShareAccessType string

ShareAccessType - Type of access to be allowed on the share for this user. 

const (
	ShareAccessTypeChange ShareAccessType = "Change"
	ShareAccessTypeCustom ShareAccessType = "Custom"
	ShareAccessTypeRead   ShareAccessType = "Read"
)

func PossibleShareAccessTypeValues 

func PossibleShareAccessTypeValues() []ShareAccessType

PossibleShareAccessTypeValues returns the possible values for the ShareAccessType const type.

type ShareList 

type ShareList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string

	// READ-ONLY; The list of shares.
	Value []*Share
}

ShareList - Collection of all the shares on the Data Box Edge/Gateway device.

func (ShareList) MarshalJSON 

func (s ShareList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ShareList.

func (*ShareList) UnmarshalJSON added in v1.1.0 

func (s *ShareList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ShareList.

type ShareProperties 

type ShareProperties struct {
	// REQUIRED; Access protocol to be used by the share.
	AccessProtocol *ShareAccessProtocol

	// REQUIRED; Current monitoring status of the share.
	MonitoringStatus *MonitoringStatus

	// REQUIRED; Current status of the share.
	ShareStatus *ShareStatus

	// Azure container mapping for the share.
	AzureContainerInfo *AzureContainerInfo

	// List of IP addresses and corresponding access rights on the share(required for NFS protocol).
	ClientAccessRights []*ClientAccessRight

	// Data policy of the share.
	DataPolicy *DataPolicy

	// Description for the share.
	Description *string

	// Details of the refresh job on this share.
	RefreshDetails *RefreshDetails

	// Mapping of users and corresponding access rights on the share (required for SMB protocol).
	UserAccessRights []*UserAccessRight

	// READ-ONLY; Share mount point to the role.
	ShareMappings []*MountPointMap
}

ShareProperties - The share properties.

func (ShareProperties) MarshalJSON 

func (s ShareProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ShareProperties.

func (*ShareProperties) UnmarshalJSON added in v1.1.0 

func (s *ShareProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ShareProperties.

type ShareStatus 

type ShareStatus string

ShareStatus - Current status of the share. 

const (
	ShareStatusNeedsAttention ShareStatus = "NeedsAttention"
	ShareStatusOK             ShareStatus = "OK"
	ShareStatusOffline        ShareStatus = "Offline"
	ShareStatusUnknown        ShareStatus = "Unknown"
	ShareStatusUpdating       ShareStatus = "Updating"
)

func PossibleShareStatusValues 

func PossibleShareStatusValues() []ShareStatus

PossibleShareStatusValues returns the possible values for the ShareStatus const type.

type SharesClient 

type SharesClient struct {
	// contains filtered or unexported fields
}

SharesClient contains the methods for the Shares group. Don't use this type directly, use NewSharesClient() instead.

func NewSharesClient 

func NewSharesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SharesClient, error)

NewSharesClient creates a new instance of SharesClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SharesClient) BeginCreateOrUpdate 

func (client *SharesClient) BeginCreateOrUpdate(ctx context.Context, deviceName string, name string, resourceGroupName string, share Share, options *SharesClientBeginCreateOrUpdateOptions) (*runtime.Poller[SharesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a new share or updates an existing share on the device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • name - The share name.
  • resourceGroupName - The resource group name.
  • share - The share properties.
  • options - SharesClientBeginCreateOrUpdateOptions contains the optional parameters for the SharesClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/SharePut.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSharesClient().BeginCreateOrUpdate(ctx, "testedgedevice", "smbshare", "GroupForEdgeAutomation", armdataboxedge.Share{
		Properties: &armdataboxedge.ShareProperties{
			Description:    to.Ptr(""),
			AccessProtocol: to.Ptr(armdataboxedge.ShareAccessProtocolSMB),
			AzureContainerInfo: &armdataboxedge.AzureContainerInfo{
				ContainerName:              to.Ptr("testContainerSMB"),
				DataFormat:                 to.Ptr(armdataboxedge.AzureContainerDataFormatBlockBlob),
				StorageAccountCredentialID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1"),
			},
			DataPolicy:       to.Ptr(armdataboxedge.DataPolicyCloud),
			MonitoringStatus: to.Ptr(armdataboxedge.MonitoringStatusEnabled),
			ShareStatus:      to.Ptr(armdataboxedge.ShareStatus("Online")),
			UserAccessRights: []*armdataboxedge.UserAccessRight{
				{
					AccessType: to.Ptr(armdataboxedge.ShareAccessTypeChange),
					UserID:     to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2"),
				}},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Share = armdataboxedge.Share{
	// 	Name: to.Ptr("smbshare"),
	// 	Type: to.Ptr("dataBoxEdgeDevices/shares"),
	// 	ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare"),
	// 	Properties: &armdataboxedge.ShareProperties{
	// 		Description: to.Ptr(""),
	// 		AccessProtocol: to.Ptr(armdataboxedge.ShareAccessProtocolSMB),
	// 		AzureContainerInfo: &armdataboxedge.AzureContainerInfo{
	// 			ContainerName: to.Ptr("testContainerSMB"),
	// 			DataFormat: to.Ptr(armdataboxedge.AzureContainerDataFormatBlockBlob),
	// 			StorageAccountCredentialID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1"),
	// 		},
	// 		ClientAccessRights: []*armdataboxedge.ClientAccessRight{
	// 		},
	// 		DataPolicy: to.Ptr(armdataboxedge.DataPolicyCloud),
	// 		MonitoringStatus: to.Ptr(armdataboxedge.MonitoringStatusDisabled),
	// 		RefreshDetails: &armdataboxedge.RefreshDetails{
	// 		},
	// 		ShareMappings: []*armdataboxedge.MountPointMap{
	// 		},
	// 		ShareStatus: to.Ptr(armdataboxedge.ShareStatus("Online")),
	// 		UserAccessRights: []*armdataboxedge.UserAccessRight{
	// 			{
	// 				AccessType: to.Ptr(armdataboxedge.ShareAccessTypeChange),
	// 				UserID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2"),
	// 		}},
	// 	},
	// }
}

Output:

func (*SharesClient) BeginDelete 

func (client *SharesClient) BeginDelete(ctx context.Context, deviceName string, name string, resourceGroupName string, options *SharesClientBeginDeleteOptions) (*runtime.Poller[SharesClientDeleteResponse], error)

BeginDelete - Deletes the share on the Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • name - The share name.
  • resourceGroupName - The resource group name.
  • options - SharesClientBeginDeleteOptions contains the optional parameters for the SharesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/ShareDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSharesClient().BeginDelete(ctx, "testedgedevice", "smbshare", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*SharesClient) BeginRefresh 

func (client *SharesClient) BeginRefresh(ctx context.Context, deviceName string, name string, resourceGroupName string, options *SharesClientBeginRefreshOptions) (*runtime.Poller[SharesClientRefreshResponse], error)

BeginRefresh - Refreshes the share metadata with the data from the cloud. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • name - The share name.
  • resourceGroupName - The resource group name.
  • options - SharesClientBeginRefreshOptions contains the optional parameters for the SharesClient.BeginRefresh method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/ShareRefreshPost.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSharesClient().BeginRefresh(ctx, "testedgedevice", "smbshare", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*SharesClient) Get 

func (client *SharesClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string, options *SharesClientGetOptions) (SharesClientGetResponse, error)

Get - Gets a share by name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • name - The share name.
  • resourceGroupName - The resource group name.
  • options - SharesClientGetOptions contains the optional parameters for the SharesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/ShareGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSharesClient().Get(ctx, "testedgedevice", "smbshare", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Share = armdataboxedge.Share{
	// 	Name: to.Ptr("smbshare"),
	// 	Type: to.Ptr("dataBoxEdgeDevices/shares"),
	// 	ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare"),
	// 	Properties: &armdataboxedge.ShareProperties{
	// 		Description: to.Ptr(""),
	// 		AccessProtocol: to.Ptr(armdataboxedge.ShareAccessProtocolSMB),
	// 		AzureContainerInfo: &armdataboxedge.AzureContainerInfo{
	// 			ContainerName: to.Ptr("testContainerSMB"),
	// 			DataFormat: to.Ptr(armdataboxedge.AzureContainerDataFormatBlockBlob),
	// 			StorageAccountCredentialID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1"),
	// 		},
	// 		ClientAccessRights: []*armdataboxedge.ClientAccessRight{
	// 		},
	// 		DataPolicy: to.Ptr(armdataboxedge.DataPolicyCloud),
	// 		MonitoringStatus: to.Ptr(armdataboxedge.MonitoringStatusDisabled),
	// 		RefreshDetails: &armdataboxedge.RefreshDetails{
	// 		},
	// 		ShareMappings: []*armdataboxedge.MountPointMap{
	// 		},
	// 		ShareStatus: to.Ptr(armdataboxedge.ShareStatus("Online")),
	// 		UserAccessRights: []*armdataboxedge.UserAccessRight{
	// 			{
	// 				AccessType: to.Ptr(armdataboxedge.ShareAccessTypeChange),
	// 				UserID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2"),
	// 		}},
	// 	},
	// }
}

Output:

func (*SharesClient) NewListByDataBoxEdgeDevicePager added in v0.4.0 

func (client *SharesClient) NewListByDataBoxEdgeDevicePager(deviceName string, resourceGroupName string, options *SharesClientListByDataBoxEdgeDeviceOptions) *runtime.Pager[SharesClientListByDataBoxEdgeDeviceResponse]

NewListByDataBoxEdgeDevicePager - Lists all the shares in a Data Box Edge/Data Box Gateway device.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - SharesClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the SharesClient.NewListByDataBoxEdgeDevicePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/ShareGetAllInDevice.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSharesClient().NewListByDataBoxEdgeDevicePager("testedgedevice", "GroupForEdgeAutomation", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ShareList = armdataboxedge.ShareList{
		// 	Value: []*armdataboxedge.Share{
		// 		{
		// 			Name: to.Ptr("smbshare"),
		// 			Type: to.Ptr("dataBoxEdgeDevices/shares"),
		// 			ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare"),
		// 			Properties: &armdataboxedge.ShareProperties{
		// 				Description: to.Ptr(""),
		// 				AccessProtocol: to.Ptr(armdataboxedge.ShareAccessProtocolSMB),
		// 				AzureContainerInfo: &armdataboxedge.AzureContainerInfo{
		// 					ContainerName: to.Ptr("testContainerSMB"),
		// 					DataFormat: to.Ptr(armdataboxedge.AzureContainerDataFormatBlockBlob),
		// 					StorageAccountCredentialID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1"),
		// 				},
		// 				ClientAccessRights: []*armdataboxedge.ClientAccessRight{
		// 				},
		// 				DataPolicy: to.Ptr(armdataboxedge.DataPolicyCloud),
		// 				MonitoringStatus: to.Ptr(armdataboxedge.MonitoringStatusDisabled),
		// 				RefreshDetails: &armdataboxedge.RefreshDetails{
		// 				},
		// 				ShareMappings: []*armdataboxedge.MountPointMap{
		// 				},
		// 				ShareStatus: to.Ptr(armdataboxedge.ShareStatus("Online")),
		// 				UserAccessRights: []*armdataboxedge.UserAccessRight{
		// 					{
		// 						AccessType: to.Ptr(armdataboxedge.ShareAccessTypeChange),
		// 						UserID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2"),
		// 				}},
		// 			},
		// 	}},
		// }
	}
}

Output:

type SharesClientBeginCreateOrUpdateOptions added in v0.2.0 

type SharesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SharesClientBeginCreateOrUpdateOptions contains the optional parameters for the SharesClient.BeginCreateOrUpdate method.

type SharesClientBeginDeleteOptions added in v0.2.0 

type SharesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SharesClientBeginDeleteOptions contains the optional parameters for the SharesClient.BeginDelete method.

type SharesClientBeginRefreshOptions added in v0.2.0 

type SharesClientBeginRefreshOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SharesClientBeginRefreshOptions contains the optional parameters for the SharesClient.BeginRefresh method.

type SharesClientCreateOrUpdateResponse added in v0.2.0 

type SharesClientCreateOrUpdateResponse struct {
	// Represents a share on the Data Box Edge/Gateway device.
	Share
}

SharesClientCreateOrUpdateResponse contains the response from method SharesClient.BeginCreateOrUpdate.

type SharesClientDeleteResponse added in v0.2.0 

type SharesClientDeleteResponse struct {
}

SharesClientDeleteResponse contains the response from method SharesClient.BeginDelete.

type SharesClientGetOptions added in v0.2.0 

type SharesClientGetOptions struct {
}

SharesClientGetOptions contains the optional parameters for the SharesClient.Get method.

type SharesClientGetResponse added in v0.2.0 

type SharesClientGetResponse struct {
	// Represents a share on the Data Box Edge/Gateway device.
	Share
}

SharesClientGetResponse contains the response from method SharesClient.Get.

type SharesClientListByDataBoxEdgeDeviceOptions added in v0.2.0 

type SharesClientListByDataBoxEdgeDeviceOptions struct {
}

SharesClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the SharesClient.NewListByDataBoxEdgeDevicePager method.

type SharesClientListByDataBoxEdgeDeviceResponse added in v0.2.0 

type SharesClientListByDataBoxEdgeDeviceResponse struct {
	// Collection of all the shares on the Data Box Edge/Gateway device.
	ShareList
}

SharesClientListByDataBoxEdgeDeviceResponse contains the response from method SharesClient.NewListByDataBoxEdgeDevicePager.

type SharesClientRefreshResponse added in v0.2.0 

type SharesClientRefreshResponse struct {
}

SharesClientRefreshResponse contains the response from method SharesClient.BeginRefresh.

type ShipmentType 

type ShipmentType string
const (
	ShipmentTypeNotApplicable     ShipmentType = "NotApplicable"
	ShipmentTypeSelfPickup        ShipmentType = "SelfPickup"
	ShipmentTypeShippedToCustomer ShipmentType = "ShippedToCustomer"
)

func PossibleShipmentTypeValues 

func PossibleShipmentTypeValues() []ShipmentType

PossibleShipmentTypeValues returns the possible values for the ShipmentType const type.

type StorageAccount 

type StorageAccount struct {
	// REQUIRED; The Storage Account properties.
	Properties *StorageAccountProperties

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of StorageAccount
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

StorageAccount - Represents a Storage Account on the Data Box Edge/Gateway device.

func (StorageAccount) MarshalJSON 

func (s StorageAccount) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StorageAccount.

func (*StorageAccount) UnmarshalJSON 

func (s *StorageAccount) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageAccount.

type StorageAccountCredential 

type StorageAccountCredential struct {
	// REQUIRED; The storage account credential properties.
	Properties *StorageAccountCredentialProperties

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of StorageAccountCredential
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

StorageAccountCredential - The storage account credential.

func (StorageAccountCredential) MarshalJSON 

func (s StorageAccountCredential) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StorageAccountCredential.

func (*StorageAccountCredential) UnmarshalJSON 

func (s *StorageAccountCredential) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageAccountCredential.

type StorageAccountCredentialList 

type StorageAccountCredentialList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string

	// READ-ONLY; The value.
	Value []*StorageAccountCredential
}

StorageAccountCredentialList - The collection of storage account credentials.

func (StorageAccountCredentialList) MarshalJSON 

func (s StorageAccountCredentialList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StorageAccountCredentialList.

func (*StorageAccountCredentialList) UnmarshalJSON added in v1.1.0 

func (s *StorageAccountCredentialList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageAccountCredentialList.

type StorageAccountCredentialProperties 

type StorageAccountCredentialProperties struct {
	// REQUIRED; Type of storage accessed on the storage account.
	AccountType *AccountType

	// REQUIRED; Alias for the storage account.
	Alias *string

	// REQUIRED; Signifies whether SSL needs to be enabled or not.
	SSLStatus *SSLStatus

	// Encrypted storage key.
	AccountKey *AsymmetricEncryptedSecret

	// Blob end point for private clouds.
	BlobDomainName *string

	// Connection string for the storage account. Use this string if username and account key are not specified.
	ConnectionString *string

	// Id of the storage account.
	StorageAccountID *string

	// Username for the storage account.
	UserName *string
}

StorageAccountCredentialProperties - The storage account credential properties.

func (StorageAccountCredentialProperties) MarshalJSON added in v1.1.0 

func (s StorageAccountCredentialProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StorageAccountCredentialProperties.

func (*StorageAccountCredentialProperties) UnmarshalJSON added in v1.1.0 

func (s *StorageAccountCredentialProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageAccountCredentialProperties.

type StorageAccountCredentialsClient 

type StorageAccountCredentialsClient struct {
	// contains filtered or unexported fields
}

StorageAccountCredentialsClient contains the methods for the StorageAccountCredentials group. Don't use this type directly, use NewStorageAccountCredentialsClient() instead.

func NewStorageAccountCredentialsClient 

func NewStorageAccountCredentialsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*StorageAccountCredentialsClient, error)

NewStorageAccountCredentialsClient creates a new instance of StorageAccountCredentialsClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*StorageAccountCredentialsClient) BeginCreateOrUpdate 

func (client *StorageAccountCredentialsClient) BeginCreateOrUpdate(ctx context.Context, deviceName string, name string, resourceGroupName string, storageAccountCredential StorageAccountCredential, options *StorageAccountCredentialsClientBeginCreateOrUpdateOptions) (*runtime.Poller[StorageAccountCredentialsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates the storage account credential. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • name - The storage account credential name.
  • resourceGroupName - The resource group name.
  • storageAccountCredential - The storage account credential.
  • options - StorageAccountCredentialsClientBeginCreateOrUpdateOptions contains the optional parameters for the StorageAccountCredentialsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/SACPut.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewStorageAccountCredentialsClient().BeginCreateOrUpdate(ctx, "testedgedevice", "sac1", "GroupForEdgeAutomation", armdataboxedge.StorageAccountCredential{
		Properties: &armdataboxedge.StorageAccountCredentialProperties{
			AccountKey: &armdataboxedge.AsymmetricEncryptedSecret{
				EncryptionAlgorithm:      to.Ptr(armdataboxedge.EncryptionAlgorithmAES256),
				EncryptionCertThumbprint: to.Ptr("2A9D8D6BE51574B5461230AEF02F162C5F01AD31"),
				Value:                    to.Ptr("lAeZEYi6rNP1/EyNaVUYmTSZEYyaIaWmwUsGwek0+xiZj54GM9Ue9/UA2ed/ClC03wuSit2XzM/cLRU5eYiFBwks23rGwiQOr3sruEL2a74EjPD050xYjA6M1I2hu/w2yjVHhn5j+DbXS4Xzi+rHHNZK3DgfDO3PkbECjPck+PbpSBjy9+6Mrjcld5DIZhUAeMlMHrFlg+WKRKB14o/og56u5/xX6WKlrMLEQ+y6E18dUwvWs2elTNoVO8PBE8SM/CfooX4AMNvaNdSObNBPdP+F6Lzc556nFNWXrBLRt0vC7s9qTiVRO4x/qCNaK/B4y7IqXMllwQFf4Np9UQ2ECA=="),
			},
			AccountType: to.Ptr(armdataboxedge.AccountTypeBlobStorage),
			Alias:       to.Ptr("sac1"),
			SSLStatus:   to.Ptr(armdataboxedge.SSLStatusDisabled),
			UserName:    to.Ptr("cisbvt"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.StorageAccountCredential = armdataboxedge.StorageAccountCredential{
	// 	Name: to.Ptr("sac1"),
	// 	Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials"),
	// 	ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1"),
	// 	Properties: &armdataboxedge.StorageAccountCredentialProperties{
	// 		AccountType: to.Ptr(armdataboxedge.AccountTypeBlobStorage),
	// 		Alias: to.Ptr("sac1"),
	// 		SSLStatus: to.Ptr(armdataboxedge.SSLStatusDisabled),
	// 		UserName: to.Ptr("cisbvt"),
	// 	},
	// }
}

Output:

func (*StorageAccountCredentialsClient) BeginDelete 

func (client *StorageAccountCredentialsClient) BeginDelete(ctx context.Context, deviceName string, name string, resourceGroupName string, options *StorageAccountCredentialsClientBeginDeleteOptions) (*runtime.Poller[StorageAccountCredentialsClientDeleteResponse], error)

BeginDelete - Deletes the storage account credential. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • name - The storage account credential name.
  • resourceGroupName - The resource group name.
  • options - StorageAccountCredentialsClientBeginDeleteOptions contains the optional parameters for the StorageAccountCredentialsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/SACDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewStorageAccountCredentialsClient().BeginDelete(ctx, "testedgedevice", "sac1", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*StorageAccountCredentialsClient) Get 

func (client *StorageAccountCredentialsClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string, options *StorageAccountCredentialsClientGetOptions) (StorageAccountCredentialsClientGetResponse, error)

Get - Gets the properties of the specified storage account credential. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • name - The storage account credential name.
  • resourceGroupName - The resource group name.
  • options - StorageAccountCredentialsClientGetOptions contains the optional parameters for the StorageAccountCredentialsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/SACGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewStorageAccountCredentialsClient().Get(ctx, "testedgedevice", "sac1", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.StorageAccountCredential = armdataboxedge.StorageAccountCredential{
	// 	Name: to.Ptr("sac1"),
	// 	Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials"),
	// 	ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1"),
	// 	Properties: &armdataboxedge.StorageAccountCredentialProperties{
	// 		AccountType: to.Ptr(armdataboxedge.AccountTypeBlobStorage),
	// 		Alias: to.Ptr("sac1"),
	// 		SSLStatus: to.Ptr(armdataboxedge.SSLStatusDisabled),
	// 		UserName: to.Ptr("cisbvt"),
	// 	},
	// }
}

Output:

func (*StorageAccountCredentialsClient) NewListByDataBoxEdgeDevicePager added in v0.4.0 

func (client *StorageAccountCredentialsClient) NewListByDataBoxEdgeDevicePager(deviceName string, resourceGroupName string, options *StorageAccountCredentialsClientListByDataBoxEdgeDeviceOptions) *runtime.Pager[StorageAccountCredentialsClientListByDataBoxEdgeDeviceResponse]

NewListByDataBoxEdgeDevicePager - Gets all the storage account credentials in a Data Box Edge/Data Box Gateway device.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - StorageAccountCredentialsClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the StorageAccountCredentialsClient.NewListByDataBoxEdgeDevicePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/SACGetAllInDevice.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewStorageAccountCredentialsClient().NewListByDataBoxEdgeDevicePager("testedgedevice", "GroupForEdgeAutomation", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.StorageAccountCredentialList = armdataboxedge.StorageAccountCredentialList{
		// 	Value: []*armdataboxedge.StorageAccountCredential{
		// 		{
		// 			Name: to.Ptr("sac1128180128323"),
		// 			Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials"),
		// 			ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1128180128323"),
		// 			Properties: &armdataboxedge.StorageAccountCredentialProperties{
		// 				AccountType: to.Ptr(armdataboxedge.AccountTypeGeneralPurposeStorage),
		// 				Alias: to.Ptr("sac1128180128323"),
		// 				SSLStatus: to.Ptr(armdataboxedge.SSLStatusDisabled),
		// 				UserName: to.Ptr("cisbvt"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("sac1128180128312"),
		// 			Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials"),
		// 			ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1128180128312"),
		// 			Properties: &armdataboxedge.StorageAccountCredentialProperties{
		// 				AccountType: to.Ptr(armdataboxedge.AccountTypeBlobStorage),
		// 				Alias: to.Ptr("sac1128180128312"),
		// 				SSLStatus: to.Ptr(armdataboxedge.SSLStatusDisabled),
		// 				UserName: to.Ptr("cisbvt"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type StorageAccountCredentialsClientBeginCreateOrUpdateOptions added in v0.2.0 

type StorageAccountCredentialsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

StorageAccountCredentialsClientBeginCreateOrUpdateOptions contains the optional parameters for the StorageAccountCredentialsClient.BeginCreateOrUpdate method.

type StorageAccountCredentialsClientBeginDeleteOptions added in v0.2.0 

type StorageAccountCredentialsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

StorageAccountCredentialsClientBeginDeleteOptions contains the optional parameters for the StorageAccountCredentialsClient.BeginDelete method.

type StorageAccountCredentialsClientCreateOrUpdateResponse added in v0.2.0 

type StorageAccountCredentialsClientCreateOrUpdateResponse struct {
	// The storage account credential.
	StorageAccountCredential
}

StorageAccountCredentialsClientCreateOrUpdateResponse contains the response from method StorageAccountCredentialsClient.BeginCreateOrUpdate.

type StorageAccountCredentialsClientDeleteResponse added in v0.2.0 

type StorageAccountCredentialsClientDeleteResponse struct {
}

StorageAccountCredentialsClientDeleteResponse contains the response from method StorageAccountCredentialsClient.BeginDelete.

type StorageAccountCredentialsClientGetOptions added in v0.2.0 

type StorageAccountCredentialsClientGetOptions struct {
}

StorageAccountCredentialsClientGetOptions contains the optional parameters for the StorageAccountCredentialsClient.Get method.

type StorageAccountCredentialsClientGetResponse added in v0.2.0 

type StorageAccountCredentialsClientGetResponse struct {
	// The storage account credential.
	StorageAccountCredential
}

StorageAccountCredentialsClientGetResponse contains the response from method StorageAccountCredentialsClient.Get.

type StorageAccountCredentialsClientListByDataBoxEdgeDeviceOptions added in v0.2.0 

type StorageAccountCredentialsClientListByDataBoxEdgeDeviceOptions struct {
}

StorageAccountCredentialsClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the StorageAccountCredentialsClient.NewListByDataBoxEdgeDevicePager method.

type StorageAccountCredentialsClientListByDataBoxEdgeDeviceResponse added in v0.2.0 

type StorageAccountCredentialsClientListByDataBoxEdgeDeviceResponse struct {
	// The collection of storage account credentials.
	StorageAccountCredentialList
}

StorageAccountCredentialsClientListByDataBoxEdgeDeviceResponse contains the response from method StorageAccountCredentialsClient.NewListByDataBoxEdgeDevicePager.

type StorageAccountList 

type StorageAccountList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string

	// READ-ONLY; The list of storageAccounts.
	Value []*StorageAccount
}

StorageAccountList - Collection of all the Storage Accounts on the Data Box Edge/Gateway device.

func (StorageAccountList) MarshalJSON 

func (s StorageAccountList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StorageAccountList.

func (*StorageAccountList) UnmarshalJSON added in v1.1.0 

func (s *StorageAccountList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageAccountList.

type StorageAccountProperties 

type StorageAccountProperties struct {
	// REQUIRED; Data policy of the storage Account.
	DataPolicy *DataPolicy

	// Description for the storage Account.
	Description *string

	// Storage Account Credential Id
	StorageAccountCredentialID *string

	// Current status of the storage account
	StorageAccountStatus *StorageAccountStatus

	// READ-ONLY; BlobEndpoint of Storage Account
	BlobEndpoint *string

	// READ-ONLY; The Container Count. Present only for Storage Accounts with DataPolicy set to Cloud.
	ContainerCount *int32
}

StorageAccountProperties - The storage account properties.

func (StorageAccountProperties) MarshalJSON added in v1.1.0 

func (s StorageAccountProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StorageAccountProperties.

func (*StorageAccountProperties) UnmarshalJSON added in v1.1.0 

func (s *StorageAccountProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageAccountProperties.

type StorageAccountStatus 

type StorageAccountStatus string

StorageAccountStatus - Current status of the storage account 

const (
	StorageAccountStatusNeedsAttention StorageAccountStatus = "NeedsAttention"
	StorageAccountStatusOK             StorageAccountStatus = "OK"
	StorageAccountStatusOffline        StorageAccountStatus = "Offline"
	StorageAccountStatusUnknown        StorageAccountStatus = "Unknown"
	StorageAccountStatusUpdating       StorageAccountStatus = "Updating"
)

func PossibleStorageAccountStatusValues 

func PossibleStorageAccountStatusValues() []StorageAccountStatus

PossibleStorageAccountStatusValues returns the possible values for the StorageAccountStatus const type.

type StorageAccountsClient 

type StorageAccountsClient struct {
	// contains filtered or unexported fields
}

StorageAccountsClient contains the methods for the StorageAccounts group. Don't use this type directly, use NewStorageAccountsClient() instead.

func NewStorageAccountsClient 

func NewStorageAccountsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*StorageAccountsClient, error)

NewStorageAccountsClient creates a new instance of StorageAccountsClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*StorageAccountsClient) BeginCreateOrUpdate 

func (client *StorageAccountsClient) BeginCreateOrUpdate(ctx context.Context, deviceName string, storageAccountName string, resourceGroupName string, storageAccount StorageAccount, options *StorageAccountsClientBeginCreateOrUpdateOptions) (*runtime.Poller[StorageAccountsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a new StorageAccount or updates an existing StorageAccount on the device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • storageAccountName - The StorageAccount name.
  • resourceGroupName - The resource group name.
  • storageAccount - The StorageAccount properties.
  • options - StorageAccountsClientBeginCreateOrUpdateOptions contains the optional parameters for the StorageAccountsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/StorageAccountPut.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewStorageAccountsClient().BeginCreateOrUpdate(ctx, "testedgedevice", "blobstorageaccount1", "GroupForEdgeAutomation", armdataboxedge.StorageAccount{
		Properties: &armdataboxedge.StorageAccountProperties{
			Description:                to.Ptr("It's an awesome storage account"),
			DataPolicy:                 to.Ptr(armdataboxedge.DataPolicyCloud),
			StorageAccountCredentialID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/cisbvt"),
			StorageAccountStatus:       to.Ptr(armdataboxedge.StorageAccountStatusOK),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.StorageAccount = armdataboxedge.StorageAccount{
	// 	Name: to.Ptr("blobstorageaccount1"),
	// 	Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts"),
	// 	ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/blobstorageaccount1"),
	// 	Properties: &armdataboxedge.StorageAccountProperties{
	// 		Description: to.Ptr("It's an awesome storage account"),
	// 		BlobEndpoint: to.Ptr("https://blobstorageaccount1.blob.testedge.microsoftdatabox.com/"),
	// 		ContainerCount: to.Ptr[int32](0),
	// 		DataPolicy: to.Ptr(armdataboxedge.DataPolicyCloud),
	// 		StorageAccountCredentialID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/cisbvt"),
	// 		StorageAccountStatus: to.Ptr(armdataboxedge.StorageAccountStatusOK),
	// 	},
	// }
}

Output:

func (*StorageAccountsClient) BeginDelete 

func (client *StorageAccountsClient) BeginDelete(ctx context.Context, deviceName string, storageAccountName string, resourceGroupName string, options *StorageAccountsClientBeginDeleteOptions) (*runtime.Poller[StorageAccountsClientDeleteResponse], error)

BeginDelete - Deletes the StorageAccount on the Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • storageAccountName - The StorageAccount name.
  • resourceGroupName - The resource group name.
  • options - StorageAccountsClientBeginDeleteOptions contains the optional parameters for the StorageAccountsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/StorageAccountDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewStorageAccountsClient().BeginDelete(ctx, "testedgedevice", "storageaccount1", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*StorageAccountsClient) Get 

func (client *StorageAccountsClient) Get(ctx context.Context, deviceName string, storageAccountName string, resourceGroupName string, options *StorageAccountsClientGetOptions) (StorageAccountsClientGetResponse, error)

Get - Gets a StorageAccount by name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • storageAccountName - The storage account name.
  • resourceGroupName - The resource group name.
  • options - StorageAccountsClientGetOptions contains the optional parameters for the StorageAccountsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/StorageAccountGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewStorageAccountsClient().Get(ctx, "testedgedevice", "blobstorageaccount1", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.StorageAccount = armdataboxedge.StorageAccount{
	// 	Name: to.Ptr("blobstorageaccount1"),
	// 	Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts"),
	// 	ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/blobstorageaccount1"),
	// 	Properties: &armdataboxedge.StorageAccountProperties{
	// 		Description: to.Ptr("It's an awesome storage account"),
	// 		BlobEndpoint: to.Ptr("https://blobstorageaccount1.blob.testedge.microsoftdatabox.com/"),
	// 		ContainerCount: to.Ptr[int32](0),
	// 		DataPolicy: to.Ptr(armdataboxedge.DataPolicyCloud),
	// 		StorageAccountCredentialID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/cisbvt"),
	// 		StorageAccountStatus: to.Ptr(armdataboxedge.StorageAccountStatusOK),
	// 	},
	// }
}

Output:

func (*StorageAccountsClient) NewListByDataBoxEdgeDevicePager added in v0.4.0 

func (client *StorageAccountsClient) NewListByDataBoxEdgeDevicePager(deviceName string, resourceGroupName string, options *StorageAccountsClientListByDataBoxEdgeDeviceOptions) *runtime.Pager[StorageAccountsClientListByDataBoxEdgeDeviceResponse]

NewListByDataBoxEdgeDevicePager - Lists all the StorageAccounts in a Data Box Edge/Data Box Gateway device.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - StorageAccountsClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the StorageAccountsClient.NewListByDataBoxEdgeDevicePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/StorageAccountGetAllInDevice.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewStorageAccountsClient().NewListByDataBoxEdgeDevicePager("testedgedevice", "GroupForEdgeAutomation", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.StorageAccountList = armdataboxedge.StorageAccountList{
		// 	Value: []*armdataboxedge.StorageAccount{
		// 		{
		// 			Name: to.Ptr("blobstorageaccount1"),
		// 			Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts"),
		// 			ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/blobstorageaccount1"),
		// 			Properties: &armdataboxedge.StorageAccountProperties{
		// 				Description: to.Ptr("It's an awesome storage account"),
		// 				BlobEndpoint: to.Ptr("https://blobstorageaccount1.blob.testedge.microsoftdatabox.com/"),
		// 				ContainerCount: to.Ptr[int32](0),
		// 				DataPolicy: to.Ptr(armdataboxedge.DataPolicyCloud),
		// 				StorageAccountCredentialID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/cisbvt"),
		// 				StorageAccountStatus: to.Ptr(armdataboxedge.StorageAccountStatusOK),
		// 			},
		// 	}},
		// }
	}
}

Output:

type StorageAccountsClientBeginCreateOrUpdateOptions added in v0.2.0 

type StorageAccountsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

StorageAccountsClientBeginCreateOrUpdateOptions contains the optional parameters for the StorageAccountsClient.BeginCreateOrUpdate method.

type StorageAccountsClientBeginDeleteOptions added in v0.2.0 

type StorageAccountsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

StorageAccountsClientBeginDeleteOptions contains the optional parameters for the StorageAccountsClient.BeginDelete method.

type StorageAccountsClientCreateOrUpdateResponse added in v0.2.0 

type StorageAccountsClientCreateOrUpdateResponse struct {
	// Represents a Storage Account on the Data Box Edge/Gateway device.
	StorageAccount
}

StorageAccountsClientCreateOrUpdateResponse contains the response from method StorageAccountsClient.BeginCreateOrUpdate.

type StorageAccountsClientDeleteResponse added in v0.2.0 

type StorageAccountsClientDeleteResponse struct {
}

StorageAccountsClientDeleteResponse contains the response from method StorageAccountsClient.BeginDelete.

type StorageAccountsClientGetOptions added in v0.2.0 

type StorageAccountsClientGetOptions struct {
}

StorageAccountsClientGetOptions contains the optional parameters for the StorageAccountsClient.Get method.

type StorageAccountsClientGetResponse added in v0.2.0 

type StorageAccountsClientGetResponse struct {
	// Represents a Storage Account on the Data Box Edge/Gateway device.
	StorageAccount
}

StorageAccountsClientGetResponse contains the response from method StorageAccountsClient.Get.

type StorageAccountsClientListByDataBoxEdgeDeviceOptions added in v0.2.0 

type StorageAccountsClientListByDataBoxEdgeDeviceOptions struct {
}

StorageAccountsClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the StorageAccountsClient.NewListByDataBoxEdgeDevicePager method.

type StorageAccountsClientListByDataBoxEdgeDeviceResponse added in v0.2.0 

type StorageAccountsClientListByDataBoxEdgeDeviceResponse struct {
	// Collection of all the Storage Accounts on the Data Box Edge/Gateway device.
	StorageAccountList
}

StorageAccountsClientListByDataBoxEdgeDeviceResponse contains the response from method StorageAccountsClient.NewListByDataBoxEdgeDevicePager.

type SubscriptionProperties 

type SubscriptionProperties struct {
	LocationPlacementID *string
	QuotaID             *string
	RegisteredFeatures  []*SubscriptionRegisteredFeatures
	SerializedDetails   *string
	TenantID            *string
}

func (SubscriptionProperties) MarshalJSON 

func (s SubscriptionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SubscriptionProperties.

func (*SubscriptionProperties) UnmarshalJSON added in v1.1.0 

func (s *SubscriptionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SubscriptionProperties.

type SubscriptionRegisteredFeatures 

type SubscriptionRegisteredFeatures struct {
	Name  *string
	State *string
}

func (SubscriptionRegisteredFeatures) MarshalJSON added in v1.1.0 

func (s SubscriptionRegisteredFeatures) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SubscriptionRegisteredFeatures.

func (*SubscriptionRegisteredFeatures) UnmarshalJSON added in v1.1.0 

func (s *SubscriptionRegisteredFeatures) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SubscriptionRegisteredFeatures.

type SubscriptionState 

type SubscriptionState string
const (
	SubscriptionStateDeleted      SubscriptionState = "Deleted"
	SubscriptionStateRegistered   SubscriptionState = "Registered"
	SubscriptionStateSuspended    SubscriptionState = "Suspended"
	SubscriptionStateUnregistered SubscriptionState = "Unregistered"
	SubscriptionStateWarned       SubscriptionState = "Warned"
)

func PossibleSubscriptionStateValues 

func PossibleSubscriptionStateValues() []SubscriptionState

PossibleSubscriptionStateValues returns the possible values for the SubscriptionState const type.

type SupportPackageRequestProperties 

type SupportPackageRequestProperties struct {
	// Type of files, which need to be included in the logs This will contain the type of logs (Default/DefaultWithDumps/None/All/DefaultWithArchived)
	// or a comma separated list of log types that are required
	Include *string

	// Start of the timespan of the log collection
	MaximumTimeStamp *time.Time

	// MinimumTimeStamp from where logs need to be collected
	MinimumTimeStamp *time.Time
}

SupportPackageRequestProperties - The share properties.

func (SupportPackageRequestProperties) MarshalJSON 

func (s SupportPackageRequestProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SupportPackageRequestProperties.

func (*SupportPackageRequestProperties) UnmarshalJSON 

func (s *SupportPackageRequestProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SupportPackageRequestProperties.

type SupportPackagesClient 

type SupportPackagesClient struct {
	// contains filtered or unexported fields
}

SupportPackagesClient contains the methods for the SupportPackages group. Don't use this type directly, use NewSupportPackagesClient() instead.

func NewSupportPackagesClient 

func NewSupportPackagesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SupportPackagesClient, error)

NewSupportPackagesClient creates a new instance of SupportPackagesClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SupportPackagesClient) BeginTriggerSupportPackage 

func (client *SupportPackagesClient) BeginTriggerSupportPackage(ctx context.Context, deviceName string, resourceGroupName string, triggerSupportPackageRequest TriggerSupportPackageRequest, options *SupportPackagesClientBeginTriggerSupportPackageOptions) (*runtime.Poller[SupportPackagesClientTriggerSupportPackageResponse], error)

BeginTriggerSupportPackage - Triggers support package on the device If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • triggerSupportPackageRequest - The trigger support package request object
  • options - SupportPackagesClientBeginTriggerSupportPackageOptions contains the optional parameters for the SupportPackagesClient.BeginTriggerSupportPackage method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/TriggerSupportPackage.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSupportPackagesClient().BeginTriggerSupportPackage(ctx, "testedgedevice", "GroupForEdgeAutomation", armdataboxedge.TriggerSupportPackageRequest{
		Properties: &armdataboxedge.SupportPackageRequestProperties{
			Include:          to.Ptr("DefaultWithDumps"),
			MaximumTimeStamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-18T02:19:51.427Z"); return t }()),
			MinimumTimeStamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-18T02:18:51.427Z"); return t }()),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

type SupportPackagesClientBeginTriggerSupportPackageOptions added in v0.2.0 

type SupportPackagesClientBeginTriggerSupportPackageOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SupportPackagesClientBeginTriggerSupportPackageOptions contains the optional parameters for the SupportPackagesClient.BeginTriggerSupportPackage method.

type SupportPackagesClientTriggerSupportPackageResponse added in v0.2.0 

type SupportPackagesClientTriggerSupportPackageResponse struct {
}

SupportPackagesClientTriggerSupportPackageResponse contains the response from method SupportPackagesClient.BeginTriggerSupportPackage.

type SymmetricKey 

type SymmetricKey struct {
	// Connection string based on the symmetric key.
	ConnectionString *AsymmetricEncryptedSecret
}

SymmetricKey - Symmetric key for authentication.

func (SymmetricKey) MarshalJSON added in v1.1.0 

func (s SymmetricKey) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SymmetricKey.

func (*SymmetricKey) UnmarshalJSON added in v1.1.0 

func (s *SymmetricKey) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SymmetricKey.

type SystemData 

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time

	// The identity that created the resource.
	CreatedBy *string

	// The type of identity that created the resource.
	CreatedByType *CreatedByType

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time

	// The identity that last modified the resource.
	LastModifiedBy *string

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON 

func (s SystemData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON 

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type TimeGrain 

type TimeGrain string
const (
	TimeGrainPT12H TimeGrain = "PT12H"
	TimeGrainPT15M TimeGrain = "PT15M"
	TimeGrainPT1D  TimeGrain = "PT1D"
	TimeGrainPT1H  TimeGrain = "PT1H"
	TimeGrainPT1M  TimeGrain = "PT1M"
	TimeGrainPT30M TimeGrain = "PT30M"
	TimeGrainPT5M  TimeGrain = "PT5M"
	TimeGrainPT6H  TimeGrain = "PT6H"
)

func PossibleTimeGrainValues 

func PossibleTimeGrainValues() []TimeGrain

PossibleTimeGrainValues returns the possible values for the TimeGrain const type.

type TrackingInfo 

type TrackingInfo struct {
	// Name of the carrier used in the delivery.
	CarrierName *string

	// Serial number of the device being tracked.
	SerialNumber *string

	// Tracking ID of the shipment.
	TrackingID *string

	// Tracking URL of the shipment.
	TrackingURL *string
}

TrackingInfo - Tracking courier information.

func (TrackingInfo) MarshalJSON added in v1.1.0 

func (t TrackingInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrackingInfo.

func (*TrackingInfo) UnmarshalJSON added in v1.1.0 

func (t *TrackingInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TrackingInfo.

type Trigger 

type Trigger struct {
	// REQUIRED; Trigger Kind.
	Kind *TriggerEventType

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of Trigger
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

Trigger details.

func (*Trigger) GetTrigger 

func (t *Trigger) GetTrigger() *Trigger

GetTrigger implements the TriggerClassification interface for type Trigger.

func (Trigger) MarshalJSON added in v1.1.0 

func (t Trigger) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Trigger.

func (*Trigger) UnmarshalJSON 

func (t *Trigger) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Trigger.

type TriggerClassification 

type TriggerClassification interface {
	// GetTrigger returns the Trigger content of the underlying type.
	GetTrigger() *Trigger
}

TriggerClassification provides polymorphic access to related types. Call the interface's GetTrigger() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *FileEventTrigger, *PeriodicTimerEventTrigger, *Trigger

type TriggerEventType 

type TriggerEventType string

TriggerEventType - Trigger Kind. 

const (
	TriggerEventTypeFileEvent          TriggerEventType = "FileEvent"
	TriggerEventTypePeriodicTimerEvent TriggerEventType = "PeriodicTimerEvent"
)

func PossibleTriggerEventTypeValues 

func PossibleTriggerEventTypeValues() []TriggerEventType

PossibleTriggerEventTypeValues returns the possible values for the TriggerEventType const type.

type TriggerList 

type TriggerList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string

	// READ-ONLY; The list of triggers.
	Value []TriggerClassification
}

TriggerList - Collection of all trigger on the data box edge device.

func (TriggerList) MarshalJSON 

func (t TriggerList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TriggerList.

func (*TriggerList) UnmarshalJSON 

func (t *TriggerList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TriggerList.

type TriggerSupportPackageRequest 

type TriggerSupportPackageRequest struct {
	// REQUIRED; The TriggerSupportPackageRequest properties.
	Properties *SupportPackageRequestProperties

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

TriggerSupportPackageRequest - The request object for trigger support package.

func (TriggerSupportPackageRequest) MarshalJSON 

func (t TriggerSupportPackageRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TriggerSupportPackageRequest.

func (*TriggerSupportPackageRequest) UnmarshalJSON 

func (t *TriggerSupportPackageRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TriggerSupportPackageRequest.

type TriggersClient 

type TriggersClient struct {
	// contains filtered or unexported fields
}

TriggersClient contains the methods for the Triggers group. Don't use this type directly, use NewTriggersClient() instead.

func NewTriggersClient 

func NewTriggersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*TriggersClient, error)

NewTriggersClient creates a new instance of TriggersClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*TriggersClient) BeginCreateOrUpdate 

func (client *TriggersClient) BeginCreateOrUpdate(ctx context.Context, deviceName string, name string, resourceGroupName string, trigger TriggerClassification, options *TriggersClientBeginCreateOrUpdateOptions) (*runtime.Poller[TriggersClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a trigger. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - Creates or updates a trigger
  • name - The trigger name.
  • resourceGroupName - The resource group name.
  • trigger - The trigger.
  • options - TriggersClientBeginCreateOrUpdateOptions contains the optional parameters for the TriggersClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/TriggerPut.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewTriggersClient().BeginCreateOrUpdate(ctx, "testedgedevice", "trigger1", "GroupForEdgeAutomation", &armdataboxedge.FileEventTrigger{
		Kind: to.Ptr(armdataboxedge.TriggerEventTypeFileEvent),
		Properties: &armdataboxedge.FileTriggerProperties{
			CustomContextTag: to.Ptr("CustomContextTags-1235346475"),
			SinkInfo: &armdataboxedge.RoleSinkInfo{
				RoleID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1"),
			},
			SourceInfo: &armdataboxedge.FileSourceInfo{
				ShareID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdataboxedge.TriggersClientCreateOrUpdateResponse{
	// 	                            TriggerClassification: &armdataboxedge.FileEventTrigger{
	// 		Name: to.Ptr("trigger1"),
	// 		Type: to.Ptr("dataBoxEdgeDevices/triggers"),
	// 		ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1"),
	// 		Kind: to.Ptr(armdataboxedge.TriggerEventTypeFileEvent),
	// 		Properties: &armdataboxedge.FileTriggerProperties{
	// 			CustomContextTag: to.Ptr("CustomContextTags-1235346475"),
	// 			SinkInfo: &armdataboxedge.RoleSinkInfo{
	// 				RoleID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1"),
	// 			},
	// 			SourceInfo: &armdataboxedge.FileSourceInfo{
	// 				ShareID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1"),
	// 			},
	// 		},
	// 	},
	// 	                        }
}

Output:

func (*TriggersClient) BeginDelete 

func (client *TriggersClient) BeginDelete(ctx context.Context, deviceName string, name string, resourceGroupName string, options *TriggersClientBeginDeleteOptions) (*runtime.Poller[TriggersClientDeleteResponse], error)

BeginDelete - Deletes the trigger on the gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • name - The trigger name.
  • resourceGroupName - The resource group name.
  • options - TriggersClientBeginDeleteOptions contains the optional parameters for the TriggersClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/TriggerDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewTriggersClient().BeginDelete(ctx, "testedgedevice", "trigger1", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*TriggersClient) Get 

func (client *TriggersClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string, options *TriggersClientGetOptions) (TriggersClientGetResponse, error)

Get - Get a specific trigger by name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • name - The trigger name.
  • resourceGroupName - The resource group name.
  • options - TriggersClientGetOptions contains the optional parameters for the TriggersClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/TriggerGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewTriggersClient().Get(ctx, "testedgedevice", "trigger1", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdataboxedge.TriggersClientGetResponse{
	// 	                            TriggerClassification: &armdataboxedge.FileEventTrigger{
	// 		Name: to.Ptr("trigger1"),
	// 		Type: to.Ptr("dataBoxEdgeDevices/triggers"),
	// 		ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1"),
	// 		Kind: to.Ptr(armdataboxedge.TriggerEventTypeFileEvent),
	// 		Properties: &armdataboxedge.FileTriggerProperties{
	// 			CustomContextTag: to.Ptr("CustomContextTags-1235346475"),
	// 			SinkInfo: &armdataboxedge.RoleSinkInfo{
	// 				RoleID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1"),
	// 			},
	// 			SourceInfo: &armdataboxedge.FileSourceInfo{
	// 				ShareID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1"),
	// 			},
	// 		},
	// 	},
	// 	                        }
}

Output:

func (*TriggersClient) NewListByDataBoxEdgeDevicePager added in v0.4.0 

func (client *TriggersClient) NewListByDataBoxEdgeDevicePager(deviceName string, resourceGroupName string, options *TriggersClientListByDataBoxEdgeDeviceOptions) *runtime.Pager[TriggersClientListByDataBoxEdgeDeviceResponse]

NewListByDataBoxEdgeDevicePager - Lists all the triggers configured in the device.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - TriggersClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the TriggersClient.NewListByDataBoxEdgeDevicePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/TriggerGetAllInDevice.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewTriggersClient().NewListByDataBoxEdgeDevicePager("testedgedevice", "GroupForEdgeAutomation", &armdataboxedge.TriggersClientListByDataBoxEdgeDeviceOptions{Filter: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.TriggerList = armdataboxedge.TriggerList{
		// 	Value: []armdataboxedge.TriggerClassification{
		// 		&armdataboxedge.FileEventTrigger{
		// 			Name: to.Ptr("trigger1"),
		// 			Type: to.Ptr("dataBoxEdgeDevices/triggers"),
		// 			ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1"),
		// 			Kind: to.Ptr(armdataboxedge.TriggerEventTypeFileEvent),
		// 			Properties: &armdataboxedge.FileTriggerProperties{
		// 				CustomContextTag: to.Ptr("CustomContextTags-1235346475"),
		// 				SinkInfo: &armdataboxedge.RoleSinkInfo{
		// 					RoleID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1"),
		// 				},
		// 				SourceInfo: &armdataboxedge.FileSourceInfo{
		// 					ShareID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1"),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

Output:

type TriggersClientBeginCreateOrUpdateOptions added in v0.2.0 

type TriggersClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

TriggersClientBeginCreateOrUpdateOptions contains the optional parameters for the TriggersClient.BeginCreateOrUpdate method.

type TriggersClientBeginDeleteOptions added in v0.2.0 

type TriggersClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

TriggersClientBeginDeleteOptions contains the optional parameters for the TriggersClient.BeginDelete method.

type TriggersClientCreateOrUpdateResponse added in v0.2.0 

type TriggersClientCreateOrUpdateResponse struct {
	// Trigger details.
	TriggerClassification
}

TriggersClientCreateOrUpdateResponse contains the response from method TriggersClient.BeginCreateOrUpdate.

func (TriggersClientCreateOrUpdateResponse) MarshalJSON added in v1.2.0 

func (t TriggersClientCreateOrUpdateResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TriggersClientCreateOrUpdateResponse.

func (*TriggersClientCreateOrUpdateResponse) UnmarshalJSON added in v0.3.0 

func (t *TriggersClientCreateOrUpdateResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TriggersClientCreateOrUpdateResponse.

type TriggersClientDeleteResponse added in v0.2.0 

type TriggersClientDeleteResponse struct {
}

TriggersClientDeleteResponse contains the response from method TriggersClient.BeginDelete.

type TriggersClientGetOptions added in v0.2.0 

type TriggersClientGetOptions struct {
}

TriggersClientGetOptions contains the optional parameters for the TriggersClient.Get method.

type TriggersClientGetResponse added in v0.2.0 

type TriggersClientGetResponse struct {
	// Trigger details.
	TriggerClassification
}

TriggersClientGetResponse contains the response from method TriggersClient.Get.

func (*TriggersClientGetResponse) UnmarshalJSON added in v0.3.0 

func (t *TriggersClientGetResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TriggersClientGetResponse.

type TriggersClientListByDataBoxEdgeDeviceOptions added in v0.2.0 

type TriggersClientListByDataBoxEdgeDeviceOptions struct {
	// Specify $filter='CustomContextTag eq ' to filter on custom context tag property
	Filter *string
}

TriggersClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the TriggersClient.NewListByDataBoxEdgeDevicePager method.

type TriggersClientListByDataBoxEdgeDeviceResponse added in v0.2.0 

type TriggersClientListByDataBoxEdgeDeviceResponse struct {
	// Collection of all trigger on the data box edge device.
	TriggerList
}

TriggersClientListByDataBoxEdgeDeviceResponse contains the response from method TriggersClient.NewListByDataBoxEdgeDevicePager.

type UpdateDetails 

type UpdateDetails struct {
	// Estimated Install Time for the update
	EstimatedInstallTimeInMins *int32

	// Friendly Version Number
	FriendlyVersionNumber *string

	// Impact of Installing an updateType
	InstallationImpact *InstallationImpact

	// Indicates if updates are available and at least one of the updates needs a reboot.
	RebootBehavior *InstallRebootBehavior

	// Status of the update.
	Status *UpdateStatus

	// Target Version number
	TargetVersion *string

	// Size of the update(In Bytes)
	UpdateSize *float64

	// Title of the Update
	UpdateTitle *string

	// Type of the Update
	UpdateType *UpdateType
}

UpdateDetails - Update Specific attributes

func (UpdateDetails) MarshalJSON added in v1.1.0 

func (u UpdateDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpdateDetails.

func (*UpdateDetails) UnmarshalJSON added in v1.1.0 

func (u *UpdateDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateDetails.

type UpdateDownloadProgress 

type UpdateDownloadProgress struct {
	// READ-ONLY; The download phase.
	DownloadPhase *DownloadPhase

	// READ-ONLY; Number of updates downloaded.
	NumberOfUpdatesDownloaded *int32

	// READ-ONLY; Number of updates to download.
	NumberOfUpdatesToDownload *int32

	// READ-ONLY; Percentage of completion.
	PercentComplete *int32

	// READ-ONLY; Total bytes downloaded.
	TotalBytesDownloaded *float64

	// READ-ONLY; Total bytes to download.
	TotalBytesToDownload *float64
}

UpdateDownloadProgress - Details about the download progress of update.

func (UpdateDownloadProgress) MarshalJSON added in v1.1.0 

func (u UpdateDownloadProgress) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpdateDownloadProgress.

func (*UpdateDownloadProgress) UnmarshalJSON added in v1.1.0 

func (u *UpdateDownloadProgress) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateDownloadProgress.

type UpdateInstallProgress 

type UpdateInstallProgress struct {
	// READ-ONLY; Number of updates installed.
	NumberOfUpdatesInstalled *int32

	// READ-ONLY; Number of updates to install.
	NumberOfUpdatesToInstall *int32

	// READ-ONLY; Percentage completed.
	PercentComplete *int32
}

UpdateInstallProgress - Progress details during installation of updates.

func (UpdateInstallProgress) MarshalJSON added in v1.1.0 

func (u UpdateInstallProgress) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpdateInstallProgress.

func (*UpdateInstallProgress) UnmarshalJSON added in v1.1.0 

func (u *UpdateInstallProgress) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateInstallProgress.

type UpdateOperation 

type UpdateOperation string

UpdateOperation - The current update operation. 

const (
	UpdateOperationDownload UpdateOperation = "Download"
	UpdateOperationInstall  UpdateOperation = "Install"
	UpdateOperationNone     UpdateOperation = "None"
	UpdateOperationScan     UpdateOperation = "Scan"
)

func PossibleUpdateOperationValues 

func PossibleUpdateOperationValues() []UpdateOperation

PossibleUpdateOperationValues returns the possible values for the UpdateOperation const type.

type UpdateOperationStage 

type UpdateOperationStage string

UpdateOperationStage - Current stage of the update operation. 

const (
	UpdateOperationStageDownloadComplete UpdateOperationStage = "DownloadComplete"
	UpdateOperationStageDownloadFailed   UpdateOperationStage = "DownloadFailed"
	UpdateOperationStageDownloadStarted  UpdateOperationStage = "DownloadStarted"
	UpdateOperationStageFailure          UpdateOperationStage = "Failure"
	UpdateOperationStageInitial          UpdateOperationStage = "Initial"
	UpdateOperationStageInstallComplete  UpdateOperationStage = "InstallComplete"
	UpdateOperationStageInstallFailed    UpdateOperationStage = "InstallFailed"
	UpdateOperationStageInstallStarted   UpdateOperationStage = "InstallStarted"
	UpdateOperationStageRebootInitiated  UpdateOperationStage = "RebootInitiated"
	UpdateOperationStageRescanComplete   UpdateOperationStage = "RescanComplete"
	UpdateOperationStageRescanFailed     UpdateOperationStage = "RescanFailed"
	UpdateOperationStageRescanStarted    UpdateOperationStage = "RescanStarted"
	UpdateOperationStageScanComplete     UpdateOperationStage = "ScanComplete"
	UpdateOperationStageScanFailed       UpdateOperationStage = "ScanFailed"
	UpdateOperationStageScanStarted      UpdateOperationStage = "ScanStarted"
	UpdateOperationStageSuccess          UpdateOperationStage = "Success"
	UpdateOperationStageUnknown          UpdateOperationStage = "Unknown"
)

func PossibleUpdateOperationStageValues 

func PossibleUpdateOperationStageValues() []UpdateOperationStage

PossibleUpdateOperationStageValues returns the possible values for the UpdateOperationStage const type.

type UpdateStatus 

type UpdateStatus string

UpdateStatus - Status of the update. 

const (
	UpdateStatusDownloadCompleted UpdateStatus = "DownloadCompleted"
	UpdateStatusDownloadPending   UpdateStatus = "DownloadPending"
	UpdateStatusDownloadStarted   UpdateStatus = "DownloadStarted"
	UpdateStatusInstallCompleted  UpdateStatus = "InstallCompleted"
	UpdateStatusInstallStarted    UpdateStatus = "InstallStarted"
)

func PossibleUpdateStatusValues 

func PossibleUpdateStatusValues() []UpdateStatus

PossibleUpdateStatusValues returns the possible values for the UpdateStatus const type.

type UpdateSummary 

type UpdateSummary struct {
	// The device update information summary.
	Properties *UpdateSummaryProperties

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of UpdateSummary
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

UpdateSummary - Details about ongoing updates and availability of updates on the device.

func (UpdateSummary) MarshalJSON 

func (u UpdateSummary) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpdateSummary.

func (*UpdateSummary) UnmarshalJSON 

func (u *UpdateSummary) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateSummary.

type UpdateSummaryProperties 

type UpdateSummaryProperties struct {
	// The last time when a scan was done on the device.
	DeviceLastScannedDateTime *time.Time

	// The current version of the device in format: 1.2.17312.13.",
	DeviceVersionNumber *string

	// The current version of the device in text format.
	FriendlyDeviceVersionName *string

	// The time when the last scan job was completed (success/cancelled/failed) on the appliance.
	LastCompletedScanJobDateTime *time.Time

	// The time when the Last Install job was completed successfully on the appliance
	LastSuccessfulInstallJobDateTime *time.Time

	// Time when the last scan job is successfully completed.
	LastSuccessfulScanJobTime *time.Time

	// READ-ONLY; The job ID of the download job in progress.
	InProgressDownloadJobID *string

	// READ-ONLY; The time when the currently running download (if any) started.
	InProgressDownloadJobStartedDateTime *time.Time

	// READ-ONLY; The job ID of the install job in progress.
	InProgressInstallJobID *string

	// READ-ONLY; The time when the currently running install (if any) started.
	InProgressInstallJobStartedDateTime *time.Time

	// READ-ONLY; The time when the last Download job was completed (success/cancelled/failed) on the appliance.
	LastCompletedDownloadJobDateTime *time.Time

	// READ-ONLY; JobId of the last ran download job.(Can be success/cancelled/failed)
	LastCompletedDownloadJobID *string

	// READ-ONLY; The time when the last Install job was completed (success/cancelled/failed) on the appliance.
	LastCompletedInstallJobDateTime *time.Time

	// READ-ONLY; JobId of the last ran install job.(Can be success/cancelled/failed)
	LastCompletedInstallJobID *string

	// READ-ONLY; JobStatus of the last ran download job.
	LastDownloadJobStatus *JobStatus

	// READ-ONLY; JobStatus of the last ran install job.
	LastInstallJobStatus *JobStatus

	// READ-ONLY; The current update operation.
	OngoingUpdateOperation *UpdateOperation

	// READ-ONLY; Indicates if updates are available and at least one of the updates needs a reboot.
	RebootBehavior *InstallRebootBehavior

	// READ-ONLY; The number of updates available for the current device version as per the last device scan.
	TotalNumberOfUpdatesAvailable *int32

	// READ-ONLY; The total number of items pending download.
	TotalNumberOfUpdatesPendingDownload *int32

	// READ-ONLY; The total number of items pending install.
	TotalNumberOfUpdatesPendingInstall *int32

	// READ-ONLY; The total time in Minutes
	TotalTimeInMinutes *int32

	// READ-ONLY; The total size of updates available for download in bytes.
	TotalUpdateSizeInBytes *float64

	// READ-ONLY; The list of updates available for install.
	UpdateTitles []*string

	// READ-ONLY; The list of updates available for install.
	Updates []*UpdateDetails
}

UpdateSummaryProperties - The device update information summary.

func (UpdateSummaryProperties) MarshalJSON 

func (u UpdateSummaryProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpdateSummaryProperties.

func (*UpdateSummaryProperties) UnmarshalJSON 

func (u *UpdateSummaryProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateSummaryProperties.

type UpdateType 

type UpdateType string

UpdateType - Type of the Update 

const (
	UpdateTypeFirmware   UpdateType = "Firmware"
	UpdateTypeKubernetes UpdateType = "Kubernetes"
	UpdateTypeSoftware   UpdateType = "Software"
)

func PossibleUpdateTypeValues 

func PossibleUpdateTypeValues() []UpdateType

PossibleUpdateTypeValues returns the possible values for the UpdateType const type.

type UploadCertificateRequest 

type UploadCertificateRequest struct {
	// REQUIRED; The Base 64 encoded certificate raw data.
	Properties *RawCertificateData
}

UploadCertificateRequest - The upload certificate request.

func (UploadCertificateRequest) MarshalJSON added in v1.1.0 

func (u UploadCertificateRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UploadCertificateRequest.

func (*UploadCertificateRequest) UnmarshalJSON added in v1.1.0 

func (u *UploadCertificateRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UploadCertificateRequest.

type UploadCertificateResponse 

type UploadCertificateResponse struct {
	// Specifies authentication type.
	AuthType *AuthenticationType

	// READ-ONLY; Identifier of the target resource that is the recipient of the requested token.
	AADAudience *string

	// READ-ONLY; Azure Active Directory tenant authority.
	AADAuthority *string

	// READ-ONLY; Azure Active Directory tenant ID.
	AADTenantID *string

	// READ-ONLY; The azure management endpoint audience.
	AzureManagementEndpointAudience *string

	// READ-ONLY; The resource ID of the Data Box Edge/Gateway device.
	ResourceID *string

	// READ-ONLY; Azure Active Directory service principal client ID.
	ServicePrincipalClientID *string

	// READ-ONLY; Azure Active Directory service principal object ID.
	ServicePrincipalObjectID *string
}

UploadCertificateResponse - The upload registration certificate response.

func (UploadCertificateResponse) MarshalJSON added in v1.1.0 

func (u UploadCertificateResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UploadCertificateResponse.

func (*UploadCertificateResponse) UnmarshalJSON added in v1.1.0 

func (u *UploadCertificateResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UploadCertificateResponse.

type User 

type User struct {
	// REQUIRED; The storage account credential properties.
	Properties *UserProperties

	// READ-ONLY; The path ID that uniquely identifies the object.
	ID *string

	// READ-ONLY; The object name.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of User
	SystemData *SystemData

	// READ-ONLY; The hierarchical type of the object.
	Type *string
}

User - Represents a user who has access to one or more shares on the Data Box Edge/Gateway device.

func (User) MarshalJSON 

func (u User) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type User.

func (*User) UnmarshalJSON 

func (u *User) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type User.

type UserAccessRight 

type UserAccessRight struct {
	// REQUIRED; Type of access to be allowed for the user.
	AccessType *ShareAccessType

	// REQUIRED; User ID (already existing in the device).
	UserID *string
}

UserAccessRight - The mapping between a particular user and the access type on the SMB share.

func (UserAccessRight) MarshalJSON added in v1.1.0 

func (u UserAccessRight) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserAccessRight.

func (*UserAccessRight) UnmarshalJSON added in v1.1.0 

func (u *UserAccessRight) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserAccessRight.

type UserList 

type UserList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string

	// READ-ONLY; The list of users.
	Value []*User
}

UserList - Collection of users.

func (UserList) MarshalJSON 

func (u UserList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserList.

func (*UserList) UnmarshalJSON added in v1.1.0 

func (u *UserList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserList.

type UserProperties 

type UserProperties struct {
	// REQUIRED; Type of the user.
	UserType *UserType

	// The password details.
	EncryptedPassword *AsymmetricEncryptedSecret

	// READ-ONLY; List of shares that the user has rights on. This field should not be specified during user creation.
	ShareAccessRights []*ShareAccessRight
}

UserProperties - The user properties.

func (UserProperties) MarshalJSON 

func (u UserProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserProperties.

func (*UserProperties) UnmarshalJSON added in v1.1.0 

func (u *UserProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserProperties.

type UserType 

type UserType string

UserType - Type of the user. 

const (
	UserTypeARM             UserType = "ARM"
	UserTypeLocalManagement UserType = "LocalManagement"
	UserTypeShare           UserType = "Share"
)

func PossibleUserTypeValues 

func PossibleUserTypeValues() []UserType

PossibleUserTypeValues returns the possible values for the UserType const type.

type UsersClient 

type UsersClient struct {
	// contains filtered or unexported fields
}

UsersClient contains the methods for the Users group. Don't use this type directly, use NewUsersClient() instead.

func NewUsersClient 

func NewUsersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*UsersClient, error)

NewUsersClient creates a new instance of UsersClient with the specified values.

  • subscriptionID - The subscription ID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*UsersClient) BeginCreateOrUpdate 

func (client *UsersClient) BeginCreateOrUpdate(ctx context.Context, deviceName string, name string, resourceGroupName string, userParam User, options *UsersClientBeginCreateOrUpdateOptions) (*runtime.Poller[UsersClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • name - The user name.
  • resourceGroupName - The resource group name.
  • userParam - The user details.
  • options - UsersClientBeginCreateOrUpdateOptions contains the optional parameters for the UsersClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/UserPut.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewUsersClient().BeginCreateOrUpdate(ctx, "testedgedevice", "user1", "GroupForEdgeAutomation", armdataboxedge.User{
		Properties: &armdataboxedge.UserProperties{
			EncryptedPassword: &armdataboxedge.AsymmetricEncryptedSecret{
				EncryptionAlgorithm:      to.Ptr(armdataboxedge.EncryptionAlgorithmNone),
				EncryptionCertThumbprint: to.Ptr("blah"),
				Value:                    to.Ptr("<value>"),
			},
			UserType: to.Ptr(armdataboxedge.UserTypeShare),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.User = armdataboxedge.User{
	// 	Name: to.Ptr("user1"),
	// 	Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/users"),
	// 	ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1"),
	// 	Properties: &armdataboxedge.UserProperties{
	// 		UserType: to.Ptr(armdataboxedge.UserTypeShare),
	// 	},
	// }
}

Output:

func (*UsersClient) BeginDelete 

func (client *UsersClient) BeginDelete(ctx context.Context, deviceName string, name string, resourceGroupName string, options *UsersClientBeginDeleteOptions) (*runtime.Poller[UsersClientDeleteResponse], error)

BeginDelete - Deletes the user on a databox edge/gateway device. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • name - The user name.
  • resourceGroupName - The resource group name.
  • options - UsersClientBeginDeleteOptions contains the optional parameters for the UsersClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/UserDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewUsersClient().BeginDelete(ctx, "testedgedevice", "user1", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*UsersClient) Get 

func (client *UsersClient) Get(ctx context.Context, deviceName string, name string, resourceGroupName string, options *UsersClientGetOptions) (UsersClientGetResponse, error)

Get - Gets the properties of the specified user. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • name - The user name.
  • resourceGroupName - The resource group name.
  • options - UsersClientGetOptions contains the optional parameters for the UsersClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/UserGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewUsersClient().Get(ctx, "testedgedevice", "user1", "GroupForEdgeAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.User = armdataboxedge.User{
	// 	Name: to.Ptr("user1"),
	// 	Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/users"),
	// 	ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1"),
	// 	Properties: &armdataboxedge.UserProperties{
	// 		UserType: to.Ptr(armdataboxedge.UserTypeShare),
	// 	},
	// }
}

Output:

func (*UsersClient) NewListByDataBoxEdgeDevicePager added in v0.4.0 

func (client *UsersClient) NewListByDataBoxEdgeDevicePager(deviceName string, resourceGroupName string, options *UsersClientListByDataBoxEdgeDeviceOptions) *runtime.Pager[UsersClientListByDataBoxEdgeDeviceResponse]

NewListByDataBoxEdgeDevicePager - Gets all the users registered on a Data Box Edge/Data Box Gateway device.

Generated from API version 2022-03-01

  • deviceName - The device name.
  • resourceGroupName - The resource group name.
  • options - UsersClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the UsersClient.NewListByDataBoxEdgeDevicePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2022-03-01/examples/UserGetAllInDevice.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databoxedge/armdataboxedge"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataboxedge.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewUsersClient().NewListByDataBoxEdgeDevicePager("testedgedevice", "GroupForEdgeAutomation", &armdataboxedge.UsersClientListByDataBoxEdgeDeviceOptions{Filter: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.UserList = armdataboxedge.UserList{
		// 	Value: []*armdataboxedge.User{
		// 		{
		// 			Name: to.Ptr("user2"),
		// 			Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/users"),
		// 			ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2"),
		// 			Properties: &armdataboxedge.UserProperties{
		// 				UserType: to.Ptr(armdataboxedge.UserTypeShare),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("user1"),
		// 			Type: to.Ptr("Microsoft.DataBoxEdge/dataBoxEdgeDevices/users"),
		// 			ID: to.Ptr("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1"),
		// 			Properties: &armdataboxedge.UserProperties{
		// 				UserType: to.Ptr(armdataboxedge.UserTypeShare),
		// 			},
		// 	}},
		// }
	}
}

Output:

type UsersClientBeginCreateOrUpdateOptions added in v0.2.0 

type UsersClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

UsersClientBeginCreateOrUpdateOptions contains the optional parameters for the UsersClient.BeginCreateOrUpdate method.

type UsersClientBeginDeleteOptions added in v0.2.0 

type UsersClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

UsersClientBeginDeleteOptions contains the optional parameters for the UsersClient.BeginDelete method.

type UsersClientCreateOrUpdateResponse added in v0.2.0 

type UsersClientCreateOrUpdateResponse struct {
	// Represents a user who has access to one or more shares on the Data Box Edge/Gateway device.
	User
}

UsersClientCreateOrUpdateResponse contains the response from method UsersClient.BeginCreateOrUpdate.

type UsersClientDeleteResponse added in v0.2.0 

type UsersClientDeleteResponse struct {
}

UsersClientDeleteResponse contains the response from method UsersClient.BeginDelete.

type UsersClientGetOptions added in v0.2.0 

type UsersClientGetOptions struct {
}

UsersClientGetOptions contains the optional parameters for the UsersClient.Get method.

type UsersClientGetResponse added in v0.2.0 

type UsersClientGetResponse struct {
	// Represents a user who has access to one or more shares on the Data Box Edge/Gateway device.
	User
}

UsersClientGetResponse contains the response from method UsersClient.Get.

type UsersClientListByDataBoxEdgeDeviceOptions added in v0.2.0 

type UsersClientListByDataBoxEdgeDeviceOptions struct {
	// Specify $filter='Type eq ' to filter on user type property
	Filter *string
}

UsersClientListByDataBoxEdgeDeviceOptions contains the optional parameters for the UsersClient.NewListByDataBoxEdgeDevicePager method.

type UsersClientListByDataBoxEdgeDeviceResponse added in v0.2.0 

type UsersClientListByDataBoxEdgeDeviceResponse struct {
	// Collection of users.
	UserList
}

UsersClientListByDataBoxEdgeDeviceResponse contains the response from method UsersClient.NewListByDataBoxEdgeDevicePager.

type VMMemory added in v0.3.0 

type VMMemory struct {
	// The current memory used by the virtual machine.
	CurrentMemoryUsageMB *int64

	// The total amount of RAM in the virtual machine, as seen by the guest operating system. For a virtual machine with dynamic
	// memory enabled, this represents the initial memory available at startup.
	StartupMemoryMB *int64
}

VMMemory - VmMemory Data.

func (VMMemory) MarshalJSON added in v1.1.0 

func (v VMMemory) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VMMemory.

func (*VMMemory) UnmarshalJSON added in v1.1.0 

func (v *VMMemory) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VMMemory.

type VMPlacementRequestResult added in v0.3.0 

type VMPlacementRequestResult struct {
	// Boolean value indicating if the VM(s) in VmSize can be created.
	IsFeasible *bool

	// Localized message to be displayed to the user to explain the check result.
	Message *string

	// MessageCode indicating reason for success or failure.
	MessageCode *string

	// List of VM sizes being checked.
	VMSize []*string
}

VMPlacementRequestResult - List of VM sizes being checked for creation on appliance along with corresponding result.

func (VMPlacementRequestResult) MarshalJSON added in v0.3.0 

func (v VMPlacementRequestResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VMPlacementRequestResult.

func (*VMPlacementRequestResult) UnmarshalJSON added in v1.1.0 

func (v *VMPlacementRequestResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VMPlacementRequestResult.

Source Files

View all Source files

Directories

Path Synopsis

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.