iotsecuritysolutionsanalytics

package
v0.20240320.1144505 Latest Latest
Warning

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

Go to latest
Published: Mar 20, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/security/2017-08-01-preview/iotsecuritysolutionsanalytics Documentation

The iotsecuritysolutionsanalytics SDK allows for interaction with the Azure Resource Manager Service security (API Version 2017-08-01-preview).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/security/2017-08-01-preview/iotsecuritysolutionsanalytics"

Client Initialization

client := iotsecuritysolutionsanalytics.NewIoTSecuritySolutionsAnalyticsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: IoTSecuritySolutionsAnalyticsClient.AggregatedAlertDismiss

ctx := context.TODO()
id := iotsecuritysolutionsanalytics.NewAggregatedAlertID("12345678-1234-9876-4563-123456789012", "example-resource-group", "iotSecuritySolutionValue", "aggregatedAlertValue")

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

Example Usage: IoTSecuritySolutionsAnalyticsClient.AggregatedAlertGet

ctx := context.TODO()
id := iotsecuritysolutionsanalytics.NewAggregatedAlertID("12345678-1234-9876-4563-123456789012", "example-resource-group", "iotSecuritySolutionValue", "aggregatedAlertValue")

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

Example Usage: IoTSecuritySolutionsAnalyticsClient.AggregatedAlertsList

ctx := context.TODO()
id := iotsecuritysolutionsanalytics.NewIotSecuritySolutionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "iotSecuritySolutionValue")

// alternatively `client.AggregatedAlertsList(ctx, id, iotsecuritysolutionsanalytics.DefaultAggregatedAlertsListOperationOptions())` can be used to do batched pagination
items, err := client.AggregatedAlertsListComplete(ctx, id, iotsecuritysolutionsanalytics.DefaultAggregatedAlertsListOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: IoTSecuritySolutionsAnalyticsClient.GetAll

ctx := context.TODO()
id := iotsecuritysolutionsanalytics.NewIotSecuritySolutionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "iotSecuritySolutionValue")

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

Example Usage: IoTSecuritySolutionsAnalyticsClient.GetDefault

ctx := context.TODO()
id := iotsecuritysolutionsanalytics.NewIotSecuritySolutionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "iotSecuritySolutionValue")

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

Example Usage: IoTSecuritySolutionsAnalyticsClient.RecommendationGet

ctx := context.TODO()
id := iotsecuritysolutionsanalytics.NewAggregatedRecommendationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "iotSecuritySolutionValue", "aggregatedRecommendationValue")

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

Example Usage: IoTSecuritySolutionsAnalyticsClient.RecommendationsList

ctx := context.TODO()
id := iotsecuritysolutionsanalytics.NewIotSecuritySolutionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "iotSecuritySolutionValue")

// alternatively `client.RecommendationsList(ctx, id, iotsecuritysolutionsanalytics.DefaultRecommendationsListOperationOptions())` can be used to do batched pagination
items, err := client.RecommendationsListComplete(ctx, id, iotsecuritysolutionsanalytics.DefaultRecommendationsListOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForReportedSeverity

func PossibleValuesForReportedSeverity() []string

func ValidateAggregatedAlertID

func ValidateAggregatedAlertID(input interface{}, key string) (warnings []string, errors []error)

ValidateAggregatedAlertID checks that 'input' can be parsed as a Aggregated Alert ID

func ValidateAggregatedRecommendationID

func ValidateAggregatedRecommendationID(input interface{}, key string) (warnings []string, errors []error)

ValidateAggregatedRecommendationID checks that 'input' can be parsed as a Aggregated Recommendation ID

func ValidateIotSecuritySolutionID

func ValidateIotSecuritySolutionID(input interface{}, key string) (warnings []string, errors []error)

ValidateIotSecuritySolutionID checks that 'input' can be parsed as a Iot Security Solution ID

Types

type AggregatedAlertDismissOperationResponse

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

type AggregatedAlertGetOperationResponse

type AggregatedAlertGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *IoTSecurityAggregatedAlert
}

type AggregatedAlertId

