serversecurityalertpolicies

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2023-02-01-preview/serversecurityalertpolicies Documentation

The serversecurityalertpolicies SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2023-02-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-sdk/resource-manager/sql/2023-02-01-preview/serversecurityalertpolicies"

Client Initialization

client := serversecurityalertpolicies.NewServerSecurityAlertPoliciesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ServerSecurityAlertPoliciesClient.CreateOrUpdate

ctx := context.TODO()
id := serversecurityalertpolicies.NewSqlServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue")

payload := serversecurityalertpolicies.ServerSecurityAlertPolicy{
	// ...
}


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

Example Usage: ServerSecurityAlertPoliciesClient.Get

ctx := context.TODO()
id := serversecurityalertpolicies.NewSqlServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue")

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: ServerSecurityAlertPoliciesClient.ListByServer

ctx := context.TODO()
id := serversecurityalertpolicies.NewSqlServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue")

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

Documentation

Index

• func PossibleValuesForSecurityAlertsPolicyState() []string
• type CreateOrUpdateOperationResponse
• type GetOperationResponse
• type ListByServerCompleteResult
• type ListByServerOperationResponse
• type SecurityAlertsPolicyProperties
  • func (o *SecurityAlertsPolicyProperties) GetCreationTimeAsTime() (*time.Time, error)
  • func (o *SecurityAlertsPolicyProperties) SetCreationTimeAsTime(input time.Time)
• type SecurityAlertsPolicyState
  • func (s *SecurityAlertsPolicyState) UnmarshalJSON(bytes []byte) error
• type ServerSecurityAlertPoliciesClient
  • func NewServerSecurityAlertPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*ServerSecurityAlertPoliciesClient, error)
  • func (c ServerSecurityAlertPoliciesClient) CreateOrUpdate(ctx context.Context, id commonids.SqlServerId, input ServerSecurityAlertPolicy) (result CreateOrUpdateOperationResponse, err error)
  • func (c ServerSecurityAlertPoliciesClient) CreateOrUpdateThenPoll(ctx context.Context, id commonids.SqlServerId, input ServerSecurityAlertPolicy) error
  • func (c ServerSecurityAlertPoliciesClient) Get(ctx context.Context, id commonids.SqlServerId) (result GetOperationResponse, err error)
  • func (c ServerSecurityAlertPoliciesClient) ListByServer(ctx context.Context, id commonids.SqlServerId) (result ListByServerOperationResponse, err error)
  • func (c ServerSecurityAlertPoliciesClient) ListByServerComplete(ctx context.Context, id commonids.SqlServerId) (ListByServerCompleteResult, error)
  • func (c ServerSecurityAlertPoliciesClient) ListByServerCompleteMatchingPredicate(ctx context.Context, id commonids.SqlServerId, ...) (result ListByServerCompleteResult, err error)
• type ServerSecurityAlertPolicy
• type ServerSecurityAlertPolicyOperationPredicate
  • func (p ServerSecurityAlertPolicyOperationPredicate) Matches(input ServerSecurityAlertPolicy) bool

Functions

func PossibleValuesForSecurityAlertsPolicyState

func PossibleValuesForSecurityAlertsPolicyState() []string

Types

type CreateOrUpdateOperationResponse

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

type GetOperationResponse

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

type ListByServerCompleteResult

type ListByServerCompleteResult struct {
	Items []ServerSecurityAlertPolicy
}

type ListByServerOperationResponse

type ListByServerOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ServerSecurityAlertPolicy
}

type SecurityAlertsPolicyProperties

type SecurityAlertsPolicyProperties 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                   SecurityAlertsPolicyState `json:"state"`
	StorageAccountAccessKey *string                   `json:"storageAccountAccessKey,omitempty"`
	StorageEndpoint         *string                   `json:"storageEndpoint,omitempty"`
}

func (*SecurityAlertsPolicyProperties) GetCreationTimeAsTime

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

func (*SecurityAlertsPolicyProperties) SetCreationTimeAsTime

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

type SecurityAlertsPolicyState

type SecurityAlertsPolicyState string

const (
	SecurityAlertsPolicyStateDisabled SecurityAlertsPolicyState = "Disabled"
	SecurityAlertsPolicyStateEnabled  SecurityAlertsPolicyState = "Enabled"
)

func (*SecurityAlertsPolicyState) UnmarshalJSON

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

type ServerSecurityAlertPoliciesClient

type ServerSecurityAlertPoliciesClient struct {
	Client *resourcemanager.Client
}

func NewServerSecurityAlertPoliciesClientWithBaseURI

func NewServerSecurityAlertPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*ServerSecurityAlertPoliciesClient, error)

func (ServerSecurityAlertPoliciesClient) CreateOrUpdate

func (c ServerSecurityAlertPoliciesClient) CreateOrUpdate(ctx context.Context, id commonids.SqlServerId, input ServerSecurityAlertPolicy) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ServerSecurityAlertPoliciesClient) CreateOrUpdateThenPoll

func (c ServerSecurityAlertPoliciesClient) CreateOrUpdateThenPoll(ctx context.Context, id commonids.SqlServerId, input ServerSecurityAlertPolicy) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ServerSecurityAlertPoliciesClient) Get

func (c ServerSecurityAlertPoliciesClient) Get(ctx context.Context, id commonids.SqlServerId) (result GetOperationResponse, err error)

Get ...

func (ServerSecurityAlertPoliciesClient) ListByServer

func (c ServerSecurityAlertPoliciesClient) ListByServer(ctx context.Context, id commonids.SqlServerId) (result ListByServerOperationResponse, err error)

ListByServer ...

func (ServerSecurityAlertPoliciesClient) ListByServerComplete

func (c ServerSecurityAlertPoliciesClient) ListByServerComplete(ctx context.Context, id commonids.SqlServerId) (ListByServerCompleteResult, error)

ListByServerComplete retrieves all the results into a single object

func (ServerSecurityAlertPoliciesClient) ListByServerCompleteMatchingPredicate

func (c ServerSecurityAlertPoliciesClient) ListByServerCompleteMatchingPredicate(ctx context.Context, id commonids.SqlServerId, predicate ServerSecurityAlertPolicyOperationPredicate) (result ListByServerCompleteResult, err error)

ListByServerCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ServerSecurityAlertPolicy

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

type ServerSecurityAlertPolicyOperationPredicate

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

func (ServerSecurityAlertPolicyOperationPredicate) Matches

func (p ServerSecurityAlertPolicyOperationPredicate) Matches(input ServerSecurityAlertPolicy) bool