securitysolutionsreferencedata

README

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

The securitysolutionsreferencedata SDK allows for interaction with Azure Resource Manager 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/securitysolutionsreferencedata"

Client Initialization

client := securitysolutionsreferencedata.NewSecuritySolutionsReferenceDataClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SecuritySolutionsReferenceDataClient.List

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

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

Example Usage: SecuritySolutionsReferenceDataClient.ListByHomeRegion

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

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

Documentation

Index

• func PossibleValuesForSecurityFamily() []string
• func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• type ListByHomeRegionOperationResponse
• type ListOperationResponse
• type LocationId
  • func NewLocationID(subscriptionId string, locationName string) LocationId
  • func ParseLocationID(input string) (*LocationId, error)
  • func ParseLocationIDInsensitively(input string) (*LocationId, error)
  • func (id *LocationId) FromParseResult(input resourceids.ParseResult) error
  • func (id LocationId) ID() string
  • func (id LocationId) Segments() []resourceids.Segment
  • func (id LocationId) String() string
• type SecurityFamily
  • func (s *SecurityFamily) UnmarshalJSON(bytes []byte) error
• type SecuritySolutionsReferenceData
• type SecuritySolutionsReferenceDataClient
  • func NewSecuritySolutionsReferenceDataClientWithBaseURI(sdkApi sdkEnv.Api) (*SecuritySolutionsReferenceDataClient, error)
  • func (c SecuritySolutionsReferenceDataClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)
  • func (c SecuritySolutionsReferenceDataClient) ListByHomeRegion(ctx context.Context, id LocationId) (result ListByHomeRegionOperationResponse, err error)
• type SecuritySolutionsReferenceDataList
• type SecuritySolutionsReferenceDataProperties

Functions

func PossibleValuesForSecurityFamily

func PossibleValuesForSecurityFamily() []string

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 ListByHomeRegionOperationResponse

type ListByHomeRegionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SecuritySolutionsReferenceDataList
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SecuritySolutionsReferenceDataList
}

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

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

type SecuritySolutionsReferenceData

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

type SecuritySolutionsReferenceDataClient

type SecuritySolutionsReferenceDataClient struct {
	Client *resourcemanager.Client
}

func NewSecuritySolutionsReferenceDataClientWithBaseURI

func NewSecuritySolutionsReferenceDataClientWithBaseURI(sdkApi sdkEnv.Api) (*SecuritySolutionsReferenceDataClient, error)

func (SecuritySolutionsReferenceDataClient) List

func (c SecuritySolutionsReferenceDataClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)

List ...

func (SecuritySolutionsReferenceDataClient) ListByHomeRegion

func (c SecuritySolutionsReferenceDataClient) ListByHomeRegion(ctx context.Context, id LocationId) (result ListByHomeRegionOperationResponse, err error)

ListByHomeRegion ...

type SecuritySolutionsReferenceDataList

type SecuritySolutionsReferenceDataList struct {
	Value *[]SecuritySolutionsReferenceData `json:"value,omitempty"`
}

type SecuritySolutionsReferenceDataProperties

type SecuritySolutionsReferenceDataProperties struct {
	AlertVendorName      string         `json:"alertVendorName"`
	PackageInfoURL       string         `json:"packageInfoUrl"`
	ProductName          string         `json:"productName"`
	Publisher            string         `json:"publisher"`
	PublisherDisplayName string         `json:"publisherDisplayName"`
	SecurityFamily       SecurityFamily `json:"securityFamily"`
	Template             string         `json:"template"`
}