replicationalertsettings

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservicessiterecovery/2023-02-01/replicationalertsettings Documentation

The replicationalertsettings SDK allows for interaction with the Azure Resource Manager Service recoveryservicessiterecovery (API Version 2023-02-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/recoveryservicessiterecovery/2023-02-01/replicationalertsettings"

Client Initialization

client := replicationalertsettings.NewReplicationAlertSettingsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ReplicationAlertSettingsClient.Create

ctx := context.TODO()
id := replicationalertsettings.NewReplicationAlertSettingID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "replicationAlertSettingValue")

payload := replicationalertsettings.ConfigureAlertRequest{
	// ...
}


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

Example Usage: ReplicationAlertSettingsClient.Get

ctx := context.TODO()
id := replicationalertsettings.NewReplicationAlertSettingID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "replicationAlertSettingValue")

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: ReplicationAlertSettingsClient.List

ctx := context.TODO()
id := replicationalertsettings.NewVaultID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue")

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

Documentation

Index

• func ValidateReplicationAlertSettingID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateVaultID(input interface{}, key string) (warnings []string, errors []error)
• type Alert
• type AlertOperationPredicate
  • func (p AlertOperationPredicate) Matches(input Alert) bool
• type AlertProperties
• type ConfigureAlertRequest
• type ConfigureAlertRequestProperties
• type CreateOperationResponse
• type GetOperationResponse
• type ListCompleteResult
• type ListOperationResponse
• type ReplicationAlertSettingId
  • func NewReplicationAlertSettingID(subscriptionId string, resourceGroupName string, vaultName string, ...) ReplicationAlertSettingId
  • func ParseReplicationAlertSettingID(input string) (*ReplicationAlertSettingId, error)
  • func ParseReplicationAlertSettingIDInsensitively(input string) (*ReplicationAlertSettingId, error)
  • func (id ReplicationAlertSettingId) ID() string
  • func (id ReplicationAlertSettingId) Segments() []resourceids.Segment
  • func (id ReplicationAlertSettingId) String() string
• type ReplicationAlertSettingsClient
  • func NewReplicationAlertSettingsClientWithBaseURI(sdkApi sdkEnv.Api) (*ReplicationAlertSettingsClient, error)
  • func (c ReplicationAlertSettingsClient) Create(ctx context.Context, id ReplicationAlertSettingId, input ConfigureAlertRequest) (result CreateOperationResponse, err error)
  • func (c ReplicationAlertSettingsClient) Get(ctx context.Context, id ReplicationAlertSettingId) (result GetOperationResponse, err error)
  • func (c ReplicationAlertSettingsClient) List(ctx context.Context, id VaultId) (result ListOperationResponse, err error)
  • func (c ReplicationAlertSettingsClient) ListComplete(ctx context.Context, id VaultId) (ListCompleteResult, error)
  • func (c ReplicationAlertSettingsClient) ListCompleteMatchingPredicate(ctx context.Context, id VaultId, predicate AlertOperationPredicate) (result ListCompleteResult, err error)
• type VaultId
  • func NewVaultID(subscriptionId string, resourceGroupName string, vaultName string) VaultId
  • func ParseVaultID(input string) (*VaultId, error)
  • func ParseVaultIDInsensitively(input string) (*VaultId, error)
  • func (id VaultId) ID() string
  • func (id VaultId) Segments() []resourceids.Segment
  • func (id VaultId) String() string

Functions

func ValidateReplicationAlertSettingID

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

ValidateReplicationAlertSettingID checks that 'input' can be parsed as a Replication Alert Setting ID

func ValidateVaultID

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

ValidateVaultID checks that 'input' can be parsed as a Vault ID

Types

type Alert

type Alert struct {
	Id         *string          `json:"id,omitempty"`
	Location   *string          `json:"location,omitempty"`
	Name       *string          `json:"name,omitempty"`
	Properties *AlertProperties `json:"properties,omitempty"`
	Type       *string          `json:"type,omitempty"`
}

type AlertOperationPredicate

type AlertOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (AlertOperationPredicate) Matches

func (p AlertOperationPredicate) Matches(input Alert) bool

type AlertProperties

