regulatorycompliance

package
v0.20230728.1065112 Latest Latest
Warning

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

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

README

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

The regulatorycompliance 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/regulatorycompliance"

Client Initialization

client := regulatorycompliance.NewRegulatoryComplianceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RegulatoryComplianceClient.AssessmentsGet

ctx := context.TODO()
id := regulatorycompliance.NewRegulatoryComplianceAssessmentID("12345678-1234-9876-4563-123456789012", "regulatoryComplianceStandardValue", "regulatoryComplianceControlValue", "regulatoryComplianceAssessmentValue")

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

Example Usage: RegulatoryComplianceClient.AssessmentsList

ctx := context.TODO()
id := regulatorycompliance.NewRegulatoryComplianceControlID("12345678-1234-9876-4563-123456789012", "regulatoryComplianceStandardValue", "regulatoryComplianceControlValue")

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

Example Usage: RegulatoryComplianceClient.ControlsGet

ctx := context.TODO()
id := regulatorycompliance.NewRegulatoryComplianceControlID("12345678-1234-9876-4563-123456789012", "regulatoryComplianceStandardValue", "regulatoryComplianceControlValue")

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

Example Usage: RegulatoryComplianceClient.ControlsList

ctx := context.TODO()
id := regulatorycompliance.NewRegulatoryComplianceStandardID("12345678-1234-9876-4563-123456789012", "regulatoryComplianceStandardValue")

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

Example Usage: RegulatoryComplianceClient.StandardsGet

ctx := context.TODO()
id := regulatorycompliance.NewRegulatoryComplianceStandardID("12345678-1234-9876-4563-123456789012", "regulatoryComplianceStandardValue")

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

Example Usage: RegulatoryComplianceClient.StandardsList

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

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

func PossibleValuesForState() []string

func ValidateRegulatoryComplianceAssessmentID

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

ValidateRegulatoryComplianceAssessmentID checks that 'input' can be parsed as a Regulatory Compliance Assessment ID

func ValidateRegulatoryComplianceControlID

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

ValidateRegulatoryComplianceControlID checks that 'input' can be parsed as a Regulatory Compliance Control ID

func ValidateRegulatoryComplianceStandardID

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

ValidateRegulatoryComplianceStandardID checks that 'input' can be parsed as a Regulatory Compliance Standard ID

Types

type AssessmentsGetOperationResponse

type AssessmentsGetOperationResponse struct {
	HttpResponse *http.Response
	Model        *RegulatoryComplianceAssessment
}

type AssessmentsListCompleteResult

type AssessmentsListCompleteResult struct {
	Items []RegulatoryComplianceAssessment
}

type AssessmentsListOperationOptions

type AssessmentsListOperationOptions struct {
	Filter *string
}

func DefaultAssessmentsListOperationOptions

func DefaultAssessmentsListOperationOptions() AssessmentsListOperationOptions

type AssessmentsListOperationResponse

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

func (AssessmentsListOperationResponse) HasMore

func (AssessmentsListOperationResponse) LoadMore

type ControlsGetOperationResponse

type ControlsGetOperationResponse struct {
	HttpResponse *http.Response
	Model        *RegulatoryComplianceControl
}

type ControlsListCompleteResult

type ControlsListCompleteResult struct {
	Items []RegulatoryComplianceControl
}

type ControlsListOperationOptions

type ControlsListOperationOptions struct {
	Filter *string
}

func DefaultControlsListOperationOptions

func DefaultControlsListOperationOptions() ControlsListOperationOptions

type ControlsListOperationResponse

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

func (ControlsListOperationResponse) HasMore

func (r ControlsListOperationResponse) HasMore() bool

func (ControlsListOperationResponse) LoadMore

type RegulatoryComplianceAssessment

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

type RegulatoryComplianceAssessmentId

type RegulatoryComplianceAssessmentId struct {
	SubscriptionId                     string
	RegulatoryComplianceStandardName   string
	RegulatoryComplianceControlName    string
	RegulatoryComplianceAssessmentName string
}

RegulatoryComplianceAssessmentId is a struct representing the Resource ID for a Regulatory Compliance Assessment

