armiotsecurity

package module
v0.1.0 Latest Latest
Warning

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

 Go to latest Published: Dec 7, 2021 License: MIT Imports: 15 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 := armiotsecurity.NewAlertTypesClient(<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{
    Host: arm.AzureChina,
}
client := armiotsecurity.NewAlertTypesClient(<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 AlertIntent 

type AlertIntent string

AlertIntent - Kill chain related intent behind the alert. Could contain multiple enum values (separated by commas) 

const (
	AlertIntentCollection          AlertIntent = "Collection"
	AlertIntentCommandAndControl   AlertIntent = "CommandAndControl"
	AlertIntentCredentialAccess    AlertIntent = "CredentialAccess"
	AlertIntentDefenseEvasion      AlertIntent = "DefenseEvasion"
	AlertIntentDiscovery           AlertIntent = "Discovery"
	AlertIntentExecution           AlertIntent = "Execution"
	AlertIntentExfiltration        AlertIntent = "Exfiltration"
	AlertIntentExploitation        AlertIntent = "Exploitation"
	AlertIntentImpact              AlertIntent = "Impact"
	AlertIntentInitialAccess       AlertIntent = "InitialAccess"
	AlertIntentLateralMovement     AlertIntent = "LateralMovement"
	AlertIntentPersistence         AlertIntent = "Persistence"
	AlertIntentPreAttack           AlertIntent = "PreAttack"
	AlertIntentPrivilegeEscalation AlertIntent = "PrivilegeEscalation"
	AlertIntentProbing             AlertIntent = "Probing"
	AlertIntentUnknown             AlertIntent = "Unknown"
)

func PossibleAlertIntentValues 

func PossibleAlertIntentValues() []AlertIntent

PossibleAlertIntentValues returns the possible values for the AlertIntent const type.

func (AlertIntent) ToPtr 

func (c AlertIntent) ToPtr() *AlertIntent

ToPtr returns a *AlertIntent pointing to the current value.

type AlertListModel 

type AlertListModel struct {
	// READ-ONLY; When available, follow the URI to get the next page of data
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

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

AlertListModel - List of IoT alerts

func (AlertListModel) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AlertListModel.

type AlertModel 

type AlertModel struct {
	ProxyResource
	// Alert properties
	Properties *AlertPropertiesModel `json:"properties,omitempty"`

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

AlertModel - IoT alert

type AlertPatchPropertiesModel 

type AlertPatchPropertiesModel struct {
	// IoT alert properties
	Properties *AlertPatchPropertiesModelProperties `json:"properties,omitempty"`
}

AlertPatchPropertiesModel - IoT alert properties

func (AlertPatchPropertiesModel) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AlertPatchPropertiesModel.

type AlertPatchPropertiesModelProperties 

type AlertPatchPropertiesModelProperties struct {
	// The severity of the alert
	Severity *AlertSeverity `json:"severity,omitempty"`

	// The status of the alert
	Status *AlertStatus `json:"status,omitempty"`
}

AlertPatchPropertiesModelProperties - IoT alert properties

type AlertPropertiesModel 

type AlertPropertiesModel struct {
	// A list of entities related to the alert
	Entities []map[string]interface{} `json:"entities,omitempty"`

	// A bag of fields which extends the alert information
	ExtendedProperties map[string]interface{} `json:"extendedProperties,omitempty"`

	// The severity of the alert
	Severity *AlertSeverity `json:"severity,omitempty"`

	// The status of the alert
	Status *AlertStatus `json:"status,omitempty"`

	// READ-ONLY; The type name of the alert
	AlertType *string `json:"alertType,omitempty" azure:"ro"`

	// READ-ONLY; Display name of the device entity being reported on
	AzureResourceID *string `json:"azureResourceId,omitempty" azure:"ro"`

	// READ-ONLY; The impact end time of the alert (the time of the last event or activity included in the alert)
	EndTimeUTC *string `json:"endTimeUtc,omitempty" azure:"ro"`

	// READ-ONLY; Kill chain related intent behind the alert. Could contain multiple enum values (separated by commas)
	Intent *AlertIntent `json:"intent,omitempty" azure:"ro"`

	// READ-ONLY; The name of a component inside the product which generated the alert
	ProductComponentName *string `json:"productComponentName,omitempty" azure:"ro"`

	// READ-ONLY; The impact start time of the alert (the time of the first event or activity included in the alert)
	StartTimeUTC *string `json:"startTimeUtc,omitempty" azure:"ro"`

	// READ-ONLY; Holds the product canonical identifier of the alert within the scope of a product
	SystemAlertID *string `json:"systemAlertId,omitempty" azure:"ro"`

	// READ-ONLY; A list of of techniques that lead up to the intent/tactic
	Techniques []*TechniqueModel `json:"techniques,omitempty" azure:"ro"`
}

AlertPropertiesModel - IoT alert properties

func (AlertPropertiesModel) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AlertPropertiesModel.

type AlertSeverity 

type AlertSeverity string

AlertSeverity - Alert Severity 

const (
	AlertSeverityHigh          AlertSeverity = "High"
	AlertSeverityInformational AlertSeverity = "Informational"
	AlertSeverityLow           AlertSeverity = "Low"
	AlertSeverityMedium        AlertSeverity = "Medium"
)

func PossibleAlertSeverityValues 

func PossibleAlertSeverityValues() []AlertSeverity

PossibleAlertSeverityValues returns the possible values for the AlertSeverity const type.

func (AlertSeverity) ToPtr 

func (c AlertSeverity) ToPtr() *AlertSeverity

ToPtr returns a *AlertSeverity pointing to the current value.

type AlertStatus 

type AlertStatus string

AlertStatus - Alert Status 

const (
	AlertStatusClosed     AlertStatus = "Closed"
	AlertStatusInProgress AlertStatus = "InProgress"
	AlertStatusNew        AlertStatus = "New"
)

func PossibleAlertStatusValues 

func PossibleAlertStatusValues() []AlertStatus

PossibleAlertStatusValues returns the possible values for the AlertStatus const type.

func (AlertStatus) ToPtr 

func (c AlertStatus) ToPtr() *AlertStatus

ToPtr returns a *AlertStatus pointing to the current value.

type AlertType 

type AlertType struct {
	ProxyResource
	// Alert type properties
	Properties *AlertTypeProperties `json:"properties,omitempty"`

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

AlertType - IoT alert type.

type AlertTypeList 

type AlertTypeList struct {
	// List data
	Value []*AlertType `json:"value,omitempty"`
}

AlertTypeList - List of alert types

func (AlertTypeList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AlertTypeList.

type AlertTypeProperties 

type AlertTypeProperties struct {
	// READ-ONLY; The display name of the alert
	AlertDisplayName *string `json:"alertDisplayName,omitempty" azure:"ro"`

	// READ-ONLY; Description of the suspected vulnerability and meaning.
	Description *string `json:"description,omitempty" azure:"ro"`

	// READ-ONLY; Kill chain related intent behind the alert. Could contain multiple enum values (separated by commas)
	Intent *AlertIntent `json:"intent,omitempty" azure:"ro"`

	// READ-ONLY; The name of a component inside the product which generated the alert
	ProductComponentName *string `json:"productComponentName,omitempty" azure:"ro"`

	// READ-ONLY; The name of the product which published this alert
	ProductName *string `json:"productName,omitempty" azure:"ro"`

	// READ-ONLY; The name of the alert provider or internal partner
	ProviderName *string `json:"providerName,omitempty" azure:"ro"`

	// READ-ONLY; Manual action items to take to remediate the alert
	RemediationSteps []*string `json:"remediationSteps,omitempty" azure:"ro"`

	// READ-ONLY; The severity of the alert
	Severity *AlertSeverity `json:"severity,omitempty" azure:"ro"`

	// READ-ONLY; The name of the vendor that raise the alert
	VendorName *string `json:"vendorName,omitempty" azure:"ro"`
}

AlertTypeProperties - IoT alert type information.

func (AlertTypeProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AlertTypeProperties.

type AlertTypesClient 

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

AlertTypesClient contains the methods for the AlertTypes group. Don't use this type directly, use NewAlertTypesClient() instead.

func NewAlertTypesClient 

func NewAlertTypesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *AlertTypesClient

NewAlertTypesClient creates a new instance of AlertTypesClient with the specified values.

func (*AlertTypesClient) Get 

func (client *AlertTypesClient) Get(ctx context.Context, alertTypeName string, options *AlertTypesGetOptions) (AlertTypesGetResponse, error)

Get - Get IoT alert type If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/AlertTypes/GetAlertType.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 := armiotsecurity.NewAlertTypesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<alert-type-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("AlertType.ID: %s\n", *res.ID)
}

Output:

func (*AlertTypesClient) List 

func (client *AlertTypesClient) List(ctx context.Context, options *AlertTypesListOptions) (AlertTypesListResponse, error)

List - List IoT alert types If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/AlertTypes/GetAlertTypeList.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 := armiotsecurity.NewAlertTypesClient("<subscription-id>", cred, nil)
	_, err = client.List(ctx,
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

type AlertTypesGetOptions 

type AlertTypesGetOptions struct {
}

AlertTypesGetOptions contains the optional parameters for the AlertTypes.Get method.

type AlertTypesGetResponse 

type AlertTypesGetResponse struct {
	AlertTypesGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AlertTypesGetResponse contains the response from method AlertTypes.Get.

type AlertTypesGetResult 

type AlertTypesGetResult struct {
	AlertType
}

AlertTypesGetResult contains the result from method AlertTypes.Get.

type AlertTypesListOptions 

type AlertTypesListOptions struct {
}

AlertTypesListOptions contains the optional parameters for the AlertTypes.List method.

type AlertTypesListResponse 

type AlertTypesListResponse struct {
	AlertTypesListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AlertTypesListResponse contains the response from method AlertTypes.List.

type AlertTypesListResult 

type AlertTypesListResult struct {
	AlertTypeList
}

AlertTypesListResult contains the result from method AlertTypes.List.

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.

func (AuthorizedState) ToPtr 

func (c AuthorizedState) ToPtr() *AuthorizedState

ToPtr returns a *AuthorizedState pointing to the current value.

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.

func (CreatedByType) ToPtr 

func (c CreatedByType) ToPtr() *CreatedByType

ToPtr returns a *CreatedByType pointing to the current value.

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.

func (Criticality) ToPtr 

func (c Criticality) ToPtr() *Criticality

ToPtr returns a *Criticality pointing to the current value.

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

NewDefenderSettingsClient creates a new instance of DefenderSettingsClient with the specified values.

func (*DefenderSettingsClient) CreateOrUpdate 

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

CreateOrUpdate - Create or update IoT Defender settings If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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/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 := armiotsecurity.NewDefenderSettingsClient("<subscription-id>", cred, nil)
	res, err := client.CreateOrUpdate(ctx,
		armiotsecurity.DefenderSettingsModel{},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("DefenderSettingsModel.ID: %s\n", *res.ID)
}

Output:

func (*DefenderSettingsClient) Delete 

func (client *DefenderSettingsClient) Delete(ctx context.Context, options *DefenderSettingsDeleteOptions) (DefenderSettingsDeleteResponse, error)

Delete - Delete IoT Defender settings If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewDefenderSettingsClient("<subscription-id>", cred, nil)
	_, err = client.Delete(ctx,
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*DefenderSettingsClient) DownloadManagerActivation 

func (client *DefenderSettingsClient) DownloadManagerActivation(ctx context.Context, options *DefenderSettingsDownloadManagerActivationOptions) (DefenderSettingsDownloadManagerActivationResponse, error)

DownloadManagerActivation - Download manager activation data defined for this subscription If the operation fails it returns a generic error.

Example

x-ms-original-file: 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 := armiotsecurity.NewDefenderSettingsClient("<subscription-id>", cred, nil)
	_, err = client.DownloadManagerActivation(ctx,
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*DefenderSettingsClient) Get 

func (client *DefenderSettingsClient) Get(ctx context.Context, options *DefenderSettingsGetOptions) (DefenderSettingsGetResponse, error)

Get - Get IoT Defender Settings If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewDefenderSettingsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("DefenderSettingsModel.ID: %s\n", *res.ID)
}

Output:

func (*DefenderSettingsClient) List 

func (client *DefenderSettingsClient) List(ctx context.Context, options *DefenderSettingsListOptions) (DefenderSettingsListResponse, error)

List - List IoT Defender Settings If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewDefenderSettingsClient("<subscription-id>", cred, nil)
	_, err = client.List(ctx,
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*DefenderSettingsClient) PackageDownloads 

func (client *DefenderSettingsClient) PackageDownloads(ctx context.Context, options *DefenderSettingsPackageDownloadsOptions) (DefenderSettingsPackageDownloadsResponse, error)

PackageDownloads - Information about downloadable packages If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewDefenderSettingsClient("<subscription-id>", cred, nil)
	_, err = client.PackageDownloads(ctx,
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

type DefenderSettingsCreateOrUpdateOptions 

type DefenderSettingsCreateOrUpdateOptions struct {
}

DefenderSettingsCreateOrUpdateOptions contains the optional parameters for the DefenderSettings.CreateOrUpdate method.

type DefenderSettingsCreateOrUpdateResponse 

type DefenderSettingsCreateOrUpdateResponse struct {
	DefenderSettingsCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DefenderSettingsCreateOrUpdateResponse contains the response from method DefenderSettings.CreateOrUpdate.

type DefenderSettingsCreateOrUpdateResult 

type DefenderSettingsCreateOrUpdateResult struct {
	DefenderSettingsModel
}

DefenderSettingsCreateOrUpdateResult contains the result from method DefenderSettings.CreateOrUpdate.

type DefenderSettingsDeleteOptions 

type DefenderSettingsDeleteOptions struct {
}

DefenderSettingsDeleteOptions contains the optional parameters for the DefenderSettings.Delete method.

type DefenderSettingsDeleteResponse 

type DefenderSettingsDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DefenderSettingsDeleteResponse contains the response from method DefenderSettings.Delete.

type DefenderSettingsDownloadManagerActivationOptions 

type DefenderSettingsDownloadManagerActivationOptions struct {
}

DefenderSettingsDownloadManagerActivationOptions contains the optional parameters for the DefenderSettings.DownloadManagerActivation method.

type DefenderSettingsDownloadManagerActivationResponse 

type DefenderSettingsDownloadManagerActivationResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DefenderSettingsDownloadManagerActivationResponse contains the response from method DefenderSettings.DownloadManagerActivation.

type DefenderSettingsGetOptions 

type DefenderSettingsGetOptions struct {
}

DefenderSettingsGetOptions contains the optional parameters for the DefenderSettings.Get method.

type DefenderSettingsGetResponse 

type DefenderSettingsGetResponse struct {
	DefenderSettingsGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DefenderSettingsGetResponse contains the response from method DefenderSettings.Get.

type DefenderSettingsGetResult 

type DefenderSettingsGetResult struct {
	DefenderSettingsModel
}

DefenderSettingsGetResult contains the result from method DefenderSettings.Get.

type DefenderSettingsList 

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

DefenderSettingsList - List of IoT Defender settings

func (DefenderSettingsList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DefenderSettingsList.

type DefenderSettingsListOptions 

type DefenderSettingsListOptions struct {
}

DefenderSettingsListOptions contains the optional parameters for the DefenderSettings.List method.

type DefenderSettingsListResponse 

type DefenderSettingsListResponse struct {
	DefenderSettingsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DefenderSettingsListResponse contains the response from method DefenderSettings.List.

type DefenderSettingsListResult 

type DefenderSettingsListResult struct {
	DefenderSettingsList
}

DefenderSettingsListResult contains the result from method DefenderSettings.List.

type DefenderSettingsModel 

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

DefenderSettingsModel - IoT Defender settings

type DefenderSettingsPackageDownloadsOptions 

type DefenderSettingsPackageDownloadsOptions struct {
}

DefenderSettingsPackageDownloadsOptions contains the optional parameters for the DefenderSettings.PackageDownloads method.

type DefenderSettingsPackageDownloadsResponse 

type DefenderSettingsPackageDownloadsResponse struct {
	DefenderSettingsPackageDownloadsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DefenderSettingsPackageDownloadsResponse contains the response from method DefenderSettings.PackageDownloads.

type DefenderSettingsPackageDownloadsResult 

type DefenderSettingsPackageDownloadsResult struct {
	PackageDownloads
}

DefenderSettingsPackageDownloadsResult contains the result from method DefenderSettings.PackageDownloads.

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.

func (DeviceDataSource) ToPtr 

func (c DeviceDataSource) ToPtr() *DeviceDataSource

ToPtr returns a *DeviceDataSource pointing to the current value.

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

func (DeviceGroupList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DeviceGroupList.

type DeviceGroupModel 

type DeviceGroupModel struct {
	ProxyResource
	// Device group properties
	Properties map[string]interface{} `json:"properties,omitempty"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,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

NewDeviceGroupsClient creates a new instance of DeviceGroupsClient with the specified values.

func (*DeviceGroupsClient) CreateOrUpdate 

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

CreateOrUpdate - Create or update device group If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewDeviceGroupsClient("<subscription-id>",
		"<iot-defender-location>", cred, nil)
	res, err := client.CreateOrUpdate(ctx,
		"<device-group-name>",
		armiotsecurity.DeviceGroupModel{
			Properties: map[string]interface{}{},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("DeviceGroupModel.ID: %s\n", *res.ID)
}

Output:

func (*DeviceGroupsClient) Delete 

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

Delete - Delete device group If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewDeviceGroupsClient("<subscription-id>",
		"<iot-defender-location>", cred, nil)
	_, err = client.Delete(ctx,
		"<device-group-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*DeviceGroupsClient) Get 

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

Get - Get device group If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewDeviceGroupsClient("<subscription-id>",
		"<iot-defender-location>", cred, nil)
	res, err := client.Get(ctx,
		"<device-group-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("DeviceGroupModel.ID: %s\n", *res.ID)
}

Output:

func (*DeviceGroupsClient) List 

func (client *DeviceGroupsClient) List(options *DeviceGroupsListOptions) *DeviceGroupsListPager

List - List device groups If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewDeviceGroupsClient("<subscription-id>",
		"<iot-defender-location>", cred, nil)
	pager := client.List(nil)
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("DeviceGroupModel.ID: %s\n", *v.ID)
		}
	}
}

Output:

type DeviceGroupsCreateOrUpdateOptions 

type DeviceGroupsCreateOrUpdateOptions struct {
}

DeviceGroupsCreateOrUpdateOptions contains the optional parameters for the DeviceGroups.CreateOrUpdate method.

type DeviceGroupsCreateOrUpdateResponse 

type DeviceGroupsCreateOrUpdateResponse struct {
	DeviceGroupsCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeviceGroupsCreateOrUpdateResponse contains the response from method DeviceGroups.CreateOrUpdate.

type DeviceGroupsCreateOrUpdateResult 

type DeviceGroupsCreateOrUpdateResult struct {
	DeviceGroupModel
}

DeviceGroupsCreateOrUpdateResult contains the result from method DeviceGroups.CreateOrUpdate.

type DeviceGroupsDeleteOptions 

type DeviceGroupsDeleteOptions struct {
}

DeviceGroupsDeleteOptions contains the optional parameters for the DeviceGroups.Delete method.

type DeviceGroupsDeleteResponse 

type DeviceGroupsDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeviceGroupsDeleteResponse contains the response from method DeviceGroups.Delete.

type DeviceGroupsGetOptions 

type DeviceGroupsGetOptions struct {
}

DeviceGroupsGetOptions contains the optional parameters for the DeviceGroups.Get method.

type DeviceGroupsGetResponse 

type DeviceGroupsGetResponse struct {
	DeviceGroupsGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeviceGroupsGetResponse contains the response from method DeviceGroups.Get.

type DeviceGroupsGetResult 

type DeviceGroupsGetResult struct {
	DeviceGroupModel
}

DeviceGroupsGetResult contains the result from method DeviceGroups.Get.

type DeviceGroupsListOptions 

type DeviceGroupsListOptions struct {
}

DeviceGroupsListOptions contains the optional parameters for the DeviceGroups.List method.

type DeviceGroupsListPager 

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

DeviceGroupsListPager provides operations for iterating over paged responses.

func (*DeviceGroupsListPager) Err 

func (p *DeviceGroupsListPager) Err() error

Err returns the last error encountered while paging.

func (*DeviceGroupsListPager) NextPage 

func (p *DeviceGroupsListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DeviceGroupsListPager) PageResponse 

func (p *DeviceGroupsListPager) PageResponse() DeviceGroupsListResponse

PageResponse returns the current DeviceGroupsListResponse page.

type DeviceGroupsListResponse 

type DeviceGroupsListResponse struct {
	DeviceGroupsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeviceGroupsListResponse contains the response from method DeviceGroups.List.

type DeviceGroupsListResult 

type DeviceGroupsListResult struct {
	DeviceGroupList
}

DeviceGroupsListResult contains the result from method DeviceGroups.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

func (DeviceList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DeviceList.

type DeviceModel 

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

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

DeviceModel - Device

type DeviceProperties 

type DeviceProperties struct {
	// A bag of fields which extends the device information.
	AdditionalFields map[string]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.

func (DeviceStatus) ToPtr 

func (c DeviceStatus) ToPtr() *DeviceStatus

ToPtr returns a *DeviceStatus pointing to the current value.

type DeviceVulnerabilityListModel 

type DeviceVulnerabilityListModel struct {
	// READ-ONLY; When available, follow the URI to get the next page of data
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

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

DeviceVulnerabilityListModel - List of IoT Device Vulnerabilities

func (DeviceVulnerabilityListModel) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DeviceVulnerabilityListModel.

type DeviceVulnerabilityModel 

type DeviceVulnerabilityModel struct {
	ProxyResource
	// Device Vulnerability properties
	Properties *DeviceVulnerabilityPropertiesModel `json:"properties,omitempty"`

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

DeviceVulnerabilityModel - IoT Device Vulnerability

type DeviceVulnerabilityPropertiesModel 

type DeviceVulnerabilityPropertiesModel struct {
	// READ-ONLY; The vulnerability affected versions
	AffectedVersions []*string `json:"affectedVersions,omitempty" azure:"ro"`

	// READ-ONLY; The vulnerability description
	Description *string `json:"description,omitempty" azure:"ro"`

	// READ-ONLY; The exploit type of the vulnerability
	ExploitType *string `json:"exploitType,omitempty" azure:"ro"`

	// READ-ONLY; The score of the vulnerability
	Score *float64 `json:"score,omitempty" azure:"ro"`

	// READ-ONLY; The severity score of the vulnerability
	SeverityScore *SeverityScore `json:"severityScore,omitempty" azure:"ro"`

	// READ-ONLY; The sources of the vulnerability
	Sources []*string `json:"sources,omitempty" azure:"ro"`
}

DeviceVulnerabilityPropertiesModel - IoT Device Vulnerability properties

func (DeviceVulnerabilityPropertiesModel) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DeviceVulnerabilityPropertiesModel.

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

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

func (*DevicesClient) Get 

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

Get - Get device If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewDevicesClient("<subscription-id>",
		"<iot-defender-location>", cred, nil)
	res, err := client.Get(ctx,
		"<device-group-name>",
		"<device-id>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("DeviceModel.ID: %s\n", *res.ID)
}

Output:

func (*DevicesClient) List 

func (client *DevicesClient) List(deviceGroupName string, options *DevicesListOptions) *DevicesListPager

List - List devices If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewDevicesClient("<subscription-id>",
		"<iot-defender-location>", cred, nil)
	pager := client.List("<device-group-name>",
		&armiotsecurity.DevicesListOptions{SkipToken: nil})
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("DeviceModel.ID: %s\n", *v.ID)
		}
	}
}

Output:

type DevicesGetOptions 

type DevicesGetOptions struct {
}

DevicesGetOptions contains the optional parameters for the Devices.Get method.

type DevicesGetResponse 

type DevicesGetResponse struct {
	DevicesGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DevicesGetResponse contains the response from method Devices.Get.

type DevicesGetResult 

type DevicesGetResult struct {
	DeviceModel
}

DevicesGetResult contains the result from method Devices.Get.

type DevicesListOptions 

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

DevicesListOptions contains the optional parameters for the Devices.List method.

type DevicesListPager 

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

DevicesListPager provides operations for iterating over paged responses.

func (*DevicesListPager) Err 

func (p *DevicesListPager) Err() error

Err returns the last error encountered while paging.

func (*DevicesListPager) NextPage 

func (p *DevicesListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DevicesListPager) PageResponse 

func (p *DevicesListPager) PageResponse() DevicesListResponse

PageResponse returns the current DevicesListResponse page.

type DevicesListResponse 

type DevicesListResponse struct {
	DevicesListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DevicesListResponse contains the response from method Devices.List.

type DevicesListResult 

type DevicesListResult struct {
	DeviceList
}

DevicesListResult contains the result from method Devices.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 map[string]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.

func (ErrorDetail) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ErrorDetail.

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

func (ErrorModel) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ErrorModel.

type ErrorResponse 

type ErrorResponse struct {

	// The error object.
	InnerError *ErrorDetail `json:"error,omitempty"`
	// contains filtered or unexported fields
}

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.). Implements the error and azcore.HTTPResponse interfaces.

func (ErrorResponse) Error 

func (e ErrorResponse) Error() string

Error implements the error interface for type ErrorResponse. The contents of the error text are not contractual and subject to change.

type ErrorResponseModel 

type ErrorResponseModel struct {

	// READ-ONLY; Gets or sets the error.
	InnerError *ErrorResponseModelError `json:"error,omitempty" azure:"ro"`
	// contains filtered or unexported fields
}

ErrorResponseModel - Default error response model Implements the error and azcore.HTTPResponse interfaces.

func (ErrorResponseModel) Error 

func (e ErrorResponseModel) Error() string

Error implements the error interface for type ErrorResponseModel. The contents of the error text are not contractual and subject to change.

type ErrorResponseModelError 

type ErrorResponseModelError struct {
	ErrorModel
}

ErrorResponseModelError - Gets or sets the error.

type Firmware 

type Firmware struct {
	// A bag of fields which extends the firmware information.
	AdditionalFields map[string]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 IotAlertsClient 

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

IotAlertsClient contains the methods for the IotAlerts group. Don't use this type directly, use NewIotAlertsClient() instead.

func NewIotAlertsClient 

func NewIotAlertsClient(subscriptionID string, iotDefenderLocation string, credential azcore.TokenCredential, options *arm.ClientOptions) *IotAlertsClient

NewIotAlertsClient creates a new instance of IotAlertsClient with the specified values.

func (*IotAlertsClient) Get 

func (client *IotAlertsClient) Get(ctx context.Context, deviceGroupName string, alertID string, options *IotAlertsGetOptions) (IotAlertsGetResponse, error)

Get - Get IoT alert If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/Alerts/GetAlert.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 := armiotsecurity.NewIotAlertsClient("<subscription-id>",
		"<iot-defender-location>", cred, nil)
	res, err := client.Get(ctx,
		"<device-group-name>",
		"<alert-id>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("AlertModel.ID: %s\n", *res.ID)
}

Output:

func (*IotAlertsClient) List 

func (client *IotAlertsClient) List(deviceGroupName string, options *IotAlertsListOptions) *IotAlertsListPager

List - List IoT alerts If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/Alerts/GetAlertList.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 := armiotsecurity.NewIotAlertsClient("<subscription-id>",
		"<iot-defender-location>", cred, nil)
	pager := client.List("<device-group-name>",
		&armiotsecurity.IotAlertsListOptions{SkipToken: nil})
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("AlertModel.ID: %s\n", *v.ID)
		}
	}
}

Output:

func (*IotAlertsClient) Patch 

func (client *IotAlertsClient) Patch(ctx context.Context, deviceGroupName string, alertID string, alertPatchModel AlertPatchPropertiesModel, options *IotAlertsPatchOptions) (IotAlertsPatchResponse, error)

Patch - Update an existing alert If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/Alerts/PatchAlert.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 := armiotsecurity.NewIotAlertsClient("<subscription-id>",
		"<iot-defender-location>", cred, nil)
	res, err := client.Patch(ctx,
		"<device-group-name>",
		"<alert-id>",
		armiotsecurity.AlertPatchPropertiesModel{
			Properties: &armiotsecurity.AlertPatchPropertiesModelProperties{
				Severity: armiotsecurity.AlertSeverityMedium.ToPtr(),
				Status:   armiotsecurity.AlertStatusInProgress.ToPtr(),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("AlertModel.ID: %s\n", *res.ID)
}

Output:

type IotAlertsGetOptions 

type IotAlertsGetOptions struct {
}

IotAlertsGetOptions contains the optional parameters for the IotAlerts.Get method.

type IotAlertsGetResponse 

type IotAlertsGetResponse struct {
	IotAlertsGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotAlertsGetResponse contains the response from method IotAlerts.Get.

type IotAlertsGetResult 

type IotAlertsGetResult struct {
	AlertModel
}

IotAlertsGetResult contains the result from method IotAlerts.Get.

type IotAlertsListOptions 

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

IotAlertsListOptions contains the optional parameters for the IotAlerts.List method.

type IotAlertsListPager 

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

IotAlertsListPager provides operations for iterating over paged responses.

func (*IotAlertsListPager) Err 

func (p *IotAlertsListPager) Err() error

Err returns the last error encountered while paging.

func (*IotAlertsListPager) NextPage 

func (p *IotAlertsListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*IotAlertsListPager) PageResponse 

func (p *IotAlertsListPager) PageResponse() IotAlertsListResponse

PageResponse returns the current IotAlertsListResponse page.

type IotAlertsListResponse 

type IotAlertsListResponse struct {
	IotAlertsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotAlertsListResponse contains the response from method IotAlerts.List.

type IotAlertsListResult 

type IotAlertsListResult struct {
	AlertListModel
}

IotAlertsListResult contains the result from method IotAlerts.List.

type IotAlertsPatchOptions 

type IotAlertsPatchOptions struct {
}

IotAlertsPatchOptions contains the optional parameters for the IotAlerts.Patch method.

type IotAlertsPatchResponse 

type IotAlertsPatchResponse struct {
	IotAlertsPatchResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotAlertsPatchResponse contains the response from method IotAlerts.Patch.

type IotAlertsPatchResult 

type IotAlertsPatchResult struct {
	AlertModel
}

IotAlertsPatchResult contains the result from method IotAlerts.Patch.

type IotDeviceVulnerabilityClient 

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

IotDeviceVulnerabilityClient contains the methods for the IotDeviceVulnerability group. Don't use this type directly, use NewIotDeviceVulnerabilityClient() instead.

func NewIotDeviceVulnerabilityClient 

func NewIotDeviceVulnerabilityClient(subscriptionID string, iotDefenderLocation string, credential azcore.TokenCredential, options *arm.ClientOptions) *IotDeviceVulnerabilityClient

NewIotDeviceVulnerabilityClient creates a new instance of IotDeviceVulnerabilityClient with the specified values.

func (*IotDeviceVulnerabilityClient) Get 

func (client *IotDeviceVulnerabilityClient) Get(ctx context.Context, deviceGroupName string, vulnerabilityID string, options *IotDeviceVulnerabilityGetOptions) (IotDeviceVulnerabilityGetResponse, error)

Get - Get IoT Device Vulnerability If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/Vulnerabilities/GetDeviceVulnerability.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 := armiotsecurity.NewIotDeviceVulnerabilityClient("<subscription-id>",
		"<iot-defender-location>", cred, nil)
	res, err := client.Get(ctx,
		"<device-group-name>",
		"<vulnerability-id>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("DeviceVulnerabilityModel.ID: %s\n", *res.ID)
}

Output:

func (*IotDeviceVulnerabilityClient) List 

func (client *IotDeviceVulnerabilityClient) List(deviceGroupName string, options *IotDeviceVulnerabilityListOptions) *IotDeviceVulnerabilityListPager

List - List IoT Device Vulnerabilities If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/Vulnerabilities/GetDeviceVulnerabilityList.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 := armiotsecurity.NewIotDeviceVulnerabilityClient("<subscription-id>",
		"<iot-defender-location>", cred, nil)
	pager := client.List("<device-group-name>",
		&armiotsecurity.IotDeviceVulnerabilityListOptions{DeviceID: nil,
			SkipToken: nil,
		})
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("DeviceVulnerabilityModel.ID: %s\n", *v.ID)
		}
	}
}

Output:

type IotDeviceVulnerabilityGetOptions 

type IotDeviceVulnerabilityGetOptions struct {
}

IotDeviceVulnerabilityGetOptions contains the optional parameters for the IotDeviceVulnerability.Get method.

type IotDeviceVulnerabilityGetResponse 

type IotDeviceVulnerabilityGetResponse struct {
	IotDeviceVulnerabilityGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotDeviceVulnerabilityGetResponse contains the response from method IotDeviceVulnerability.Get.

type IotDeviceVulnerabilityGetResult 

type IotDeviceVulnerabilityGetResult struct {
	DeviceVulnerabilityModel
}

IotDeviceVulnerabilityGetResult contains the result from method IotDeviceVulnerability.Get.

type IotDeviceVulnerabilityListOptions 

type IotDeviceVulnerabilityListOptions struct {
	// Device ID filter
	DeviceID *string
	// Skip token used for pagination
	SkipToken *string
}

IotDeviceVulnerabilityListOptions contains the optional parameters for the IotDeviceVulnerability.List method.

type IotDeviceVulnerabilityListPager 

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

IotDeviceVulnerabilityListPager provides operations for iterating over paged responses.

func (*IotDeviceVulnerabilityListPager) Err 

func (p *IotDeviceVulnerabilityListPager) Err() error

Err returns the last error encountered while paging.

func (*IotDeviceVulnerabilityListPager) NextPage 

func (p *IotDeviceVulnerabilityListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*IotDeviceVulnerabilityListPager) PageResponse 

func (p *IotDeviceVulnerabilityListPager) PageResponse() IotDeviceVulnerabilityListResponse

PageResponse returns the current IotDeviceVulnerabilityListResponse page.

type IotDeviceVulnerabilityListResponse 

type IotDeviceVulnerabilityListResponse struct {
	IotDeviceVulnerabilityListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotDeviceVulnerabilityListResponse contains the response from method IotDeviceVulnerability.List.

type IotDeviceVulnerabilityListResult 

type IotDeviceVulnerabilityListResult struct {
	DeviceVulnerabilityListModel
}

IotDeviceVulnerabilityListResult contains the result from method IotDeviceVulnerability.List.

type IotRecommendationsClient 

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

IotRecommendationsClient contains the methods for the IotRecommendations group. Don't use this type directly, use NewIotRecommendationsClient() instead.

func NewIotRecommendationsClient 

func NewIotRecommendationsClient(subscriptionID string, iotDefenderLocation string, credential azcore.TokenCredential, options *arm.ClientOptions) *IotRecommendationsClient

NewIotRecommendationsClient creates a new instance of IotRecommendationsClient with the specified values.

func (*IotRecommendationsClient) Get 

func (client *IotRecommendationsClient) Get(ctx context.Context, deviceGroupName string, recommendationID string, options *IotRecommendationsGetOptions) (IotRecommendationsGetResponse, error)

Get - Get IoT recommendation If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/Recommendations/GetRecommendation.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 := armiotsecurity.NewIotRecommendationsClient("<subscription-id>",
		"<iot-defender-location>", cred, nil)
	res, err := client.Get(ctx,
		"<device-group-name>",
		"<recommendation-id>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("RecommendationModel.ID: %s\n", *res.ID)
}

Output:

func (*IotRecommendationsClient) List 

func (client *IotRecommendationsClient) List(deviceGroupName string, options *IotRecommendationsListOptions) *IotRecommendationsListPager

List - List IoT recommendations If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/Recommendations/GetRecommendationList.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 := armiotsecurity.NewIotRecommendationsClient("<subscription-id>",
		"<iot-defender-location>", cred, nil)
	pager := client.List("<device-group-name>",
		&armiotsecurity.IotRecommendationsListOptions{SkipToken: nil})
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("RecommendationModel.ID: %s\n", *v.ID)
		}
	}
}

Output:

type IotRecommendationsGetOptions 

type IotRecommendationsGetOptions struct {
}

IotRecommendationsGetOptions contains the optional parameters for the IotRecommendations.Get method.

type IotRecommendationsGetResponse 

type IotRecommendationsGetResponse struct {
	IotRecommendationsGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotRecommendationsGetResponse contains the response from method IotRecommendations.Get.

type IotRecommendationsGetResult 

type IotRecommendationsGetResult struct {
	RecommendationModel
}

IotRecommendationsGetResult contains the result from method IotRecommendations.Get.

type IotRecommendationsListOptions 

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

IotRecommendationsListOptions contains the optional parameters for the IotRecommendations.List method.

type IotRecommendationsListPager 

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

IotRecommendationsListPager provides operations for iterating over paged responses.

func (*IotRecommendationsListPager) Err 

func (p *IotRecommendationsListPager) Err() error

Err returns the last error encountered while paging.

func (*IotRecommendationsListPager) NextPage 

func (p *IotRecommendationsListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*IotRecommendationsListPager) PageResponse 

func (p *IotRecommendationsListPager) PageResponse() IotRecommendationsListResponse

PageResponse returns the current IotRecommendationsListResponse page.

type IotRecommendationsListResponse 

type IotRecommendationsListResponse struct {
	IotRecommendationsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotRecommendationsListResponse contains the response from method IotRecommendations.List.

type IotRecommendationsListResult 

type IotRecommendationsListResult struct {
	RecommendationListModel
}

IotRecommendationsListResult contains the result from method IotRecommendations.List.

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

func (LocationList) MarshalJSON 

func (l LocationList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LocationList.

type LocationModel 

type LocationModel struct {
	ProxyResource
	// IoT Defender location properties
	Properties map[string]interface{} `json:"properties,omitempty"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,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

NewLocationsClient creates a new instance of LocationsClient with the specified values.

func (*LocationsClient) Get 

func (client *LocationsClient) Get(ctx context.Context, options *LocationsGetOptions) (LocationsGetResponse, error)

Get - Get a Defender for IoT location associated with the given subscription. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewLocationsClient("<subscription-id>",
		"<iot-defender-location>", cred, nil)
	res, err := client.Get(ctx,
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("LocationModel.ID: %s\n", *res.ID)
}

Output:

func (*LocationsClient) List 

func (client *LocationsClient) List(options *LocationsListOptions) *LocationsListPager

List - Lists Defender for IoT locations associated with the given subscription. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewLocationsClient("<subscription-id>",
		"<iot-defender-location>", cred, nil)
	pager := client.List(nil)
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("LocationModel.ID: %s\n", *v.ID)
		}
	}
}

Output:

type LocationsGetOptions 

type LocationsGetOptions struct {
}

LocationsGetOptions contains the optional parameters for the Locations.Get method.

type LocationsGetResponse 

type LocationsGetResponse struct {
	LocationsGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LocationsGetResponse contains the response from method Locations.Get.

type LocationsGetResult 

type LocationsGetResult struct {
	LocationModel
}

LocationsGetResult contains the result from method Locations.Get.

type LocationsListOptions 

type LocationsListOptions struct {
}

LocationsListOptions contains the optional parameters for the Locations.List method.

type LocationsListPager 

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

LocationsListPager provides operations for iterating over paged responses.

func (*LocationsListPager) Err 

func (p *LocationsListPager) Err() error

Err returns the last error encountered while paging.

func (*LocationsListPager) NextPage 

func (p *LocationsListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*LocationsListPager) PageResponse 

func (p *LocationsListPager) PageResponse() LocationsListResponse

PageResponse returns the current LocationsListResponse page.

type LocationsListResponse 

type LocationsListResponse struct {
	LocationsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LocationsListResponse contains the response from method Locations.List.

type LocationsListResult 

type LocationsListResult struct {
	LocationList
}

LocationsListResult contains the result from method Locations.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.

func (MacCertainty) ToPtr 

func (c MacCertainty) ToPtr() *MacCertainty

ToPtr returns a *MacCertainty pointing to the current value.

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.

func (MdeIntegration) ToPtr 

func (c MdeIntegration) ToPtr() *MdeIntegration

ToPtr returns a *MdeIntegration pointing to the current value.

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 {
	ProxyResource
	// On-premise IoT sensor properties
	Properties map[string]interface{} `json:"properties,omitempty"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,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

NewOnPremiseSensorsClient creates a new instance of OnPremiseSensorsClient with the specified values.

func (*OnPremiseSensorsClient) CreateOrUpdate 

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

CreateOrUpdate - Create or update on-premise IoT sensor If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewOnPremiseSensorsClient("<subscription-id>", cred, nil)
	res, err := client.CreateOrUpdate(ctx,
		"<on-premise-sensor-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("OnPremiseSensor.ID: %s\n", *res.ID)
}

Output:

func (*OnPremiseSensorsClient) Delete 

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

Delete - Delete on-premise IoT sensor If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewOnPremiseSensorsClient("<subscription-id>", cred, nil)
	_, err = client.Delete(ctx,
		"<on-premise-sensor-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*OnPremiseSensorsClient) DownloadActivation 

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

DownloadActivation - Download sensor activation file If the operation fails it returns a generic error.

Example

x-ms-original-file: 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 := armiotsecurity.NewOnPremiseSensorsClient("<subscription-id>", cred, nil)
	_, err = client.DownloadActivation(ctx,
		"<on-premise-sensor-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*OnPremiseSensorsClient) DownloadResetPassword 

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

DownloadResetPassword - Download file for reset password of the sensor If the operation fails it returns a generic error.

Example

x-ms-original-file: 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 := armiotsecurity.NewOnPremiseSensorsClient("<subscription-id>", cred, nil)
	_, err = client.DownloadResetPassword(ctx,
		"<on-premise-sensor-name>",
		armiotsecurity.ResetPasswordInput{
			ApplianceID: to.StringPtr("<appliance-id>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*OnPremiseSensorsClient) Get 

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

Get - Get on-premise IoT sensor If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewOnPremiseSensorsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<on-premise-sensor-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("OnPremiseSensor.ID: %s\n", *res.ID)
}

Output:

func (*OnPremiseSensorsClient) List 

func (client *OnPremiseSensorsClient) List(ctx context.Context, options *OnPremiseSensorsListOptions) (OnPremiseSensorsListResponse, error)

List - List on-premise IoT sensors If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewOnPremiseSensorsClient("<subscription-id>", cred, nil)
	_, err = client.List(ctx,
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

type OnPremiseSensorsCreateOrUpdateOptions 

type OnPremiseSensorsCreateOrUpdateOptions struct {
}

OnPremiseSensorsCreateOrUpdateOptions contains the optional parameters for the OnPremiseSensors.CreateOrUpdate method.

type OnPremiseSensorsCreateOrUpdateResponse 

type OnPremiseSensorsCreateOrUpdateResponse struct {
	OnPremiseSensorsCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OnPremiseSensorsCreateOrUpdateResponse contains the response from method OnPremiseSensors.CreateOrUpdate.

type OnPremiseSensorsCreateOrUpdateResult 

type OnPremiseSensorsCreateOrUpdateResult struct {
	OnPremiseSensor
}

OnPremiseSensorsCreateOrUpdateResult contains the result from method OnPremiseSensors.CreateOrUpdate.

type OnPremiseSensorsDeleteOptions 

type OnPremiseSensorsDeleteOptions struct {
}

OnPremiseSensorsDeleteOptions contains the optional parameters for the OnPremiseSensors.Delete method.

type OnPremiseSensorsDeleteResponse 

type OnPremiseSensorsDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OnPremiseSensorsDeleteResponse contains the response from method OnPremiseSensors.Delete.

type OnPremiseSensorsDownloadActivationOptions 

type OnPremiseSensorsDownloadActivationOptions struct {
}

OnPremiseSensorsDownloadActivationOptions contains the optional parameters for the OnPremiseSensors.DownloadActivation method.

type OnPremiseSensorsDownloadActivationResponse 

type OnPremiseSensorsDownloadActivationResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OnPremiseSensorsDownloadActivationResponse contains the response from method OnPremiseSensors.DownloadActivation.

type OnPremiseSensorsDownloadResetPasswordOptions 

type OnPremiseSensorsDownloadResetPasswordOptions struct {
}

OnPremiseSensorsDownloadResetPasswordOptions contains the optional parameters for the OnPremiseSensors.DownloadResetPassword method.

type OnPremiseSensorsDownloadResetPasswordResponse 

type OnPremiseSensorsDownloadResetPasswordResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OnPremiseSensorsDownloadResetPasswordResponse contains the response from method OnPremiseSensors.DownloadResetPassword.

type OnPremiseSensorsGetOptions 

type OnPremiseSensorsGetOptions struct {
}

OnPremiseSensorsGetOptions contains the optional parameters for the OnPremiseSensors.Get method.

type OnPremiseSensorsGetResponse 

type OnPremiseSensorsGetResponse struct {
	OnPremiseSensorsGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OnPremiseSensorsGetResponse contains the response from method OnPremiseSensors.Get.

type OnPremiseSensorsGetResult 

type OnPremiseSensorsGetResult struct {
	OnPremiseSensor
}

OnPremiseSensorsGetResult contains the result from method OnPremiseSensors.Get.

type OnPremiseSensorsList 

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

OnPremiseSensorsList - List of on-premise IoT sensors

func (OnPremiseSensorsList) MarshalJSON 

func (o OnPremiseSensorsList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OnPremiseSensorsList.

type OnPremiseSensorsListOptions 

type OnPremiseSensorsListOptions struct {
}

OnPremiseSensorsListOptions contains the optional parameters for the OnPremiseSensors.List method.

type OnPremiseSensorsListResponse 

type OnPremiseSensorsListResponse struct {
	OnPremiseSensorsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OnPremiseSensorsListResponse contains the response from method OnPremiseSensors.List.

type OnPremiseSensorsListResult 

type OnPremiseSensorsListResult struct {
	OnPremiseSensorsList
}

OnPremiseSensorsListResult contains the result from method OnPremiseSensors.List.

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.

func (OnboardingKind) ToPtr 

func (c OnboardingKind) ToPtr() *OnboardingKind

ToPtr returns a *OnboardingKind pointing to the current value.

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.

func (OnboardingStatus) ToPtr 

func (c OnboardingStatus) ToPtr() *OnboardingStatus

ToPtr returns a *OnboardingStatus pointing to the current value.

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

func (OperationList) MarshalJSON 

func (o OperationList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationList.

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

func (OperationMetaMetricSpecification) MarshalJSON 

func (o OperationMetaMetricSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationMetaMetricSpecification.

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

func (OperationMetaServiceSpecification) MarshalJSON 

func (o OperationMetaServiceSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationMetaServiceSpecification.

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

NewOperationsClient creates a new instance of OperationsClient with the specified values.

func (*OperationsClient) List 

func (client *OperationsClient) List(options *OperationsListOptions) *OperationsListPager

List - List of available operations If the operation fails it returns the *ErrorResponseModel error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewOperationsClient(cred, nil)
	pager := client.List(nil)
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
	}
}

Output:

type OperationsListOptions 

type OperationsListOptions struct {
}

OperationsListOptions contains the optional parameters for the Operations.List method.

type OperationsListPager 

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

OperationsListPager provides operations for iterating over paged responses.

func (*OperationsListPager) Err 

func (p *OperationsListPager) Err() error

Err returns the last error encountered while paging.

func (*OperationsListPager) NextPage 

func (p *OperationsListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*OperationsListPager) PageResponse 

func (p *OperationsListPager) PageResponse() OperationsListResponse

PageResponse returns the current OperationsListResponse page.

type OperationsListResponse 

type OperationsListResponse struct {
	OperationsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OperationsListResponse contains the response from method Operations.List.

type OperationsListResult 

type OperationsListResult struct {
	OperationList
}

OperationsListResult contains the result from method Operations.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

func (PackageDownloads) MarshalJSON 

func (p PackageDownloads) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PackageDownloads.

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

func (PackageDownloadsCentralManager) MarshalJSON 

func (p PackageDownloadsCentralManager) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PackageDownloadsCentralManager.

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

func (PackageDownloadsCentralManagerFull) MarshalJSON 

func (p PackageDownloadsCentralManagerFull) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PackageDownloadsCentralManagerFull.

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

func (PackageDownloadsCentralManagerFullOvf) MarshalJSON 

func (p PackageDownloadsCentralManagerFullOvf) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PackageDownloadsCentralManagerFullOvf.

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

func (PackageDownloadsSensor) MarshalJSON 

func (p PackageDownloadsSensor) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PackageDownloadsSensor.

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

func (PackageDownloadsSensorFull) MarshalJSON 

func (p PackageDownloadsSensorFull) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PackageDownloadsSensorFull.

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

func (PackageDownloadsSensorFullOvf) MarshalJSON 

func (p PackageDownloadsSensorFullOvf) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PackageDownloadsSensorFullOvf.

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.

func (ProgrammingState) ToPtr 

func (c ProgrammingState) ToPtr() *ProgrammingState

ToPtr returns a *ProgrammingState pointing to the current value.

type ProxyResource 

type ProxyResource struct {
	Resource
}

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.

func (PurdueLevel) ToPtr 

func (c PurdueLevel) ToPtr() *PurdueLevel

ToPtr returns a *PurdueLevel pointing to the current value.

type RecommendationListModel 

type RecommendationListModel struct {
	// READ-ONLY; When available, follow the URI to get the next page of data
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

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

RecommendationListModel - List of IoT recommendations

func (RecommendationListModel) MarshalJSON 

func (r RecommendationListModel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RecommendationListModel.

type RecommendationModel 

type RecommendationModel struct {
	ProxyResource
	// Recommendation properties
	Properties *RecommendationPropertiesModel `json:"properties,omitempty"`

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

RecommendationModel - IoT recommendation

type RecommendationPropertiesModel 

type RecommendationPropertiesModel struct {
	// A bag of fields which extends the recommendation information
	RecommendationAdditionalData map[string]interface{} `json:"recommendationAdditionalData,omitempty"`

	// READ-ONLY; Azure Resource Identifier of the device being reported on
	AzureResourceID *string `json:"azureResourceId,omitempty" azure:"ro"`

	// READ-ONLY; The name of the recommendation's control category
	Control *string `json:"control,omitempty" azure:"ro"`

	// READ-ONLY; The discovery time of the recommendation
	DiscoveredTimeUTC *string `json:"discoveredTimeUtc,omitempty" azure:"ro"`

	// READ-ONLY; The name of a component inside the product which generated the recommendation
	ProductComponentName *string `json:"productComponentName,omitempty" azure:"ro"`

	// READ-ONLY; The type name of the recommendation
	RecommendationType *string `json:"recommendationType,omitempty" azure:"ro"`

	// READ-ONLY; The severity of the recommendation
	Severity *RecommendationSeverity `json:"severity,omitempty" azure:"ro"`
}

RecommendationPropertiesModel - IoT recommendation properties

type RecommendationSeverity 

type RecommendationSeverity string

RecommendationSeverity - The severity of the recommendation 

const (
	RecommendationSeverityHealthy       RecommendationSeverity = "Healthy"
	RecommendationSeverityHigh          RecommendationSeverity = "High"
	RecommendationSeverityLow           RecommendationSeverity = "Low"
	RecommendationSeverityMedium        RecommendationSeverity = "Medium"
	RecommendationSeverityNotApplicable RecommendationSeverity = "NotApplicable"
	RecommendationSeverityOffByPolicy   RecommendationSeverity = "OffByPolicy"
	RecommendationSeverityUnknown       RecommendationSeverity = "Unknown"
)

func PossibleRecommendationSeverityValues 

func PossibleRecommendationSeverityValues() []RecommendationSeverity

PossibleRecommendationSeverityValues returns the possible values for the RecommendationSeverity const type.

func (RecommendationSeverity) ToPtr 

func (c RecommendationSeverity) ToPtr() *RecommendationSeverity

ToPtr returns a *RecommendationSeverity pointing to the current value.

type RecommendationType 

type RecommendationType struct {
	ProxyResource
	// Recommendation type properties
	Properties *RecommendationTypeProperties `json:"properties,omitempty"`

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

RecommendationType - IoT recommendation type.

type RecommendationTypeList 

type RecommendationTypeList struct {
	// List data
	Value []*RecommendationType `json:"value,omitempty"`
}

RecommendationTypeList - List of recommendation types

func (RecommendationTypeList) MarshalJSON 

func (r RecommendationTypeList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RecommendationTypeList.

type RecommendationTypeProperties 

type RecommendationTypeProperties struct {
	// READ-ONLY; The name of the recommendation's control category
	Control *string `json:"control,omitempty" azure:"ro"`

	// READ-ONLY; The alert's data source
	DataSource *string `json:"dataSource,omitempty" azure:"ro"`

	// READ-ONLY; Description of the suspected vulnerability and meaning.
	Description *string `json:"description,omitempty" azure:"ro"`

	// READ-ONLY; The name of a component inside the product which generated the recommendation
	ProductComponentName *string `json:"productComponentName,omitempty" azure:"ro"`

	// READ-ONLY; The name of the product which published this recommendation
	ProductName *string `json:"productName,omitempty" azure:"ro"`

	// READ-ONLY; The display name of the recommendation
	RecommendationDisplayName *string `json:"recommendationDisplayName,omitempty" azure:"ro"`

	// READ-ONLY; Manual action items to take to resolve the recommendation
	RemediationSteps []*string `json:"remediationSteps,omitempty" azure:"ro"`

	// READ-ONLY; The severity of the recommendation
	Severity *RecommendationSeverity `json:"severity,omitempty" azure:"ro"`

	// READ-ONLY; The name of the vendor that raised the recommendation
	VendorName *string `json:"vendorName,omitempty" azure:"ro"`
}

RecommendationTypeProperties - IoT recommendation type information.

func (RecommendationTypeProperties) MarshalJSON 

func (r RecommendationTypeProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RecommendationTypeProperties.

type RecommendationTypesClient 

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

RecommendationTypesClient contains the methods for the RecommendationTypes group. Don't use this type directly, use NewRecommendationTypesClient() instead.

func NewRecommendationTypesClient 

func NewRecommendationTypesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *RecommendationTypesClient

NewRecommendationTypesClient creates a new instance of RecommendationTypesClient with the specified values.

func (*RecommendationTypesClient) Get 

func (client *RecommendationTypesClient) Get(ctx context.Context, recommendationTypeName string, options *RecommendationTypesGetOptions) (RecommendationTypesGetResponse, error)

Get - Get IoT recommendation type If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/RecommendationTypes/GetRecommendationType.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 := armiotsecurity.NewRecommendationTypesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<recommendation-type-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("RecommendationType.ID: %s\n", *res.ID)
}

Output:

func (*RecommendationTypesClient) List 

func (client *RecommendationTypesClient) List(ctx context.Context, options *RecommendationTypesListOptions) (RecommendationTypesListResponse, error)

List - List IoT recommendation types If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/RecommendationTypes/GetRecommendationTypeList.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 := armiotsecurity.NewRecommendationTypesClient("<subscription-id>", cred, nil)
	_, err = client.List(ctx,
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

type RecommendationTypesGetOptions 

type RecommendationTypesGetOptions struct {
}

RecommendationTypesGetOptions contains the optional parameters for the RecommendationTypes.Get method.

type RecommendationTypesGetResponse 

type RecommendationTypesGetResponse struct {
	RecommendationTypesGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RecommendationTypesGetResponse contains the response from method RecommendationTypes.Get.

type RecommendationTypesGetResult 

type RecommendationTypesGetResult struct {
	RecommendationType
}

RecommendationTypesGetResult contains the result from method RecommendationTypes.Get.

type RecommendationTypesListOptions 

type RecommendationTypesListOptions struct {
}

RecommendationTypesListOptions contains the optional parameters for the RecommendationTypes.List method.

type RecommendationTypesListResponse 

type RecommendationTypesListResponse struct {
	RecommendationTypesListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RecommendationTypesListResponse contains the response from method RecommendationTypes.List.

type RecommendationTypesListResult 

type RecommendationTypesListResult struct {
	RecommendationTypeList
}

RecommendationTypesListResult contains the result from method RecommendationTypes.List.

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 {
	Resource
	// IoT sensor properties
	Properties *SensorProperties `json:"properties,omitempty"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,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.

func (SensorStatus) ToPtr 

func (c SensorStatus) ToPtr() *SensorStatus

ToPtr returns a *SensorStatus pointing to the current value.

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.

func (SensorType) ToPtr 

func (c SensorType) ToPtr() *SensorType

ToPtr returns a *SensorType pointing to the current value.

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

NewSensorsClient creates a new instance of SensorsClient with the specified values.

func (*SensorsClient) CreateOrUpdate 

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

CreateOrUpdate - Create or update IoT sensor If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewSensorsClient(cred, nil)
	res, err := client.CreateOrUpdate(ctx,
		"<scope>",
		"<sensor-name>",
		armiotsecurity.SensorModel{
			Properties: &armiotsecurity.SensorProperties{
				SensorType:         armiotsecurity.SensorTypeOt.ToPtr(),
				TiAutomaticUpdates: to.BoolPtr(true),
				Zone:               to.StringPtr("<zone>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("SensorModel.ID: %s\n", *res.ID)
}

Output:

func (*SensorsClient) Delete 

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

Delete - Delete IoT sensor If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewSensorsClient(cred, nil)
	_, err = client.Delete(ctx,
		"<scope>",
		"<sensor-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*SensorsClient) DownloadActivation 

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

DownloadActivation - Download sensor activation file If the operation fails it returns a generic error.

Example

x-ms-original-file: 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 := armiotsecurity.NewSensorsClient(cred, nil)
	_, err = client.DownloadActivation(ctx,
		"<scope>",
		"<sensor-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*SensorsClient) DownloadResetPassword 

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

DownloadResetPassword - Download file for reset password of the sensor If the operation fails it returns a generic error.

Example

x-ms-original-file: 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 := armiotsecurity.NewSensorsClient(cred, nil)
	_, err = client.DownloadResetPassword(ctx,
		"<scope>",
		"<sensor-name>",
		armiotsecurity.ResetPasswordInput{
			ApplianceID: to.StringPtr("<appliance-id>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*SensorsClient) Get 

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

Get - Get IoT sensor If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewSensorsClient(cred, nil)
	res, err := client.Get(ctx,
		"<scope>",
		"<sensor-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("SensorModel.ID: %s\n", *res.ID)
}

Output:

func (*SensorsClient) List 

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

List - List IoT sensors If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewSensorsClient(cred, nil)
	_, err = client.List(ctx,
		"<scope>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*SensorsClient) TriggerTiPackageUpdate 

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

TriggerTiPackageUpdate - Trigger threat intelligence package update If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewSensorsClient(cred, nil)
	_, err = client.TriggerTiPackageUpdate(ctx,
		"<scope>",
		"<sensor-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

type SensorsCreateOrUpdateOptions 

type SensorsCreateOrUpdateOptions struct {
}

SensorsCreateOrUpdateOptions contains the optional parameters for the Sensors.CreateOrUpdate method.

type SensorsCreateOrUpdateResponse 

type SensorsCreateOrUpdateResponse struct {
	SensorsCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SensorsCreateOrUpdateResponse contains the response from method Sensors.CreateOrUpdate.

type SensorsCreateOrUpdateResult 

type SensorsCreateOrUpdateResult struct {
	SensorModel
}

SensorsCreateOrUpdateResult contains the result from method Sensors.CreateOrUpdate.

type SensorsDeleteOptions 

type SensorsDeleteOptions struct {
}

SensorsDeleteOptions contains the optional parameters for the Sensors.Delete method.

type SensorsDeleteResponse 

type SensorsDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SensorsDeleteResponse contains the response from method Sensors.Delete.

type SensorsDownloadActivationOptions 

type SensorsDownloadActivationOptions struct {
}

SensorsDownloadActivationOptions contains the optional parameters for the Sensors.DownloadActivation method.

type SensorsDownloadActivationResponse 

type SensorsDownloadActivationResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SensorsDownloadActivationResponse contains the response from method Sensors.DownloadActivation.

type SensorsDownloadResetPasswordOptions 

type SensorsDownloadResetPasswordOptions struct {
}

SensorsDownloadResetPasswordOptions contains the optional parameters for the Sensors.DownloadResetPassword method.

type SensorsDownloadResetPasswordResponse 

type SensorsDownloadResetPasswordResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SensorsDownloadResetPasswordResponse contains the response from method Sensors.DownloadResetPassword.

type SensorsGetOptions 

type SensorsGetOptions struct {
}

SensorsGetOptions contains the optional parameters for the Sensors.Get method.

type SensorsGetResponse 

type SensorsGetResponse struct {
	SensorsGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SensorsGetResponse contains the response from method Sensors.Get.

type SensorsGetResult 

type SensorsGetResult struct {
	SensorModel
}

SensorsGetResult contains the result from method Sensors.Get.

type SensorsList 

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

SensorsList - List of IoT sensors

func (SensorsList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SensorsList.

type SensorsListOptions 

type SensorsListOptions struct {
}

SensorsListOptions contains the optional parameters for the Sensors.List method.

type SensorsListResponse 

type SensorsListResponse struct {
	SensorsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SensorsListResponse contains the response from method Sensors.List.

type SensorsListResult 

type SensorsListResult struct {
	SensorsList
}

SensorsListResult contains the result from method Sensors.List.

type SensorsTriggerTiPackageUpdateOptions 

type SensorsTriggerTiPackageUpdateOptions struct {
}

SensorsTriggerTiPackageUpdateOptions contains the optional parameters for the Sensors.TriggerTiPackageUpdate method.

type SensorsTriggerTiPackageUpdateResponse 

type SensorsTriggerTiPackageUpdateResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SensorsTriggerTiPackageUpdateResponse contains the response from method Sensors.TriggerTiPackageUpdate.

type SeverityScore 

type SeverityScore string

SeverityScore - The severity score of the vulnerability 

const (
	SeverityScoreCritical SeverityScore = "Critical"
	SeverityScoreHigh     SeverityScore = "High"
	SeverityScoreLow      SeverityScore = "Low"
	SeverityScoreMedium   SeverityScore = "Medium"
	SeverityScoreNone     SeverityScore = "None"
)

func PossibleSeverityScoreValues 

func PossibleSeverityScoreValues() []SeverityScore

PossibleSeverityScoreValues returns the possible values for the SeverityScore const type.

func (SeverityScore) ToPtr 

func (c SeverityScore) ToPtr() *SeverityScore

ToPtr returns a *SeverityScore pointing to the current value.

type SiteModel 

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

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,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

NewSitesClient creates a new instance of SitesClient with the specified values.

func (*SitesClient) CreateOrUpdate 

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

CreateOrUpdate - Create or update IoT site If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewSitesClient(cred, nil)
	res, err := client.CreateOrUpdate(ctx,
		"<scope>",
		armiotsecurity.SiteModel{
			Properties: &armiotsecurity.SiteProperties{
				DisplayName: to.StringPtr("<display-name>"),
				Tags: map[string]*string{
					"key1": to.StringPtr("value1"),
					"key2": to.StringPtr("value2"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("SiteModel.ID: %s\n", *res.ID)
}

Output:

func (*SitesClient) Delete 

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

Delete - Delete IoT site If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewSitesClient(cred, nil)
	_, err = client.Delete(ctx,
		"<scope>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*SitesClient) Get 

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

Get - Get IoT site If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewSitesClient(cred, nil)
	res, err := client.Get(ctx,
		"<scope>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("SiteModel.ID: %s\n", *res.ID)
}

Output:

func (*SitesClient) List 

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

List - List IoT sites If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: 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 := armiotsecurity.NewSitesClient(cred, nil)
	_, err = client.List(ctx,
		"<scope>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

type SitesCreateOrUpdateOptions 

type SitesCreateOrUpdateOptions struct {
}

SitesCreateOrUpdateOptions contains the optional parameters for the Sites.CreateOrUpdate method.

type SitesCreateOrUpdateResponse 

type SitesCreateOrUpdateResponse struct {
	SitesCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SitesCreateOrUpdateResponse contains the response from method Sites.CreateOrUpdate.

type SitesCreateOrUpdateResult 

type SitesCreateOrUpdateResult struct {
	SiteModel
}

SitesCreateOrUpdateResult contains the result from method Sites.CreateOrUpdate.

type SitesDeleteOptions 

type SitesDeleteOptions struct {
}

SitesDeleteOptions contains the optional parameters for the Sites.Delete method.

type SitesDeleteResponse 

type SitesDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SitesDeleteResponse contains the response from method Sites.Delete.

type SitesGetOptions 

type SitesGetOptions struct {
}

SitesGetOptions contains the optional parameters for the Sites.Get method.

type SitesGetResponse 

type SitesGetResponse struct {
	SitesGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SitesGetResponse contains the response from method Sites.Get.

type SitesGetResult 

type SitesGetResult struct {
	SiteModel
}

SitesGetResult contains the result from method Sites.Get.

type SitesList 

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

SitesList - List of IoT sites

func (SitesList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SitesList.

type SitesListOptions 

type SitesListOptions struct {
}

SitesListOptions contains the optional parameters for the Sites.List method.

type SitesListResponse 

type SitesListResponse struct {
	SitesListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SitesListResponse contains the response from method Sites.List.

type SitesListResult 

type SitesListResult struct {
	SitesList
}

SitesListResult contains the result from method Sites.List.

type Slot 

type Slot struct {
	// A bag of fields which extends the slot information.
	AdditionalData map[string]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.

func (SlotType) ToPtr 

func (c SlotType) ToPtr() *SlotType

ToPtr returns a *SlotType pointing to the current value.

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 TechniqueModel 

type TechniqueModel struct {
	// READ-ONLY; Technique description
	Description *string `json:"description,omitempty" azure:"ro"`

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

	// READ-ONLY; Link to the technique in MITRE portal
	Link *string `json:"link,omitempty" azure:"ro"`

	// READ-ONLY; Technique display name
	Name *string `json:"name,omitempty" azure:"ro"`
}

TechniqueModel - Technique properties

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.

func (TiStatus) ToPtr 

func (c TiStatus) ToPtr() *TiStatus

ToPtr returns a *TiStatus pointing to the current value.

type UpgradePackageDownloadInfo 

type UpgradePackageDownloadInfo struct {
	PackageDownloadInfo
	// READ-ONLY; Minimum base version for upgrade
	FromVersion *string `json:"fromVersion,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.

func (VersionKind) ToPtr 

func (c VersionKind) ToPtr() *VersionKind

ToPtr returns a *VersionKind pointing to the current value.

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.