type AlertProperties struct {
	CustomEmailAddresses *[]string `json:"customEmailAddresses,omitempty"`
	Locale               *string   `json:"locale,omitempty"`
	SendToOwners         *string   `json:"sendToOwners,omitempty"`
}

type ConfigureAlertRequest

type ConfigureAlertRequest struct {
	Properties *ConfigureAlertRequestProperties `json:"properties,omitempty"`
}

type ConfigureAlertRequestProperties

type ConfigureAlertRequestProperties struct {
	CustomEmailAddresses *[]string `json:"customEmailAddresses,omitempty"`
	Locale               *string   `json:"locale,omitempty"`
	SendToOwners         *string   `json:"sendToOwners,omitempty"`
}

type CreateOperationResponse

type CreateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Alert
}

type GetOperationResponse

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

type ListCompleteResult

type ListCompleteResult struct {
	Items []Alert
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Alert
}

type ReplicationAlertSettingId

type ReplicationAlertSettingId struct {
	SubscriptionId              string
	ResourceGroupName           string
	VaultName                   string
	ReplicationAlertSettingName string
}

ReplicationAlertSettingId is a struct representing the Resource ID for a Replication Alert Setting

func NewReplicationAlertSettingID

func NewReplicationAlertSettingID(subscriptionId string, resourceGroupName string, vaultName string, replicationAlertSettingName string) ReplicationAlertSettingId

NewReplicationAlertSettingID returns a new ReplicationAlertSettingId struct

func ParseReplicationAlertSettingID

func ParseReplicationAlertSettingID(input string) (*ReplicationAlertSettingId, error)

ParseReplicationAlertSettingID parses 'input' into a ReplicationAlertSettingId

func ParseReplicationAlertSettingIDInsensitively

func ParseReplicationAlertSettingIDInsensitively(input string) (*ReplicationAlertSettingId, error)

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

func (ReplicationAlertSettingId) ID

func (id ReplicationAlertSettingId) ID() string

ID returns the formatted Replication Alert Setting ID

func (ReplicationAlertSettingId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Replication Alert Setting ID

func (ReplicationAlertSettingId) String

func (id ReplicationAlertSettingId) String() string

String returns a human-readable description of this Replication Alert Setting ID

type ReplicationAlertSettingsClient

type ReplicationAlertSettingsClient struct {
	Client *resourcemanager.Client
}

func NewReplicationAlertSettingsClientWithBaseURI

func NewReplicationAlertSettingsClientWithBaseURI(sdkApi sdkEnv.Api) (*ReplicationAlertSettingsClient, error)

func (ReplicationAlertSettingsClient) Create

func (c ReplicationAlertSettingsClient) Create(ctx context.Context, id ReplicationAlertSettingId, input ConfigureAlertRequest) (result CreateOperationResponse, err error)

Create ...

func (ReplicationAlertSettingsClient) Get

func (c ReplicationAlertSettingsClient) Get(ctx context.Context, id ReplicationAlertSettingId) (result GetOperationResponse, err error)

Get ...

func (ReplicationAlertSettingsClient) List

func (c ReplicationAlertSettingsClient) List(ctx context.Context, id VaultId) (result ListOperationResponse, err error)

List ...

func (ReplicationAlertSettingsClient) ListComplete

func (c ReplicationAlertSettingsClient) ListComplete(ctx context.Context, id VaultId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (ReplicationAlertSettingsClient) ListCompleteMatchingPredicate

func (c ReplicationAlertSettingsClient) ListCompleteMatchingPredicate(ctx context.Context, id VaultId, predicate AlertOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type VaultId

type VaultId struct {
	SubscriptionId    string
	ResourceGroupName string
	VaultName         string
}

VaultId is a struct representing the Resource ID for a Vault

func NewVaultID

func NewVaultID(subscriptionId string, resourceGroupName string, vaultName string) VaultId

NewVaultID returns a new VaultId struct

func ParseVaultID

func ParseVaultID(input string) (*VaultId, error)

ParseVaultID parses 'input' into a VaultId

func ParseVaultIDInsensitively

func ParseVaultIDInsensitively(input string) (*VaultId, error)

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

func (VaultId) ID

func (id VaultId) ID() string

ID returns the formatted Vault ID

func (VaultId) Segments

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

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

func (VaultId) String

func (id VaultId) String() string

String returns a human-readable description of this Vault ID