type AggregatedAlertId struct {
	SubscriptionId          string
	ResourceGroupName       string
	IotSecuritySolutionName string
	AggregatedAlertName     string
}

AggregatedAlertId is a struct representing the Resource ID for a Aggregated Alert

func NewAggregatedAlertID

func NewAggregatedAlertID(subscriptionId string, resourceGroupName string, iotSecuritySolutionName string, aggregatedAlertName string) AggregatedAlertId

NewAggregatedAlertID returns a new AggregatedAlertId struct

func ParseAggregatedAlertID

func ParseAggregatedAlertID(input string) (*AggregatedAlertId, error)

ParseAggregatedAlertID parses 'input' into a AggregatedAlertId

func ParseAggregatedAlertIDInsensitively

func ParseAggregatedAlertIDInsensitively(input string) (*AggregatedAlertId, error)

ParseAggregatedAlertIDInsensitively parses 'input' case-insensitively into a AggregatedAlertId note: this method should only be used for API response data and not user input

func (*AggregatedAlertId) FromParseResult

func (id *AggregatedAlertId) FromParseResult(input resourceids.ParseResult) error

func (AggregatedAlertId) ID

func (id AggregatedAlertId) ID() string

ID returns the formatted Aggregated Alert ID

func (AggregatedAlertId) Segments

func (id AggregatedAlertId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Aggregated Alert ID

func (AggregatedAlertId) String

func (id AggregatedAlertId) String() string

String returns a human-readable description of this Aggregated Alert ID

type AggregatedAlertsListCompleteResult

type AggregatedAlertsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []IoTSecurityAggregatedAlert
}

type AggregatedAlertsListOperationOptions

type AggregatedAlertsListOperationOptions struct {
	Top *int64
}

func DefaultAggregatedAlertsListOperationOptions

func DefaultAggregatedAlertsListOperationOptions() AggregatedAlertsListOperationOptions

func (AggregatedAlertsListOperationOptions) ToHeaders added in v0.20240228.1142829

func (AggregatedAlertsListOperationOptions) ToOData added in v0.20240228.1142829

func (AggregatedAlertsListOperationOptions) ToQuery added in v0.20240228.1142829

type AggregatedAlertsListOperationResponse

type AggregatedAlertsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]IoTSecurityAggregatedAlert
}

type AggregatedRecommendationId

type AggregatedRecommendationId struct {
	SubscriptionId               string
	ResourceGroupName            string
	IotSecuritySolutionName      string
	AggregatedRecommendationName string
}

AggregatedRecommendationId is a struct representing the Resource ID for a Aggregated Recommendation

func NewAggregatedRecommendationID

func NewAggregatedRecommendationID(subscriptionId string, resourceGroupName string, iotSecuritySolutionName string, aggregatedRecommendationName string) AggregatedRecommendationId

NewAggregatedRecommendationID returns a new AggregatedRecommendationId struct

func ParseAggregatedRecommendationID

func ParseAggregatedRecommendationID(input string) (*AggregatedRecommendationId, error)

ParseAggregatedRecommendationID parses 'input' into a AggregatedRecommendationId

func ParseAggregatedRecommendationIDInsensitively

func ParseAggregatedRecommendationIDInsensitively(input string) (*AggregatedRecommendationId, error)

ParseAggregatedRecommendationIDInsensitively parses 'input' case-insensitively into a AggregatedRecommendationId note: this method should only be used for API response data and not user input

func (*AggregatedRecommendationId) FromParseResult

func (id *AggregatedRecommendationId) FromParseResult(input resourceids.ParseResult) error

func (AggregatedRecommendationId) ID

ID returns the formatted Aggregated Recommendation ID

func (AggregatedRecommendationId) Segments

Segments returns a slice of Resource ID Segments which comprise this Aggregated Recommendation ID

func (AggregatedRecommendationId) String

func (id AggregatedRecommendationId) String() string

String returns a human-readable description of this Aggregated Recommendation ID

type GetAllCompleteResult added in v0.20240226.1173038

type GetAllCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []IoTSecuritySolutionAnalyticsModel
}

type GetAllOperationResponse

type GetAllOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]IoTSecuritySolutionAnalyticsModel
}

