databasevulnerabilityassessmentscans

package
v0.20240923.1151247 Latest Latest
Warning

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

 Go to latest Published: Sep 23, 2024 License: MPL-2.0 Imports: 15 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2023-05-01-preview/databasevulnerabilityassessmentscans Documentation

The databasevulnerabilityassessmentscans SDK allows for interaction with Azure Resource Manager sql (API Version 2023-05-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/sql/2023-05-01-preview/databasevulnerabilityassessmentscans"

Client Initialization

client := databasevulnerabilityassessmentscans.NewDatabaseVulnerabilityAssessmentScansClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DatabaseVulnerabilityAssessmentScansClient.Export

ctx := context.TODO()
id := databasevulnerabilityassessmentscans.NewVulnerabilityAssessmentScanID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverName", "databaseName", "scanId")

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

Example Usage: DatabaseVulnerabilityAssessmentScansClient.Get

ctx := context.TODO()
id := databasevulnerabilityassessmentscans.NewVulnerabilityAssessmentScanID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverName", "databaseName", "scanId")

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: DatabaseVulnerabilityAssessmentScansClient.InitiateScan

ctx := context.TODO()
id := databasevulnerabilityassessmentscans.NewVulnerabilityAssessmentScanID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverName", "databaseName", "scanId")

if err := client.InitiateScanThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: DatabaseVulnerabilityAssessmentScansClient.ListByDatabase

ctx := context.TODO()
id := commonids.NewSqlDatabaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverName", "databaseName")

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

func PossibleValuesForVulnerabilityAssessmentScanState() []string

func PossibleValuesForVulnerabilityAssessmentScanTriggerType 

func PossibleValuesForVulnerabilityAssessmentScanTriggerType() []string

func ValidateVulnerabilityAssessmentScanID 

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

ValidateVulnerabilityAssessmentScanID checks that 'input' can be parsed as a Vulnerability Assessment Scan ID

Types

type DatabaseVulnerabilityAssessmentScanExportProperties 

type DatabaseVulnerabilityAssessmentScanExportProperties struct {
	ExportedReportLocation *string `json:"exportedReportLocation,omitempty"`
}

type DatabaseVulnerabilityAssessmentScansClient 

type DatabaseVulnerabilityAssessmentScansClient struct {
	Client *resourcemanager.Client
}

func NewDatabaseVulnerabilityAssessmentScansClientWithBaseURI 

func NewDatabaseVulnerabilityAssessmentScansClientWithBaseURI(sdkApi sdkEnv.Api) (*DatabaseVulnerabilityAssessmentScansClient, error)

func (DatabaseVulnerabilityAssessmentScansClient) Export 

func (c DatabaseVulnerabilityAssessmentScansClient) Export(ctx context.Context, id VulnerabilityAssessmentScanId) (result ExportOperationResponse, err error)

Export ...

func (DatabaseVulnerabilityAssessmentScansClient) Get 

func (c DatabaseVulnerabilityAssessmentScansClient) Get(ctx context.Context, id VulnerabilityAssessmentScanId) (result GetOperationResponse, err error)

Get ...

func (DatabaseVulnerabilityAssessmentScansClient) InitiateScan 

func (c DatabaseVulnerabilityAssessmentScansClient) InitiateScan(ctx context.Context, id VulnerabilityAssessmentScanId) (result InitiateScanOperationResponse, err error)

InitiateScan ...

func (DatabaseVulnerabilityAssessmentScansClient) InitiateScanThenPoll 

func (c DatabaseVulnerabilityAssessmentScansClient) InitiateScanThenPoll(ctx context.Context, id VulnerabilityAssessmentScanId) error

InitiateScanThenPoll performs InitiateScan then polls until it's completed

func (DatabaseVulnerabilityAssessmentScansClient) ListByDatabase 

func (c DatabaseVulnerabilityAssessmentScansClient) ListByDatabase(ctx context.Context, id commonids.SqlDatabaseId) (result ListByDatabaseOperationResponse, err error)

ListByDatabase ...

func (DatabaseVulnerabilityAssessmentScansClient) ListByDatabaseComplete 

func (c DatabaseVulnerabilityAssessmentScansClient) ListByDatabaseComplete(ctx context.Context, id commonids.SqlDatabaseId) (ListByDatabaseCompleteResult, error)

ListByDatabaseComplete retrieves all the results into a single object

func (DatabaseVulnerabilityAssessmentScansClient) ListByDatabaseCompleteMatchingPredicate 

func (c DatabaseVulnerabilityAssessmentScansClient) ListByDatabaseCompleteMatchingPredicate(ctx context.Context, id commonids.SqlDatabaseId, predicate VulnerabilityAssessmentScanRecordOperationPredicate) (result ListByDatabaseCompleteResult, err error)

ListByDatabaseCompleteMatchingPredicate retrieves all the results and then applies the predicate

type DatabaseVulnerabilityAssessmentScansExport 

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

type ExportOperationResponse 

type ExportOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DatabaseVulnerabilityAssessmentScansExport
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VulnerabilityAssessmentScanRecord
}

type InitiateScanOperationResponse 

type InitiateScanOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type ListByDatabaseCompleteResult 

type ListByDatabaseCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []VulnerabilityAssessmentScanRecord
}

type ListByDatabaseCustomPager added in v0.20240628.1153531 

type ListByDatabaseCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByDatabaseCustomPager) NextPageLink() *odata.Link

type ListByDatabaseOperationResponse 

type ListByDatabaseOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]VulnerabilityAssessmentScanRecord
}

type VulnerabilityAssessmentScanError 

type VulnerabilityAssessmentScanError struct {
	Code    *string `json:"code,omitempty"`
	Message *string `json:"message,omitempty"`
}

type VulnerabilityAssessmentScanId 

type VulnerabilityAssessmentScanId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServerName        string
	DatabaseName      string
	ScanId            string
}

VulnerabilityAssessmentScanId is a struct representing the Resource ID for a Vulnerability Assessment Scan

func NewVulnerabilityAssessmentScanID 

func NewVulnerabilityAssessmentScanID(subscriptionId string, resourceGroupName string, serverName string, databaseName string, scanId string) VulnerabilityAssessmentScanId

NewVulnerabilityAssessmentScanID returns a new VulnerabilityAssessmentScanId struct

func ParseVulnerabilityAssessmentScanID 

func ParseVulnerabilityAssessmentScanID(input string) (*VulnerabilityAssessmentScanId, error)

ParseVulnerabilityAssessmentScanID parses 'input' into a VulnerabilityAssessmentScanId

func ParseVulnerabilityAssessmentScanIDInsensitively 

func ParseVulnerabilityAssessmentScanIDInsensitively(input string) (*VulnerabilityAssessmentScanId, error)

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

func (*VulnerabilityAssessmentScanId) FromParseResult 

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

func (VulnerabilityAssessmentScanId) ID 

func (id VulnerabilityAssessmentScanId) ID() string

ID returns the formatted Vulnerability Assessment Scan ID

func (VulnerabilityAssessmentScanId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Vulnerability Assessment Scan ID

func (VulnerabilityAssessmentScanId) String 

func (id VulnerabilityAssessmentScanId) String() string

String returns a human-readable description of this Vulnerability Assessment Scan ID

type VulnerabilityAssessmentScanRecord 

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

type VulnerabilityAssessmentScanRecordOperationPredicate 

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

func (VulnerabilityAssessmentScanRecordOperationPredicate) Matches 

func (p VulnerabilityAssessmentScanRecordOperationPredicate) Matches(input VulnerabilityAssessmentScanRecord) bool

type VulnerabilityAssessmentScanRecordProperties 

type VulnerabilityAssessmentScanRecordProperties struct {
	EndTime                      *string                                 `json:"endTime,omitempty"`
	Errors                       *[]VulnerabilityAssessmentScanError     `json:"errors,omitempty"`
	NumberOfFailedSecurityChecks *int64                                  `json:"numberOfFailedSecurityChecks,omitempty"`
	ScanId                       *string                                 `json:"scanId,omitempty"`
	StartTime                    *string                                 `json:"startTime,omitempty"`
	State                        *VulnerabilityAssessmentScanState       `json:"state,omitempty"`
	StorageContainerPath         *string                                 `json:"storageContainerPath,omitempty"`
	TriggerType                  *VulnerabilityAssessmentScanTriggerType `json:"triggerType,omitempty"`
}

func (*VulnerabilityAssessmentScanRecordProperties) GetEndTimeAsTime 

func (o *VulnerabilityAssessmentScanRecordProperties) GetEndTimeAsTime() (*time.Time, error)

func (*VulnerabilityAssessmentScanRecordProperties) GetStartTimeAsTime 

func (o *VulnerabilityAssessmentScanRecordProperties) GetStartTimeAsTime() (*time.Time, error)

func (*VulnerabilityAssessmentScanRecordProperties) SetEndTimeAsTime 

func (o *VulnerabilityAssessmentScanRecordProperties) SetEndTimeAsTime(input time.Time)

func (*VulnerabilityAssessmentScanRecordProperties) SetStartTimeAsTime 

func (o *VulnerabilityAssessmentScanRecordProperties) SetStartTimeAsTime(input time.Time)

type VulnerabilityAssessmentScanState 

type VulnerabilityAssessmentScanState string
const (
	VulnerabilityAssessmentScanStateFailed      VulnerabilityAssessmentScanState = "Failed"
	VulnerabilityAssessmentScanStateFailedToRun VulnerabilityAssessmentScanState = "FailedToRun"
	VulnerabilityAssessmentScanStateInProgress  VulnerabilityAssessmentScanState = "InProgress"
	VulnerabilityAssessmentScanStatePassed      VulnerabilityAssessmentScanState = "Passed"
)

func (*VulnerabilityAssessmentScanState) UnmarshalJSON 

func (s *VulnerabilityAssessmentScanState) UnmarshalJSON(bytes []byte) error

type VulnerabilityAssessmentScanTriggerType 

type VulnerabilityAssessmentScanTriggerType string
const (
	VulnerabilityAssessmentScanTriggerTypeOnDemand  VulnerabilityAssessmentScanTriggerType = "OnDemand"
	VulnerabilityAssessmentScanTriggerTypeRecurring VulnerabilityAssessmentScanTriggerType = "Recurring"
)

func (*VulnerabilityAssessmentScanTriggerType) UnmarshalJSON 

func (s *VulnerabilityAssessmentScanTriggerType) UnmarshalJSON(bytes []byte) error

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.