assessmentsmetadata

package
v0.20231124.1163225 Latest Latest
Warning

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

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

README

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

The assessmentsmetadata SDK allows for interaction with the Azure Resource Manager Service security (API Version 2021-06-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/2021-06-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.SecurityAssessmentMetadataResponse{
	// ...
}


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 PossibleValuesForTactics

func PossibleValuesForTactics() []string

func PossibleValuesForTechniques

func PossibleValuesForTechniques() []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) CreateInSubscription added in v0.20230906.1160501

CreateInSubscription ...

func (AssessmentsMetadataClient) DeleteInSubscription added in v0.20230906.1160501

DeleteInSubscription ...

func (AssessmentsMetadataClient) Get added in v0.20230906.1160501

Get ...

func (AssessmentsMetadataClient) GetInSubscription added in v0.20230906.1160501

GetInSubscription ...

func (AssessmentsMetadataClient) List added in v0.20230906.1160501

List ...

func (AssessmentsMetadataClient) ListBySubscription added in v0.20230906.1160501

ListBySubscription ...

func (AssessmentsMetadataClient) ListBySubscriptionComplete added in v0.20230906.1160501

ListBySubscriptionComplete retrieves all of the results into a single object

func (AssessmentsMetadataClient) ListBySubscriptionCompleteMatchingPredicate added in v0.20230906.1160501

ListBySubscriptionCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (AssessmentsMetadataClient) ListComplete added in v0.20230906.1160501

ListComplete retrieves all of the results into a single object

func (AssessmentsMetadataClient) ListCompleteMatchingPredicate added in v0.20230906.1160501

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        *SecurityAssessmentMetadataResponse
}

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        *SecurityAssessmentMetadataResponse
}

type GetOperationResponse added in v0.20230906.1160501

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

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 []SecurityAssessmentMetadataResponse
}

type ListBySubscriptionOperationResponse added in v0.20230906.1160501

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

func (ListBySubscriptionOperationResponse) HasMore added in v0.20230906.1160501

func (ListBySubscriptionOperationResponse) LoadMore added in v0.20230906.1160501

type ListCompleteResult added in v0.20230906.1160501

type ListCompleteResult struct {
	Items []SecurityAssessmentMetadataResponse
}

type ListOperationResponse added in v0.20230906.1160501

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

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

type SecurityAssessmentMetadataPropertiesResponse

type SecurityAssessmentMetadataPropertiesResponse 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"`
	PlannedDeprecationDate *string                                                   `json:"plannedDeprecationDate,omitempty"`
	PolicyDefinitionId     *string                                                   `json:"policyDefinitionId,omitempty"`
	Preview                *bool                                                     `json:"preview,omitempty"`
	PublishDates           *SecurityAssessmentMetadataPropertiesResponsePublishDates `json:"publishDates,omitempty"`
	RemediationDescription *string                                                   `json:"remediationDescription,omitempty"`
	Severity               Severity                                                  `json:"severity"`
	Tactics                *[]Tactics                                                `json:"tactics,omitempty"`
	Techniques             *[]Techniques                                             `json:"techniques,omitempty"`
	Threats                *[]Threats                                                `json:"threats,omitempty"`
	UserImpact             *UserImpact                                               `json:"userImpact,omitempty"`
}

type SecurityAssessmentMetadataPropertiesResponsePublishDates

type SecurityAssessmentMetadataPropertiesResponsePublishDates struct {
	GA     *string `json:"GA,omitempty"`
	Public string  `json:"public"`
}

type SecurityAssessmentMetadataResponse

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

type SecurityAssessmentMetadataResponseOperationPredicate

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

func (SecurityAssessmentMetadataResponseOperationPredicate) Matches

type Severity

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

type Tactics

type Tactics string
const (
	TacticsCollection          Tactics = "Collection"
	TacticsCommandAndControl   Tactics = "Command and Control"
	TacticsCredentialAccess    Tactics = "Credential Access"
	TacticsDefenseEvasion      Tactics = "Defense Evasion"
	TacticsDiscovery           Tactics = "Discovery"
	TacticsExecution           Tactics = "Execution"
	TacticsExfiltration        Tactics = "Exfiltration"
	TacticsImpact              Tactics = "Impact"
	TacticsInitialAccess       Tactics = "Initial Access"
	TacticsLateralMovement     Tactics = "Lateral Movement"
	TacticsPersistence         Tactics = "Persistence"
	TacticsPrivilegeEscalation Tactics = "Privilege Escalation"
	TacticsReconnaissance      Tactics = "Reconnaissance"
	TacticsResourceDevelopment Tactics = "Resource Development"
)

