managedserversecurityalertpolicies

README

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

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

Client Initialization

client := managedserversecurityalertpolicies.NewManagedServerSecurityAlertPoliciesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ManagedServerSecurityAlertPoliciesClient.CreateOrUpdate

ctx := context.TODO()
id := commonids.NewSqlManagedInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue")

payload := managedserversecurityalertpolicies.ManagedServerSecurityAlertPolicy{
	// ...
}


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

Example Usage: ManagedServerSecurityAlertPoliciesClient.Get

ctx := context.TODO()
id := commonids.NewSqlManagedInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue")

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: ManagedServerSecurityAlertPoliciesClient.ListByInstance

ctx := context.TODO()
id := commonids.NewSqlManagedInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue")

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

Documentation

Index

• func PossibleValuesForSecurityAlertsPolicyState() []string
• type CreateOrUpdateOperationResponse
• type GetOperationResponse
• type ListByInstanceCompleteResult
• type ListByInstanceCustomPager
  • func (p *ListByInstanceCustomPager) NextPageLink() *odata.Link
• type ListByInstanceOperationResponse
• type ManagedServerSecurityAlertPoliciesClient
  • func NewManagedServerSecurityAlertPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*ManagedServerSecurityAlertPoliciesClient, error)
  • func (c ManagedServerSecurityAlertPoliciesClient) CreateOrUpdate(ctx context.Context, id commonids.SqlManagedInstanceId, ...) (result CreateOrUpdateOperationResponse, err error)
  • func (c ManagedServerSecurityAlertPoliciesClient) CreateOrUpdateThenPoll(ctx context.Context, id commonids.SqlManagedInstanceId, ...) error
  • func (c ManagedServerSecurityAlertPoliciesClient) Get(ctx context.Context, id commonids.SqlManagedInstanceId) (result GetOperationResponse, err error)
  • func (c ManagedServerSecurityAlertPoliciesClient) ListByInstance(ctx context.Context, id commonids.SqlManagedInstanceId) (result ListByInstanceOperationResponse, err error)
  • func (c ManagedServerSecurityAlertPoliciesClient) ListByInstanceComplete(ctx context.Context, id commonids.SqlManagedInstanceId) (ListByInstanceCompleteResult, error)
  • func (c ManagedServerSecurityAlertPoliciesClient) ListByInstanceCompleteMatchingPredicate(ctx context.Context, id commonids.SqlManagedInstanceId, ...) (result ListByInstanceCompleteResult, err error)
• type ManagedServerSecurityAlertPolicy
• type ManagedServerSecurityAlertPolicyOperationPredicate
  • func (p ManagedServerSecurityAlertPolicyOperationPredicate) Matches(input ManagedServerSecurityAlertPolicy) bool
• 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

Functions

func PossibleValuesForSecurityAlertsPolicyState

func PossibleValuesForSecurityAlertsPolicyState() []string

Types

type CreateOrUpdateOperationResponse

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

type GetOperationResponse

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

type ListByInstanceCompleteResult

type ListByInstanceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ManagedServerSecurityAlertPolicy
}

type ListByInstanceCustomPager

type ListByInstanceCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*ListByInstanceCustomPager) NextPageLink

func (p *ListByInstanceCustomPager) NextPageLink() *odata.Link

type ListByInstanceOperationResponse

type ListByInstanceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ManagedServerSecurityAlertPolicy
}

type ManagedServerSecurityAlertPoliciesClient

type ManagedServerSecurityAlertPoliciesClient struct {
	Client *resourcemanager.Client
}

func NewManagedServerSecurityAlertPoliciesClientWithBaseURI

func NewManagedServerSecurityAlertPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*ManagedServerSecurityAlertPoliciesClient, error)

func (ManagedServerSecurityAlertPoliciesClient) CreateOrUpdate

func (c ManagedServerSecurityAlertPoliciesClient) CreateOrUpdate(ctx context.Context, id commonids.SqlManagedInstanceId, input ManagedServerSecurityAlertPolicy) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ManagedServerSecurityAlertPoliciesClient) CreateOrUpdateThenPoll

func (c ManagedServerSecurityAlertPoliciesClient) CreateOrUpdateThenPoll(ctx context.Context, id commonids.SqlManagedInstanceId, input ManagedServerSecurityAlertPolicy) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ManagedServerSecurityAlertPoliciesClient) Get

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

Get ...

func (ManagedServerSecurityAlertPoliciesClient) ListByInstance

func (c ManagedServerSecurityAlertPoliciesClient) ListByInstance(ctx context.Context, id commonids.SqlManagedInstanceId) (result ListByInstanceOperationResponse, err error)

ListByInstance ...

func (ManagedServerSecurityAlertPoliciesClient) ListByInstanceComplete

func (c ManagedServerSecurityAlertPoliciesClient) ListByInstanceComplete(ctx context.Context, id commonids.SqlManagedInstanceId) (ListByInstanceCompleteResult, error)

ListByInstanceComplete retrieves all the results into a single object

func (ManagedServerSecurityAlertPoliciesClient) ListByInstanceCompleteMatchingPredicate

func (c ManagedServerSecurityAlertPoliciesClient) ListByInstanceCompleteMatchingPredicate(ctx context.Context, id commonids.SqlManagedInstanceId, predicate ManagedServerSecurityAlertPolicyOperationPredicate) (result ListByInstanceCompleteResult, err error)

ListByInstanceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ManagedServerSecurityAlertPolicy

type ManagedServerSecurityAlertPolicy 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 ManagedServerSecurityAlertPolicyOperationPredicate

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

func (ManagedServerSecurityAlertPolicyOperationPredicate) Matches

func (p ManagedServerSecurityAlertPolicyOperationPredicate) Matches(input ManagedServerSecurityAlertPolicy) bool

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