type GetDefaultOperationResponse

type GetDefaultOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *IoTSecuritySolutionAnalyticsModel
}

type IoTSecurityAggregatedAlert

type IoTSecurityAggregatedAlert struct {
	Id         *string                               `json:"id,omitempty"`
	Name       *string                               `json:"name,omitempty"`
	Properties *IoTSecurityAggregatedAlertProperties `json:"properties,omitempty"`
	Tags       *map[string]string                    `json:"tags,omitempty"`
	Type       *string                               `json:"type,omitempty"`
}

type IoTSecurityAggregatedAlertOperationPredicate

type IoTSecurityAggregatedAlertOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (IoTSecurityAggregatedAlertOperationPredicate) Matches

type IoTSecurityAggregatedAlertProperties

type IoTSecurityAggregatedAlertProperties struct {
	ActionTaken          *string           `json:"actionTaken,omitempty"`
	AggregatedDateUtc    *string           `json:"aggregatedDateUtc,omitempty"`
	AlertDisplayName     *string           `json:"alertDisplayName,omitempty"`
	AlertType            *string           `json:"alertType,omitempty"`
	Count                *int64            `json:"count,omitempty"`
	Description          *string           `json:"description,omitempty"`
	EffectedResourceType *string           `json:"effectedResourceType,omitempty"`
	LogAnalyticsQuery    *string           `json:"logAnalyticsQuery,omitempty"`
	RemediationSteps     *string           `json:"remediationSteps,omitempty"`
	ReportedSeverity     *ReportedSeverity `json:"reportedSeverity,omitempty"`
	SystemSource         *string           `json:"systemSource,omitempty"`
	VendorName           *string           `json:"vendorName,omitempty"`
}

type IoTSecurityAggregatedRecommendation

type IoTSecurityAggregatedRecommendation struct {
	Id         *string                                        `json:"id,omitempty"`
	Name       *string                                        `json:"name,omitempty"`
	Properties *IoTSecurityAggregatedRecommendationProperties `json:"properties,omitempty"`
	Tags       *map[string]string                             `json:"tags,omitempty"`
	Type       *string                                        `json:"type,omitempty"`
}

type IoTSecurityAggregatedRecommendationOperationPredicate

type IoTSecurityAggregatedRecommendationOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (IoTSecurityAggregatedRecommendationOperationPredicate) Matches

type IoTSecurityAggregatedRecommendationProperties

type IoTSecurityAggregatedRecommendationProperties struct {
	Description               *string           `json:"description,omitempty"`
	DetectedBy                *string           `json:"detectedBy,omitempty"`
	HealthyDevices            *int64            `json:"healthyDevices,omitempty"`
	LogAnalyticsQuery         *string           `json:"logAnalyticsQuery,omitempty"`
	RecommendationDisplayName *string           `json:"recommendationDisplayName,omitempty"`
	RecommendationName        *string           `json:"recommendationName,omitempty"`
	RecommendationTypeId      *string           `json:"recommendationTypeId,omitempty"`
	RemediationSteps          *string           `json:"remediationSteps,omitempty"`
	ReportedSeverity          *ReportedSeverity `json:"reportedSeverity,omitempty"`
	UnhealthyDeviceCount      *int64            `json:"unhealthyDeviceCount,omitempty"`
}

type IoTSecurityAlertedDevice

type IoTSecurityAlertedDevice struct {
	AlertsCount *int64  `json:"alertsCount,omitempty"`
	DeviceId    *string `json:"deviceId,omitempty"`
}

type IoTSecurityAlertedDevicesList

type IoTSecurityAlertedDevicesList struct {
	NextLink *string                    `json:"nextLink,omitempty"`
	Value    []IoTSecurityAlertedDevice `json:"value"`
}

type IoTSecurityDeviceAlert

type IoTSecurityDeviceAlert struct {
	AlertDisplayName *string           `json:"alertDisplayName,omitempty"`
	AlertsCount      *int64            `json:"alertsCount,omitempty"`
	ReportedSeverity *ReportedSeverity `json:"reportedSeverity,omitempty"`
}

type IoTSecurityDeviceAlertsList

