assessmentsmetadata

package
v0.20230823.1052657 Latest Latest
Warning

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

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

README

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

The assessmentsmetadata SDK allows for interaction with the Azure Resource Manager Service security (API Version 2019-01-01-preview).

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/2019-01-01-preview/assessmentsmetadata"

Client Initialization

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

Example Usage: AssessmentsMetadataClient.AssessmentsMetadataGet

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

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

Example Usage: AssessmentsMetadataClient.AssessmentsMetadataList

ctx := context.TODO()


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

Example Usage: AssessmentsMetadataClient.AssessmentsMetadataSubscriptionCreate

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

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


read, err := client.AssessmentsMetadataSubscriptionCreate(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.AssessmentsMetadataSubscriptionDelete

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

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

Example Usage: AssessmentsMetadataClient.AssessmentsMetadataSubscriptionGet

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

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

Example Usage: AssessmentsMetadataClient.AssessmentsMetadataSubscriptionList

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

// alternatively `client.AssessmentsMetadataSubscriptionList(ctx, id)` can be used to do batched pagination
items, err := client.AssessmentsMetadataSubscriptionListComplete(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) 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"
)

type AssessmentsMetadataClient 

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

func NewAssessmentsMetadataClientWithBaseURI 

func NewAssessmentsMetadataClientWithBaseURI(endpoint string) AssessmentsMetadataClient

func (AssessmentsMetadataClient) AssessmentsMetadataGet 

func (c AssessmentsMetadataClient) AssessmentsMetadataGet(ctx context.Context, id AssessmentMetadataId) (result AssessmentsMetadataGetOperationResponse, err error)

AssessmentsMetadataGet ...

func (AssessmentsMetadataClient) AssessmentsMetadataList 

func (c AssessmentsMetadataClient) AssessmentsMetadataList(ctx context.Context) (resp AssessmentsMetadataListOperationResponse, err error)

AssessmentsMetadataList ...

func (AssessmentsMetadataClient) AssessmentsMetadataListComplete 

func (c AssessmentsMetadataClient) AssessmentsMetadataListComplete(ctx context.Context) (AssessmentsMetadataListCompleteResult, error)

AssessmentsMetadataListComplete retrieves all of the results into a single object

func (AssessmentsMetadataClient) AssessmentsMetadataListCompleteMatchingPredicate 

func (c AssessmentsMetadataClient) AssessmentsMetadataListCompleteMatchingPredicate(ctx context.Context, predicate SecurityAssessmentMetadataOperationPredicate) (resp AssessmentsMetadataListCompleteResult, err error)

AssessmentsMetadataListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (AssessmentsMetadataClient) AssessmentsMetadataSubscriptionCreate 

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

AssessmentsMetadataSubscriptionCreate ...

func (AssessmentsMetadataClient) AssessmentsMetadataSubscriptionDelete 

func (c AssessmentsMetadataClient) AssessmentsMetadataSubscriptionDelete(ctx context.Context, id ProviderAssessmentMetadataId) (result AssessmentsMetadataSubscriptionDeleteOperationResponse, err error)

AssessmentsMetadataSubscriptionDelete ...

func (AssessmentsMetadataClient) AssessmentsMetadataSubscriptionGet 

func (c AssessmentsMetadataClient) AssessmentsMetadataSubscriptionGet(ctx context.Context, id ProviderAssessmentMetadataId) (result AssessmentsMetadataSubscriptionGetOperationResponse, err error)

AssessmentsMetadataSubscriptionGet ...

func (AssessmentsMetadataClient) AssessmentsMetadataSubscriptionList 

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

AssessmentsMetadataSubscriptionList ...

func (AssessmentsMetadataClient) AssessmentsMetadataSubscriptionListComplete 

func (c AssessmentsMetadataClient) AssessmentsMetadataSubscriptionListComplete(ctx context.Context, id commonids.SubscriptionId) (AssessmentsMetadataSubscriptionListCompleteResult, error)

AssessmentsMetadataSubscriptionListComplete retrieves all of the results into a single object

func (AssessmentsMetadataClient) AssessmentsMetadataSubscriptionListCompleteMatchingPredicate 

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

AssessmentsMetadataSubscriptionListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type AssessmentsMetadataGetOperationResponse 

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

type AssessmentsMetadataListCompleteResult 

type AssessmentsMetadataListCompleteResult struct {
	Items []SecurityAssessmentMetadata
}

type AssessmentsMetadataListOperationResponse 

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

func (AssessmentsMetadataListOperationResponse) HasMore 

func (r AssessmentsMetadataListOperationResponse) HasMore() bool

func (AssessmentsMetadataListOperationResponse) LoadMore 

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

type AssessmentsMetadataSubscriptionCreateOperationResponse 

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

type AssessmentsMetadataSubscriptionDeleteOperationResponse 

type AssessmentsMetadataSubscriptionDeleteOperationResponse struct {
	HttpResponse *http.Response
}

type AssessmentsMetadataSubscriptionGetOperationResponse 

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

type AssessmentsMetadataSubscriptionListCompleteResult 

type AssessmentsMetadataSubscriptionListCompleteResult struct {
	Items []SecurityAssessmentMetadata
}

type AssessmentsMetadataSubscriptionListOperationResponse 

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

func (AssessmentsMetadataSubscriptionListOperationResponse) HasMore 

func (r AssessmentsMetadataSubscriptionListOperationResponse) HasMore() bool

func (AssessmentsMetadataSubscriptionListOperationResponse) LoadMore 

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

type Categories 

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

type ImplementationEffort 

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

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) 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 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"`
	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.