securitysettings

package
v0.20240731.1212841 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/azurestackhci/2024-01-01/securitysettings Documentation

The securitysettings SDK allows for interaction with the Azure Resource Manager Service azurestackhci (API Version 2024-01-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/azurestackhci/2024-01-01/securitysettings"

Client Initialization

client := securitysettings.NewSecuritySettingsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SecuritySettingsClient.CreateOrUpdate

ctx := context.TODO()
id := securitysettings.NewSecuritySettingID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue", "securitySettingValue")

payload := securitysettings.SecuritySetting{
	// ...
}


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

Example Usage: SecuritySettingsClient.Delete

ctx := context.TODO()
id := securitysettings.NewSecuritySettingID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue", "securitySettingValue")

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

Example Usage: SecuritySettingsClient.Get

ctx := context.TODO()
id := securitysettings.NewSecuritySettingID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue", "securitySettingValue")

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: SecuritySettingsClient.ListByClusters

ctx := context.TODO()
id := securitysettings.NewClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue")

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

func PossibleValuesForComplianceAssignmentType() []string

func PossibleValuesForComplianceStatus 

func PossibleValuesForComplianceStatus() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateClusterID 

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

ValidateClusterID checks that 'input' can be parsed as a Cluster ID

func ValidateSecuritySettingID 

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

ValidateSecuritySettingID checks that 'input' can be parsed as a Security Setting ID

Types

type ClusterId 

type ClusterId struct {
	SubscriptionId    string
	ResourceGroupName string
	ClusterName       string
}

ClusterId is a struct representing the Resource ID for a Cluster

func NewClusterID 

func NewClusterID(subscriptionId string, resourceGroupName string, clusterName string) ClusterId

NewClusterID returns a new ClusterId struct

func ParseClusterID 

func ParseClusterID(input string) (*ClusterId, error)

ParseClusterID parses 'input' into a ClusterId

func ParseClusterIDInsensitively 

func ParseClusterIDInsensitively(input string) (*ClusterId, error)

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

func (*ClusterId) FromParseResult 

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

func (ClusterId) ID 

func (id ClusterId) ID() string

ID returns the formatted Cluster ID

func (ClusterId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Cluster ID

func (ClusterId) String 

func (id ClusterId) String() string

String returns a human-readable description of this Cluster ID

type ComplianceAssignmentType 

type ComplianceAssignmentType string
const (
	ComplianceAssignmentTypeApplyAndAutoCorrect ComplianceAssignmentType = "ApplyAndAutoCorrect"
	ComplianceAssignmentTypeAudit               ComplianceAssignmentType = "Audit"
)

func (*ComplianceAssignmentType) UnmarshalJSON 

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

type ComplianceStatus 

type ComplianceStatus string
const (
	ComplianceStatusCompliant    ComplianceStatus = "Compliant"
	ComplianceStatusNonCompliant ComplianceStatus = "NonCompliant"
	ComplianceStatusPending      ComplianceStatus = "Pending"
)

func (*ComplianceStatus) UnmarshalJSON 

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

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SecuritySetting
}

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListByClustersCompleteResult 

type ListByClustersCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SecuritySetting
}

type ListByClustersCustomPager added in v0.20240628.1153531 

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

type ListByClustersOperationResponse 

type ListByClustersOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SecuritySetting
}

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted     ProvisioningState = "Accepted"
	ProvisioningStateCanceled     ProvisioningState = "Canceled"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateProvisioning ProvisioningState = "Provisioning"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
	ProvisioningStateUpdating     ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

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

type SecurityComplianceStatus 

type SecurityComplianceStatus struct {
	DataAtRestEncrypted    *ComplianceStatus `json:"dataAtRestEncrypted,omitempty"`
	DataInTransitProtected *ComplianceStatus `json:"dataInTransitProtected,omitempty"`
	LastUpdated            *string           `json:"lastUpdated,omitempty"`
	SecuredCoreCompliance  *ComplianceStatus `json:"securedCoreCompliance,omitempty"`
	WdacCompliance         *ComplianceStatus `json:"wdacCompliance,omitempty"`
}

func (*SecurityComplianceStatus) GetLastUpdatedAsTime 