type Techniques

type Techniques string
const (
	TechniquesAbuseElevationControlMechanism          Techniques = "Abuse Elevation Control Mechanism"
	TechniquesAccessTokenManipulation                 Techniques = "Access Token Manipulation"
	TechniquesAccountDiscovery                        Techniques = "Account Discovery"
	TechniquesAccountManipulation                     Techniques = "Account Manipulation"
	TechniquesActiveScanning                          Techniques = "Active Scanning"
	TechniquesApplicationLayerProtocol                Techniques = "Application Layer Protocol"
	TechniquesAudioCapture                            Techniques = "Audio Capture"
	TechniquesBootOrLogonAutostartExecution           Techniques = "Boot or Logon Autostart Execution"
	TechniquesBootOrLogonInitializationScripts        Techniques = "Boot or Logon Initialization Scripts"
	TechniquesBruteForce                              Techniques = "Brute Force"
	TechniquesCloudInfrastructureDiscovery            Techniques = "Cloud Infrastructure Discovery"
	TechniquesCloudServiceDashboard                   Techniques = "Cloud Service Dashboard"
	TechniquesCloudServiceDiscovery                   Techniques = "Cloud Service Discovery"
	TechniquesCommandAndScriptingInterpreter          Techniques = "Command and Scripting Interpreter"
	TechniquesCompromiseClientSoftwareBinary          Techniques = "Compromise Client Software Binary"
	TechniquesCompromiseInfrastructure                Techniques = "Compromise Infrastructure"
	TechniquesContainerAndResourceDiscovery           Techniques = "Container and Resource Discovery"
	TechniquesCreateAccount                           Techniques = "Create Account"
	TechniquesCreateOrModifySystemProcess             Techniques = "Create or Modify System Process"
	TechniquesCredentialsFromPasswordStores           Techniques = "Credentials from Password Stores"
	TechniquesDataDestruction                         Techniques = "Data Destruction"
	TechniquesDataEncryptedForImpact                  Techniques = "Data Encrypted for Impact"
	TechniquesDataFromCloudStorageObject              Techniques = "Data from Cloud Storage Object"
	TechniquesDataFromConfigurationRepository         Techniques = "Data from Configuration Repository"
	TechniquesDataFromInformationRepositories         Techniques = "Data from Information Repositories"
	TechniquesDataFromLocalSystem                     Techniques = "Data from Local System"
	TechniquesDataManipulation                        Techniques = "Data Manipulation"
	TechniquesDataStaged                              Techniques = "Data Staged"
	TechniquesDefacement                              Techniques = "Defacement"
	TechniquesDeobfuscateDecodeFilesOrInformation     Techniques = "Deobfuscate/Decode Files or Information"
	TechniquesDiskWipe                                Techniques = "Disk Wipe"
	TechniquesDomainTrustDiscovery                    Techniques = "Domain Trust Discovery"
	TechniquesDriveNegativebyCompromise               Techniques = "Drive-by Compromise"
	TechniquesDynamicResolution                       Techniques = "Dynamic Resolution"
	TechniquesEndpointDenialOfService                 Techniques = "Endpoint Denial of Service"
	TechniquesEventTriggeredExecution                 Techniques = "Event Triggered Execution"
	TechniquesExfiltrationOverAlternativeProtocol     Techniques = "Exfiltration Over Alternative Protocol"
	TechniquesExploitPublicNegativeFacingApplication  Techniques = "Exploit Public-Facing Application"
	TechniquesExploitationForClientExecution          Techniques = "Exploitation for Client Execution"
	TechniquesExploitationForCredentialAccess         Techniques = "Exploitation for Credential Access"
	TechniquesExploitationForDefenseEvasion           Techniques = "Exploitation for Defense Evasion"
	TechniquesExploitationForPrivilegeEscalation      Techniques = "Exploitation for Privilege Escalation"
	TechniquesExploitationOfRemoteServices            Techniques = "Exploitation of Remote Services"
	TechniquesExternalRemoteServices                  Techniques = "External Remote Services"
	TechniquesFallbackChannels                        Techniques = "Fallback Channels"
	TechniquesFileAndDirectoryDiscovery               Techniques = "File and Directory Discovery"
	TechniquesFileAndDirectoryPermissionsModification Techniques = "File and Directory Permissions Modification"
	TechniquesGatherVictimNetworkInformation          Techniques = "Gather Victim Network Information"
	TechniquesHideArtifacts                           Techniques = "Hide Artifacts"
	TechniquesHijackExecutionFlow                     Techniques = "Hijack Execution Flow"
	TechniquesImpairDefenses                          Techniques = "Impair Defenses"
	TechniquesImplantContainerImage                   Techniques = "Implant Container Image"
	TechniquesIndicatorRemovalOnHost                  Techniques = "Indicator Removal on Host"
	TechniquesIndirectCommandExecution                Techniques = "Indirect Command Execution"
	TechniquesIngressToolTransfer                     Techniques = "Ingress Tool Transfer"
	TechniquesInputCapture                            Techniques = "Input Capture"
	TechniquesInterNegativeProcessCommunication       Techniques = "Inter-Process Communication"
	TechniquesLateralToolTransfer                     Techniques = "Lateral Tool Transfer"
	TechniquesManNegativeinNegativetheNegativeMiddle  Techniques = "Man-in-the-Middle"
	TechniquesMasquerading                            Techniques = "Masquerading"
	TechniquesModifyAuthenticationProcess             Techniques = "Modify Authentication Process"
	TechniquesModifyRegistry                          Techniques = "Modify Registry"
	TechniquesNetworkDenialOfService                  Techniques = "Network Denial of Service"
	TechniquesNetworkServiceScanning                  Techniques = "Network Service Scanning"
	TechniquesNetworkSniffing                         Techniques = "Network Sniffing"
	TechniquesNonNegativeApplicationLayerProtocol     Techniques = "Non-Application Layer Protocol"
	TechniquesNonNegativeStandardPort                 Techniques = "Non-Standard Port"
	TechniquesOSCredentialDumping                     Techniques = "OS Credential Dumping"
	TechniquesObfuscatedFilesOrInformation            Techniques = "Obfuscated Files or Information"
	TechniquesObtainCapabilities                      Techniques = "Obtain Capabilities"
	TechniquesOfficeApplicationStartup                Techniques = "Office Application Startup"
	TechniquesPermissionGroupsDiscovery               Techniques = "Permission Groups Discovery"
	TechniquesPhishing                                Techniques = "Phishing"
	TechniquesPreNegativeOSBoot                       Techniques = "Pre-OS Boot"
	TechniquesProcessDiscovery                        Techniques = "Process Discovery"
	TechniquesProcessInjection                        Techniques = "Process Injection"
	TechniquesProtocolTunneling                       Techniques = "Protocol Tunneling"
	TechniquesProxy                                   Techniques = "Proxy"
	TechniquesQueryRegistry                           Techniques = "Query Registry"
	TechniquesRemoteAccessSoftware                    Techniques = "Remote Access Software"
	TechniquesRemoteServiceSessionHijacking           Techniques = "Remote Service Session Hijacking"
	TechniquesRemoteServices                          Techniques = "Remote Services"
	TechniquesRemoteSystemDiscovery                   Techniques = "Remote System Discovery"
	TechniquesResourceHijacking                       Techniques = "Resource Hijacking"
	TechniquesSQLStoredProcedures                     Techniques = "SQL Stored Procedures"
	TechniquesScheduledTaskJob                        Techniques = "Scheduled Task/Job"
	TechniquesScreenCapture                           Techniques = "Screen Capture"
	TechniquesSearchVictimNegativeOwnedWebsites       Techniques = "Search Victim-Owned Websites"
	TechniquesServerSoftwareComponent                 Techniques = "Server Software Component"
	TechniquesServiceStop                             Techniques = "Service Stop"
	TechniquesSignedBinaryProxyExecution              Techniques = "Signed Binary Proxy Execution"
	TechniquesSoftwareDeploymentTools                 Techniques = "Software Deployment Tools"
	TechniquesStealOrForgeKerberosTickets             Techniques = "Steal or Forge Kerberos Tickets"
	TechniquesSubvertTrustControls                    Techniques = "Subvert Trust Controls"
	TechniquesSupplyChainCompromise                   Techniques = "Supply Chain Compromise"
	TechniquesSystemInformationDiscovery              Techniques = "System Information Discovery"
	TechniquesTaintSharedContent                      Techniques = "Taint Shared Content"
	TechniquesTrafficSignaling                        Techniques = "Traffic Signaling"
	TechniquesTransferDataToCloudAccount              Techniques = "Transfer Data to Cloud Account"
	TechniquesTrustedRelationship                     Techniques = "Trusted Relationship"
	TechniquesUnsecuredCredentials                    Techniques = "Unsecured Credentials"
	TechniquesUserExecution                           Techniques = "User Execution"
	TechniquesValidAccounts                           Techniques = "Valid Accounts"
	TechniquesWindowsManagementInstrumentation        Techniques = "Windows Management Instrumentation"
)

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