securescorecontroldefinitions

package
v0.20240731.1212841 Latest Latest
Warning

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

 Go to latest Published: Jul 31, 2024 License: MPL-2.0 Imports: 10 Imported by: 1

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

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForControlType 

func PossibleValuesForControlType() []string

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 ListBySubscriptionCompleteResult 

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SecureScoreControlDefinitionItem
}

type ListBySubscriptionCustomPager added in v0.20240628.1153531 

type ListBySubscriptionCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListBySubscriptionCustomPager) NextPageLink() *odata.Link

type ListBySubscriptionOperationResponse 

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SecureScoreControlDefinitionItem
}

type ListCompleteResult 

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

type ListCustomPager added in v0.20240628.1153531 

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationResponse 

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

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 *resourcemanager.Client
}

func NewSecureScoreControlDefinitionsClientWithBaseURI 

func NewSecureScoreControlDefinitionsClientWithBaseURI(sdkApi sdkEnv.Api) (*SecureScoreControlDefinitionsClient, error)

func (SecureScoreControlDefinitionsClient) List 

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

List ...

func (SecureScoreControlDefinitionsClient) ListBySubscription 

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

ListBySubscription ...

func (SecureScoreControlDefinitionsClient) ListBySubscriptionComplete 

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

ListBySubscriptionComplete retrieves all the results into a single object

func (SecureScoreControlDefinitionsClient) ListBySubscriptionCompleteMatchingPredicate 

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

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SecureScoreControlDefinitionsClient) ListComplete 

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

ListComplete retrieves all the results into a single object

func (SecureScoreControlDefinitionsClient) ListCompleteMatchingPredicate 

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.