informationprotectionpolicies

package
v0.20240325.1113504 Latest Latest
Warning

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

 Go to latest Published: Mar 25, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/security/2017-08-01-preview/informationprotectionpolicies Documentation

The informationprotectionpolicies SDK allows for interaction with the Azure Resource Manager Service security (API Version 2017-08-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/2017-08-01-preview/informationprotectionpolicies"

Client Initialization

client := informationprotectionpolicies.NewInformationProtectionPoliciesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: InformationProtectionPoliciesClient.CreateOrUpdate

ctx := context.TODO()
id := informationprotectionpolicies.NewScopedInformationProtectionPolicyID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "custom")

payload := informationprotectionpolicies.InformationProtectionPolicy{
	// ...
}


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

Example Usage: InformationProtectionPoliciesClient.Get

ctx := context.TODO()
id := informationprotectionpolicies.NewScopedInformationProtectionPolicyID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "custom")

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: InformationProtectionPoliciesClient.List

ctx := context.TODO()
id := commonids.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

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

func PossibleValuesForInformationProtectionPolicyName() []string

func PossibleValuesForRank 

func PossibleValuesForRank() []string

func ValidateScopedInformationProtectionPolicyID 

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

ValidateScopedInformationProtectionPolicyID checks that 'input' can be parsed as a Scoped Information Protection Policy ID

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *InformationProtectionPolicy
}

type GetOperationResponse 

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

type InformationProtectionKeyword 

type InformationProtectionKeyword struct {
	CanBeNumeric *bool   `json:"canBeNumeric,omitempty"`
	Custom       *bool   `json:"custom,omitempty"`
	Excluded     *bool   `json:"excluded,omitempty"`
	Pattern      *string `json:"pattern,omitempty"`
}

type InformationProtectionPoliciesClient 

type InformationProtectionPoliciesClient struct {
	Client *resourcemanager.Client
}

func NewInformationProtectionPoliciesClientWithBaseURI 

func NewInformationProtectionPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*InformationProtectionPoliciesClient, error)

func (InformationProtectionPoliciesClient) CreateOrUpdate 

func (c InformationProtectionPoliciesClient) CreateOrUpdate(ctx context.Context, id ScopedInformationProtectionPolicyId, input InformationProtectionPolicy) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (InformationProtectionPoliciesClient) Get 

func (c InformationProtectionPoliciesClient) Get(ctx context.Context, id ScopedInformationProtectionPolicyId) (result GetOperationResponse, err error)

Get ...

func (InformationProtectionPoliciesClient) List 

func (c InformationProtectionPoliciesClient) List(ctx context.Context, id commonids.ScopeId) (result ListOperationResponse, err error)

List ...

func (InformationProtectionPoliciesClient) ListComplete 

func (c InformationProtectionPoliciesClient) ListComplete(ctx context.Context, id commonids.ScopeId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (InformationProtectionPoliciesClient) ListCompleteMatchingPredicate 

func (c InformationProtectionPoliciesClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, predicate InformationProtectionPolicyOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type InformationProtectionPolicy 

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

type InformationProtectionPolicyName 

type InformationProtectionPolicyName string
const (
	InformationProtectionPolicyNameCustom    InformationProtectionPolicyName = "custom"
	InformationProtectionPolicyNameEffective InformationProtectionPolicyName = "effective"
)

func (*InformationProtectionPolicyName) UnmarshalJSON added in v0.20240228.1142829 

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

type InformationProtectionPolicyOperationPredicate 

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

func (InformationProtectionPolicyOperationPredicate) Matches 

func (p InformationProtectionPolicyOperationPredicate) Matches(input InformationProtectionPolicy) bool

type InformationProtectionPolicyProperties 

type InformationProtectionPolicyProperties struct {
	InformationTypes *map[string]InformationType  `json:"informationTypes,omitempty"`
	Labels           *map[string]SensitivityLabel `json:"labels,omitempty"`
	LastModifiedUtc  *string                      `json:"lastModifiedUtc,omitempty"`
	Version          *string                      `json:"version,omitempty"`
}

func (*InformationProtectionPolicyProperties) GetLastModifiedUtcAsTime 

func (o *InformationProtectionPolicyProperties) GetLastModifiedUtcAsTime() (*time.Time, error)

func (*InformationProtectionPolicyProperties) SetLastModifiedUtcAsTime 

func (o *InformationProtectionPolicyProperties) SetLastModifiedUtcAsTime(input time.Time)

type InformationType 

type InformationType struct {
	Custom             *bool                           `json:"custom,omitempty"`
	Description        *string                         `json:"description,omitempty"`
	DisplayName        *string                         `json:"displayName,omitempty"`
	Enabled            *bool                           `json:"enabled,omitempty"`
	Keywords           *[]InformationProtectionKeyword `json:"keywords,omitempty"`
	Order              *int64                          `json:"order,omitempty"`
	RecommendedLabelId *string                         `json:"recommendedLabelId,omitempty"`
}

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []InformationProtectionPolicy
}

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]InformationProtectionPolicy
}

type Rank 

type Rank string
const (
	RankCritical Rank = "Critical"
	RankHigh     Rank = "High"
	RankLow      Rank = "Low"
	RankMedium   Rank = "Medium"
	RankNone     Rank = "None"
)

func (*Rank) UnmarshalJSON added in v0.20240228.1142829 

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

type ScopedInformationProtectionPolicyId 

type ScopedInformationProtectionPolicyId struct {
	Scope                           string
	InformationProtectionPolicyName InformationProtectionPolicyName
}

ScopedInformationProtectionPolicyId is a struct representing the Resource ID for a Scoped Information Protection Policy

func NewScopedInformationProtectionPolicyID 

func NewScopedInformationProtectionPolicyID(scope string, informationProtectionPolicyName InformationProtectionPolicyName) ScopedInformationProtectionPolicyId

NewScopedInformationProtectionPolicyID returns a new ScopedInformationProtectionPolicyId struct

func ParseScopedInformationProtectionPolicyID 

func ParseScopedInformationProtectionPolicyID(input string) (*ScopedInformationProtectionPolicyId, error)

ParseScopedInformationProtectionPolicyID parses 'input' into a ScopedInformationProtectionPolicyId

func ParseScopedInformationProtectionPolicyIDInsensitively 

func ParseScopedInformationProtectionPolicyIDInsensitively(input string) (*ScopedInformationProtectionPolicyId, error)

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

func (*ScopedInformationProtectionPolicyId) FromParseResult 

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

func (ScopedInformationProtectionPolicyId) ID 

func (id ScopedInformationProtectionPolicyId) ID() string

ID returns the formatted Scoped Information Protection Policy ID

func (ScopedInformationProtectionPolicyId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Scoped Information Protection Policy ID

func (ScopedInformationProtectionPolicyId) String 

func (id ScopedInformationProtectionPolicyId) String() string

String returns a human-readable description of this Scoped Information Protection Policy ID

type SensitivityLabel 

type SensitivityLabel struct {
	Description *string `json:"description,omitempty"`
	DisplayName *string `json:"displayName,omitempty"`
	Enabled     *bool   `json:"enabled,omitempty"`
	Order       *int64  `json:"order,omitempty"`
	Rank        *Rank   `json:"rank,omitempty"`
}

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.