securescore

package
v0.20240627.1145836 Latest Latest
Warning

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

Go to latest
Published: Jun 27, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

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

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

Client Initialization

client := securescore.NewSecureScoreClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SecureScoreClient.ControlsListBySecureScore

ctx := context.TODO()
id := securescore.NewSecureScoreID("12345678-1234-9876-4563-123456789012", "secureScoreValue")

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

Example Usage: SecureScoreClient.Get

ctx := context.TODO()
id := securescore.NewSecureScoreID("12345678-1234-9876-4563-123456789012", "secureScoreValue")

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: SecureScoreClient.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

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForControlType

func PossibleValuesForControlType() []string

func PossibleValuesForExpandControlsEnum

func PossibleValuesForExpandControlsEnum() []string

func ValidateSecureScoreID

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

ValidateSecureScoreID checks that 'input' can be parsed as a Secure Score ID

Types

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

type ControlType

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

func (*ControlType) UnmarshalJSON added in v0.20240228.1142829

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

type ControlsListBySecureScoreCompleteResult

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

type ControlsListBySecureScoreOperationOptions

type ControlsListBySecureScoreOperationOptions struct {
	Expand *ExpandControlsEnum
}

func DefaultControlsListBySecureScoreOperationOptions

func DefaultControlsListBySecureScoreOperationOptions() ControlsListBySecureScoreOperationOptions

func (ControlsListBySecureScoreOperationOptions) ToHeaders added in v0.20240228.1142829

func (ControlsListBySecureScoreOperationOptions) ToOData added in v0.20240228.1142829

func (ControlsListBySecureScoreOperationOptions) ToQuery added in v0.20240228.1142829

type ControlsListBySecureScoreOperationResponse

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

type ExpandControlsEnum

type ExpandControlsEnum string
const (
	ExpandControlsEnumDefinition ExpandControlsEnum = "definition"
)

func (*ExpandControlsEnum) UnmarshalJSON added in v0.20240228.1142829

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

type GetOperationResponse

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

type ListCompleteResult

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

type ListOperationResponse

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

type ScoreDetails

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

type SecureScoreClient

type SecureScoreClient struct {
	Client *resourcemanager.Client
}

func NewSecureScoreClientWithBaseURI

func NewSecureScoreClientWithBaseURI(sdkApi sdkEnv.Api) (*SecureScoreClient, error)

func (SecureScoreClient) ControlsListBySecureScore

ControlsListBySecureScore ...

func (SecureScoreClient) ControlsListBySecureScoreComplete

ControlsListBySecureScoreComplete retrieves all the results into a single object

func (SecureScoreClient) ControlsListBySecureScoreCompleteMatchingPredicate

ControlsListBySecureScoreCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SecureScoreClient) Get

Get ...

func (SecureScoreClient) List

List ...

func (SecureScoreClient) ListComplete

ListComplete retrieves all the results into a single object

func (SecureScoreClient) ListCompleteMatchingPredicate

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

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

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 SecureScoreId

type SecureScoreId struct {
	SubscriptionId  string
	SecureScoreName string
}

SecureScoreId is a struct representing the Resource ID for a Secure Score

func NewSecureScoreID

func NewSecureScoreID(subscriptionId string, secureScoreName string) SecureScoreId

NewSecureScoreID returns a new SecureScoreId struct

func ParseSecureScoreID

func ParseSecureScoreID(input string) (*SecureScoreId, error)

ParseSecureScoreID parses 'input' into a SecureScoreId

func ParseSecureScoreIDInsensitively

func ParseSecureScoreIDInsensitively(input string) (*SecureScoreId, error)

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

func (*SecureScoreId) FromParseResult

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

func (SecureScoreId) ID

func (id SecureScoreId) ID() string

ID returns the formatted Secure Score ID

func (SecureScoreId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Secure Score ID

func (SecureScoreId) String

func (id SecureScoreId) String() string

String returns a human-readable description of this Secure Score ID

type SecureScoreItem

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

type SecureScoreItemOperationPredicate

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

func (SecureScoreItemOperationPredicate) Matches

type SecureScoreItemProperties

type SecureScoreItemProperties struct {
	DisplayName *string       `json:"displayName,omitempty"`
	Score       *ScoreDetails `json:"score,omitempty"`
	Weight      *int64        `json:"weight,omitempty"`
}

Jump to

Keyboard shortcuts

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