iotsecuritysolutions

package
v0.20240125.1170241 Latest Latest
Warning

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

 Go to latest Published: Jan 25, 2024 License: MPL-2.0 Imports: 9 Imported by: 0

README

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

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

Client Initialization

client := iotsecuritysolutions.NewIotSecuritySolutionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: IotSecuritySolutionsClient.IoTSecuritySolutionsList

ctx := context.TODO()
id := iotsecuritysolutions.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: IotSecuritySolutionsClient.IoTSecuritySolutionsResourceGroupList

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

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

Example Usage: IotSecuritySolutionsClient.IotSecuritySolutionCreate

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

payload := iotsecuritysolutions.IoTSecuritySolutionModel{
	// ...
}


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

Example Usage: IotSecuritySolutionsClient.IotSecuritySolutionDelete

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

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

Example Usage: IotSecuritySolutionsClient.IotSecuritySolutionGet

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

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

Example Usage: IotSecuritySolutionsClient.IotSecuritySolutionUpdate

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

payload := iotsecuritysolutions.UpdateIotSecuritySolutionData{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForDataSource 

func PossibleValuesForDataSource() []string

func PossibleValuesForExportData 

func PossibleValuesForExportData() []string

func PossibleValuesForRecommendationConfigStatus 

func PossibleValuesForRecommendationConfigStatus() []string

func PossibleValuesForRecommendationType 

func PossibleValuesForRecommendationType() []string

func PossibleValuesForSecuritySolutionStatus 

func PossibleValuesForSecuritySolutionStatus() []string

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 DataSource 

type DataSource string
const (
	DataSourceTwinData DataSource = "TwinData"
)

type ExportData 

type ExportData string
const (
	ExportDataRawEvents ExportData = "RawEvents"
)

type IoTSecuritySolutionModel 

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

type IoTSecuritySolutionModelOperationPredicate 

type IoTSecuritySolutionModelOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (IoTSecuritySolutionModelOperationPredicate) Matches 

func (p IoTSecuritySolutionModelOperationPredicate) Matches(input IoTSecuritySolutionModel) bool

type IoTSecuritySolutionProperties 

type IoTSecuritySolutionProperties struct {
	AutoDiscoveredResources      *[]string                                `json:"autoDiscoveredResources,omitempty"`
	DisabledDataSources          *[]DataSource                            `json:"disabledDataSources,omitempty"`
	DisplayName                  string                                   `json:"displayName"`
	Export                       *[]ExportData                            `json:"export,omitempty"`
	IotHubs                      []string                                 `json:"iotHubs"`
	RecommendationsConfiguration *[]RecommendationConfigurationProperties `json:"recommendationsConfiguration,omitempty"`
	Status                       *SecuritySolutionStatus                  `json:"status,omitempty"`
	UserDefinedResources         *UserDefinedResourcesProperties          `json:"userDefinedResources,omitempty"`
	Workspace                    string                                   `json:"workspace"`
}

type IoTSecuritySolutionsListCompleteResult 

type IoTSecuritySolutionsListCompleteResult struct {
	Items []IoTSecuritySolutionModel
}

type IoTSecuritySolutionsListOperationOptions 

type IoTSecuritySolutionsListOperationOptions struct {
	Filter *string
}

func DefaultIoTSecuritySolutionsListOperationOptions 

func DefaultIoTSecuritySolutionsListOperationOptions() IoTSecuritySolutionsListOperationOptions

type IoTSecuritySolutionsListOperationResponse 

type IoTSecuritySolutionsListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]IoTSecuritySolutionModel
	// contains filtered or unexported fields
}

func (IoTSecuritySolutionsListOperationResponse) HasMore 

func (r IoTSecuritySolutionsListOperationResponse) HasMore() bool

func (IoTSecuritySolutionsListOperationResponse) LoadMore 

func (r IoTSecuritySolutionsListOperationResponse) LoadMore(ctx context.Context) (resp IoTSecuritySolutionsListOperationResponse, err error)

type IoTSecuritySolutionsResourceGroupListCompleteResult 

type IoTSecuritySolutionsResourceGroupListCompleteResult struct {
	Items []IoTSecuritySolutionModel
}

type IoTSecuritySolutionsResourceGroupListOperationOptions 

type IoTSecuritySolutionsResourceGroupListOperationOptions struct {
	Filter *string
}

func DefaultIoTSecuritySolutionsResourceGroupListOperationOptions 

func DefaultIoTSecuritySolutionsResourceGroupListOperationOptions() IoTSecuritySolutionsResourceGroupListOperationOptions

type IoTSecuritySolutionsResourceGroupListOperationResponse 

type IoTSecuritySolutionsResourceGroupListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]IoTSecuritySolutionModel
	// contains filtered or unexported fields
}

func (IoTSecuritySolutionsResourceGroupListOperationResponse) HasMore 

func (r IoTSecuritySolutionsResourceGroupListOperationResponse) HasMore() bool

func (IoTSecuritySolutionsResourceGroupListOperationResponse) LoadMore 

func (r IoTSecuritySolutionsResourceGroupListOperationResponse) LoadMore(ctx context.Context) (resp IoTSecuritySolutionsResourceGroupListOperationResponse, err error)

type IotSecuritySolutionCreateOperationResponse 

type IotSecuritySolutionCreateOperationResponse struct {
	HttpResponse *http.Response
	Model        *IoTSecuritySolutionModel
}

type IotSecuritySolutionDeleteOperationResponse 

type IotSecuritySolutionDeleteOperationResponse struct {
	HttpResponse *http.Response
}

type IotSecuritySolutionGetOperationResponse 

type IotSecuritySolutionGetOperationResponse struct {
	HttpResponse *http.Response
	Model        *IoTSecuritySolutionModel
}

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 IotSecuritySolutionUpdateOperationResponse 

type IotSecuritySolutionUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *IoTSecuritySolutionModel
}

type IotSecuritySolutionsClient 

type IotSecuritySolutionsClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewIotSecuritySolutionsClientWithBaseURI 

func NewIotSecuritySolutionsClientWithBaseURI(endpoint string) IotSecuritySolutionsClient

func (IotSecuritySolutionsClient) IoTSecuritySolutionsList 

func (c IotSecuritySolutionsClient) IoTSecuritySolutionsList(ctx context.Context, id commonids.SubscriptionId, options IoTSecuritySolutionsListOperationOptions) (resp IoTSecuritySolutionsListOperationResponse, err error)

IoTSecuritySolutionsList ...

func (IotSecuritySolutionsClient) IoTSecuritySolutionsListComplete 

func (c IotSecuritySolutionsClient) IoTSecuritySolutionsListComplete(ctx context.Context, id commonids.SubscriptionId, options IoTSecuritySolutionsListOperationOptions) (IoTSecuritySolutionsListCompleteResult, error)

IoTSecuritySolutionsListComplete retrieves all of the results into a single object

func (IotSecuritySolutionsClient) IoTSecuritySolutionsListCompleteMatchingPredicate 

func (c IotSecuritySolutionsClient) IoTSecuritySolutionsListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options IoTSecuritySolutionsListOperationOptions, predicate IoTSecuritySolutionModelOperationPredicate) (resp IoTSecuritySolutionsListCompleteResult, err error)

IoTSecuritySolutionsListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (IotSecuritySolutionsClient) IoTSecuritySolutionsResourceGroupList 

func (c IotSecuritySolutionsClient) IoTSecuritySolutionsResourceGroupList(ctx context.Context, id commonids.ResourceGroupId, options IoTSecuritySolutionsResourceGroupListOperationOptions) (resp IoTSecuritySolutionsResourceGroupListOperationResponse, err error)

IoTSecuritySolutionsResourceGroupList ...

func (IotSecuritySolutionsClient) IoTSecuritySolutionsResourceGroupListComplete 

func (c IotSecuritySolutionsClient) IoTSecuritySolutionsResourceGroupListComplete(ctx context.Context, id commonids.ResourceGroupId, options IoTSecuritySolutionsResourceGroupListOperationOptions) (IoTSecuritySolutionsResourceGroupListCompleteResult, error)

IoTSecuritySolutionsResourceGroupListComplete retrieves all of the results into a single object

func (IotSecuritySolutionsClient) IoTSecuritySolutionsResourceGroupListCompleteMatchingPredicate 

func (c IotSecuritySolutionsClient) IoTSecuritySolutionsResourceGroupListCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, options IoTSecuritySolutionsResourceGroupListOperationOptions, predicate IoTSecuritySolutionModelOperationPredicate) (resp IoTSecuritySolutionsResourceGroupListCompleteResult, err error)

IoTSecuritySolutionsResourceGroupListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (IotSecuritySolutionsClient) IotSecuritySolutionCreate 

func (c IotSecuritySolutionsClient) IotSecuritySolutionCreate(ctx context.Context, id IotSecuritySolutionId, input IoTSecuritySolutionModel) (result IotSecuritySolutionCreateOperationResponse, err error)

IotSecuritySolutionCreate ...

func (IotSecuritySolutionsClient) IotSecuritySolutionDelete 

func (c IotSecuritySolutionsClient) IotSecuritySolutionDelete(ctx context.Context, id IotSecuritySolutionId) (result IotSecuritySolutionDeleteOperationResponse, err error)

IotSecuritySolutionDelete ...

func (IotSecuritySolutionsClient) IotSecuritySolutionGet 

func (c IotSecuritySolutionsClient) IotSecuritySolutionGet(ctx context.Context, id IotSecuritySolutionId) (result IotSecuritySolutionGetOperationResponse, err error)

IotSecuritySolutionGet ...

func (IotSecuritySolutionsClient) IotSecuritySolutionUpdate 

func (c IotSecuritySolutionsClient) IotSecuritySolutionUpdate(ctx context.Context, id IotSecuritySolutionId, input UpdateIotSecuritySolutionData) (result IotSecuritySolutionUpdateOperationResponse, err error)

IotSecuritySolutionUpdate ...

type RecommendationConfigStatus 

type RecommendationConfigStatus string
const (
	RecommendationConfigStatusDisabled RecommendationConfigStatus = "Disabled"
	RecommendationConfigStatusEnabled  RecommendationConfigStatus = "Enabled"
)

type RecommendationConfigurationProperties 

type RecommendationConfigurationProperties struct {
	Name               *string                    `json:"name,omitempty"`
	RecommendationType RecommendationType         `json:"recommendationType"`
	Status             RecommendationConfigStatus `json:"status"`
}

type RecommendationType 

type RecommendationType string
const (
	RecommendationTypeIoTACRAuthentication             RecommendationType = "IoT_ACRAuthentication"
	RecommendationTypeIoTAgentSendsUnutilizedMessages  RecommendationType = "IoT_AgentSendsUnutilizedMessages"
	RecommendationTypeIoTBaseline                      RecommendationType = "IoT_Baseline"
	RecommendationTypeIoTEdgeHubMemOptimize            RecommendationType = "IoT_EdgeHubMemOptimize"
	RecommendationTypeIoTEdgeLoggingOptions            RecommendationType = "IoT_EdgeLoggingOptions"
	RecommendationTypeIoTIPFilterDenyAll               RecommendationType = "IoT_IPFilter_DenyAll"
	RecommendationTypeIoTIPFilterPermissiveRule        RecommendationType = "IoT_IPFilter_PermissiveRule"
	RecommendationTypeIoTInconsistentModuleSettings    RecommendationType = "IoT_InconsistentModuleSettings"
	RecommendationTypeIoTInstallAgent                  RecommendationType = "IoT_InstallAgent"
	RecommendationTypeIoTOpenPorts                     RecommendationType = "IoT_OpenPorts"
	RecommendationTypeIoTPermissiveFirewallPolicy      RecommendationType = "IoT_PermissiveFirewallPolicy"
	RecommendationTypeIoTPermissiveInputFirewallRules  RecommendationType = "IoT_PermissiveInputFirewallRules"
	RecommendationTypeIoTPermissiveOutputFirewallRules RecommendationType = "IoT_PermissiveOutputFirewallRules"
	RecommendationTypeIoTPrivilegedDockerOptions       RecommendationType = "IoT_PrivilegedDockerOptions"
	RecommendationTypeIoTSharedCredentials             RecommendationType = "IoT_SharedCredentials"
	RecommendationTypeIoTVulnerableTLSCipherSuite      RecommendationType = "IoT_VulnerableTLSCipherSuite"
)

type SecuritySolutionStatus 

type SecuritySolutionStatus string
const (
	SecuritySolutionStatusDisabled SecuritySolutionStatus = "Disabled"
	SecuritySolutionStatusEnabled  SecuritySolutionStatus = "Enabled"
)

type UpdateIotSecuritySolutionData 

type UpdateIotSecuritySolutionData struct {
	RecommendationsConfiguration *[]RecommendationConfigurationProperties `json:"recommendationsConfiguration,omitempty"`
	Tags                         *map[string]string                       `json:"tags,omitempty"`
	UserDefinedResources         *UserDefinedResourcesProperties          `json:"userDefinedResources,omitempty"`
}

type UserDefinedResourcesProperties 

type UserDefinedResourcesProperties struct {
	Query              string   `json:"query"`
	QuerySubscriptions []string `json:"querySubscriptions"`
}

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.