func (o *SecurityComplianceStatus) GetLastUpdatedAsTime() (*time.Time, error)

func (*SecurityComplianceStatus) SetLastUpdatedAsTime 

func (o *SecurityComplianceStatus) SetLastUpdatedAsTime(input time.Time)

type SecurityProperties 

type SecurityProperties struct {
	ProvisioningState               *ProvisioningState        `json:"provisioningState,omitempty"`
	SecuredCoreComplianceAssignment *ComplianceAssignmentType `json:"securedCoreComplianceAssignment,omitempty"`
	SecurityComplianceStatus        *SecurityComplianceStatus `json:"securityComplianceStatus,omitempty"`
}

type SecuritySetting 

type SecuritySetting struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *SecurityProperties    `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type SecuritySettingId 

type SecuritySettingId struct {
	SubscriptionId      string
	ResourceGroupName   string
	ClusterName         string
	SecuritySettingName string
}

SecuritySettingId is a struct representing the Resource ID for a Security Setting

func NewSecuritySettingID 

func NewSecuritySettingID(subscriptionId string, resourceGroupName string, clusterName string, securitySettingName string) SecuritySettingId

NewSecuritySettingID returns a new SecuritySettingId struct

func ParseSecuritySettingID 

func ParseSecuritySettingID(input string) (*SecuritySettingId, error)

ParseSecuritySettingID parses 'input' into a SecuritySettingId

func ParseSecuritySettingIDInsensitively 

func ParseSecuritySettingIDInsensitively(input string) (*SecuritySettingId, error)

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

func (*SecuritySettingId) FromParseResult 

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

func (SecuritySettingId) ID 

func (id SecuritySettingId) ID() string

ID returns the formatted Security Setting ID

func (SecuritySettingId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Security Setting ID

func (SecuritySettingId) String 

func (id SecuritySettingId) String() string

String returns a human-readable description of this Security Setting ID

type SecuritySettingOperationPredicate 

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

func (SecuritySettingOperationPredicate) Matches 

func (p SecuritySettingOperationPredicate) Matches(input SecuritySetting) bool

type SecuritySettingsClient 

type SecuritySettingsClient struct {
	Client *resourcemanager.Client
}

func NewSecuritySettingsClientWithBaseURI 

func NewSecuritySettingsClientWithBaseURI(sdkApi sdkEnv.Api) (*SecuritySettingsClient, error)

func (SecuritySettingsClient) CreateOrUpdate 

func (c SecuritySettingsClient) CreateOrUpdate(ctx context.Context, id SecuritySettingId, input SecuritySetting) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (SecuritySettingsClient) CreateOrUpdateThenPoll 

func (c SecuritySettingsClient) CreateOrUpdateThenPoll(ctx context.Context, id SecuritySettingId, input SecuritySetting) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (SecuritySettingsClient) Delete 

func (c SecuritySettingsClient) Delete(ctx context.Context, id SecuritySettingId) (result DeleteOperationResponse, err error)

Delete ...

func (SecuritySettingsClient) DeleteThenPoll 

func (c SecuritySettingsClient) DeleteThenPoll(ctx context.Context, id SecuritySettingId) error

DeleteThenPoll performs Delete then polls until it's completed

func (SecuritySettingsClient) Get 

func (c SecuritySettingsClient) Get(ctx context.Context, id SecuritySettingId) (result GetOperationResponse, err error)

Get ...

func (SecuritySettingsClient) ListByClusters 

func (c SecuritySettingsClient) ListByClusters(ctx context.Context, id ClusterId) (result ListByClustersOperationResponse, err error)

ListByClusters ...

func (SecuritySettingsClient) ListByClustersComplete 

func (c SecuritySettingsClient) ListByClustersComplete(ctx context.Context, id ClusterId) (ListByClustersCompleteResult, error)

ListByClustersComplete retrieves all the results into a single object

func (SecuritySettingsClient) ListByClustersCompleteMatchingPredicate 

func (c SecuritySettingsClient) ListByClustersCompleteMatchingPredicate(ctx context.Context, id ClusterId, predicate SecuritySettingOperationPredicate) (result ListByClustersCompleteResult, err error)

ListByClustersCompleteMatchingPredicate retrieves all the results and then applies the predicate

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.