assessmentsmetadata

package
v0.20230606.1092251 Latest Latest
Warning

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

Go to latest
Published: Jun 6, 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.AssessmentsMetadataCreateInSubscription

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

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


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

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

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

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.AssessmentsMetadataGetInSubscription

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

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

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

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

AssessmentsMetadataCreateInSubscription ...

func (AssessmentsMetadataClient) AssessmentsMetadataDeleteInSubscription

AssessmentsMetadataDeleteInSubscription ...

func (AssessmentsMetadataClient) AssessmentsMetadataGet

AssessmentsMetadataGet ...

func (AssessmentsMetadataClient) AssessmentsMetadataGetInSubscription

AssessmentsMetadataGetInSubscription ...

func (AssessmentsMetadataClient) AssessmentsMetadataList

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

AssessmentsMetadataList ...

func (AssessmentsMetadataClient) AssessmentsMetadataListBySubscription

AssessmentsMetadataListBySubscription ...

func (AssessmentsMetadataClient) AssessmentsMetadataListBySubscriptionComplete

AssessmentsMetadataListBySubscriptionComplete retrieves all of the results into a single object

func (AssessmentsMetadataClient) AssessmentsMetadataListBySubscriptionCompleteMatchingPredicate

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

AssessmentsMetadataListBySubscriptionCompleteMatchingPredicate retrieves all of the results and then applied the predicate

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

type AssessmentsMetadataCreateInSubscriptionOperationResponse

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

type AssessmentsMetadataDeleteInSubscriptionOperationResponse

type AssessmentsMetadataDeleteInSubscriptionOperationResponse struct {
	HttpResponse *http.Response
}

type AssessmentsMetadataGetInSubscriptionOperationResponse

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

type AssessmentsMetadataGetOperationResponse

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

type AssessmentsMetadataListBySubscriptionCompleteResult

type AssessmentsMetadataListBySubscriptionCompleteResult struct {
	Items []SecurityAssessmentMetadata
}

type AssessmentsMetadataListBySubscriptionOperationResponse

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

func (AssessmentsMetadataListBySubscriptionOperationResponse) HasMore

func (AssessmentsMetadataListBySubscriptionOperationResponse) LoadMore

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 (AssessmentsMetadataListOperationResponse) LoadMore

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

ID returns the formatted Provider Assessment Metadata ID

func (ProviderAssessmentMetadataId) Segments

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

func (ProviderAssessmentMetadataId) 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

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

Jump to

Keyboard shortcuts

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