securitysolutions

README

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

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

Client Initialization

client := securitysolutions.NewSecuritySolutionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SecuritySolutionsClient.Get

ctx := context.TODO()
id := securitysolutions.NewSecuritySolutionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "locationName", "securitySolutionName")

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: SecuritySolutionsClient.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
}

Documentation

Index

• func PossibleValuesForProvisioningState() []string
• func PossibleValuesForSecurityFamily() []string
• func ValidateSecuritySolutionID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationResponse
• type ListCompleteResult
• type ListCustomPager
  • func (p *ListCustomPager) NextPageLink() *odata.Link
• type ListOperationResponse
• type ProvisioningState
  • func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
• type SecurityFamily
  • func (s *SecurityFamily) UnmarshalJSON(bytes []byte) error
• type SecuritySolution
• type SecuritySolutionId
  • func NewSecuritySolutionID(subscriptionId string, resourceGroupName string, locationName string, ...) SecuritySolutionId
  • func ParseSecuritySolutionID(input string) (*SecuritySolutionId, error)
  • func ParseSecuritySolutionIDInsensitively(input string) (*SecuritySolutionId, error)
  • func (id *SecuritySolutionId) FromParseResult(input resourceids.ParseResult) error
  • func (id SecuritySolutionId) ID() string
  • func (id SecuritySolutionId) Segments() []resourceids.Segment
  • func (id SecuritySolutionId) String() string
• type SecuritySolutionOperationPredicate
  • func (p SecuritySolutionOperationPredicate) Matches(input SecuritySolution) bool
• type SecuritySolutionProperties
• type SecuritySolutionsClient
  • func NewSecuritySolutionsClientWithBaseURI(sdkApi sdkEnv.Api) (*SecuritySolutionsClient, error)
  • func (c SecuritySolutionsClient) Get(ctx context.Context, id SecuritySolutionId) (result GetOperationResponse, err error)
  • func (c SecuritySolutionsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)
  • func (c SecuritySolutionsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)
  • func (c SecuritySolutionsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListCompleteResult, err error)

Functions

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func PossibleValuesForSecurityFamily

func PossibleValuesForSecurityFamily() []string

func ValidateSecuritySolutionID

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

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

Types

type GetOperationResponse

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

type ListCompleteResult

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

type ListCustomPager

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*ListCustomPager) NextPageLink

func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationResponse

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

type ProvisioningState

type ProvisioningState string

const (
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON

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

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 SecuritySolution

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

type SecuritySolutionId

type SecuritySolutionId struct {
	SubscriptionId       string
	ResourceGroupName    string
	LocationName         string
	SecuritySolutionName string
}

SecuritySolutionId is a struct representing the Resource ID for a Security Solution

func NewSecuritySolutionID

func NewSecuritySolutionID(subscriptionId string, resourceGroupName string, locationName string, securitySolutionName string) SecuritySolutionId

NewSecuritySolutionID returns a new SecuritySolutionId struct

func ParseSecuritySolutionID

func ParseSecuritySolutionID(input string) (*SecuritySolutionId, error)

ParseSecuritySolutionID parses 'input' into a SecuritySolutionId

func ParseSecuritySolutionIDInsensitively

func ParseSecuritySolutionIDInsensitively(input string) (*SecuritySolutionId, error)

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

func (*SecuritySolutionId) FromParseResult

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

func (SecuritySolutionId) ID

func (id SecuritySolutionId) ID() string

ID returns the formatted Security Solution ID

func (SecuritySolutionId) Segments

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

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

func (SecuritySolutionId) String

func (id SecuritySolutionId) String() string

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

type SecuritySolutionOperationPredicate

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

func (SecuritySolutionOperationPredicate) Matches

func (p SecuritySolutionOperationPredicate) Matches(input SecuritySolution) bool

type SecuritySolutionProperties

type SecuritySolutionProperties struct {
	ProtectionStatus  string            `json:"protectionStatus"`
	ProvisioningState ProvisioningState `json:"provisioningState"`
	SecurityFamily    SecurityFamily    `json:"securityFamily"`
	Template          string            `json:"template"`
}

type SecuritySolutionsClient

type SecuritySolutionsClient struct {
	Client *resourcemanager.Client
}

func NewSecuritySolutionsClientWithBaseURI

func NewSecuritySolutionsClientWithBaseURI(sdkApi sdkEnv.Api) (*SecuritySolutionsClient, error)

func (SecuritySolutionsClient) Get

func (c SecuritySolutionsClient) Get(ctx context.Context, id SecuritySolutionId) (result GetOperationResponse, err error)

Get ...

func (SecuritySolutionsClient) List

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

List ...

func (SecuritySolutionsClient) ListComplete

func (c SecuritySolutionsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (SecuritySolutionsClient) ListCompleteMatchingPredicate

func (c SecuritySolutionsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate SecuritySolutionOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate