assessmentsmetadata

package
v0.20231208.1131741 Latest Latest
Warning

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

 Go to latest Published: Dec 8, 2023 License: MPL-2.0 Imports: 9 Imported by: 1

README

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

The assessmentsmetadata 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-sdk/resource-manager/security/2020-01-01/assessmentsmetadata"

Client Initialization

client := assessmentsmetadata.NewAssessmentsMetadataClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AssessmentsMetadataClient.CreateInSubscription

ctx := context.TODO()
id := assessmentsmetadata.NewProviderAssessmentMetadataID("12345678-1234-9876-4563-123456789012", "assessmentMetadataValue")

payload := assessmentsmetadata.SecurityAssessmentMetadata{
	// ...
}


read, err := client.CreateInSubscription(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: AssessmentsMetadataClient.DeleteInSubscription

ctx := context.TODO()
id := assessmentsmetadata.NewProviderAssessmentMetadataID("12345678-1234-9876-4563-123456789012", "assessmentMetadataValue")

read, err := client.DeleteInSubscription(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: AssessmentsMetadataClient.Get

ctx := context.TODO()
id := assessmentsmetadata.NewAssessmentMetadataID("assessmentMetadataValue")

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: AssessmentsMetadataClient.GetInSubscription

ctx := context.TODO()
id := assessmentsmetadata.NewProviderAssessmentMetadataID("12345678-1234-9876-4563-123456789012", "assessmentMetadataValue")

read, err := client.GetInSubscription(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: AssessmentsMetadataClient.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: AssessmentsMetadataClient.ListBySubscription

ctx := context.TODO()
id := assessmentsmetadata.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 PossibleValuesForAssessmentType 

func PossibleValuesForAssessmentType() []string

func PossibleValuesForCategories 

func PossibleValuesForCategories() []string

func PossibleValuesForImplementationEffort 

func PossibleValuesForImplementationEffort() []string

func PossibleValuesForSeverity 

func PossibleValuesForSeverity() []string

func PossibleValuesForThreats 

func PossibleValuesForThreats() []string

func PossibleValuesForUserImpact 

func PossibleValuesForUserImpact() []string

func ValidateAssessmentMetadataID 

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

ValidateAssessmentMetadataID checks that 'input' can be parsed as a Assessment Metadata ID

func ValidateProviderAssessmentMetadataID 

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

ValidateProviderAssessmentMetadataID checks that 'input' can be parsed as a Provider Assessment Metadata ID

Types

type AssessmentMetadataId 

type AssessmentMetadataId struct {
	AssessmentMetadataName string
}

AssessmentMetadataId is a struct representing the Resource ID for a Assessment Metadata

func NewAssessmentMetadataID 

func NewAssessmentMetadataID(assessmentMetadataName string) AssessmentMetadataId

NewAssessmentMetadataID returns a new AssessmentMetadataId struct

func ParseAssessmentMetadataID 

func ParseAssessmentMetadataID(input string) (*AssessmentMetadataId, error)

ParseAssessmentMetadataID parses 'input' into a AssessmentMetadataId

func ParseAssessmentMetadataIDInsensitively 

func ParseAssessmentMetadataIDInsensitively(input string) (*AssessmentMetadataId, error)

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

func (*AssessmentMetadataId) FromParseResult added in v0.20231127.1171502 

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

func (AssessmentMetadataId) ID 

func (id AssessmentMetadataId) ID() string

ID returns the formatted Assessment Metadata ID

func (AssessmentMetadataId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Assessment Metadata ID

func (AssessmentMetadataId) String 

func (id AssessmentMetadataId) String() string

String returns a human-readable description of this Assessment Metadata ID

type AssessmentType 

type AssessmentType string
const (
	AssessmentTypeBuiltIn         AssessmentType = "BuiltIn"
	AssessmentTypeCustomPolicy    AssessmentType = "CustomPolicy"
	AssessmentTypeCustomerManaged AssessmentType = "CustomerManaged"
	AssessmentTypeVerifiedPartner AssessmentType = "VerifiedPartner"
)

type AssessmentsMetadataClient 

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

func NewAssessmentsMetadataClientWithBaseURI 

func NewAssessmentsMetadataClientWithBaseURI(endpoint string) AssessmentsMetadataClient

func (AssessmentsMetadataClient) CreateInSubscription added in v0.20230906.1160501 

func (c AssessmentsMetadataClient) CreateInSubscription(ctx context.Context, id ProviderAssessmentMetadataId, input SecurityAssessmentMetadata) (result CreateInSubscriptionOperationResponse, err error)

CreateInSubscription ...

func (AssessmentsMetadataClient) DeleteInSubscription added in v0.20230906.1160501 

func (c AssessmentsMetadataClient) DeleteInSubscription(ctx context.Context, id ProviderAssessmentMetadataId) (result DeleteInSubscriptionOperationResponse, err error)

DeleteInSubscription ...

func (AssessmentsMetadataClient) Get added in v0.20230906.1160501 

func (c AssessmentsMetadataClient) Get(ctx context.Context, id AssessmentMetadataId) (result GetOperationResponse, err error)

Get ...

func (AssessmentsMetadataClient) GetInSubscription added in v0.20230906.1160501 

func (c AssessmentsMetadataClient) GetInSubscription(ctx context.Context, id ProviderAssessmentMetadataId) (result GetInSubscriptionOperationResponse, err error)

GetInSubscription ...

func (AssessmentsMetadataClient) List added in v0.20230906.1160501 

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

List ...

func (AssessmentsMetadataClient) ListBySubscription added in v0.20230906.1160501 

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

ListBySubscription ...

func (AssessmentsMetadataClient) ListBySubscriptionComplete added in v0.20230906.1160501 

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

ListBySubscriptionComplete retrieves all of the results into a single object

func (AssessmentsMetadataClient) ListBySubscriptionCompleteMatchingPredicate added in v0.20230906.1160501 

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

ListBySubscriptionCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (AssessmentsMetadataClient) ListComplete added in v0.20230906.1160501 

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

ListComplete retrieves all of the results into a single object

func (AssessmentsMetadataClient) ListCompleteMatchingPredicate added in v0.20230906.1160501 

func (c AssessmentsMetadataClient) ListCompleteMatchingPredicate(ctx context.Context, predicate SecurityAssessmentMetadataOperationPredicate) (resp ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type Categories 

type Categories string
const (
	CategoriesCompute           Categories = "Compute"
	CategoriesData              Categories = "Data"
	CategoriesIdentityAndAccess Categories = "IdentityAndAccess"
	CategoriesIoT               Categories = "IoT"
	CategoriesNetworking        Categories = "Networking"
)

type CreateInSubscriptionOperationResponse added in v0.20230906.1160501 

type CreateInSubscriptionOperationResponse struct {
	HttpResponse *http.Response
	Model        *SecurityAssessmentMetadata
}

type DeleteInSubscriptionOperationResponse added in v0.20230906.1160501 

type DeleteInSubscriptionOperationResponse struct {
	HttpResponse *http.Response
}

type GetInSubscriptionOperationResponse added in v0.20230906.1160501 

type GetInSubscriptionOperationResponse struct {
	HttpResponse *http.Response
	Model        *SecurityAssessmentMetadata
}

type GetOperationResponse added in v0.20230906.1160501 

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *SecurityAssessmentMetadata
}

type ImplementationEffort 

type ImplementationEffort string
const (
	ImplementationEffortHigh     ImplementationEffort = "High"
	ImplementationEffortLow      ImplementationEffort = "Low"
	ImplementationEffortModerate ImplementationEffort = "Moderate"
)

type ListBySubscriptionCompleteResult added in v0.20230906.1160501 

type ListBySubscriptionCompleteResult struct {
	Items []SecurityAssessmentMetadata
}

type ListBySubscriptionOperationResponse added in v0.20230906.1160501 

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

func (ListBySubscriptionOperationResponse) HasMore added in v0.20230906.1160501 

func (r ListBySubscriptionOperationResponse) HasMore() bool

func (ListBySubscriptionOperationResponse) LoadMore added in v0.20230906.1160501 

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

type ListCompleteResult added in v0.20230906.1160501 

type ListCompleteResult struct {
	Items []SecurityAssessmentMetadata
}

type ListOperationResponse added in v0.20230906.1160501 

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

func (ListOperationResponse) HasMore added in v0.20230906.1160501 

func (r ListOperationResponse) HasMore() bool

func (ListOperationResponse) LoadMore added in v0.20230906.1160501 

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

type ProviderAssessmentMetadataId 

type ProviderAssessmentMetadataId struct {
	SubscriptionId         string
	AssessmentMetadataName string
}

ProviderAssessmentMetadataId is a struct representing the Resource ID for a Provider Assessment Metadata

func NewProviderAssessmentMetadataID 

func NewProviderAssessmentMetadataID(subscriptionId string, assessmentMetadataName string) ProviderAssessmentMetadataId

NewProviderAssessmentMetadataID returns a new ProviderAssessmentMetadataId struct

func ParseProviderAssessmentMetadataID 

func ParseProviderAssessmentMetadataID(input string) (*ProviderAssessmentMetadataId, error)

ParseProviderAssessmentMetadataID parses 'input' into a ProviderAssessmentMetadataId

func ParseProviderAssessmentMetadataIDInsensitively 

func ParseProviderAssessmentMetadataIDInsensitively(input string) (*ProviderAssessmentMetadataId, error)

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

func (*ProviderAssessmentMetadataId) FromParseResult added in v0.20231127.1171502 

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

func (ProviderAssessmentMetadataId) ID 

func (id ProviderAssessmentMetadataId) ID() string

ID returns the formatted Provider Assessment Metadata ID

func (ProviderAssessmentMetadataId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Provider Assessment Metadata ID

func (ProviderAssessmentMetadataId) String 

func (id ProviderAssessmentMetadataId) String() string

String returns a human-readable description of this Provider Assessment Metadata ID

type SecurityAssessmentMetadata 

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

type SecurityAssessmentMetadataOperationPredicate 

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

func (SecurityAssessmentMetadataOperationPredicate) Matches 

func (p SecurityAssessmentMetadataOperationPredicate) Matches(input SecurityAssessmentMetadata) bool

type SecurityAssessmentMetadataPartnerData 

type SecurityAssessmentMetadataPartnerData struct {
	PartnerName string  `json:"partnerName"`
	ProductName *string `json:"productName,omitempty"`
	Secret      string  `json:"secret"`
}

type SecurityAssessmentMetadataProperties 

type SecurityAssessmentMetadataProperties struct {
	AssessmentType         AssessmentType                         `json:"assessmentType"`
	Categories             *[]Categories                          `json:"categories,omitempty"`
	Description            *string                                `json:"description,omitempty"`
	DisplayName            string                                 `json:"displayName"`
	ImplementationEffort   *ImplementationEffort                  `json:"implementationEffort,omitempty"`
	PartnerData            *SecurityAssessmentMetadataPartnerData `json:"partnerData,omitempty"`
	PolicyDefinitionId     *string                                `json:"policyDefinitionId,omitempty"`
	Preview                *bool                                  `json:"preview,omitempty"`
	RemediationDescription *string                                `json:"remediationDescription,omitempty"`
	Severity               Severity                               `json:"severity"`
	Threats                *[]Threats                             `json:"threats,omitempty"`
	UserImpact             *UserImpact                            `json:"userImpact,omitempty"`
}

type Severity 

type Severity string
const (
	SeverityHigh   Severity = "High"
	SeverityLow    Severity = "Low"
	SeverityMedium Severity = "Medium"
)

type Threats 

type Threats string
const (
	ThreatsAccountBreach        Threats = "accountBreach"
	ThreatsDataExfiltration     Threats = "dataExfiltration"
	ThreatsDataSpillage         Threats = "dataSpillage"
	ThreatsDenialOfService      Threats = "denialOfService"
	ThreatsElevationOfPrivilege Threats = "elevationOfPrivilege"
	ThreatsMaliciousInsider     Threats = "maliciousInsider"
	ThreatsMissingCoverage      Threats = "missingCoverage"
	ThreatsThreatResistance     Threats = "threatResistance"
)

type UserImpact 

type UserImpact string
const (
	UserImpactHigh     UserImpact = "High"
	UserImpactLow      UserImpact = "Low"
	UserImpactModerate UserImpact = "Moderate"
)

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.