armiotsecurity

package module
v0.5.0 Latest Latest
Warning

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

 Go to latest Published: May 18, 2022 License: MIT Imports: 17 Imported by: 13

README

Azure IoT Security Module for Go

PkgGoDev

The armiotsecurity module provides operations for working with Azure IoT Security.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure IoT Security module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure IoT Security. 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.

Clients

Azure IoT Security modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client, err := armiotsecurity.NewDevicesClient(<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,
    },
}
client, err := armiotsecurity.NewDevicesClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the IoT Security 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 AuthorizedState 

type AuthorizedState string

AuthorizedState - Authorized state of the device. 

const (
	AuthorizedStateAuthorized   AuthorizedState = "Authorized"
	AuthorizedStateUnauthorized AuthorizedState = "Unauthorized"
)

func PossibleAuthorizedStateValues 

func PossibleAuthorizedStateValues() []AuthorizedState

PossibleAuthorizedStateValues returns the possible values for the AuthorizedState const type.

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 Criticality 

type Criticality string

Criticality - Device criticality. 

const (
	CriticalityHigh   Criticality = "High"
	CriticalityLow    Criticality = "Low"
	CriticalityNormal Criticality = "Normal"
)

func PossibleCriticalityValues 

func PossibleCriticalityValues() []Criticality

PossibleCriticalityValues returns the possible values for the Criticality const type.

type DefenderSettingsClient 

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

DefenderSettingsClient contains the methods for the DefenderSettings group. Don't use this type directly, use NewDefenderSettingsClient() instead.

func NewDefenderSettingsClient 

func NewDefenderSettingsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DefenderSettingsClient, error)

NewDefenderSettingsClient creates a new instance of DefenderSettingsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*DefenderSettingsClient) CreateOrUpdate 

