sqlpoolssecurityalertpolicies

README

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

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

Client Initialization

client := sqlpoolssecurityalertpolicies.NewSqlPoolsSecurityAlertPoliciesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SqlPoolsSecurityAlertPoliciesClient.SqlPoolSecurityAlertPoliciesCreateOrUpdate

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

payload := sqlpoolssecurityalertpolicies.SqlPoolSecurityAlertPolicy{
	// ...
}


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

Example Usage: SqlPoolsSecurityAlertPoliciesClient.SqlPoolSecurityAlertPoliciesGet

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

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

Example Usage: SqlPoolsSecurityAlertPoliciesClient.SqlPoolSecurityAlertPoliciesList

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

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

Documentation

Index

• func PossibleValuesForSecurityAlertPolicyState() []string
• func ValidateSqlPoolID(input interface{}, key string) (warnings []string, errors []error)
• type SecurityAlertPolicyProperties
  • func (o *SecurityAlertPolicyProperties) GetCreationTimeAsTime() (*time.Time, error)
  • func (o *SecurityAlertPolicyProperties) SetCreationTimeAsTime(input time.Time)
• type SecurityAlertPolicyState
  • func (s *SecurityAlertPolicyState) UnmarshalJSON(bytes []byte) error
• 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 SqlPoolSecurityAlertPoliciesCreateOrUpdateOperationResponse
• type SqlPoolSecurityAlertPoliciesGetOperationResponse
• type SqlPoolSecurityAlertPoliciesListCompleteResult
• type SqlPoolSecurityAlertPoliciesListOperationResponse
• type SqlPoolSecurityAlertPolicy
• type SqlPoolSecurityAlertPolicyOperationPredicate
  • func (p SqlPoolSecurityAlertPolicyOperationPredicate) Matches(input SqlPoolSecurityAlertPolicy) bool
• type SqlPoolsSecurityAlertPoliciesClient
  • func NewSqlPoolsSecurityAlertPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*SqlPoolsSecurityAlertPoliciesClient, error)
  • func (c SqlPoolsSecurityAlertPoliciesClient) SqlPoolSecurityAlertPoliciesCreateOrUpdate(ctx context.Context, id SqlPoolId, input SqlPoolSecurityAlertPolicy) (result SqlPoolSecurityAlertPoliciesCreateOrUpdateOperationResponse, err error)
  • func (c SqlPoolsSecurityAlertPoliciesClient) SqlPoolSecurityAlertPoliciesGet(ctx context.Context, id SqlPoolId) (result SqlPoolSecurityAlertPoliciesGetOperationResponse, err error)
  • func (c SqlPoolsSecurityAlertPoliciesClient) SqlPoolSecurityAlertPoliciesList(ctx context.Context, id SqlPoolId) (result SqlPoolSecurityAlertPoliciesListOperationResponse, err error)
  • func (c SqlPoolsSecurityAlertPoliciesClient) SqlPoolSecurityAlertPoliciesListComplete(ctx context.Context, id SqlPoolId) (SqlPoolSecurityAlertPoliciesListCompleteResult, error)
  • func (c SqlPoolsSecurityAlertPoliciesClient) SqlPoolSecurityAlertPoliciesListCompleteMatchingPredicate(ctx context.Context, id SqlPoolId, ...) (result SqlPoolSecurityAlertPoliciesListCompleteResult, err error)

Functions

func PossibleValuesForSecurityAlertPolicyState

func PossibleValuesForSecurityAlertPolicyState() []string

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 SecurityAlertPolicyProperties

type SecurityAlertPolicyProperties struct {
	CreationTime            *string                  `json:"creationTime,omitempty"`
	DisabledAlerts          *[]string                `json:"disabledAlerts,omitempty"`
	EmailAccountAdmins      *bool                    `json:"emailAccountAdmins,omitempty"`
	EmailAddresses          *[]string                `json:"emailAddresses,omitempty"`
	RetentionDays           *int64                   `json:"retentionDays,omitempty"`
	State                   SecurityAlertPolicyState `json:"state"`
	StorageAccountAccessKey *string                  `json:"storageAccountAccessKey,omitempty"`
	StorageEndpoint         *string                  `json:"storageEndpoint,omitempty"`
}

func (*SecurityAlertPolicyProperties) GetCreationTimeAsTime

func (o *SecurityAlertPolicyProperties) GetCreationTimeAsTime() (*time.Time, error)

func (*SecurityAlertPolicyProperties) SetCreationTimeAsTime

func (o *SecurityAlertPolicyProperties) SetCreationTimeAsTime(input time.Time)

type SecurityAlertPolicyState

type SecurityAlertPolicyState string

const (
	SecurityAlertPolicyStateDisabled SecurityAlertPolicyState = "Disabled"
	SecurityAlertPolicyStateEnabled  SecurityAlertPolicyState = "Enabled"
	SecurityAlertPolicyStateNew      SecurityAlertPolicyState = "New"
)

func (*SecurityAlertPolicyState) UnmarshalJSON

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

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 SqlPoolSecurityAlertPoliciesCreateOrUpdateOperationResponse

type SqlPoolSecurityAlertPoliciesCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SqlPoolSecurityAlertPolicy
}

type SqlPoolSecurityAlertPoliciesGetOperationResponse

type SqlPoolSecurityAlertPoliciesGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SqlPoolSecurityAlertPolicy
}

type SqlPoolSecurityAlertPoliciesListCompleteResult

type SqlPoolSecurityAlertPoliciesListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SqlPoolSecurityAlertPolicy
}

type SqlPoolSecurityAlertPoliciesListOperationResponse

type SqlPoolSecurityAlertPoliciesListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SqlPoolSecurityAlertPolicy
}

type SqlPoolSecurityAlertPolicy

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

type SqlPoolSecurityAlertPolicyOperationPredicate

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

func (SqlPoolSecurityAlertPolicyOperationPredicate) Matches

func (p SqlPoolSecurityAlertPolicyOperationPredicate) Matches(input SqlPoolSecurityAlertPolicy) bool

type SqlPoolsSecurityAlertPoliciesClient

type SqlPoolsSecurityAlertPoliciesClient struct {
	Client *resourcemanager.Client
}

func NewSqlPoolsSecurityAlertPoliciesClientWithBaseURI

func NewSqlPoolsSecurityAlertPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*SqlPoolsSecurityAlertPoliciesClient, error)

func (SqlPoolsSecurityAlertPoliciesClient) SqlPoolSecurityAlertPoliciesCreateOrUpdate

func (c SqlPoolsSecurityAlertPoliciesClient) SqlPoolSecurityAlertPoliciesCreateOrUpdate(ctx context.Context, id SqlPoolId, input SqlPoolSecurityAlertPolicy) (result SqlPoolSecurityAlertPoliciesCreateOrUpdateOperationResponse, err error)

SqlPoolSecurityAlertPoliciesCreateOrUpdate ...

func (SqlPoolsSecurityAlertPoliciesClient) SqlPoolSecurityAlertPoliciesGet

func (c SqlPoolsSecurityAlertPoliciesClient) SqlPoolSecurityAlertPoliciesGet(ctx context.Context, id SqlPoolId) (result SqlPoolSecurityAlertPoliciesGetOperationResponse, err error)

SqlPoolSecurityAlertPoliciesGet ...

func (SqlPoolsSecurityAlertPoliciesClient) SqlPoolSecurityAlertPoliciesList

func (c SqlPoolsSecurityAlertPoliciesClient) SqlPoolSecurityAlertPoliciesList(ctx context.Context, id SqlPoolId) (result SqlPoolSecurityAlertPoliciesListOperationResponse, err error)

SqlPoolSecurityAlertPoliciesList ...

func (SqlPoolsSecurityAlertPoliciesClient) SqlPoolSecurityAlertPoliciesListComplete

func (c SqlPoolsSecurityAlertPoliciesClient) SqlPoolSecurityAlertPoliciesListComplete(ctx context.Context, id SqlPoolId) (SqlPoolSecurityAlertPoliciesListCompleteResult, error)

SqlPoolSecurityAlertPoliciesListComplete retrieves all the results into a single object

func (SqlPoolsSecurityAlertPoliciesClient) SqlPoolSecurityAlertPoliciesListCompleteMatchingPredicate

func (c SqlPoolsSecurityAlertPoliciesClient) SqlPoolSecurityAlertPoliciesListCompleteMatchingPredicate(ctx context.Context, id SqlPoolId, predicate SqlPoolSecurityAlertPolicyOperationPredicate) (result SqlPoolSecurityAlertPoliciesListCompleteResult, err error)

SqlPoolSecurityAlertPoliciesListCompleteMatchingPredicate retrieves all the results and then applies the predicate