sqlpoolsdatamaskingrules

README

github.com/hashicorp/go-azure-sdk/resource-manager/synapse/2021-06-01/sqlpoolsdatamaskingrules Documentation

The sqlpoolsdatamaskingrules SDK allows for interaction with the Azure Resource Manager Service synapse (API Version 2021-06-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/synapse/2021-06-01/sqlpoolsdatamaskingrules"

Client Initialization

client := sqlpoolsdatamaskingrules.NewSqlPoolsDataMaskingRulesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SqlPoolsDataMaskingRulesClient.DataMaskingRulesCreateOrUpdate

ctx := context.TODO()
id := sqlpoolsdatamaskingrules.NewRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "sqlPoolValue", "ruleValue")

payload := sqlpoolsdatamaskingrules.DataMaskingRule{
	// ...
}


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

Example Usage: SqlPoolsDataMaskingRulesClient.DataMaskingRulesGet

ctx := context.TODO()
id := sqlpoolsdatamaskingrules.NewRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "sqlPoolValue", "ruleValue")

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

Example Usage: SqlPoolsDataMaskingRulesClient.DataMaskingRulesListBySqlPool

ctx := context.TODO()
id := sqlpoolsdatamaskingrules.NewSqlPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "sqlPoolValue")

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

Documentation

Index

• func PossibleValuesForDataMaskingFunction() []string
• func PossibleValuesForDataMaskingRuleState() []string
• func ValidateRuleID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateSqlPoolID(input interface{}, key string) (warnings []string, errors []error)
• type DataMaskingFunction
  • func (s *DataMaskingFunction) UnmarshalJSON(bytes []byte) error
• type DataMaskingRule
• type DataMaskingRuleListResult
• type DataMaskingRuleProperties
• type DataMaskingRuleState
  • func (s *DataMaskingRuleState) UnmarshalJSON(bytes []byte) error
• type DataMaskingRulesCreateOrUpdateOperationResponse
• type DataMaskingRulesGetOperationResponse
• type DataMaskingRulesListBySqlPoolOperationResponse
• type RuleId
  • func NewRuleID(subscriptionId string, resourceGroupName string, workspaceName string, ...) RuleId
  • func ParseRuleID(input string) (*RuleId, error)
  • func ParseRuleIDInsensitively(input string) (*RuleId, error)
  • func (id *RuleId) FromParseResult(input resourceids.ParseResult) error
  • func (id RuleId) ID() string
  • func (id RuleId) Segments() []resourceids.Segment
  • func (id RuleId) String() string
• type SqlPoolId
  • func NewSqlPoolID(subscriptionId string, resourceGroupName string, workspaceName string, ...) SqlPoolId
  • func ParseSqlPoolID(input string) (*SqlPoolId, error)
  • func ParseSqlPoolIDInsensitively(input string) (*SqlPoolId, error)
  • func (id *SqlPoolId) FromParseResult(input resourceids.ParseResult) error
  • func (id SqlPoolId) ID() string
  • func (id SqlPoolId) Segments() []resourceids.Segment
  • func (id SqlPoolId) String() string
• type SqlPoolsDataMaskingRulesClient
  • func NewSqlPoolsDataMaskingRulesClientWithBaseURI(sdkApi sdkEnv.Api) (*SqlPoolsDataMaskingRulesClient, error)
  • func (c SqlPoolsDataMaskingRulesClient) DataMaskingRulesCreateOrUpdate(ctx context.Context, id RuleId, input DataMaskingRule) (result DataMaskingRulesCreateOrUpdateOperationResponse, err error)
  • func (c SqlPoolsDataMaskingRulesClient) DataMaskingRulesGet(ctx context.Context, id RuleId) (result DataMaskingRulesGetOperationResponse, err error)
  • func (c SqlPoolsDataMaskingRulesClient) DataMaskingRulesListBySqlPool(ctx context.Context, id SqlPoolId) (result DataMaskingRulesListBySqlPoolOperationResponse, err error)

Functions

func PossibleValuesForDataMaskingFunction

func PossibleValuesForDataMaskingFunction() []string

func PossibleValuesForDataMaskingRuleState

func PossibleValuesForDataMaskingRuleState() []string

func ValidateRuleID

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

ValidateRuleID checks that 'input' can be parsed as a Rule ID

func ValidateSqlPoolID

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

ValidateSqlPoolID checks that 'input' can be parsed as a Sql Pool ID

Types

type DataMaskingFunction

type DataMaskingFunction string

const (
	DataMaskingFunctionCCN     DataMaskingFunction = "CCN"
	DataMaskingFunctionDefault DataMaskingFunction = "Default"
	DataMaskingFunctionEmail   DataMaskingFunction = "Email"
	DataMaskingFunctionNumber  DataMaskingFunction = "Number"
	DataMaskingFunctionSSN     DataMaskingFunction = "SSN"
	DataMaskingFunctionText    DataMaskingFunction = "Text"
)

func (*DataMaskingFunction) UnmarshalJSON

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

type DataMaskingRule

type DataMaskingRule struct {
	Id         *string                    `json:"id,omitempty"`
	Kind       *string                    `json:"kind,omitempty"`
	Location   *string                    `json:"location,omitempty"`
	Name       *string                    `json:"name,omitempty"`
	Properties *DataMaskingRuleProperties `json:"properties,omitempty"`
	Type       *string                    `json:"type,omitempty"`
}

type DataMaskingRuleListResult

type DataMaskingRuleListResult struct {
	Value *[]DataMaskingRule `json:"value,omitempty"`
}

type DataMaskingRuleProperties

type DataMaskingRuleProperties struct {
	AliasName         *string               `json:"aliasName,omitempty"`
	ColumnName        string                `json:"columnName"`
	Id                *string               `json:"id,omitempty"`
	MaskingFunction   DataMaskingFunction   `json:"maskingFunction"`
	NumberFrom        *string               `json:"numberFrom,omitempty"`
	NumberTo          *string               `json:"numberTo,omitempty"`
	PrefixSize        *string               `json:"prefixSize,omitempty"`
	ReplacementString *string               `json:"replacementString,omitempty"`
	RuleState         *DataMaskingRuleState `json:"ruleState,omitempty"`
	SchemaName        string                `json:"schemaName"`
	SuffixSize        *string               `json:"suffixSize,omitempty"`
	TableName         string                `json:"tableName"`
}

type DataMaskingRuleState

type DataMaskingRuleState string

const (
	DataMaskingRuleStateDisabled DataMaskingRuleState = "Disabled"
	DataMaskingRuleStateEnabled  DataMaskingRuleState = "Enabled"
)

func (*DataMaskingRuleState) UnmarshalJSON

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

type DataMaskingRulesCreateOrUpdateOperationResponse

type DataMaskingRulesCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DataMaskingRule
}

type DataMaskingRulesGetOperationResponse

type DataMaskingRulesGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DataMaskingRule
}

type DataMaskingRulesListBySqlPoolOperationResponse

type DataMaskingRulesListBySqlPoolOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DataMaskingRuleListResult
}

type RuleId

type RuleId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	SqlPoolName       string
	RuleName          string
}

RuleId is a struct representing the Resource ID for a Rule

func NewRuleID

func NewRuleID(subscriptionId string, resourceGroupName string, workspaceName string, sqlPoolName string, ruleName string) RuleId

NewRuleID returns a new RuleId struct

func ParseRuleID

func ParseRuleID(input string) (*RuleId, error)

ParseRuleID parses 'input' into a RuleId

func ParseRuleIDInsensitively

func ParseRuleIDInsensitively(input string) (*RuleId, error)

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

func (*RuleId) FromParseResult

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

func (RuleId) ID

func (id RuleId) ID() string

ID returns the formatted Rule ID

func (RuleId) Segments

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

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

func (RuleId) String

func (id RuleId) String() string

String returns a human-readable description of this Rule ID

type SqlPoolId

type SqlPoolId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	SqlPoolName       string
}

SqlPoolId is a struct representing the Resource ID for a Sql Pool

func NewSqlPoolID

func NewSqlPoolID(subscriptionId string, resourceGroupName string, workspaceName string, sqlPoolName string) SqlPoolId

NewSqlPoolID returns a new SqlPoolId struct

func ParseSqlPoolID

func ParseSqlPoolID(input string) (*SqlPoolId, error)

ParseSqlPoolID parses 'input' into a SqlPoolId

func ParseSqlPoolIDInsensitively

func ParseSqlPoolIDInsensitively(input string) (*SqlPoolId, error)

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

func (*SqlPoolId) FromParseResult

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

func (SqlPoolId) ID

func (id SqlPoolId) ID() string

ID returns the formatted Sql Pool ID

func (SqlPoolId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Sql Pool ID

func (SqlPoolId) String

func (id SqlPoolId) String() string

String returns a human-readable description of this Sql Pool ID

type SqlPoolsDataMaskingRulesClient

type SqlPoolsDataMaskingRulesClient struct {
	Client *resourcemanager.Client
}

func NewSqlPoolsDataMaskingRulesClientWithBaseURI

func NewSqlPoolsDataMaskingRulesClientWithBaseURI(sdkApi sdkEnv.Api) (*SqlPoolsDataMaskingRulesClient, error)

func (SqlPoolsDataMaskingRulesClient) DataMaskingRulesCreateOrUpdate

func (c SqlPoolsDataMaskingRulesClient) DataMaskingRulesCreateOrUpdate(ctx context.Context, id RuleId, input DataMaskingRule) (result DataMaskingRulesCreateOrUpdateOperationResponse, err error)

DataMaskingRulesCreateOrUpdate ...

func (SqlPoolsDataMaskingRulesClient) DataMaskingRulesGet

func (c SqlPoolsDataMaskingRulesClient) DataMaskingRulesGet(ctx context.Context, id RuleId) (result DataMaskingRulesGetOperationResponse, err error)

DataMaskingRulesGet ...

func (SqlPoolsDataMaskingRulesClient) DataMaskingRulesListBySqlPool

func (c SqlPoolsDataMaskingRulesClient) DataMaskingRulesListBySqlPool(ctx context.Context, id SqlPoolId) (result DataMaskingRulesListBySqlPoolOperationResponse, err error)

DataMaskingRulesListBySqlPool ...