func NewRegulatoryComplianceAssessmentID

func NewRegulatoryComplianceAssessmentID(subscriptionId string, regulatoryComplianceStandardName string, regulatoryComplianceControlName string, regulatoryComplianceAssessmentName string) RegulatoryComplianceAssessmentId

NewRegulatoryComplianceAssessmentID returns a new RegulatoryComplianceAssessmentId struct

func ParseRegulatoryComplianceAssessmentID

func ParseRegulatoryComplianceAssessmentID(input string) (*RegulatoryComplianceAssessmentId, error)

ParseRegulatoryComplianceAssessmentID parses 'input' into a RegulatoryComplianceAssessmentId

func ParseRegulatoryComplianceAssessmentIDInsensitively

func ParseRegulatoryComplianceAssessmentIDInsensitively(input string) (*RegulatoryComplianceAssessmentId, error)

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

func (RegulatoryComplianceAssessmentId) ID

ID returns the formatted Regulatory Compliance Assessment ID

func (RegulatoryComplianceAssessmentId) Segments

Segments returns a slice of Resource ID Segments which comprise this Regulatory Compliance Assessment ID

func (RegulatoryComplianceAssessmentId) String

String returns a human-readable description of this Regulatory Compliance Assessment ID

type RegulatoryComplianceAssessmentOperationPredicate

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

func (RegulatoryComplianceAssessmentOperationPredicate) Matches

type RegulatoryComplianceAssessmentProperties

type RegulatoryComplianceAssessmentProperties struct {
	AssessmentDetailsLink *string `json:"assessmentDetailsLink,omitempty"`
	AssessmentType        *string `json:"assessmentType,omitempty"`
	Description           *string `json:"description,omitempty"`
	FailedResources       *int64  `json:"failedResources,omitempty"`
	PassedResources       *int64  `json:"passedResources,omitempty"`
	SkippedResources      *int64  `json:"skippedResources,omitempty"`
	State                 *State  `json:"state,omitempty"`
	UnsupportedResources  *int64  `json:"unsupportedResources,omitempty"`
}

type RegulatoryComplianceClient

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

func NewRegulatoryComplianceClientWithBaseURI

func NewRegulatoryComplianceClientWithBaseURI(endpoint string) RegulatoryComplianceClient

func (RegulatoryComplianceClient) AssessmentsGet

AssessmentsGet ...

func (RegulatoryComplianceClient) AssessmentsList

AssessmentsList ...

func (RegulatoryComplianceClient) AssessmentsListComplete

AssessmentsListComplete retrieves all of the results into a single object

func (RegulatoryComplianceClient) AssessmentsListCompleteMatchingPredicate

AssessmentsListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (RegulatoryComplianceClient) ControlsGet

ControlsGet ...

func (RegulatoryComplianceClient) ControlsList

ControlsList ...

func (RegulatoryComplianceClient) ControlsListComplete

ControlsListComplete retrieves all of the results into a single object

func (RegulatoryComplianceClient) ControlsListCompleteMatchingPredicate

ControlsListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (RegulatoryComplianceClient) StandardsGet

StandardsGet ...

func (RegulatoryComplianceClient) StandardsList

StandardsList ...

func (RegulatoryComplianceClient) StandardsListComplete

StandardsListComplete retrieves all of the results into a single object

func (RegulatoryComplianceClient) StandardsListCompleteMatchingPredicate

StandardsListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type RegulatoryComplianceControl

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

type RegulatoryComplianceControlId

type RegulatoryComplianceControlId struct {
	SubscriptionId                   string
	RegulatoryComplianceStandardName string
	RegulatoryComplianceControlName  string
}

RegulatoryComplianceControlId is a struct representing the Resource ID for a Regulatory Compliance Control

func NewRegulatoryComplianceControlID

func NewRegulatoryComplianceControlID(subscriptionId string, regulatoryComplianceStandardName string, regulatoryComplianceControlName string) RegulatoryComplianceControlId

NewRegulatoryComplianceControlID returns a new RegulatoryComplianceControlId struct

func ParseRegulatoryComplianceControlID

func ParseRegulatoryComplianceControlID(input string) (*RegulatoryComplianceControlId, error)

ParseRegulatoryComplianceControlID parses 'input' into a RegulatoryComplianceControlId

func ParseRegulatoryComplianceControlIDInsensitively

func ParseRegulatoryComplianceControlIDInsensitively(input string) (*RegulatoryComplianceControlId, error)

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

func (RegulatoryComplianceControlId) ID

ID returns the formatted Regulatory Compliance Control ID

func (RegulatoryComplianceControlId) Segments

Segments returns a slice of Resource ID Segments which comprise this Regulatory Compliance Control ID

func (RegulatoryComplianceControlId) String

String returns a human-readable description of this Regulatory Compliance Control ID

type RegulatoryComplianceControlOperationPredicate

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

func (RegulatoryComplianceControlOperationPredicate) Matches

type RegulatoryComplianceControlProperties

type RegulatoryComplianceControlProperties struct {
	Description        *string `json:"description,omitempty"`
	FailedAssessments  *int64  `json:"failedAssessments,omitempty"`
	PassedAssessments  *int64  `json:"passedAssessments,omitempty"`
	SkippedAssessments *int64  `json:"skippedAssessments,omitempty"`
	State              *State  `json:"state,omitempty"`
}

type RegulatoryComplianceStandard

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

type RegulatoryComplianceStandardId

type RegulatoryComplianceStandardId struct {
	SubscriptionId                   string
	RegulatoryComplianceStandardName string
}

RegulatoryComplianceStandardId is a struct representing the Resource ID for a Regulatory Compliance Standard

func NewRegulatoryComplianceStandardID

func NewRegulatoryComplianceStandardID(subscriptionId string, regulatoryComplianceStandardName string) RegulatoryComplianceStandardId

NewRegulatoryComplianceStandardID returns a new RegulatoryComplianceStandardId struct

func ParseRegulatoryComplianceStandardID

func ParseRegulatoryComplianceStandardID(input string) (*RegulatoryComplianceStandardId, error)

ParseRegulatoryComplianceStandardID parses 'input' into a RegulatoryComplianceStandardId

func ParseRegulatoryComplianceStandardIDInsensitively

func ParseRegulatoryComplianceStandardIDInsensitively(input string) (*RegulatoryComplianceStandardId, error)

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

func (RegulatoryComplianceStandardId) ID

ID returns the formatted Regulatory Compliance Standard ID

func (RegulatoryComplianceStandardId) Segments

Segments returns a slice of Resource ID Segments which comprise this Regulatory Compliance Standard ID

func (RegulatoryComplianceStandardId) String

String returns a human-readable description of this Regulatory Compliance Standard ID

type RegulatoryComplianceStandardOperationPredicate

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

func (RegulatoryComplianceStandardOperationPredicate) Matches

type RegulatoryComplianceStandardProperties

type RegulatoryComplianceStandardProperties struct {
	FailedControls      *int64 `json:"failedControls,omitempty"`
	PassedControls      *int64 `json:"passedControls,omitempty"`
	SkippedControls     *int64 `json:"skippedControls,omitempty"`
	State               *State `json:"state,omitempty"`
	UnsupportedControls *int64 `json:"unsupportedControls,omitempty"`
}

type StandardsGetOperationResponse

type StandardsGetOperationResponse struct {
	HttpResponse *http.Response
	Model        *RegulatoryComplianceStandard
}

type StandardsListCompleteResult

type StandardsListCompleteResult struct {
	Items []RegulatoryComplianceStandard
}

type StandardsListOperationOptions

type StandardsListOperationOptions struct {
	Filter *string
}

func DefaultStandardsListOperationOptions

func DefaultStandardsListOperationOptions() StandardsListOperationOptions

type StandardsListOperationResponse

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

func (StandardsListOperationResponse) HasMore

func (StandardsListOperationResponse) LoadMore

type State

type State string
const (
	StateFailed      State = "Failed"
	StatePassed      State = "Passed"
	StateSkipped     State = "Skipped"
	StateUnsupported State = "Unsupported"
)

Jump to

Keyboard shortcuts

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