regulatorycompliance

package
v0.20241009.1142232 Latest Latest
Warning

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

 Go to latest Published: Oct 9, 2024 License: MPL-2.0 Imports: 12 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 Azure Resource Manager 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/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", "regulatoryComplianceStandardName", "regulatoryComplianceControlName", "regulatoryComplianceAssessmentName")

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", "regulatoryComplianceStandardName", "regulatoryComplianceControlName")

// 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", "regulatoryComplianceStandardName", "regulatoryComplianceControlName")

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

// 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", "regulatoryComplianceStandardName")

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 := commonids.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
	OData        *odata.OData
	Model        *RegulatoryComplianceAssessment
}

type AssessmentsListCompleteResult 

type AssessmentsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []RegulatoryComplianceAssessment
}

type AssessmentsListCustomPager added in v0.20240628.1153531 

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

type AssessmentsListOperationOptions 

type AssessmentsListOperationOptions struct {
	Filter *string
}

func DefaultAssessmentsListOperationOptions 

func DefaultAssessmentsListOperationOptions() AssessmentsListOperationOptions

func (AssessmentsListOperationOptions) ToHeaders added in v0.20240228.1142829 

func (o AssessmentsListOperationOptions) ToHeaders() *client.Headers

func (AssessmentsListOperationOptions) ToOData added in v0.20240228.1142829 

func (o AssessmentsListOperationOptions) ToOData() *odata.Query

func (AssessmentsListOperationOptions) ToQuery added in v0.20240228.1142829 

func (o AssessmentsListOperationOptions) ToQuery() *client.QueryParams

type AssessmentsListOperationResponse 

type AssessmentsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]RegulatoryComplianceAssessment
}

type ControlsGetOperationResponse 

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

type ControlsListCompleteResult 

type ControlsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []RegulatoryComplianceControl
}

type ControlsListCustomPager added in v0.20240628.1153531 

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

type ControlsListOperationOptions 

type ControlsListOperationOptions struct {
	Filter *string
}

func DefaultControlsListOperationOptions 

func DefaultControlsListOperationOptions() ControlsListOperationOptions

func (ControlsListOperationOptions) ToHeaders added in v0.20240228.1142829 

func (o ControlsListOperationOptions) ToHeaders() *client.Headers

func (ControlsListOperationOptions) ToOData added in v0.20240228.1142829 

func (o ControlsListOperationOptions) ToOData() *odata.Query

func (ControlsListOperationOptions) ToQuery added in v0.20240228.1142829 

func (o ControlsListOperationOptions) ToQuery() *client.QueryParams

type ControlsListOperationResponse 

type ControlsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]RegulatoryComplianceControl
}

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

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

func (RegulatoryComplianceAssessmentId) ID 

func (id RegulatoryComplianceAssessmentId) ID() string

ID returns the formatted Regulatory Compliance Assessment ID

func (RegulatoryComplianceAssessmentId) Segments 

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

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

func (RegulatoryComplianceAssessmentId) String 

func (id RegulatoryComplianceAssessmentId) String() 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 

func (p RegulatoryComplianceAssessmentOperationPredicate) Matches(input RegulatoryComplianceAssessment) bool

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 *resourcemanager.Client
}

func NewRegulatoryComplianceClientWithBaseURI 

func NewRegulatoryComplianceClientWithBaseURI(sdkApi sdkEnv.Api) (*RegulatoryComplianceClient, error)

func (RegulatoryComplianceClient) AssessmentsGet 

func (c RegulatoryComplianceClient) AssessmentsGet(ctx context.Context, id RegulatoryComplianceAssessmentId) (result AssessmentsGetOperationResponse, err error)

AssessmentsGet ...

func (RegulatoryComplianceClient) AssessmentsList 

func (c RegulatoryComplianceClient) AssessmentsList(ctx context.Context, id RegulatoryComplianceControlId, options AssessmentsListOperationOptions) (result AssessmentsListOperationResponse, err error)

AssessmentsList ...

func (RegulatoryComplianceClient) AssessmentsListComplete 

func (c RegulatoryComplianceClient) AssessmentsListComplete(ctx context.Context, id RegulatoryComplianceControlId, options AssessmentsListOperationOptions) (AssessmentsListCompleteResult, error)

AssessmentsListComplete retrieves all the results into a single object

func (RegulatoryComplianceClient) AssessmentsListCompleteMatchingPredicate 

func (c RegulatoryComplianceClient) AssessmentsListCompleteMatchingPredicate(ctx context.Context, id RegulatoryComplianceControlId, options AssessmentsListOperationOptions, predicate RegulatoryComplianceAssessmentOperationPredicate) (result AssessmentsListCompleteResult, err error)

AssessmentsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (RegulatoryComplianceClient) ControlsGet 

func (c RegulatoryComplianceClient) ControlsGet(ctx context.Context, id RegulatoryComplianceControlId) (result ControlsGetOperationResponse, err error)

ControlsGet ...

func (RegulatoryComplianceClient) ControlsList 

func (c RegulatoryComplianceClient) ControlsList(ctx context.Context, id RegulatoryComplianceStandardId, options ControlsListOperationOptions) (result ControlsListOperationResponse, err error)

ControlsList ...

func (RegulatoryComplianceClient) ControlsListComplete 

func (c RegulatoryComplianceClient) ControlsListComplete(ctx context.Context, id RegulatoryComplianceStandardId, options ControlsListOperationOptions) (ControlsListCompleteResult, error)

ControlsListComplete retrieves all the results into a single object

func (RegulatoryComplianceClient) ControlsListCompleteMatchingPredicate 

func (c RegulatoryComplianceClient) ControlsListCompleteMatchingPredicate(ctx context.Context, id RegulatoryComplianceStandardId, options ControlsListOperationOptions, predicate RegulatoryComplianceControlOperationPredicate) (result ControlsListCompleteResult, err error)

ControlsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (RegulatoryComplianceClient) StandardsGet 

func (c RegulatoryComplianceClient) StandardsGet(ctx context.Context, id RegulatoryComplianceStandardId) (result StandardsGetOperationResponse, err error)

StandardsGet ...

func (RegulatoryComplianceClient) StandardsList 

func (c RegulatoryComplianceClient) StandardsList(ctx context.Context, id commonids.SubscriptionId, options StandardsListOperationOptions) (result StandardsListOperationResponse, err error)

StandardsList ...

func (RegulatoryComplianceClient) StandardsListComplete 

func (c RegulatoryComplianceClient) StandardsListComplete(ctx context.Context, id commonids.SubscriptionId, options StandardsListOperationOptions) (StandardsListCompleteResult, error)

StandardsListComplete retrieves all the results into a single object

func (RegulatoryComplianceClient) StandardsListCompleteMatchingPredicate 

func (c RegulatoryComplianceClient) StandardsListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options StandardsListOperationOptions, predicate RegulatoryComplianceStandardOperationPredicate) (result StandardsListCompleteResult, err error)

StandardsListCompleteMatchingPredicate retrieves all the results and then applies 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) FromParseResult 

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

func (RegulatoryComplianceControlId) ID 

func (id RegulatoryComplianceControlId) ID() string

ID returns the formatted Regulatory Compliance Control ID

func (RegulatoryComplianceControlId) Segments 

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

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

func (RegulatoryComplianceControlId) String 

func (id RegulatoryComplianceControlId) String() 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 

func (p RegulatoryComplianceControlOperationPredicate) Matches(input RegulatoryComplianceControl) bool

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

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

func (RegulatoryComplianceStandardId) ID 

func (id RegulatoryComplianceStandardId) ID() string

ID returns the formatted Regulatory Compliance Standard ID

func (RegulatoryComplianceStandardId) Segments 

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

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

func (RegulatoryComplianceStandardId) String 

func (id RegulatoryComplianceStandardId) String() 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 

func (p RegulatoryComplianceStandardOperationPredicate) Matches(input RegulatoryComplianceStandard) bool

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
	OData        *odata.OData
	Model        *RegulatoryComplianceStandard
}

type StandardsListCompleteResult 

type StandardsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []RegulatoryComplianceStandard
}

type StandardsListCustomPager added in v0.20240628.1153531 

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

type StandardsListOperationOptions 

type StandardsListOperationOptions struct {
	Filter *string
}

func DefaultStandardsListOperationOptions 

func DefaultStandardsListOperationOptions() StandardsListOperationOptions

func (StandardsListOperationOptions) ToHeaders added in v0.20240228.1142829 

func (o StandardsListOperationOptions) ToHeaders() *client.Headers

func (StandardsListOperationOptions) ToOData added in v0.20240228.1142829 

func (o StandardsListOperationOptions) ToOData() *odata.Query

func (StandardsListOperationOptions) ToQuery added in v0.20240228.1142829 

func (o StandardsListOperationOptions) ToQuery() *client.QueryParams

type StandardsListOperationResponse 

type StandardsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]RegulatoryComplianceStandard
}

type State 

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

func (*State) UnmarshalJSON added in v0.20240228.1142829 

func (s *State) 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.