securescorecontroldefinitions

README

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

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

Client Initialization

client := securescorecontroldefinitions.NewSecureScoreControlDefinitionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SecureScoreControlDefinitionsClient.List

ctx := context.TODO()


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

Example Usage: SecureScoreControlDefinitionsClient.ListBySubscription

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

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

Documentation

Index

• func PossibleValuesForControlType() []string
• type AzureResourceLink
• type ControlType
• type ListBySubscriptionCompleteResult
• type ListBySubscriptionOperationResponse
  • func (r ListBySubscriptionOperationResponse) HasMore() bool
  • func (r ListBySubscriptionOperationResponse) LoadMore(ctx context.Context) (resp ListBySubscriptionOperationResponse, err error)
• type ListCompleteResult
• type ListOperationResponse
  • func (r ListOperationResponse) HasMore() bool
  • func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err error)
• type SecureScoreControlDefinitionItem
• type SecureScoreControlDefinitionItemOperationPredicate
  • func (p SecureScoreControlDefinitionItemOperationPredicate) Matches(input SecureScoreControlDefinitionItem) bool
• type SecureScoreControlDefinitionItemProperties
• type SecureScoreControlDefinitionSource
• type SecureScoreControlDefinitionsClient
  • func NewSecureScoreControlDefinitionsClientWithBaseURI(endpoint string) SecureScoreControlDefinitionsClient
  • func (c SecureScoreControlDefinitionsClient) List(ctx context.Context) (resp ListOperationResponse, err error)
  • func (c SecureScoreControlDefinitionsClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (resp ListBySubscriptionOperationResponse, err error)
  • func (c SecureScoreControlDefinitionsClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)
  • func (c SecureScoreControlDefinitionsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (resp ListBySubscriptionCompleteResult, err error)
  • func (c SecureScoreControlDefinitionsClient) ListComplete(ctx context.Context) (ListCompleteResult, error)
  • func (c SecureScoreControlDefinitionsClient) ListCompleteMatchingPredicate(ctx context.Context, ...) (resp ListCompleteResult, err error)

Functions

func PossibleValuesForControlType

func PossibleValuesForControlType() []string

Types

type AzureResourceLink

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

type ControlType

type ControlType string

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

type ListBySubscriptionCompleteResult

type ListBySubscriptionCompleteResult struct {
	Items []SecureScoreControlDefinitionItem
}

type ListBySubscriptionOperationResponse

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]SecureScoreControlDefinitionItem
	// contains filtered or unexported fields
}

func (ListBySubscriptionOperationResponse) HasMore

func (r ListBySubscriptionOperationResponse) HasMore() bool

func (ListBySubscriptionOperationResponse) LoadMore

func (r ListBySubscriptionOperationResponse) LoadMore(ctx context.Context) (resp ListBySubscriptionOperationResponse, err error)

type ListCompleteResult

type ListCompleteResult struct {
	Items []SecureScoreControlDefinitionItem
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]SecureScoreControlDefinitionItem
	// contains filtered or unexported fields
}

func (ListOperationResponse) HasMore

func (r ListOperationResponse) HasMore() bool

func (ListOperationResponse) LoadMore

func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err error)

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 SecureScoreControlDefinitionItemOperationPredicate

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

func (SecureScoreControlDefinitionItemOperationPredicate) Matches

func (p SecureScoreControlDefinitionItemOperationPredicate) Matches(input SecureScoreControlDefinitionItem) bool

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 SecureScoreControlDefinitionsClient

type SecureScoreControlDefinitionsClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewSecureScoreControlDefinitionsClientWithBaseURI

func NewSecureScoreControlDefinitionsClientWithBaseURI(endpoint string) SecureScoreControlDefinitionsClient

func (SecureScoreControlDefinitionsClient) List

func (c SecureScoreControlDefinitionsClient) List(ctx context.Context) (resp ListOperationResponse, err error)

List ...

func (SecureScoreControlDefinitionsClient) ListBySubscription

func (c SecureScoreControlDefinitionsClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (resp ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (SecureScoreControlDefinitionsClient) ListBySubscriptionComplete

func (c SecureScoreControlDefinitionsClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all of the results into a single object

func (SecureScoreControlDefinitionsClient) ListBySubscriptionCompleteMatchingPredicate

func (c SecureScoreControlDefinitionsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate SecureScoreControlDefinitionItemOperationPredicate) (resp ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (SecureScoreControlDefinitionsClient) ListComplete

func (c SecureScoreControlDefinitionsClient) ListComplete(ctx context.Context) (ListCompleteResult, error)

ListComplete retrieves all of the results into a single object

func (SecureScoreControlDefinitionsClient) ListCompleteMatchingPredicate

func (c SecureScoreControlDefinitionsClient) ListCompleteMatchingPredicate(ctx context.Context, predicate SecureScoreControlDefinitionItemOperationPredicate) (resp ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate