securescorecontrols

README

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

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

Client Initialization

client := securescorecontrols.NewSecureScoreControlsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SecureScoreControlsClient.List

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

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

Documentation

Index

• func PossibleValuesForControlType() []string
• func PossibleValuesForExpandControlsEnum() []string
• type AzureResourceLink
• type ControlType
  • func (s *ControlType) UnmarshalJSON(bytes []byte) error
• type ExpandControlsEnum
  • func (s *ExpandControlsEnum) UnmarshalJSON(bytes []byte) error
• type ListCompleteResult
• type ListCustomPager
  • func (p *ListCustomPager) NextPageLink() *odata.Link
• type ListOperationOptions
  • func DefaultListOperationOptions() ListOperationOptions
  • func (o ListOperationOptions) ToHeaders() *client.Headers
  • func (o ListOperationOptions) ToOData() *odata.Query
  • func (o ListOperationOptions) ToQuery() *client.QueryParams
• type ListOperationResponse
• type ScoreDetails
• type SecureScoreControlDefinitionItem
• type SecureScoreControlDefinitionItemProperties
• type SecureScoreControlDefinitionSource
• type SecureScoreControlDetails
• type SecureScoreControlDetailsOperationPredicate
  • func (p SecureScoreControlDetailsOperationPredicate) Matches(input SecureScoreControlDetails) bool
• type SecureScoreControlScoreDetails
• type SecureScoreControlsClient
  • func NewSecureScoreControlsClientWithBaseURI(sdkApi sdkEnv.Api) (*SecureScoreControlsClient, error)
  • func (c SecureScoreControlsClient) List(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions) (result ListOperationResponse, err error)
  • func (c SecureScoreControlsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions) (ListCompleteResult, error)
  • func (c SecureScoreControlsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions, ...) (result ListCompleteResult, err error)

Functions

func PossibleValuesForControlType

func PossibleValuesForControlType() []string

func PossibleValuesForExpandControlsEnum

func PossibleValuesForExpandControlsEnum() []string

Types

type AzureResourceLink

type AzureResourceLink struct {
	Id *string `json:"id,omitempty"`
}

type ControlType

type ControlType string

const (
	ControlTypeBuiltIn ControlType = "BuiltIn"
	ControlTypeCustom  ControlType = "Custom"
)

func (*ControlType) UnmarshalJSON

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

type ExpandControlsEnum

type ExpandControlsEnum string

const (
	ExpandControlsEnumDefinition ExpandControlsEnum = "definition"
)

func (*ExpandControlsEnum) UnmarshalJSON

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

type ListCompleteResult

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

type ListCustomPager

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

func (*ListCustomPager) NextPageLink

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

type ListOperationOptions

type ListOperationOptions struct {
	Expand *ExpandControlsEnum
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery

func (o ListOperationOptions) ToQuery() *client.QueryParams

type ListOperationResponse

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

type ScoreDetails

type ScoreDetails struct {
	Current    *float64 `json:"current,omitempty"`
	Max        *int64   `json:"max,omitempty"`
	Percentage *float64 `json:"percentage,omitempty"`
}

type SecureScoreControlDefinitionItem

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

type SecureScoreControlDefinitionItemProperties

type SecureScoreControlDefinitionItemProperties struct {
	AssessmentDefinitions *[]AzureResourceLink                `json:"assessmentDefinitions,omitempty"`
	Description           *string                             `json:"description,omitempty"`
	DisplayName           *string                             `json:"displayName,omitempty"`
	MaxScore              *int64                              `json:"maxScore,omitempty"`
	Source                *SecureScoreControlDefinitionSource `json:"source,omitempty"`
}

type SecureScoreControlDefinitionSource

type SecureScoreControlDefinitionSource struct {
	SourceType *ControlType `json:"sourceType,omitempty"`
}

type SecureScoreControlDetails

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

type SecureScoreControlDetailsOperationPredicate

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

func (SecureScoreControlDetailsOperationPredicate) Matches

func (p SecureScoreControlDetailsOperationPredicate) Matches(input SecureScoreControlDetails) bool

type SecureScoreControlScoreDetails

type SecureScoreControlScoreDetails struct {
	Definition                 *SecureScoreControlDefinitionItem `json:"definition,omitempty"`
	DisplayName                *string                           `json:"displayName,omitempty"`
	HealthyResourceCount       *int64                            `json:"healthyResourceCount,omitempty"`
	NotApplicableResourceCount *int64                            `json:"notApplicableResourceCount,omitempty"`
	Score                      *ScoreDetails                     `json:"score,omitempty"`
	UnhealthyResourceCount     *int64                            `json:"unhealthyResourceCount,omitempty"`
	Weight                     *int64                            `json:"weight,omitempty"`
}

type SecureScoreControlsClient

type SecureScoreControlsClient struct {
	Client *resourcemanager.Client
}

func NewSecureScoreControlsClientWithBaseURI

func NewSecureScoreControlsClientWithBaseURI(sdkApi sdkEnv.Api) (*SecureScoreControlsClient, error)

func (SecureScoreControlsClient) List

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

List ...

func (SecureScoreControlsClient) ListComplete

func (c SecureScoreControlsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (SecureScoreControlsClient) ListCompleteMatchingPredicate

func (c SecureScoreControlsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions, predicate SecureScoreControlDetailsOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate