manageddatabasesecurityalertpolicies

README

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

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

Client Initialization

client := manageddatabasesecurityalertpolicies.NewManagedDatabaseSecurityAlertPoliciesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ManagedDatabaseSecurityAlertPoliciesClient.CreateOrUpdate

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

payload := manageddatabasesecurityalertpolicies.ManagedDatabaseSecurityAlertPolicy{
	// ...
}


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: ManagedDatabaseSecurityAlertPoliciesClient.Get

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

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: ManagedDatabaseSecurityAlertPoliciesClient.ListByDatabase

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

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

Documentation

Index

• func PossibleValuesForSecurityAlertPolicyState() []string
• type CreateOrUpdateOperationResponse
• type GetOperationResponse
• type ListByDatabaseCompleteResult
• type ListByDatabaseOperationResponse
• type ManagedDatabaseSecurityAlertPoliciesClient
  • func NewManagedDatabaseSecurityAlertPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*ManagedDatabaseSecurityAlertPoliciesClient, error)
  • func (c ManagedDatabaseSecurityAlertPoliciesClient) CreateOrUpdate(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId, ...) (result CreateOrUpdateOperationResponse, err error)
  • func (c ManagedDatabaseSecurityAlertPoliciesClient) Get(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId) (result GetOperationResponse, err error)
  • func (c ManagedDatabaseSecurityAlertPoliciesClient) ListByDatabase(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId) (result ListByDatabaseOperationResponse, err error)
  • func (c ManagedDatabaseSecurityAlertPoliciesClient) ListByDatabaseComplete(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId) (ListByDatabaseCompleteResult, error)
  • func (c ManagedDatabaseSecurityAlertPoliciesClient) ListByDatabaseCompleteMatchingPredicate(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId, ...) (result ListByDatabaseCompleteResult, err error)
• type ManagedDatabaseSecurityAlertPolicy
• type ManagedDatabaseSecurityAlertPolicyOperationPredicate
  • func (p ManagedDatabaseSecurityAlertPolicyOperationPredicate) Matches(input ManagedDatabaseSecurityAlertPolicy) bool
• 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

Functions

func PossibleValuesForSecurityAlertPolicyState

func PossibleValuesForSecurityAlertPolicyState() []string

Types

type CreateOrUpdateOperationResponse

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

type GetOperationResponse

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

type ListByDatabaseCompleteResult

type ListByDatabaseCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ManagedDatabaseSecurityAlertPolicy
}

type ListByDatabaseOperationResponse

type ListByDatabaseOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ManagedDatabaseSecurityAlertPolicy
}

type ManagedDatabaseSecurityAlertPoliciesClient

type ManagedDatabaseSecurityAlertPoliciesClient struct {
	Client *resourcemanager.Client
}

func NewManagedDatabaseSecurityAlertPoliciesClientWithBaseURI

func NewManagedDatabaseSecurityAlertPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*ManagedDatabaseSecurityAlertPoliciesClient, error)

func (ManagedDatabaseSecurityAlertPoliciesClient) CreateOrUpdate

func (c ManagedDatabaseSecurityAlertPoliciesClient) CreateOrUpdate(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId, input ManagedDatabaseSecurityAlertPolicy) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ManagedDatabaseSecurityAlertPoliciesClient) Get

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

Get ...

func (ManagedDatabaseSecurityAlertPoliciesClient) ListByDatabase

func (c ManagedDatabaseSecurityAlertPoliciesClient) ListByDatabase(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId) (result ListByDatabaseOperationResponse, err error)

ListByDatabase ...

func (ManagedDatabaseSecurityAlertPoliciesClient) ListByDatabaseComplete

func (c ManagedDatabaseSecurityAlertPoliciesClient) ListByDatabaseComplete(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId) (ListByDatabaseCompleteResult, error)

ListByDatabaseComplete retrieves all the results into a single object

func (ManagedDatabaseSecurityAlertPoliciesClient) ListByDatabaseCompleteMatchingPredicate

func (c ManagedDatabaseSecurityAlertPoliciesClient) ListByDatabaseCompleteMatchingPredicate(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId, predicate ManagedDatabaseSecurityAlertPolicyOperationPredicate) (result ListByDatabaseCompleteResult, err error)

ListByDatabaseCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ManagedDatabaseSecurityAlertPolicy

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

type ManagedDatabaseSecurityAlertPolicyOperationPredicate

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

func (ManagedDatabaseSecurityAlertPolicyOperationPredicate) Matches

func (p ManagedDatabaseSecurityAlertPolicyOperationPredicate) Matches(input ManagedDatabaseSecurityAlertPolicy) bool

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