type IoTSecurityDeviceAlertsList struct {
	NextLink *string                  `json:"nextLink,omitempty"`
	Value    []IoTSecurityDeviceAlert `json:"value"`
}

type IoTSecurityDeviceRecommendation

type IoTSecurityDeviceRecommendation struct {
	DevicesCount              *int64            `json:"devicesCount,omitempty"`
	RecommendationDisplayName *string           `json:"recommendationDisplayName,omitempty"`
	ReportedSeverity          *ReportedSeverity `json:"reportedSeverity,omitempty"`
}

type IoTSecurityDeviceRecommendationsList

type IoTSecurityDeviceRecommendationsList struct {
	NextLink *string                           `json:"nextLink,omitempty"`
	Value    []IoTSecurityDeviceRecommendation `json:"value"`
}

type IoTSecuritySolutionAnalyticsModel

type IoTSecuritySolutionAnalyticsModel struct {
	Id         *string                                      `json:"id,omitempty"`
	Name       *string                                      `json:"name,omitempty"`
	Properties *IoTSecuritySolutionAnalyticsModelProperties `json:"properties,omitempty"`
	Type       *string                                      `json:"type,omitempty"`
}

type IoTSecuritySolutionAnalyticsModelOperationPredicate added in v0.20240226.1173038

type IoTSecuritySolutionAnalyticsModelOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (IoTSecuritySolutionAnalyticsModelOperationPredicate) Matches added in v0.20240226.1173038

type IoTSecuritySolutionAnalyticsModelProperties

type IoTSecuritySolutionAnalyticsModelProperties struct {
	DevicesMetrics                     *[]IoTSecuritySolutionAnalyticsModelPropertiesDevicesMetricsInlined `json:"devicesMetrics,omitempty"`
	Metrics                            *IoTSeverityMetrics                                                 `json:"metrics,omitempty"`
	MostPrevalentDeviceAlerts          *IoTSecurityDeviceAlertsList                                        `json:"mostPrevalentDeviceAlerts,omitempty"`
	MostPrevalentDeviceRecommendations *IoTSecurityDeviceRecommendationsList                               `json:"mostPrevalentDeviceRecommendations,omitempty"`
	TopAlertedDevices                  *IoTSecurityAlertedDevicesList                                      `json:"topAlertedDevices,omitempty"`
	UnhealthyDeviceCount               *int64                                                              `json:"unhealthyDeviceCount,omitempty"`
}

type IoTSecuritySolutionAnalyticsModelPropertiesDevicesMetricsInlined

type IoTSecuritySolutionAnalyticsModelPropertiesDevicesMetricsInlined struct {
	Date           *string             `json:"date,omitempty"`
	DevicesMetrics *IoTSeverityMetrics `json:"devicesMetrics,omitempty"`
}

func (*IoTSecuritySolutionAnalyticsModelPropertiesDevicesMetricsInlined) GetDateAsTime

func (*IoTSecuritySolutionAnalyticsModelPropertiesDevicesMetricsInlined) SetDateAsTime

type IoTSecuritySolutionsAnalyticsClient

type IoTSecuritySolutionsAnalyticsClient struct {
	Client *resourcemanager.Client
}

func NewIoTSecuritySolutionsAnalyticsClientWithBaseURI

func NewIoTSecuritySolutionsAnalyticsClientWithBaseURI(sdkApi sdkEnv.Api) (*IoTSecuritySolutionsAnalyticsClient, error)

func (IoTSecuritySolutionsAnalyticsClient) AggregatedAlertDismiss

AggregatedAlertDismiss ...

func (IoTSecuritySolutionsAnalyticsClient) AggregatedAlertGet

AggregatedAlertGet ...

func (IoTSecuritySolutionsAnalyticsClient) AggregatedAlertsList

AggregatedAlertsList ...

func (IoTSecuritySolutionsAnalyticsClient) AggregatedAlertsListComplete

AggregatedAlertsListComplete retrieves all the results into a single object

func (IoTSecuritySolutionsAnalyticsClient) AggregatedAlertsListCompleteMatchingPredicate

AggregatedAlertsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (IoTSecuritySolutionsAnalyticsClient) GetAll

GetAll ...

func (IoTSecuritySolutionsAnalyticsClient) GetAllComplete added in v0.20240226.1173038

GetAllComplete retrieves all the results into a single object

func (IoTSecuritySolutionsAnalyticsClient) GetAllCompleteMatchingPredicate added in v0.20240226.1173038

GetAllCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (IoTSecuritySolutionsAnalyticsClient) GetDefault

GetDefault ...

func (IoTSecuritySolutionsAnalyticsClient) RecommendationGet

RecommendationGet ...

func (IoTSecuritySolutionsAnalyticsClient) RecommendationsList

RecommendationsList ...

func (IoTSecuritySolutionsAnalyticsClient) RecommendationsListComplete

RecommendationsListComplete retrieves all the results into a single object

func (IoTSecuritySolutionsAnalyticsClient) RecommendationsListCompleteMatchingPredicate

RecommendationsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type IoTSeverityMetrics

type IoTSeverityMetrics struct {
	High   *int64 `json:"high,omitempty"`
	Low    *int64 `json:"low,omitempty"`
	Medium *int64 `json:"medium,omitempty"`
}

type IotSecuritySolutionId

type IotSecuritySolutionId struct {
	SubscriptionId          string
	ResourceGroupName       string
	IotSecuritySolutionName string
}

IotSecuritySolutionId is a struct representing the Resource ID for a Iot Security Solution

func NewIotSecuritySolutionID

func NewIotSecuritySolutionID(subscriptionId string, resourceGroupName string, iotSecuritySolutionName string) IotSecuritySolutionId

NewIotSecuritySolutionID returns a new IotSecuritySolutionId struct

func ParseIotSecuritySolutionID

func ParseIotSecuritySolutionID(input string) (*IotSecuritySolutionId, error)

ParseIotSecuritySolutionID parses 'input' into a IotSecuritySolutionId

func ParseIotSecuritySolutionIDInsensitively

func ParseIotSecuritySolutionIDInsensitively(input string) (*IotSecuritySolutionId, error)

ParseIotSecuritySolutionIDInsensitively parses 'input' case-insensitively into a IotSecuritySolutionId note: this method should only be used for API response data and not user input

func (*IotSecuritySolutionId) FromParseResult

func (id *IotSecuritySolutionId) FromParseResult(input resourceids.ParseResult) error

func (IotSecuritySolutionId) ID

func (id IotSecuritySolutionId) ID() string

ID returns the formatted Iot Security Solution ID

func (IotSecuritySolutionId) Segments

func (id IotSecuritySolutionId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Iot Security Solution ID

func (IotSecuritySolutionId) String

func (id IotSecuritySolutionId) String() string

String returns a human-readable description of this Iot Security Solution ID

type RecommendationGetOperationResponse

type RecommendationGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *IoTSecurityAggregatedRecommendation
}

type RecommendationsListCompleteResult

type RecommendationsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []IoTSecurityAggregatedRecommendation
}

type RecommendationsListOperationOptions

type RecommendationsListOperationOptions struct {
	Top *int64
}

func DefaultRecommendationsListOperationOptions

func DefaultRecommendationsListOperationOptions() RecommendationsListOperationOptions

func (RecommendationsListOperationOptions) ToHeaders added in v0.20240228.1142829

func (RecommendationsListOperationOptions) ToOData added in v0.20240228.1142829

func (RecommendationsListOperationOptions) ToQuery added in v0.20240228.1142829

type RecommendationsListOperationResponse

type RecommendationsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]IoTSecurityAggregatedRecommendation
}

type ReportedSeverity

type ReportedSeverity string
const (
	ReportedSeverityHigh          ReportedSeverity = "High"
	ReportedSeverityInformational ReportedSeverity = "Informational"
	ReportedSeverityLow           ReportedSeverity = "Low"
	ReportedSeverityMedium        ReportedSeverity = "Medium"
)

func (*ReportedSeverity) UnmarshalJSON added in v0.20240228.1142829

func (s *ReportedSeverity) UnmarshalJSON(bytes []byte) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL