discoveredsecuritysolutions

package
v0.20240325.1113504 Latest Latest
Warning

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

Go to latest
Published: Mar 25, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/security/2020-01-01/discoveredsecuritysolutions Documentation

The discoveredsecuritysolutions SDK allows for interaction with the Azure Resource Manager Service security (API Version 2020-01-01).

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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/security/2020-01-01/discoveredsecuritysolutions"

Client Initialization

client := discoveredsecuritysolutions.NewDiscoveredSecuritySolutionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DiscoveredSecuritySolutionsClient.Get

ctx := context.TODO()
id := discoveredsecuritysolutions.NewDiscoveredSecuritySolutionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "locationValue", "discoveredSecuritySolutionValue")

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

Example Usage: DiscoveredSecuritySolutionsClient.List

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

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

Example Usage: DiscoveredSecuritySolutionsClient.ListByHomeRegion

ctx := context.TODO()
id := discoveredsecuritysolutions.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

// alternatively `client.ListByHomeRegion(ctx, id)` can be used to do batched pagination
items, err := client.ListByHomeRegionComplete(ctx, id)
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 PossibleValuesForSecurityFamily

func PossibleValuesForSecurityFamily() []string

func ValidateDiscoveredSecuritySolutionID

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

ValidateDiscoveredSecuritySolutionID checks that 'input' can be parsed as a Discovered Security Solution ID

func ValidateLocationID

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type DiscoveredSecuritySolution

type DiscoveredSecuritySolution struct {
	Id         *string                              `json:"id,omitempty"`
	Location   *string                              `json:"location,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties DiscoveredSecuritySolutionProperties `json:"properties"`
	Type       *string                              `json:"type,omitempty"`
}

type DiscoveredSecuritySolutionId

type DiscoveredSecuritySolutionId struct {
	SubscriptionId                 string
	ResourceGroupName              string
	LocationName                   string
	DiscoveredSecuritySolutionName string
}

DiscoveredSecuritySolutionId is a struct representing the Resource ID for a Discovered Security Solution

func NewDiscoveredSecuritySolutionID

func NewDiscoveredSecuritySolutionID(subscriptionId string, resourceGroupName string, locationName string, discoveredSecuritySolutionName string) DiscoveredSecuritySolutionId

NewDiscoveredSecuritySolutionID returns a new DiscoveredSecuritySolutionId struct

func ParseDiscoveredSecuritySolutionID

func ParseDiscoveredSecuritySolutionID(input string) (*DiscoveredSecuritySolutionId, error)

ParseDiscoveredSecuritySolutionID parses 'input' into a DiscoveredSecuritySolutionId

func ParseDiscoveredSecuritySolutionIDInsensitively

func ParseDiscoveredSecuritySolutionIDInsensitively(input string) (*DiscoveredSecuritySolutionId, error)

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

func (*DiscoveredSecuritySolutionId) FromParseResult

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

func (DiscoveredSecuritySolutionId) ID

ID returns the formatted Discovered Security Solution ID

func (DiscoveredSecuritySolutionId) Segments

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

func (DiscoveredSecuritySolutionId) String

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

type DiscoveredSecuritySolutionOperationPredicate

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

func (DiscoveredSecuritySolutionOperationPredicate) Matches

type DiscoveredSecuritySolutionProperties

type DiscoveredSecuritySolutionProperties struct {
	Offer          string         `json:"offer"`
	Publisher      string         `json:"publisher"`
	SecurityFamily SecurityFamily `json:"securityFamily"`
	Sku            string         `json:"sku"`
}

type DiscoveredSecuritySolutionsClient

type DiscoveredSecuritySolutionsClient struct {
	Client *resourcemanager.Client
}

func NewDiscoveredSecuritySolutionsClientWithBaseURI

func NewDiscoveredSecuritySolutionsClientWithBaseURI(sdkApi sdkEnv.Api) (*DiscoveredSecuritySolutionsClient, error)

func (DiscoveredSecuritySolutionsClient) Get

Get ...

func (DiscoveredSecuritySolutionsClient) List

List ...

func (DiscoveredSecuritySolutionsClient) ListByHomeRegion

ListByHomeRegion ...

func (DiscoveredSecuritySolutionsClient) ListByHomeRegionComplete

ListByHomeRegionComplete retrieves all the results into a single object

func (DiscoveredSecuritySolutionsClient) ListByHomeRegionCompleteMatchingPredicate

func (c DiscoveredSecuritySolutionsClient) ListByHomeRegionCompleteMatchingPredicate(ctx context.Context, id LocationId, predicate DiscoveredSecuritySolutionOperationPredicate) (result ListByHomeRegionCompleteResult, err error)

ListByHomeRegionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DiscoveredSecuritySolutionsClient) ListComplete

ListComplete retrieves all the results into a single object

func (DiscoveredSecuritySolutionsClient) ListCompleteMatchingPredicate

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DiscoveredSecuritySolution
}

type ListByHomeRegionCompleteResult

type ListByHomeRegionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DiscoveredSecuritySolution
}

type ListByHomeRegionOperationResponse

type ListByHomeRegionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DiscoveredSecuritySolution
}

type ListCompleteResult

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DiscoveredSecuritySolution
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DiscoveredSecuritySolution
}

type LocationId

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (*LocationId) FromParseResult

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

func (LocationId) ID

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Location ID

func (LocationId) String

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type SecurityFamily

type SecurityFamily string
const (
	SecurityFamilyNgfw    SecurityFamily = "Ngfw"
	SecurityFamilySaasWaf SecurityFamily = "SaasWaf"
	SecurityFamilyVa      SecurityFamily = "Va"
	SecurityFamilyWaf     SecurityFamily = "Waf"
)

func (*SecurityFamily) UnmarshalJSON added in v0.20240228.1142829

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

Jump to

Keyboard shortcuts

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