assessmentsmetadata

package
v0.20240221.1115631 Latest Latest
Warning

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

Go to latest
Published: Feb 21, 2024 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-helpers/resourcemanager/commonids"
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.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.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.SubscriptionCreate

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

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


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

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

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

Example Usage: AssessmentsMetadataClient.SubscriptionGet

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

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

Example Usage: AssessmentsMetadataClient.SubscriptionList

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

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

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

type AssessmentsMetadataClient

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

func NewAssessmentsMetadataClientWithBaseURI

func NewAssessmentsMetadataClientWithBaseURI(endpoint string) AssessmentsMetadataClient

func (AssessmentsMetadataClient) Get

Get ...

func (AssessmentsMetadataClient) List

List ...

func (AssessmentsMetadataClient) ListComplete

ListComplete retrieves all of the results into a single object

func (AssessmentsMetadataClient) ListCompleteMatchingPredicate

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

ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (AssessmentsMetadataClient) SubscriptionCreate

SubscriptionCreate ...

func (AssessmentsMetadataClient) SubscriptionDelete

SubscriptionDelete ...

func (AssessmentsMetadataClient) SubscriptionGet

SubscriptionGet ...

func (AssessmentsMetadataClient) SubscriptionList

SubscriptionList ...

func (AssessmentsMetadataClient) SubscriptionListComplete

SubscriptionListComplete retrieves all of the results into a single object

func (AssessmentsMetadataClient) SubscriptionListCompleteMatchingPredicate

SubscriptionListCompleteMatchingPredicate 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 GetOperationResponse

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

type ImplementationEffort

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

type ListCompleteResult

type ListCompleteResult struct {
	Items []SecurityAssessmentMetadata
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]SecurityAssessmentMetadata
	// 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 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

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

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 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 SubscriptionCreateOperationResponse

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

type SubscriptionDeleteOperationResponse

type SubscriptionDeleteOperationResponse struct {
	HttpResponse *http.Response
}

type SubscriptionGetOperationResponse

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

type SubscriptionListCompleteResult

type SubscriptionListCompleteResult struct {
	Items []SecurityAssessmentMetadata
}

type SubscriptionListOperationResponse

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

func (SubscriptionListOperationResponse) HasMore

func (SubscriptionListOperationResponse) LoadMore

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