func (client *DefenderSettingsClient) CreateOrUpdate(ctx context.Context, defenderSettingsModel DefenderSettingsModel, options *DefenderSettingsClientCreateOrUpdateOptions) (DefenderSettingsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update IoT Defender settings If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview defenderSettingsModel - The IoT defender settings model options - DefenderSettingsClientCreateOrUpdateOptions contains the optional parameters for the DefenderSettingsClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/DefenderSettings/Put.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/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewDefenderSettingsClient("20ff7fc3-e762-44dd-bd96-b71116dcdc23", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		armiotsecurity.DefenderSettingsModel{
			Properties: &armiotsecurity.DefenderSettingsProperties{
				DeviceQuota: to.Ptr[int32](2000),
				MdeIntegration: &armiotsecurity.DefenderSettingsPropertiesMdeIntegration{
					Status: to.Ptr(armiotsecurity.MdeIntegrationEnabled),
				},
				OnboardingKind: to.Ptr(armiotsecurity.OnboardingKindDefault),
				SentinelWorkspaceResourceIDs: []*string{
					to.Ptr("/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1")},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*DefenderSettingsClient) Delete 

func (client *DefenderSettingsClient) Delete(ctx context.Context, options *DefenderSettingsClientDeleteOptions) (DefenderSettingsClientDeleteResponse, error)

Delete - Delete IoT Defender settings If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview options - DefenderSettingsClientDeleteOptions contains the optional parameters for the DefenderSettingsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/DefenderSettings/Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewDefenderSettingsClient("20ff7fc3-e762-44dd-bd96-b71116dcdc23", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*DefenderSettingsClient) DownloadManagerActivation 

func (client *DefenderSettingsClient) DownloadManagerActivation(ctx context.Context, options *DefenderSettingsClientDownloadManagerActivationOptions) (DefenderSettingsClientDownloadManagerActivationResponse, error)

DownloadManagerActivation - Download manager activation data defined for this subscription If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview options - DefenderSettingsClientDownloadManagerActivationOptions contains the optional parameters for the DefenderSettingsClient.DownloadManagerActivation method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/DefenderSettings/DownloadManagerActivation.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewDefenderSettingsClient("20ff7fc3-e762-44dd-bd96-b71116dcdc23", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.DownloadManagerActivation(ctx,
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*DefenderSettingsClient) Get 

func (client *DefenderSettingsClient) Get(ctx context.Context, options *DefenderSettingsClientGetOptions) (DefenderSettingsClientGetResponse, error)

Get - Get IoT Defender Settings If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview options - DefenderSettingsClientGetOptions contains the optional parameters for the DefenderSettingsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/DefenderSettings/Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewDefenderSettingsClient("20ff7fc3-e762-44dd-bd96-b71116dcdc23", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*DefenderSettingsClient) List 

func (client *DefenderSettingsClient) List(ctx context.Context, options *DefenderSettingsClientListOptions) (DefenderSettingsClientListResponse, error)

List - List IoT Defender Settings If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview options - DefenderSettingsClientListOptions contains the optional parameters for the DefenderSettingsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/DefenderSettings/List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewDefenderSettingsClient("20ff7fc3-e762-44dd-bd96-b71116dcdc23", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.List(ctx,
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*DefenderSettingsClient) PackageDownloads 

func (client *DefenderSettingsClient) PackageDownloads(ctx context.Context, options *DefenderSettingsClientPackageDownloadsOptions) (DefenderSettingsClientPackageDownloadsResponse, error)

PackageDownloads - Information about downloadable packages If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview options - DefenderSettingsClientPackageDownloadsOptions contains the optional parameters for the DefenderSettingsClient.PackageDownloads method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/DefenderSettings/PackageDownloads.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewDefenderSettingsClient("20ff7fc3-e762-44dd-bd96-b71116dcdc23", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.PackageDownloads(ctx,
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type DefenderSettingsClientCreateOrUpdateOptions added in v0.2.0 

type DefenderSettingsClientCreateOrUpdateOptions struct {
}

DefenderSettingsClientCreateOrUpdateOptions contains the optional parameters for the DefenderSettingsClient.CreateOrUpdate method.

type DefenderSettingsClientCreateOrUpdateResponse added in v0.2.0 

type DefenderSettingsClientCreateOrUpdateResponse struct {
	DefenderSettingsModel
}

DefenderSettingsClientCreateOrUpdateResponse contains the response from method DefenderSettingsClient.CreateOrUpdate.

type DefenderSettingsClientDeleteOptions added in v0.2.0 

type DefenderSettingsClientDeleteOptions struct {
}

DefenderSettingsClientDeleteOptions contains the optional parameters for the DefenderSettingsClient.Delete method.

type DefenderSettingsClientDeleteResponse added in v0.2.0 

type DefenderSettingsClientDeleteResponse struct {
}

DefenderSettingsClientDeleteResponse contains the response from method DefenderSettingsClient.Delete.

type DefenderSettingsClientDownloadManagerActivationOptions added in v0.2.0 

type DefenderSettingsClientDownloadManagerActivationOptions struct {
}

DefenderSettingsClientDownloadManagerActivationOptions contains the optional parameters for the DefenderSettingsClient.DownloadManagerActivation method.

type DefenderSettingsClientDownloadManagerActivationResponse added in v0.2.0 

type DefenderSettingsClientDownloadManagerActivationResponse struct {
	// Body contains the streaming response.
	Body io.ReadCloser
}

DefenderSettingsClientDownloadManagerActivationResponse contains the response from method DefenderSettingsClient.DownloadManagerActivation.

type DefenderSettingsClientGetOptions added in v0.2.0 

type DefenderSettingsClientGetOptions struct {
}

DefenderSettingsClientGetOptions contains the optional parameters for the DefenderSettingsClient.Get method.

type DefenderSettingsClientGetResponse added in v0.2.0 

type DefenderSettingsClientGetResponse struct {
	DefenderSettingsModel
}

DefenderSettingsClientGetResponse contains the response from method DefenderSettingsClient.Get.

type DefenderSettingsClientListOptions added in v0.2.0 

type DefenderSettingsClientListOptions struct {
}

DefenderSettingsClientListOptions contains the optional parameters for the DefenderSettingsClient.List method.

type DefenderSettingsClientListResponse added in v0.2.0 

type DefenderSettingsClientListResponse struct {
	DefenderSettingsList
}

DefenderSettingsClientListResponse contains the response from method DefenderSettingsClient.List.

type DefenderSettingsClientPackageDownloadsOptions added in v0.2.0 

type DefenderSettingsClientPackageDownloadsOptions struct {
}

DefenderSettingsClientPackageDownloadsOptions contains the optional parameters for the DefenderSettingsClient.PackageDownloads method.

type DefenderSettingsClientPackageDownloadsResponse added in v0.2.0 

type DefenderSettingsClientPackageDownloadsResponse struct {
	PackageDownloads
}

DefenderSettingsClientPackageDownloadsResponse contains the response from method DefenderSettingsClient.PackageDownloads.

type DefenderSettingsList 

type DefenderSettingsList struct {
	// READ-ONLY; List data
	Value []*DefenderSettingsModel `json:"value,omitempty" azure:"ro"`
}

DefenderSettingsList - List of IoT Defender settings

type DefenderSettingsModel 

type DefenderSettingsModel struct {
	// IoT Defender settings properties
	Properties *DefenderSettingsProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

DefenderSettingsModel - IoT Defender settings

type DefenderSettingsProperties 

type DefenderSettingsProperties struct {
	// REQUIRED; Size of the device quota. Value is required to be in multiples of 100.
	DeviceQuota *int32 `json:"deviceQuota,omitempty"`

	// REQUIRED; MDE integration configuration
	MdeIntegration *DefenderSettingsPropertiesMdeIntegration `json:"mdeIntegration,omitempty"`

	// REQUIRED; The kind of onboarding for the subscription
	OnboardingKind *OnboardingKind `json:"onboardingKind,omitempty"`

	// REQUIRED; Sentinel Workspace Resource Ids
	SentinelWorkspaceResourceIDs []*string `json:"sentinelWorkspaceResourceIds,omitempty"`

	// READ-ONLY; End time of the evaluation period, if such exist
	EvaluationEndTime *time.Time `json:"evaluationEndTime,omitempty" azure:"ro"`
}

DefenderSettingsProperties - IoT Defender settings properties

func (DefenderSettingsProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DefenderSettingsProperties.

func (*DefenderSettingsProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DefenderSettingsProperties.

type DefenderSettingsPropertiesMdeIntegration 

type DefenderSettingsPropertiesMdeIntegration struct {
	// REQUIRED; Integration status
	Status *MdeIntegration `json:"status,omitempty"`
}

DefenderSettingsPropertiesMdeIntegration - MDE integration configuration

type DeviceDataSource 

type DeviceDataSource string

DeviceDataSource - Device data source 

const (
	DeviceDataSourceCorpSensor DeviceDataSource = "CorpSensor"
	DeviceDataSourceMde        DeviceDataSource = "Mde"
	DeviceDataSourceMicroAgent DeviceDataSource = "MicroAgent"
	DeviceDataSourceOtSensor   DeviceDataSource = "OtSensor"
	DeviceDataSourceOther      DeviceDataSource = "Other"
)

func PossibleDeviceDataSourceValues 

func PossibleDeviceDataSourceValues() []DeviceDataSource

PossibleDeviceDataSourceValues returns the possible values for the DeviceDataSource const type.

type DeviceGroupList 

type DeviceGroupList struct {
	// READ-ONLY; Link to next page of resources.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; List data
	Value []*DeviceGroupModel `json:"value,omitempty" azure:"ro"`
}

DeviceGroupList - List of device groups

type DeviceGroupModel 

type DeviceGroupModel struct {
	// Device group properties
	Properties interface{} `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

DeviceGroupModel - Device group

type DeviceGroupsClient 

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

DeviceGroupsClient contains the methods for the DeviceGroups group. Don't use this type directly, use NewDeviceGroupsClient() instead.

func NewDeviceGroupsClient 

func NewDeviceGroupsClient(subscriptionID string, iotDefenderLocation string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DeviceGroupsClient, error)

NewDeviceGroupsClient creates a new instance of DeviceGroupsClient with the specified values. subscriptionID - The ID of the target subscription. iotDefenderLocation - Defender for IoT location credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*DeviceGroupsClient) CreateOrUpdate 

func (client *DeviceGroupsClient) CreateOrUpdate(ctx context.Context, deviceGroupName string, deviceGroupModel DeviceGroupModel, options *DeviceGroupsClientCreateOrUpdateOptions) (DeviceGroupsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update device group If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview deviceGroupName - Device group name deviceGroupModel - Device group model options - DeviceGroupsClientCreateOrUpdateOptions contains the optional parameters for the DeviceGroupsClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/DeviceGroups/Put.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewDeviceGroupsClient("20ff7fc3-e762-44dd-bd96-b71116dcdc23",
		"eastus", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"myGroup",
		armiotsecurity.DeviceGroupModel{
			Properties: map[string]interface{}{},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*DeviceGroupsClient) Delete 

func (client *DeviceGroupsClient) Delete(ctx context.Context, deviceGroupName string, options *DeviceGroupsClientDeleteOptions) (DeviceGroupsClientDeleteResponse, error)

Delete - Delete device group If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview deviceGroupName - Device group name options - DeviceGroupsClientDeleteOptions contains the optional parameters for the DeviceGroupsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/DeviceGroups/Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewDeviceGroupsClient("20ff7fc3-e762-44dd-bd96-b71116dcdc23",
		"eastus", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"myGroup",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*DeviceGroupsClient) Get 

func (client *DeviceGroupsClient) Get(ctx context.Context, deviceGroupName string, options *DeviceGroupsClientGetOptions) (DeviceGroupsClientGetResponse, error)

Get - Get device group If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview deviceGroupName - Device group name options - DeviceGroupsClientGetOptions contains the optional parameters for the DeviceGroupsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/DeviceGroups/Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewDeviceGroupsClient("20ff7fc3-e762-44dd-bd96-b71116dcdc23",
		"eastus", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"myGroup",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*DeviceGroupsClient) NewListPager added in v0.4.0 

func (client *DeviceGroupsClient) NewListPager(options *DeviceGroupsClientListOptions) *runtime.Pager[DeviceGroupsClientListResponse]

NewListPager - List device groups If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview options - DeviceGroupsClientListOptions contains the optional parameters for the DeviceGroupsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/DeviceGroups/List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewDeviceGroupsClient("20ff7fc3-e762-44dd-bd96-b71116dcdc23",
		"eastus", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type DeviceGroupsClientCreateOrUpdateOptions added in v0.2.0 

type DeviceGroupsClientCreateOrUpdateOptions struct {
}

DeviceGroupsClientCreateOrUpdateOptions contains the optional parameters for the DeviceGroupsClient.CreateOrUpdate method.

type DeviceGroupsClientCreateOrUpdateResponse added in v0.2.0 

type DeviceGroupsClientCreateOrUpdateResponse struct {
	DeviceGroupModel
}

DeviceGroupsClientCreateOrUpdateResponse contains the response from method DeviceGroupsClient.CreateOrUpdate.

type DeviceGroupsClientDeleteOptions added in v0.2.0 

type DeviceGroupsClientDeleteOptions struct {
}

DeviceGroupsClientDeleteOptions contains the optional parameters for the DeviceGroupsClient.Delete method.

type DeviceGroupsClientDeleteResponse added in v0.2.0 

type DeviceGroupsClientDeleteResponse struct {
}

DeviceGroupsClientDeleteResponse contains the response from method DeviceGroupsClient.Delete.

type DeviceGroupsClientGetOptions added in v0.2.0 

type DeviceGroupsClientGetOptions struct {
}

DeviceGroupsClientGetOptions contains the optional parameters for the DeviceGroupsClient.Get method.

type DeviceGroupsClientGetResponse added in v0.2.0 

type DeviceGroupsClientGetResponse struct {
	DeviceGroupModel
}

DeviceGroupsClientGetResponse contains the response from method DeviceGroupsClient.Get.

type DeviceGroupsClientListOptions added in v0.2.0 

type DeviceGroupsClientListOptions struct {
}

DeviceGroupsClientListOptions contains the optional parameters for the DeviceGroupsClient.List method.

type DeviceGroupsClientListResponse added in v0.2.0 

type DeviceGroupsClientListResponse struct {
	DeviceGroupList
}

DeviceGroupsClientListResponse contains the response from method DeviceGroupsClient.List.

type DeviceList 

type DeviceList struct {
	// READ-ONLY; When there are too many devices for one page, use this URI to fetch the next page.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; List data
	Value []*DeviceModel `json:"value,omitempty" azure:"ro"`
}

DeviceList - List of devices

type DeviceModel 

type DeviceModel struct {
	// Device properties
	Properties *DeviceProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

DeviceModel - Device

type DeviceProperties 

type DeviceProperties struct {
	// A bag of fields which extends the device information.
	AdditionalFields interface{} `json:"additionalFields,omitempty"`

	// Authorized state of the device.
	AuthorizedState *AuthorizedState `json:"authorizedState,omitempty"`

	// Device business function
	BusinessFunction *string `json:"businessFunction,omitempty"`

	// Device criticality.
	Criticality *Criticality `json:"criticality,omitempty"`

	// Device category id
	DeviceCategoryID *int32 `json:"deviceCategoryId,omitempty"`

	// Device name
	DeviceName *string `json:"deviceName,omitempty"`

	// Device sub type id
	DeviceSubTypeID *int32 `json:"deviceSubTypeId,omitempty"`

	// Device tags
	DeviceTags []*string `json:"deviceTags,omitempty"`

	// Device type id
	DeviceTypeID *int32 `json:"deviceTypeId,omitempty"`

	// List of device firmwares.
	Firmwares []*Firmware `json:"firmwares,omitempty"`

	// Device hardware data
	Hardware *Hardware `json:"hardware,omitempty"`

	// Device operating system data
	OperatingSystem *OperatingSystem `json:"operatingSystem,omitempty"`

	// List of device packages
	Packages []*Package `json:"packages,omitempty"`

	// Purdue level of the device.
	PurdueLevel *PurdueLevel `json:"purdueLevel,omitempty"`

	// READ-ONLY; List of Common Platform Enumeration (CPE)
	Cpes []*string `json:"cpes,omitempty" azure:"ro"`

	// READ-ONLY; Device category display name
	DeviceCategoryDisplayName *string `json:"deviceCategoryDisplayName,omitempty" azure:"ro"`

	// READ-ONLY; Device data source.
	DeviceDataSource *DeviceDataSource `json:"deviceDataSource,omitempty" azure:"ro"`

	// READ-ONLY; Device status.
	DeviceStatus *DeviceStatus `json:"deviceStatus,omitempty" azure:"ro"`

	// READ-ONLY; Device sub type display name
	DeviceSubTypeDisplayName *string `json:"deviceSubTypeDisplayName,omitempty" azure:"ro"`

	// READ-ONLY; Device type display name
	DeviceTypeDisplayName *string `json:"deviceTypeDisplayName,omitempty" azure:"ro"`

	// READ-ONLY; First time the device was seen.
	FirstSeen *time.Time `json:"firstSeen,omitempty" azure:"ro"`

	// READ-ONLY; last time the device was programming or programed.
	LastProgrammingTime *time.Time `json:"lastProgrammingTime,omitempty" azure:"ro"`

	// READ-ONLY; Last time the device was seen.
	LastSeen *time.Time `json:"lastSeen,omitempty" azure:"ro"`

	// READ-ONLY; Last time the device was updated by the profiler.
	LastUpdated *time.Time `json:"lastUpdated,omitempty" azure:"ro"`

	// READ-ONLY; List of merged devices data
	MergedDevices []*MergedDevice `json:"mergedDevices,omitempty" azure:"ro"`

	// READ-ONLY; The device Id that this device was merged into
	MergedToDeviceID *string `json:"mergedToDeviceId,omitempty" azure:"ro"`

	// READ-ONLY; List of the device network interface cards.
	Nics []*Nic `json:"nics,omitempty" azure:"ro"`

	// READ-ONLY; Device onboarding status.
	OnboardingStatus *OnboardingStatus `json:"onboardingStatus,omitempty" azure:"ro"`

	// READ-ONLY; For nested device, this is the parent device id.
	ParentDeviceID *string `json:"parentDeviceId,omitempty" azure:"ro"`

	// READ-ONLY; For nested device, this is the rack number in the parent device that holds the nested device.
	ParentRackNumber *int32 `json:"parentRackNumber,omitempty" azure:"ro"`

	// READ-ONLY; For nested device, this is the slot number in the parent device that holds the nested device.
	ParentSlotNumber *int32 `json:"parentSlotNumber,omitempty" azure:"ro"`

	// READ-ONLY; Confidence of the device profile
	ProfilingConfidence *int32 `json:"profilingConfidence,omitempty" azure:"ro"`

	// READ-ONLY; Indicates whether this device is programming
	ProgrammingState *ProgrammingState `json:"programmingState,omitempty" azure:"ro"`

	// READ-ONLY; risk score of the device.
	RiskScore *int32 `json:"riskScore,omitempty" azure:"ro"`

	// READ-ONLY; Version of the device model schema
	SchemaVersion *string `json:"schemaVersion,omitempty" azure:"ro"`

	// READ-ONLY; Sensor that scanned this device.
	Sensor *Sensor `json:"sensor,omitempty" azure:"ro"`

	// READ-ONLY; List of the device slot in the backplane
	Slots []*Slot `json:"slots,omitempty" azure:"ro"`
}

DeviceProperties - Device properties

func (DeviceProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DeviceProperties.

func (*DeviceProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DeviceProperties.

type DeviceStatus 

type DeviceStatus string

DeviceStatus - Device status. 

const (
	DeviceStatusActive   DeviceStatus = "Active"
	DeviceStatusDeleted  DeviceStatus = "Deleted"
	DeviceStatusInactive DeviceStatus = "Inactive"
	DeviceStatusRemoved  DeviceStatus = "Removed"
)

func PossibleDeviceStatusValues 

func PossibleDeviceStatusValues() []DeviceStatus

PossibleDeviceStatusValues returns the possible values for the DeviceStatus 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, iotDefenderLocation string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DevicesClient, error)

NewDevicesClient creates a new instance of DevicesClient with the specified values. subscriptionID - The ID of the target subscription. iotDefenderLocation - Defender for IoT location credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*DevicesClient) Get 

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

Get - Get device If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview deviceGroupName - Device group name deviceID - Device Id options - DevicesClientGetOptions contains the optional parameters for the DevicesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/Devices/Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewDevicesClient("20ff7fc3-e762-44dd-bd96-b71116dcdc23",
		"eastus", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"myGroup",
		"fa30e727-16e1-4e81-84f1-d26b9153d1b2",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*DevicesClient) NewListPager added in v0.4.0 

func (client *DevicesClient) NewListPager(deviceGroupName string, options *DevicesClientListOptions) *runtime.Pager[DevicesClientListResponse]

NewListPager - List devices If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview deviceGroupName - Device group name options - DevicesClientListOptions contains the optional parameters for the DevicesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/Devices/List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewDevicesClient("20ff7fc3-e762-44dd-bd96-b71116dcdc23",
		"eastus", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager("myGroup",
		&armiotsecurity.DevicesClientListOptions{SkipToken: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

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 {
	DeviceModel
}

DevicesClientGetResponse contains the response from method DevicesClient.Get.

type DevicesClientListOptions added in v0.2.0 

type DevicesClientListOptions struct {
	// Skip token used for pagination
	SkipToken *string
}

DevicesClientListOptions contains the optional parameters for the DevicesClient.List method.

type DevicesClientListResponse added in v0.2.0 

type DevicesClientListResponse struct {
	DeviceList
}

DevicesClientListResponse contains the response from method DevicesClient.List.

type DimensionProperties 

type DimensionProperties struct {
	// localized display name of the dimension to customer
	DisplayName *string `json:"displayName,omitempty"`

	// dimension name
	Name *string `json:"name,omitempty"`

	// flag indicating whether this dimension should be included to the customer in Azure Monitor logs (aka Shoebox)
	ToBeExportedForCustomer *bool `json:"toBeExportedForCustomer,omitempty"`
}

DimensionProperties - properties for dimension

type ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info interface{} `json:"info,omitempty" azure:"ro"`

	// READ-ONLY; The additional info type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ErrorAdditionalInfo - The resource management error additional info.

type ErrorDetail 

type ErrorDetail struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo `json:"additionalInfo,omitempty" azure:"ro"`

	// READ-ONLY; The error code.
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; The error details.
	Details []*ErrorDetail `json:"details,omitempty" azure:"ro"`

	// READ-ONLY; The error message.
	Message *string `json:"message,omitempty" azure:"ro"`

	// READ-ONLY; The error target.
	Target *string `json:"target,omitempty" azure:"ro"`
}

ErrorDetail - The error detail.

type ErrorModel 

type ErrorModel struct {
	// READ-ONLY; Gets or sets the code.
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; Gets or sets the details.
	Details []*ErrorModel `json:"details,omitempty" azure:"ro"`

	// READ-ONLY; Gets or sets the messages.
	Message *string `json:"message,omitempty" azure:"ro"`

	// READ-ONLY; Gets or sets the target.
	Target *string `json:"target,omitempty" azure:"ro"`
}

ErrorModel - Default error model

type ErrorResponse 

type ErrorResponse struct {
	// The error object.
	Error *ErrorDetail `json:"error,omitempty"`
}

ErrorResponse - Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

type ErrorResponseModel 

type ErrorResponseModel struct {
	// READ-ONLY; Gets or sets the error.
	Error *ErrorResponseModelError `json:"error,omitempty" azure:"ro"`
}

ErrorResponseModel - Default error response model

type ErrorResponseModelError 

type ErrorResponseModelError struct {
	// READ-ONLY; Gets or sets the code.
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; Gets or sets the details.
	Details []*ErrorModel `json:"details,omitempty" azure:"ro"`

	// READ-ONLY; Gets or sets the messages.
	Message *string `json:"message,omitempty" azure:"ro"`

	// READ-ONLY; Gets or sets the target.
	Target *string `json:"target,omitempty" azure:"ro"`
}

ErrorResponseModelError - Gets or sets the error.

type Firmware 

type Firmware struct {
	// A bag of fields which extends the firmware information.
	AdditionalFields interface{} `json:"additionalFields,omitempty"`

	// Firmware module address.
	ModuleAddress *string `json:"moduleAddress,omitempty"`

	// Firmware name.
	Name *string `json:"name,omitempty"`

	// Firmware serial.
	Serial *string `json:"serial,omitempty"`

	// Firmware vendor.
	Vendor *string `json:"vendor,omitempty"`

	// Firmware version.
	Version *string `json:"version,omitempty"`
}

Firmware - Device firmware data

type Hardware 

type Hardware struct {
	// Hardware model.
	Model *string `json:"model,omitempty"`

	// Hardware serial number.
	SerialNumber *string `json:"serialNumber,omitempty"`

	// Hardware vendor.
	Vendor *string `json:"vendor,omitempty"`
}

Hardware - Device hardware data

type LocationList 

type LocationList struct {
	// READ-ONLY; Link to next page of resources.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; List data
	Value []*LocationModel `json:"value,omitempty" azure:"ro"`
}

LocationList - List of Defender for IoT locations

type LocationModel 

type LocationModel struct {
	// IoT Defender location properties
	Properties interface{} `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

LocationModel - IoT Defender location

type LocationsClient 

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

LocationsClient contains the methods for the Locations group. Don't use this type directly, use NewLocationsClient() instead.

func NewLocationsClient 

func NewLocationsClient(subscriptionID string, iotDefenderLocation string, credential azcore.TokenCredential, options *arm.ClientOptions) (*LocationsClient, error)

NewLocationsClient creates a new instance of LocationsClient with the specified values. subscriptionID - The ID of the target subscription. iotDefenderLocation - Defender for IoT location credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*LocationsClient) Get 

func (client *LocationsClient) Get(ctx context.Context, options *LocationsClientGetOptions) (LocationsClientGetResponse, error)

Get - Get a Defender for IoT location associated with the given subscription. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview options - LocationsClientGetOptions contains the optional parameters for the LocationsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/Locations/Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewLocationsClient("20ff7fc3-e762-44dd-bd96-b71116dcdc23",
		"eastus", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*LocationsClient) NewListPager added in v0.4.0 

func (client *LocationsClient) NewListPager(options *LocationsClientListOptions) *runtime.Pager[LocationsClientListResponse]

NewListPager - Lists Defender for IoT locations associated with the given subscription. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview options - LocationsClientListOptions contains the optional parameters for the LocationsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/Locations/List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewLocationsClient("20ff7fc3-e762-44dd-bd96-b71116dcdc23",
		"<iot-defender-location>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type LocationsClientGetOptions added in v0.2.0 

type LocationsClientGetOptions struct {
}

LocationsClientGetOptions contains the optional parameters for the LocationsClient.Get method.

type LocationsClientGetResponse added in v0.2.0 

type LocationsClientGetResponse struct {
	LocationModel
}

LocationsClientGetResponse contains the response from method LocationsClient.Get.

type LocationsClientListOptions added in v0.2.0 

type LocationsClientListOptions struct {
}

LocationsClientListOptions contains the optional parameters for the LocationsClient.List method.

type LocationsClientListResponse added in v0.2.0 

type LocationsClientListResponse struct {
	LocationList
}

LocationsClientListResponse contains the response from method LocationsClient.List.

type MacCertainty 

type MacCertainty string

MacCertainty - Indicates whether the association of the mac to the ip address is certain or a guess. 

const (
	MacCertaintyCertain MacCertainty = "Certain"
	MacCertaintyGuess   MacCertainty = "Guess"
)

func PossibleMacCertaintyValues 

func PossibleMacCertaintyValues() []MacCertainty

PossibleMacCertaintyValues returns the possible values for the MacCertainty const type.

type MdeIntegration 

type MdeIntegration string

MdeIntegration - Integration status 

const (
	MdeIntegrationDisabled MdeIntegration = "Disabled"
	MdeIntegrationEnabled  MdeIntegration = "Enabled"
)

func PossibleMdeIntegrationValues 

func PossibleMdeIntegrationValues() []MdeIntegration

PossibleMdeIntegrationValues returns the possible values for the MdeIntegration const type.

type MergedDevice 

type MergedDevice struct {
	// READ-ONLY; Device data source
	DeviceDataSource *DeviceDataSource `json:"deviceDataSource,omitempty" azure:"ro"`

	// READ-ONLY; device id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Device sensor data
	Sensor *Sensor `json:"sensor,omitempty" azure:"ro"`
}

MergedDevice - Merged device data

type Nic 

type Nic struct {
	// READ-ONLY; Ipv4 address
	IPv4Address *string `json:"ipv4Address,omitempty" azure:"ro"`

	// READ-ONLY; Ipv6 address
	IPv6Address *string `json:"ipv6Address,omitempty" azure:"ro"`

	// READ-ONLY; Last seen time
	LastSeen *time.Time `json:"lastSeen,omitempty" azure:"ro"`

	// READ-ONLY; Mac address
	MacAddress *string `json:"macAddress,omitempty" azure:"ro"`

	// READ-ONLY; Indicates whether the association of the mac to the ip address is certain or a guess.
	MacCertainty *MacCertainty `json:"macCertainty,omitempty" azure:"ro"`

	// READ-ONLY; Network adapter vendor.
	NetworkAdapterVendor *string `json:"networkAdapterVendor,omitempty" azure:"ro"`

	// READ-ONLY; List of virtual LAN (vlan)
	Vlans []*string `json:"vlans,omitempty" azure:"ro"`
}

Nic - Network interface card properties

func (Nic) MarshalJSON 

func (n Nic) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Nic.

func (*Nic) UnmarshalJSON 

func (n *Nic) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Nic.

type OnPremiseSensor 

type OnPremiseSensor struct {
	// On-premise IoT sensor properties
	Properties interface{} `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

OnPremiseSensor - On-premise IoT sensor

type OnPremiseSensorsClient 

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

OnPremiseSensorsClient contains the methods for the OnPremiseSensors group. Don't use this type directly, use NewOnPremiseSensorsClient() instead.

func NewOnPremiseSensorsClient 

func NewOnPremiseSensorsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*OnPremiseSensorsClient, error)

NewOnPremiseSensorsClient creates a new instance of OnPremiseSensorsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OnPremiseSensorsClient) CreateOrUpdate 

func (client *OnPremiseSensorsClient) CreateOrUpdate(ctx context.Context, onPremiseSensorName string, options *OnPremiseSensorsClientCreateOrUpdateOptions) (OnPremiseSensorsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update on-premise IoT sensor If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview onPremiseSensorName - Name of the on-premise IoT sensor options - OnPremiseSensorsClientCreateOrUpdateOptions contains the optional parameters for the OnPremiseSensorsClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/OnPremiseSensors/Put.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewOnPremiseSensorsClient("20ff7fc3-e762-44dd-bd96-b71116dcdc23", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"mySensor",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*OnPremiseSensorsClient) Delete 

func (client *OnPremiseSensorsClient) Delete(ctx context.Context, onPremiseSensorName string, options *OnPremiseSensorsClientDeleteOptions) (OnPremiseSensorsClientDeleteResponse, error)

Delete - Delete on-premise IoT sensor If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview onPremiseSensorName - Name of the on-premise IoT sensor options - OnPremiseSensorsClientDeleteOptions contains the optional parameters for the OnPremiseSensorsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/OnPremiseSensors/Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewOnPremiseSensorsClient("20ff7fc3-e762-44dd-bd96-b71116dcdc24", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"mySensor",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*OnPremiseSensorsClient) DownloadActivation 

func (client *OnPremiseSensorsClient) DownloadActivation(ctx context.Context, onPremiseSensorName string, options *OnPremiseSensorsClientDownloadActivationOptions) (OnPremiseSensorsClientDownloadActivationResponse, error)

DownloadActivation - Download sensor activation file If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview onPremiseSensorName - Name of the on-premise IoT sensor options - OnPremiseSensorsClientDownloadActivationOptions contains the optional parameters for the OnPremiseSensorsClient.DownloadActivation method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/OnPremiseSensors/DownloadActivation.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewOnPremiseSensorsClient("20ff7fc3-e762-44dd-bd96-b71116dcdc23", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.DownloadActivation(ctx,
		"mySensor",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*OnPremiseSensorsClient) DownloadResetPassword 

func (client *OnPremiseSensorsClient) DownloadResetPassword(ctx context.Context, onPremiseSensorName string, body ResetPasswordInput, options *OnPremiseSensorsClientDownloadResetPasswordOptions) (OnPremiseSensorsClientDownloadResetPasswordResponse, error)

DownloadResetPassword - Download file for reset password of the sensor If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview onPremiseSensorName - Name of the on-premise IoT sensor body - Input for reset password. options - OnPremiseSensorsClientDownloadResetPasswordOptions contains the optional parameters for the OnPremiseSensorsClient.DownloadResetPassword method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/OnPremiseSensors/DownloadResetPassword.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/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewOnPremiseSensorsClient("20ff7fc3-e762-44dd-bd96-b71116dcdc23", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.DownloadResetPassword(ctx,
		"mySensor",
		armiotsecurity.ResetPasswordInput{
			ApplianceID: to.Ptr("3214-528AV23-D121-D3-E1"),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*OnPremiseSensorsClient) Get 

func (client *OnPremiseSensorsClient) Get(ctx context.Context, onPremiseSensorName string, options *OnPremiseSensorsClientGetOptions) (OnPremiseSensorsClientGetResponse, error)

Get - Get on-premise IoT sensor If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview onPremiseSensorName - Name of the on-premise IoT sensor options - OnPremiseSensorsClientGetOptions contains the optional parameters for the OnPremiseSensorsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/OnPremiseSensors/Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewOnPremiseSensorsClient("20ff7fc3-e762-44dd-bd96-b71116dcdc23", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"mySensor",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*OnPremiseSensorsClient) List 

func (client *OnPremiseSensorsClient) List(ctx context.Context, options *OnPremiseSensorsClientListOptions) (OnPremiseSensorsClientListResponse, error)

List - List on-premise IoT sensors If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview options - OnPremiseSensorsClientListOptions contains the optional parameters for the OnPremiseSensorsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/OnPremiseSensors/List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewOnPremiseSensorsClient("20ff7fc3-e762-44dd-bd96-b71116dcdc23", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.List(ctx,
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type OnPremiseSensorsClientCreateOrUpdateOptions added in v0.2.0 

type OnPremiseSensorsClientCreateOrUpdateOptions struct {
}

OnPremiseSensorsClientCreateOrUpdateOptions contains the optional parameters for the OnPremiseSensorsClient.CreateOrUpdate method.

type OnPremiseSensorsClientCreateOrUpdateResponse added in v0.2.0 

type OnPremiseSensorsClientCreateOrUpdateResponse struct {
	OnPremiseSensor
}

OnPremiseSensorsClientCreateOrUpdateResponse contains the response from method OnPremiseSensorsClient.CreateOrUpdate.

type OnPremiseSensorsClientDeleteOptions added in v0.2.0 

type OnPremiseSensorsClientDeleteOptions struct {
}

OnPremiseSensorsClientDeleteOptions contains the optional parameters for the OnPremiseSensorsClient.Delete method.

type OnPremiseSensorsClientDeleteResponse added in v0.2.0 

type OnPremiseSensorsClientDeleteResponse struct {
}

OnPremiseSensorsClientDeleteResponse contains the response from method OnPremiseSensorsClient.Delete.

type OnPremiseSensorsClientDownloadActivationOptions added in v0.2.0 

type OnPremiseSensorsClientDownloadActivationOptions struct {
}

OnPremiseSensorsClientDownloadActivationOptions contains the optional parameters for the OnPremiseSensorsClient.DownloadActivation method.

type OnPremiseSensorsClientDownloadActivationResponse added in v0.2.0 

type OnPremiseSensorsClientDownloadActivationResponse struct {
	// Body contains the streaming response.
	Body io.ReadCloser
}

OnPremiseSensorsClientDownloadActivationResponse contains the response from method OnPremiseSensorsClient.DownloadActivation.

type OnPremiseSensorsClientDownloadResetPasswordOptions added in v0.2.0 

type OnPremiseSensorsClientDownloadResetPasswordOptions struct {
}

OnPremiseSensorsClientDownloadResetPasswordOptions contains the optional parameters for the OnPremiseSensorsClient.DownloadResetPassword method.

type OnPremiseSensorsClientDownloadResetPasswordResponse added in v0.2.0 

type OnPremiseSensorsClientDownloadResetPasswordResponse struct {
	// Body contains the streaming response.
	Body io.ReadCloser
}

OnPremiseSensorsClientDownloadResetPasswordResponse contains the response from method OnPremiseSensorsClient.DownloadResetPassword.

type OnPremiseSensorsClientGetOptions added in v0.2.0 

type OnPremiseSensorsClientGetOptions struct {
}

OnPremiseSensorsClientGetOptions contains the optional parameters for the OnPremiseSensorsClient.Get method.

type OnPremiseSensorsClientGetResponse added in v0.2.0 

type OnPremiseSensorsClientGetResponse struct {
	OnPremiseSensor
}

OnPremiseSensorsClientGetResponse contains the response from method OnPremiseSensorsClient.Get.

type OnPremiseSensorsClientListOptions added in v0.2.0 

type OnPremiseSensorsClientListOptions struct {
}

OnPremiseSensorsClientListOptions contains the optional parameters for the OnPremiseSensorsClient.List method.

type OnPremiseSensorsClientListResponse added in v0.2.0 

type OnPremiseSensorsClientListResponse struct {
	OnPremiseSensorsList
}

OnPremiseSensorsClientListResponse contains the response from method OnPremiseSensorsClient.List.

type OnPremiseSensorsList 

type OnPremiseSensorsList struct {
	// READ-ONLY; List data
	Value []*OnPremiseSensor `json:"value,omitempty" azure:"ro"`
}

OnPremiseSensorsList - List of on-premise IoT sensors

type OnboardingKind 

type OnboardingKind string

OnboardingKind - The kind of onboarding for the subscription 

const (
	OnboardingKindDefault         OnboardingKind = "Default"
	OnboardingKindEvaluation      OnboardingKind = "Evaluation"
	OnboardingKindMigratedToAzure OnboardingKind = "MigratedToAzure"
	OnboardingKindPurchased       OnboardingKind = "Purchased"
)

func PossibleOnboardingKindValues 

func PossibleOnboardingKindValues() []OnboardingKind

PossibleOnboardingKindValues returns the possible values for the OnboardingKind const type.

type OnboardingStatus 

type OnboardingStatus string

OnboardingStatus - Device onboarding status. 

const (
	OnboardingStatusInsufficientInfo OnboardingStatus = "InsufficientInfo"
	OnboardingStatusNotOnboarded     OnboardingStatus = "NotOnboarded"
	OnboardingStatusNotSupported     OnboardingStatus = "NotSupported"
	OnboardingStatusOnboarded        OnboardingStatus = "Onboarded"
)

func PossibleOnboardingStatusValues 

func PossibleOnboardingStatusValues() []OnboardingStatus

PossibleOnboardingStatusValues returns the possible values for the OnboardingStatus const type.

type OperatingSystem 

type OperatingSystem struct {
	// OS architecture
	Architecture *string `json:"architecture,omitempty"`

	// OS build
	Build *string `json:"build,omitempty"`

	// OS distribution
	Distribution *string `json:"distribution,omitempty"`

	// OS platform
	Platform *string `json:"platform,omitempty"`

	// OS version
	Version *string `json:"version,omitempty"`
}

OperatingSystem - Device operating system data

type Operation 

type Operation struct {
	// Properties on the operation
	Display *OperationDisplay `json:"display,omitempty"`

	// Whether operation is a data action
	IsDataAction *bool `json:"isDataAction,omitempty"`

	// Operation name for display purposes
	Name *string `json:"name,omitempty"`

	// origin of the operation
	Origin *string `json:"origin,omitempty"`

	// properties for the operation meta info
	Properties *OperationProperties `json:"properties,omitempty"`
}

Operation resource

type OperationDisplay 

type OperationDisplay struct {
	// Description of the operation for display purposes
	Description *string `json:"description,omitempty"`

	// Name of the operation for display purposes
	Operation *string `json:"operation,omitempty"`

	// Name of the provider for display purposes
	Provider *string `json:"provider,omitempty"`

	// Name of the resource type for display purposes
	Resource *string `json:"resource,omitempty"`
}

OperationDisplay - The response model for get operation properties

type OperationList 

type OperationList struct {
	// REQUIRED; Collection of items of type results.
	Value []*Operation `json:"value,omitempty"`

	// Total item count.
	Count *int64 `json:"count,omitempty"`

	// The Url of next result page.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationList - Paged list of operation resources

type OperationMetaLogSpecification 

type OperationMetaLogSpecification struct {
	// blob duration of the log
	BlobDuration *string `json:"blobDuration,omitempty"`

	// localized name of the log category
	DisplayName *string `json:"displayName,omitempty"`

	// name of the log category
	Name *string `json:"name,omitempty"`
}

OperationMetaLogSpecification - log specifications for operation api

type OperationMetaMetricSpecification 

type OperationMetaMetricSpecification struct {
	// aggregation type of metric
	AggregationType *string `json:"aggregationType,omitempty"`

	// properties for dimension
	Dimensions []*DimensionProperties `json:"dimensions,omitempty"`

	// description of the metric
	DisplayDescription *string `json:"displayDescription,omitempty"`

	// localized name of the metric
	DisplayName *string `json:"displayName,omitempty"`

	// enable regional mdm account
	EnableRegionalMdmAccount *string `json:"enableRegionalMdmAccount,omitempty"`

	// internal metric name
	InternalMetricName *string `json:"internalMetricName,omitempty"`

	// name of the metric
	Name *string `json:"name,omitempty"`

	// dimension name use to replace resource id if specified
	ResourceIDDimensionNameOverride *string `json:"resourceIdDimensionNameOverride,omitempty"`

	// Metric namespace. Only set the namespace if different from the default value, leaving it empty makes it use the value from
	// the ARM manifest.
	SourceMdmNamespace *string `json:"sourceMdmNamespace,omitempty"`

	// supported aggregation types
	SupportedAggregationTypes []*string `json:"supportedAggregationTypes,omitempty"`

	// supported time grain types
	SupportedTimeGrainTypes []*string `json:"supportedTimeGrainTypes,omitempty"`

	// units for the metric
	Unit *string `json:"unit,omitempty"`
}

OperationMetaMetricSpecification - metric specifications for the operation

type OperationMetaServiceSpecification 

type OperationMetaServiceSpecification struct {
	// log specifications for the operation
	LogSpecifications []*OperationMetaLogSpecification `json:"logSpecifications,omitempty"`

	// metric specifications for the operation
	MetricSpecifications []*OperationMetaMetricSpecification `json:"metricSpecifications,omitempty"`
}

OperationMetaServiceSpecification - The operation meta service specification

type OperationProperties 

type OperationProperties struct {
	// meta service specification
	ServiceSpecification *OperationMetaServiceSpecification `json:"serviceSpecification,omitempty"`
}

OperationProperties - properties on meta info

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 of available operations If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/Operations/List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewOperationsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type OperationsClientListOptions added in v0.2.0 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListResponse added in v0.2.0 

type OperationsClientListResponse struct {
	OperationList
}

OperationsClientListResponse contains the response from method OperationsClient.List.

type Package 

type Package struct {
	// Package name.
	Name *string `json:"name,omitempty"`

	// Package version.
	Version *string `json:"version,omitempty"`
}

Package - Device package data

type PackageDownloadInfo 

type PackageDownloadInfo struct {
	// READ-ONLY; Download link
	Link *string `json:"link,omitempty" azure:"ro"`

	// READ-ONLY; Version number
	Version *string `json:"version,omitempty" azure:"ro"`

	// READ-ONLY; Kind of the version
	VersionKind *VersionKind `json:"versionKind,omitempty" azure:"ro"`
}

PackageDownloadInfo - Information on a specific package download

type PackageDownloads 

type PackageDownloads struct {
	// READ-ONLY; Authorized devices import template
	AuthorizedDevicesImportTemplate []*PackageDownloadInfo `json:"authorizedDevicesImportTemplate,omitempty" azure:"ro"`

	// READ-ONLY; All downloads for Central Manager
	CentralManager *PackageDownloadsCentralManager `json:"centralManager,omitempty" azure:"ro"`

	// READ-ONLY; Authorized devices import template
	DeviceInformationUpdateImportTemplate []*PackageDownloadInfo `json:"deviceInformationUpdateImportTemplate,omitempty" azure:"ro"`

	// READ-ONLY; Contains all Sensor binary downloads
	Sensor *PackageDownloadsSensor `json:"sensor,omitempty" azure:"ro"`

	// READ-ONLY; SNMP Server file
	Snmp []*PackageDownloadInfo `json:"snmp,omitempty" azure:"ro"`

	// READ-ONLY; All downloads for threat intelligence
	ThreatIntelligence []*PackageDownloadInfo `json:"threatIntelligence,omitempty" azure:"ro"`

	// READ-ONLY; Used for local configuration export
	WmiTool []*PackageDownloadInfo `json:"wmiTool,omitempty" azure:"ro"`
}

PackageDownloads - Information about package downloads

type PackageDownloadsCentralManager 

type PackageDownloadsCentralManager struct {
	// READ-ONLY; Contains full package downloads
	Full *PackageDownloadsCentralManagerFull `json:"full,omitempty" azure:"ro"`

	// READ-ONLY; Central Manager upgrade package downloads (on existing installations)
	Upgrade []*UpgradePackageDownloadInfo `json:"upgrade,omitempty" azure:"ro"`
}

PackageDownloadsCentralManager - All downloads for Central Manager

type PackageDownloadsCentralManagerFull 

type PackageDownloadsCentralManagerFull struct {
	// READ-ONLY; Contains all ISO full versions of the Central Manager
	Iso []*PackageDownloadInfo `json:"iso,omitempty" azure:"ro"`

	// READ-ONLY; Contains all OVF (virtual machine) full versions of the Central Manager
	Ovf *PackageDownloadsCentralManagerFullOvf `json:"ovf,omitempty" azure:"ro"`
}

PackageDownloadsCentralManagerFull - Contains full package downloads

type PackageDownloadsCentralManagerFullOvf 

type PackageDownloadsCentralManagerFullOvf struct {
	// READ-ONLY; The Enterprise package type
	Enterprise []*PackageDownloadInfo `json:"enterprise,omitempty" azure:"ro"`

	// READ-ONLY; The EnterpriseHighAvailability package type
	EnterpriseHighAvailability []*PackageDownloadInfo `json:"enterpriseHighAvailability,omitempty" azure:"ro"`

	// READ-ONLY; The Medium package type
	Medium []*PackageDownloadInfo `json:"medium,omitempty" azure:"ro"`

	// READ-ONLY; The MediumHighAvailability package type
	MediumHighAvailability []*PackageDownloadInfo `json:"mediumHighAvailability,omitempty" azure:"ro"`
}

PackageDownloadsCentralManagerFullOvf - Contains all OVF (virtual machine) full versions of the Central Manager

type PackageDownloadsSensor 

type PackageDownloadsSensor struct {
	// Sensor upgrade package downloads (on existing installations)
	Upgrade []*UpgradePackageDownloadInfo `json:"upgrade,omitempty"`

	// READ-ONLY; Contains full package downloads
	Full *PackageDownloadsSensorFull `json:"full,omitempty" azure:"ro"`
}

PackageDownloadsSensor - Contains all Sensor binary downloads

type PackageDownloadsSensorFull 

type PackageDownloadsSensorFull struct {
	// Contains all OVF (virtual machine) full versions for the sensor
	Ovf *PackageDownloadsSensorFullOvf `json:"ovf,omitempty"`

	// READ-ONLY; Contains all ISO full versions for the sensor
	Iso []*PackageDownloadInfo `json:"iso,omitempty" azure:"ro"`
}

PackageDownloadsSensorFull - Contains full package downloads

type PackageDownloadsSensorFullOvf 

type PackageDownloadsSensorFullOvf struct {
	// READ-ONLY; Enterprise package type
	Enterprise []*PackageDownloadInfo `json:"enterprise,omitempty" azure:"ro"`

	// READ-ONLY; Line package type
	Line []*PackageDownloadInfo `json:"line,omitempty" azure:"ro"`

	// READ-ONLY; Medium package type
	Medium []*PackageDownloadInfo `json:"medium,omitempty" azure:"ro"`
}

PackageDownloadsSensorFullOvf - Contains all OVF (virtual machine) full versions for the sensor

type ProgrammingState 

type ProgrammingState string

ProgrammingState - Indicates whether this device is programming 

const (
	ProgrammingStateNotProgrammingDevice ProgrammingState = "NotProgrammingDevice"
	ProgrammingStateProgrammingDevice    ProgrammingState = "ProgrammingDevice"
)

func PossibleProgrammingStateValues 

func PossibleProgrammingStateValues() []ProgrammingState

PossibleProgrammingStateValues returns the possible values for the ProgrammingState const type.

type ProxyResource 

type ProxyResource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

ProxyResource - The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

type PurdueLevel 

type PurdueLevel string

PurdueLevel - Purdue level of the device. 

const (
	PurdueLevelEnterprise     PurdueLevel = "Enterprise"
	PurdueLevelProcessControl PurdueLevel = "ProcessControl"
	PurdueLevelSupervisory    PurdueLevel = "Supervisory"
)

func PossiblePurdueLevelValues 

func PossiblePurdueLevelValues() []PurdueLevel

PossiblePurdueLevelValues returns the possible values for the PurdueLevel const type.

type ResetPasswordInput 

type ResetPasswordInput struct {
	// The appliance id of the sensor.
	ApplianceID *string `json:"applianceId,omitempty"`
}

ResetPasswordInput - Reset password input.

type Resource 

type Resource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - Common fields that are returned in the response for all Azure Resource Manager resources

type Sensor 

type Sensor struct {
	// READ-ONLY; Sensor name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Sensor site.
	Site *string `json:"site,omitempty" azure:"ro"`

	// READ-ONLY; Sensor type.
	Type *SensorType `json:"type,omitempty" azure:"ro"`

	// READ-ONLY; Sensor zone.
	Zone *string `json:"zone,omitempty" azure:"ro"`
}

Sensor that scanned the device

type SensorModel 

type SensorModel struct {
	// IoT sensor properties
	Properties *SensorProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

SensorModel - IoT sensor model

type SensorProperties 

type SensorProperties struct {
	// Type of sensor
	SensorType *SensorType `json:"sensorType,omitempty"`

	// TI Automatic mode status of the IoT sensor
	TiAutomaticUpdates *bool `json:"tiAutomaticUpdates,omitempty"`

	// Zone of the IoT sensor
	Zone *string `json:"zone,omitempty"`

	// READ-ONLY; Last connectivity time of the IoT sensor
	ConnectivityTime *string `json:"connectivityTime,omitempty" azure:"ro"`

	// READ-ONLY; Dynamic mode status of the IoT sensor
	DynamicLearning *bool `json:"dynamicLearning,omitempty" azure:"ro"`

	// READ-ONLY; Learning mode status of the IoT sensor
	LearningMode *bool `json:"learningMode,omitempty" azure:"ro"`

	// READ-ONLY; Status of the IoT sensor
	SensorStatus *SensorStatus `json:"sensorStatus,omitempty" azure:"ro"`

	// READ-ONLY; Version of the IoT sensor
	SensorVersion *string `json:"sensorVersion,omitempty" azure:"ro"`

	// READ-ONLY; TI Status of the IoT sensor
	TiStatus *TiStatus `json:"tiStatus,omitempty" azure:"ro"`

	// READ-ONLY; TI Version of the IoT sensor
	TiVersion *string `json:"tiVersion,omitempty" azure:"ro"`
}

SensorProperties - IoT sensor properties

type SensorStatus 

type SensorStatus string

SensorStatus - Status of the IoT sensor 

const (
	SensorStatusDisconnected SensorStatus = "Disconnected"
	SensorStatusOk           SensorStatus = "Ok"
	SensorStatusUnavailable  SensorStatus = "Unavailable"
)

func PossibleSensorStatusValues 

func PossibleSensorStatusValues() []SensorStatus

PossibleSensorStatusValues returns the possible values for the SensorStatus const type.

type SensorType 

type SensorType string

SensorType - Type of sensor 

const (
	SensorTypeEnterprise SensorType = "Enterprise"
	SensorTypeOt         SensorType = "Ot"
)

func PossibleSensorTypeValues 

func PossibleSensorTypeValues() []SensorType

PossibleSensorTypeValues returns the possible values for the SensorType const type.

type SensorsClient 

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

SensorsClient contains the methods for the Sensors group. Don't use this type directly, use NewSensorsClient() instead.

func NewSensorsClient 

func NewSensorsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*SensorsClient, error)

NewSensorsClient creates a new instance of SensorsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*SensorsClient) CreateOrUpdate 

func (client *SensorsClient) CreateOrUpdate(ctx context.Context, scope string, sensorName string, sensorModel SensorModel, options *SensorsClientCreateOrUpdateOptions) (SensorsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update IoT sensor If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview scope - Scope of the query (IoT Hub, /providers/Microsoft.Devices/iotHubs/myHub) sensorName - Name of the IoT sensor sensorModel - The IoT sensor model options - SensorsClientCreateOrUpdateOptions contains the optional parameters for the SensorsClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/Sensors/Put.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/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewSensorsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub",
		"mySensor",
		armiotsecurity.SensorModel{
			Properties: &armiotsecurity.SensorProperties{
				SensorType:         to.Ptr(armiotsecurity.SensorTypeOt),
				TiAutomaticUpdates: to.Ptr(true),
				Zone:               to.Ptr("Zone Name"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*SensorsClient) Delete 

func (client *SensorsClient) Delete(ctx context.Context, scope string, sensorName string, options *SensorsClientDeleteOptions) (SensorsClientDeleteResponse, error)

Delete - Delete IoT sensor If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview scope - Scope of the query (IoT Hub, /providers/Microsoft.Devices/iotHubs/myHub) sensorName - Name of the IoT sensor options - SensorsClientDeleteOptions contains the optional parameters for the SensorsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/Sensors/Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewSensorsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub",
		"mySensor",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*SensorsClient) DownloadActivation 

func (client *SensorsClient) DownloadActivation(ctx context.Context, scope string, sensorName string, options *SensorsClientDownloadActivationOptions) (SensorsClientDownloadActivationResponse, error)

DownloadActivation - Download sensor activation file If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview scope - Scope of the query (IoT Hub, /providers/Microsoft.Devices/iotHubs/myHub) sensorName - Name of the IoT sensor options - SensorsClientDownloadActivationOptions contains the optional parameters for the SensorsClient.DownloadActivation method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/Sensors/DownloadActivation.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewSensorsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.DownloadActivation(ctx,
		"subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub",
		"mySensor",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*SensorsClient) DownloadResetPassword 

func (client *SensorsClient) DownloadResetPassword(ctx context.Context, scope string, sensorName string, body ResetPasswordInput, options *SensorsClientDownloadResetPasswordOptions) (SensorsClientDownloadResetPasswordResponse, error)

DownloadResetPassword - Download file for reset password of the sensor If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview scope - Scope of the query (IoT Hub, /providers/Microsoft.Devices/iotHubs/myHub) sensorName - Name of the IoT sensor body - The reset password input. options - SensorsClientDownloadResetPasswordOptions contains the optional parameters for the SensorsClient.DownloadResetPassword method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/Sensors/DownloadResetPassword.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/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewSensorsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.DownloadResetPassword(ctx,
		"subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub",
		"mySensor",
		armiotsecurity.ResetPasswordInput{
			ApplianceID: to.Ptr("3214-528AV23-D121-D3-E1"),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*SensorsClient) Get 

func (client *SensorsClient) Get(ctx context.Context, scope string, sensorName string, options *SensorsClientGetOptions) (SensorsClientGetResponse, error)

Get - Get IoT sensor If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview scope - Scope of the query (IoT Hub, /providers/Microsoft.Devices/iotHubs/myHub) sensorName - Name of the IoT sensor options - SensorsClientGetOptions contains the optional parameters for the SensorsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/Sensors/Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewSensorsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub",
		"mySensor",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*SensorsClient) List 

func (client *SensorsClient) List(ctx context.Context, scope string, options *SensorsClientListOptions) (SensorsClientListResponse, error)

List - List IoT sensors If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview scope - Scope of the query (IoT Hub, /providers/Microsoft.Devices/iotHubs/myHub) options - SensorsClientListOptions contains the optional parameters for the SensorsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/Sensors/List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewSensorsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.List(ctx,
		"subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*SensorsClient) TriggerTiPackageUpdate 

func (client *SensorsClient) TriggerTiPackageUpdate(ctx context.Context, scope string, sensorName string, options *SensorsClientTriggerTiPackageUpdateOptions) (SensorsClientTriggerTiPackageUpdateResponse, error)

TriggerTiPackageUpdate - Trigger threat intelligence package update If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview scope - Scope of the query (IoT Hub, /providers/Microsoft.Devices/iotHubs/myHub) sensorName - Name of the IoT sensor options - SensorsClientTriggerTiPackageUpdateOptions contains the optional parameters for the SensorsClient.TriggerTiPackageUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/Sensors/TriggerTiPackageUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewSensorsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.TriggerTiPackageUpdate(ctx,
		"subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub",
		"mySensor",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

type SensorsClientCreateOrUpdateOptions added in v0.2.0 

type SensorsClientCreateOrUpdateOptions struct {
}

SensorsClientCreateOrUpdateOptions contains the optional parameters for the SensorsClient.CreateOrUpdate method.

type SensorsClientCreateOrUpdateResponse added in v0.2.0 

type SensorsClientCreateOrUpdateResponse struct {
	SensorModel
}

SensorsClientCreateOrUpdateResponse contains the response from method SensorsClient.CreateOrUpdate.

type SensorsClientDeleteOptions added in v0.2.0 

type SensorsClientDeleteOptions struct {
}

SensorsClientDeleteOptions contains the optional parameters for the SensorsClient.Delete method.

type SensorsClientDeleteResponse added in v0.2.0 

type SensorsClientDeleteResponse struct {
}

SensorsClientDeleteResponse contains the response from method SensorsClient.Delete.

type SensorsClientDownloadActivationOptions added in v0.2.0 

type SensorsClientDownloadActivationOptions struct {
}

SensorsClientDownloadActivationOptions contains the optional parameters for the SensorsClient.DownloadActivation method.

type SensorsClientDownloadActivationResponse added in v0.2.0 

type SensorsClientDownloadActivationResponse struct {
	// Body contains the streaming response.
	Body io.ReadCloser
}

SensorsClientDownloadActivationResponse contains the response from method SensorsClient.DownloadActivation.

type SensorsClientDownloadResetPasswordOptions added in v0.2.0 

type SensorsClientDownloadResetPasswordOptions struct {
}

SensorsClientDownloadResetPasswordOptions contains the optional parameters for the SensorsClient.DownloadResetPassword method.

type SensorsClientDownloadResetPasswordResponse added in v0.2.0 

type SensorsClientDownloadResetPasswordResponse struct {
	// Body contains the streaming response.
	Body io.ReadCloser
}

SensorsClientDownloadResetPasswordResponse contains the response from method SensorsClient.DownloadResetPassword.

type SensorsClientGetOptions added in v0.2.0 

type SensorsClientGetOptions struct {
}

SensorsClientGetOptions contains the optional parameters for the SensorsClient.Get method.

type SensorsClientGetResponse added in v0.2.0 

type SensorsClientGetResponse struct {
	SensorModel
}

SensorsClientGetResponse contains the response from method SensorsClient.Get.

type SensorsClientListOptions added in v0.2.0 

type SensorsClientListOptions struct {
}

SensorsClientListOptions contains the optional parameters for the SensorsClient.List method.

type SensorsClientListResponse added in v0.2.0 

type SensorsClientListResponse struct {
	SensorsList
}

SensorsClientListResponse contains the response from method SensorsClient.List.

type SensorsClientTriggerTiPackageUpdateOptions added in v0.2.0 

type SensorsClientTriggerTiPackageUpdateOptions struct {
}

SensorsClientTriggerTiPackageUpdateOptions contains the optional parameters for the SensorsClient.TriggerTiPackageUpdate method.

type SensorsClientTriggerTiPackageUpdateResponse added in v0.2.0 

type SensorsClientTriggerTiPackageUpdateResponse struct {
}

SensorsClientTriggerTiPackageUpdateResponse contains the response from method SensorsClient.TriggerTiPackageUpdate.

type SensorsList 

type SensorsList struct {
	// READ-ONLY; List data
	Value []*SensorModel `json:"value,omitempty" azure:"ro"`
}

SensorsList - List of IoT sensors

type SiteModel 

type SiteModel struct {
	// IoT site properties
	Properties *SiteProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

SiteModel - IoT site model

type SiteProperties 

type SiteProperties struct {
	// REQUIRED; Display name of the IoT site
	DisplayName *string `json:"displayName,omitempty"`

	// Tags of the IoT site
	Tags map[string]*string `json:"tags,omitempty"`
}

SiteProperties - IoT site properties

func (SiteProperties) MarshalJSON 

func (s SiteProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SiteProperties.

type SitesClient 

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

SitesClient contains the methods for the Sites group. Don't use this type directly, use NewSitesClient() instead.

func NewSitesClient 

func NewSitesClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*SitesClient, error)

NewSitesClient creates a new instance of SitesClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*SitesClient) CreateOrUpdate 

func (client *SitesClient) CreateOrUpdate(ctx context.Context, scope string, siteModel SiteModel, options *SitesClientCreateOrUpdateOptions) (SitesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update IoT site If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview scope - Scope of the query (IoT Hub, /providers/Microsoft.Devices/iotHubs/myHub) siteModel - The IoT sites model options - SitesClientCreateOrUpdateOptions contains the optional parameters for the SitesClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/Sites/Put.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/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewSitesClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub",
		armiotsecurity.SiteModel{
			Properties: &armiotsecurity.SiteProperties{
				DisplayName: to.Ptr("IoT site name"),
				Tags: map[string]*string{
					"key1": to.Ptr("value1"),
					"key2": to.Ptr("value2"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*SitesClient) Delete 

func (client *SitesClient) Delete(ctx context.Context, scope string, options *SitesClientDeleteOptions) (SitesClientDeleteResponse, error)

Delete - Delete IoT site If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview scope - Scope of the query (IoT Hub, /providers/Microsoft.Devices/iotHubs/myHub) options - SitesClientDeleteOptions contains the optional parameters for the SitesClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/Sites/Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewSitesClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*SitesClient) Get 

func (client *SitesClient) Get(ctx context.Context, scope string, options *SitesClientGetOptions) (SitesClientGetResponse, error)

Get - Get IoT site If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview scope - Scope of the query (IoT Hub, /providers/Microsoft.Devices/iotHubs/myHub) options - SitesClientGetOptions contains the optional parameters for the SitesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/Sites/Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewSitesClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*SitesClient) List 

func (client *SitesClient) List(ctx context.Context, scope string, options *SitesClientListOptions) (SitesClientListResponse, error)

List - List IoT sites If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-02-01-preview scope - Scope of the query (IoT Hub, /providers/Microsoft.Devices/iotHubs/myHub) options - SitesClientListOptions contains the optional parameters for the SitesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/Sites/List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotsecurity/armiotsecurity"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armiotsecurity.NewSitesClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.List(ctx,
		"subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/sites",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type SitesClientCreateOrUpdateOptions added in v0.2.0 

type SitesClientCreateOrUpdateOptions struct {
}

SitesClientCreateOrUpdateOptions contains the optional parameters for the SitesClient.CreateOrUpdate method.

type SitesClientCreateOrUpdateResponse added in v0.2.0 

type SitesClientCreateOrUpdateResponse struct {
	SiteModel
}

SitesClientCreateOrUpdateResponse contains the response from method SitesClient.CreateOrUpdate.

type SitesClientDeleteOptions added in v0.2.0 

type SitesClientDeleteOptions struct {
}

SitesClientDeleteOptions contains the optional parameters for the SitesClient.Delete method.

type SitesClientDeleteResponse added in v0.2.0 

type SitesClientDeleteResponse struct {
}

SitesClientDeleteResponse contains the response from method SitesClient.Delete.

type SitesClientGetOptions added in v0.2.0 

type SitesClientGetOptions struct {
}

SitesClientGetOptions contains the optional parameters for the SitesClient.Get method.

type SitesClientGetResponse added in v0.2.0 

type SitesClientGetResponse struct {
	SiteModel
}

SitesClientGetResponse contains the response from method SitesClient.Get.

type SitesClientListOptions added in v0.2.0 

type SitesClientListOptions struct {
}

SitesClientListOptions contains the optional parameters for the SitesClient.List method.

type SitesClientListResponse added in v0.2.0 

type SitesClientListResponse struct {
	SitesList
}

SitesClientListResponse contains the response from method SitesClient.List.

type SitesList 

type SitesList struct {
	// READ-ONLY; List data
	Value []*SiteModel `json:"value,omitempty" azure:"ro"`
}

SitesList - List of IoT sites

type Slot 

type Slot struct {
	// A bag of fields which extends the slot information.
	AdditionalData interface{} `json:"additionalData,omitempty"`

	// Firmware revision of the slot.
	FirmwareVersion *string `json:"firmwareVersion,omitempty"`

	// Hardware revision of the slot.
	HardwareRevision *string `json:"hardwareRevision,omitempty"`

	// Hardware vendor of the slot.
	HardwareVendor *string `json:"hardwareVendor,omitempty"`

	// Model of the slot.
	Model *string `json:"model,omitempty"`

	// Module version of the slot.
	ModuleVersion *string `json:"moduleVersion,omitempty"`

	// Product code of the slot.
	ProductCode *string `json:"productCode,omitempty"`

	// Serial number of the slot.
	SerialNumber *string `json:"serialNumber,omitempty"`

	// Slot type.
	SlotType *SlotType `json:"slotType,omitempty"`

	// READ-ONLY; List of Common Platform Enumeration (CPE) of the slot
	Cpes []*string `json:"cpes,omitempty" azure:"ro"`

	// READ-ONLY; Rack number in the backplane
	RackNumber *int32 `json:"rackNumber,omitempty" azure:"ro"`

	// READ-ONLY; Slot number inside the rack
	SlotNumber *int32 `json:"slotNumber,omitempty" azure:"ro"`
}

Slot data in PLC backplane

func (Slot) MarshalJSON 

func (s Slot) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Slot.

type SlotType 

type SlotType string

SlotType - Slot type. 

const (
	SlotTypeAnalogIO    SlotType = "AnalogIO"
	SlotTypeCPU         SlotType = "Cpu"
	SlotTypeCommAdapter SlotType = "CommAdapter"
	SlotTypeDigitalIO   SlotType = "DigitalIO"
	SlotTypeGeneric     SlotType = "Generic"
	SlotTypeHmi         SlotType = "Hmi"
	SlotTypeSupply      SlotType = "Supply"
)

func PossibleSlotTypeValues 

func PossibleSlotTypeValues() []SlotType

PossibleSlotTypeValues returns the possible values for the SlotType const type.

type SystemData 

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// The type of identity that created the resource.
	CreatedByType *CreatedByType `json:"createdByType,omitempty"`

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time `json:"lastModifiedAt,omitempty"`

	// The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType `json:"lastModifiedByType,omitempty"`
}

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 TiStatus 

type TiStatus string

TiStatus - TI Status of the IoT sensor 

const (
	TiStatusFailed          TiStatus = "Failed"
	TiStatusInProgress      TiStatus = "InProgress"
	TiStatusOk              TiStatus = "Ok"
	TiStatusUpdateAvailable TiStatus = "UpdateAvailable"
)

func PossibleTiStatusValues 

func PossibleTiStatusValues() []TiStatus

PossibleTiStatusValues returns the possible values for the TiStatus const type.

type UpgradePackageDownloadInfo 

type UpgradePackageDownloadInfo struct {
	// READ-ONLY; Minimum base version for upgrade
	FromVersion *string `json:"fromVersion,omitempty" azure:"ro"`

	// READ-ONLY; Download link
	Link *string `json:"link,omitempty" azure:"ro"`

	// READ-ONLY; Version number
	Version *string `json:"version,omitempty" azure:"ro"`

	// READ-ONLY; Kind of the version
	VersionKind *VersionKind `json:"versionKind,omitempty" azure:"ro"`
}

UpgradePackageDownloadInfo - Information on a specific package upgrade download

type VersionKind 

type VersionKind string

VersionKind - Kind of the version 

const (
	VersionKindLatest   VersionKind = "Latest"
	VersionKindPreview  VersionKind = "Preview"
	VersionKindPrevious VersionKind = "Previous"
)

func PossibleVersionKindValues 

func PossibleVersionKindValues() []VersionKind

PossibleVersionKindValues returns the possible values for the VersionKind const type.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.