disasterrecoveryconfigs

package
v0.20221013.1040645 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 13, 2022 License: MPL-2.0 Imports: 9 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/servicebus/2021-06-01-preview/disasterrecoveryconfigs Documentation

The disasterrecoveryconfigs SDK allows for interaction with the Azure Resource Manager Service servicebus (API Version 2021-06-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/servicebus/2021-06-01-preview/disasterrecoveryconfigs"

Client Initialization

client := disasterrecoveryconfigs.NewDisasterRecoveryConfigsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DisasterRecoveryConfigsClient.BreakPairing

ctx := context.TODO()
id := disasterrecoveryconfigs.NewDisasterRecoveryConfigID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "aliasValue")

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

Example Usage: DisasterRecoveryConfigsClient.CheckNameAvailability

ctx := context.TODO()
id := disasterrecoveryconfigs.NewNamespaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue")

payload := disasterrecoveryconfigs.CheckNameAvailability{
	// ...
}


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

Example Usage: DisasterRecoveryConfigsClient.CreateOrUpdate

ctx := context.TODO()
id := disasterrecoveryconfigs.NewDisasterRecoveryConfigID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "aliasValue")

payload := disasterrecoveryconfigs.ArmDisasterRecovery{
	// ...
}


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: DisasterRecoveryConfigsClient.Delete

ctx := context.TODO()
id := disasterrecoveryconfigs.NewDisasterRecoveryConfigID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "aliasValue")

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

Example Usage: DisasterRecoveryConfigsClient.FailOver

ctx := context.TODO()
id := disasterrecoveryconfigs.NewDisasterRecoveryConfigID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "aliasValue")

payload := disasterrecoveryconfigs.FailoverProperties{
	// ...
}


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

Example Usage: DisasterRecoveryConfigsClient.Get

ctx := context.TODO()
id := disasterrecoveryconfigs.NewDisasterRecoveryConfigID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "aliasValue")

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: DisasterRecoveryConfigsClient.GetAuthorizationRule

ctx := context.TODO()
id := disasterrecoveryconfigs.NewAuthorizationRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "authorizationRuleValue")

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

Example Usage: DisasterRecoveryConfigsClient.List

ctx := context.TODO()
id := disasterrecoveryconfigs.NewNamespaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue")

// 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
}

Example Usage: DisasterRecoveryConfigsClient.ListAuthorizationRules

ctx := context.TODO()
id := disasterrecoveryconfigs.NewDisasterRecoveryConfigID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "aliasValue")

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

Example Usage: DisasterRecoveryConfigsClient.ListKeys

ctx := context.TODO()
id := disasterrecoveryconfigs.NewAuthorizationRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "authorizationRuleValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAccessRights 

func PossibleValuesForAccessRights() []string

func PossibleValuesForProvisioningStateDR 

func PossibleValuesForProvisioningStateDR() []string

func PossibleValuesForRoleDisasterRecovery 

func PossibleValuesForRoleDisasterRecovery() []string

func PossibleValuesForUnavailableReason 

func PossibleValuesForUnavailableReason() []string

func ValidateAuthorizationRuleID added in v0.20220624.1152631 

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

ValidateAuthorizationRuleID checks that 'input' can be parsed as a Authorization Rule ID

func ValidateDisasterRecoveryConfigID 

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

ValidateDisasterRecoveryConfigID checks that 'input' can be parsed as a Disaster Recovery Config ID

func ValidateNamespaceID 

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

ValidateNamespaceID checks that 'input' can be parsed as a Namespace ID

Types

type AccessKeys 

type AccessKeys struct {
	AliasPrimaryConnectionString   *string `json:"aliasPrimaryConnectionString,omitempty"`
	AliasSecondaryConnectionString *string `json:"aliasSecondaryConnectionString,omitempty"`
	KeyName                        *string `json:"keyName,omitempty"`
	PrimaryConnectionString        *string `json:"primaryConnectionString,omitempty"`
	PrimaryKey                     *string `json:"primaryKey,omitempty"`
	SecondaryConnectionString      *string `json:"secondaryConnectionString,omitempty"`
	SecondaryKey                   *string `json:"secondaryKey,omitempty"`
}

type AccessRights 

type AccessRights string
const (
	AccessRightsListen AccessRights = "Listen"
	AccessRightsManage AccessRights = "Manage"
	AccessRightsSend   AccessRights = "Send"
)

type ArmDisasterRecovery 

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

type ArmDisasterRecoveryOperationPredicate 

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

func (ArmDisasterRecoveryOperationPredicate) Matches 

func (p ArmDisasterRecoveryOperationPredicate) Matches(input ArmDisasterRecovery) bool

type ArmDisasterRecoveryProperties 

type ArmDisasterRecoveryProperties struct {
	AlternateName                     *string               `json:"alternateName,omitempty"`
	PartnerNamespace                  *string               `json:"partnerNamespace,omitempty"`
	PendingReplicationOperationsCount *int64                `json:"pendingReplicationOperationsCount,omitempty"`
	ProvisioningState                 *ProvisioningStateDR  `json:"provisioningState,omitempty"`
	Role                              *RoleDisasterRecovery `json:"role,omitempty"`
}

type AuthorizationRuleId added in v0.20220624.1152631 

type AuthorizationRuleId struct {
	SubscriptionId        string
	ResourceGroupName     string
	NamespaceName         string
	AuthorizationRuleName string
}

AuthorizationRuleId is a struct representing the Resource ID for a Authorization Rule

func NewAuthorizationRuleID added in v0.20220624.1152631 

func NewAuthorizationRuleID(subscriptionId string, resourceGroupName string, namespaceName string, authorizationRuleName string) AuthorizationRuleId

NewAuthorizationRuleID returns a new AuthorizationRuleId struct

func ParseAuthorizationRuleID added in v0.20220624.1152631 

func ParseAuthorizationRuleID(input string) (*AuthorizationRuleId, error)

ParseAuthorizationRuleID parses 'input' into a AuthorizationRuleId

func ParseAuthorizationRuleIDInsensitively added in v0.20220624.1152631 

func ParseAuthorizationRuleIDInsensitively(input string) (*AuthorizationRuleId, error)

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

func (AuthorizationRuleId) ID added in v0.20220624.1152631 

func (id AuthorizationRuleId) ID() string

ID returns the formatted Authorization Rule ID

func (AuthorizationRuleId) Segments added in v0.20220624.1152631 

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

Segments returns a slice of Resource ID Segments which comprise this Authorization Rule ID

func (AuthorizationRuleId) String added in v0.20220624.1152631 

func (id AuthorizationRuleId) String() string

String returns a human-readable description of this Authorization Rule ID

type BreakPairingOperationResponse 

type BreakPairingOperationResponse struct {
	HttpResponse *http.Response
}

type CheckNameAvailability 

type CheckNameAvailability struct {
	Name string `json:"name"`
}

type CheckNameAvailabilityOperationResponse 

type CheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	Model        *CheckNameAvailabilityResult
}

type CheckNameAvailabilityResult 

type CheckNameAvailabilityResult struct {
	Message       *string            `json:"message,omitempty"`
	NameAvailable *bool              `json:"nameAvailable,omitempty"`
	Reason        *UnavailableReason `json:"reason,omitempty"`
}

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *ArmDisasterRecovery
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

type DisasterRecoveryConfigId 

type DisasterRecoveryConfigId struct {
	SubscriptionId    string
	ResourceGroupName string
	NamespaceName     string
	Alias             string
}

DisasterRecoveryConfigId is a struct representing the Resource ID for a Disaster Recovery Config

func NewDisasterRecoveryConfigID 

func NewDisasterRecoveryConfigID(subscriptionId string, resourceGroupName string, namespaceName string, alias string) DisasterRecoveryConfigId

NewDisasterRecoveryConfigID returns a new DisasterRecoveryConfigId struct

func ParseDisasterRecoveryConfigID 

func ParseDisasterRecoveryConfigID(input string) (*DisasterRecoveryConfigId, error)

ParseDisasterRecoveryConfigID parses 'input' into a DisasterRecoveryConfigId

func ParseDisasterRecoveryConfigIDInsensitively 

func ParseDisasterRecoveryConfigIDInsensitively(input string) (*DisasterRecoveryConfigId, error)

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

func (DisasterRecoveryConfigId) ID 

func (id DisasterRecoveryConfigId) ID() string

ID returns the formatted Disaster Recovery Config ID

func (DisasterRecoveryConfigId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Disaster Recovery Config ID

func (DisasterRecoveryConfigId) String 

func (id DisasterRecoveryConfigId) String() string

String returns a human-readable description of this Disaster Recovery Config ID

type DisasterRecoveryConfigsClient 

type DisasterRecoveryConfigsClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewDisasterRecoveryConfigsClientWithBaseURI 

func NewDisasterRecoveryConfigsClientWithBaseURI(endpoint string) DisasterRecoveryConfigsClient

func (DisasterRecoveryConfigsClient) BreakPairing 

func (c DisasterRecoveryConfigsClient) BreakPairing(ctx context.Context, id DisasterRecoveryConfigId) (result BreakPairingOperationResponse, err error)

BreakPairing ...

func (DisasterRecoveryConfigsClient) CheckNameAvailability 

func (c DisasterRecoveryConfigsClient) CheckNameAvailability(ctx context.Context, id NamespaceId, input CheckNameAvailability) (result CheckNameAvailabilityOperationResponse, err error)

CheckNameAvailability ...

func (DisasterRecoveryConfigsClient) CreateOrUpdate 

func (c DisasterRecoveryConfigsClient) CreateOrUpdate(ctx context.Context, id DisasterRecoveryConfigId, input ArmDisasterRecovery) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (DisasterRecoveryConfigsClient) Delete 

func (c DisasterRecoveryConfigsClient) Delete(ctx context.Context, id DisasterRecoveryConfigId) (result DeleteOperationResponse, err error)

Delete ...

func (DisasterRecoveryConfigsClient) FailOver 

func (c DisasterRecoveryConfigsClient) FailOver(ctx context.Context, id DisasterRecoveryConfigId, input FailoverProperties) (result FailOverOperationResponse, err error)

FailOver ...

func (DisasterRecoveryConfigsClient) Get 

func (c DisasterRecoveryConfigsClient) Get(ctx context.Context, id DisasterRecoveryConfigId) (result GetOperationResponse, err error)

Get ...

func (DisasterRecoveryConfigsClient) GetAuthorizationRule 

func (c DisasterRecoveryConfigsClient) GetAuthorizationRule(ctx context.Context, id AuthorizationRuleId) (result GetAuthorizationRuleOperationResponse, err error)

GetAuthorizationRule ...

func (DisasterRecoveryConfigsClient) List 

func (c DisasterRecoveryConfigsClient) List(ctx context.Context, id NamespaceId) (resp ListOperationResponse, err error)

List ...

func (DisasterRecoveryConfigsClient) ListAuthorizationRules 

func (c DisasterRecoveryConfigsClient) ListAuthorizationRules(ctx context.Context, id DisasterRecoveryConfigId) (resp ListAuthorizationRulesOperationResponse, err error)

ListAuthorizationRules ...

func (DisasterRecoveryConfigsClient) ListAuthorizationRulesComplete 

func (c DisasterRecoveryConfigsClient) ListAuthorizationRulesComplete(ctx context.Context, id DisasterRecoveryConfigId) (ListAuthorizationRulesCompleteResult, error)

ListAuthorizationRulesComplete retrieves all of the results into a single object

func (DisasterRecoveryConfigsClient) ListAuthorizationRulesCompleteMatchingPredicate 

func (c DisasterRecoveryConfigsClient) ListAuthorizationRulesCompleteMatchingPredicate(ctx context.Context, id DisasterRecoveryConfigId, predicate SBAuthorizationRuleOperationPredicate) (resp ListAuthorizationRulesCompleteResult, err error)

ListAuthorizationRulesCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (DisasterRecoveryConfigsClient) ListComplete 

func (c DisasterRecoveryConfigsClient) ListComplete(ctx context.Context, id NamespaceId) (ListCompleteResult, error)

ListComplete retrieves all of the results into a single object

func (DisasterRecoveryConfigsClient) ListCompleteMatchingPredicate 

func (c DisasterRecoveryConfigsClient) ListCompleteMatchingPredicate(ctx context.Context, id NamespaceId, predicate ArmDisasterRecoveryOperationPredicate) (resp ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (DisasterRecoveryConfigsClient) ListKeys 

func (c DisasterRecoveryConfigsClient) ListKeys(ctx context.Context, id AuthorizationRuleId) (result ListKeysOperationResponse, err error)

ListKeys ...

type FailOverOperationResponse 

type FailOverOperationResponse struct {
	HttpResponse *http.Response
}

type FailoverProperties 

type FailoverProperties struct {
	Properties *FailoverPropertiesProperties `json:"properties,omitempty"`
}

type FailoverPropertiesProperties 

type FailoverPropertiesProperties struct {
	IsSafeFailover *bool `json:"IsSafeFailover,omitempty"`
}

type GetAuthorizationRuleOperationResponse 

type GetAuthorizationRuleOperationResponse struct {
	HttpResponse *http.Response
	Model        *SBAuthorizationRule
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *ArmDisasterRecovery
}

type ListAuthorizationRulesCompleteResult 

type ListAuthorizationRulesCompleteResult struct {
	Items []SBAuthorizationRule
}

type ListAuthorizationRulesOperationResponse 

type ListAuthorizationRulesOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]SBAuthorizationRule
	// contains filtered or unexported fields
}

func (ListAuthorizationRulesOperationResponse) HasMore 

func (r ListAuthorizationRulesOperationResponse) HasMore() bool

func (ListAuthorizationRulesOperationResponse) LoadMore 

func (r ListAuthorizationRulesOperationResponse) LoadMore(ctx context.Context) (resp ListAuthorizationRulesOperationResponse, err error)

type ListCompleteResult 

type ListCompleteResult struct {
	Items []ArmDisasterRecovery
}

type ListKeysOperationResponse 

type ListKeysOperationResponse struct {
	HttpResponse *http.Response
	Model        *AccessKeys
}

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]ArmDisasterRecovery
	// contains filtered or unexported fields
}

func (ListOperationResponse) HasMore 

func (r ListOperationResponse) HasMore() bool

func (ListOperationResponse) LoadMore 

func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err error)

type NamespaceId 

type NamespaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	NamespaceName     string
}

NamespaceId is a struct representing the Resource ID for a Namespace

func NewNamespaceID 

func NewNamespaceID(subscriptionId string, resourceGroupName string, namespaceName string) NamespaceId

NewNamespaceID returns a new NamespaceId struct

func ParseNamespaceID 

func ParseNamespaceID(input string) (*NamespaceId, error)

ParseNamespaceID parses 'input' into a NamespaceId

func ParseNamespaceIDInsensitively 

func ParseNamespaceIDInsensitively(input string) (*NamespaceId, error)

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

func (NamespaceId) ID 

func (id NamespaceId) ID() string

ID returns the formatted Namespace ID

func (NamespaceId) Segments 

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

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

func (NamespaceId) String 

func (id NamespaceId) String() string

String returns a human-readable description of this Namespace ID

type ProvisioningStateDR 

type ProvisioningStateDR string
const (
	ProvisioningStateDRAccepted  ProvisioningStateDR = "Accepted"
	ProvisioningStateDRFailed    ProvisioningStateDR = "Failed"
	ProvisioningStateDRSucceeded ProvisioningStateDR = "Succeeded"
)

type RoleDisasterRecovery 

type RoleDisasterRecovery string
const (
	RoleDisasterRecoveryPrimary               RoleDisasterRecovery = "Primary"
	RoleDisasterRecoveryPrimaryNotReplicating RoleDisasterRecovery = "PrimaryNotReplicating"
	RoleDisasterRecoverySecondary             RoleDisasterRecovery = "Secondary"
)

type SBAuthorizationRule 

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

type SBAuthorizationRuleOperationPredicate 

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

func (SBAuthorizationRuleOperationPredicate) Matches 

func (p SBAuthorizationRuleOperationPredicate) Matches(input SBAuthorizationRule) bool

type SBAuthorizationRuleProperties 

type SBAuthorizationRuleProperties struct {
	Rights []AccessRights `json:"rights"`
}

type UnavailableReason 

type UnavailableReason string
const (
	UnavailableReasonInvalidName                           UnavailableReason = "InvalidName"
	UnavailableReasonNameInLockdown                        UnavailableReason = "NameInLockdown"
	UnavailableReasonNameInUse                             UnavailableReason = "NameInUse"
	UnavailableReasonNone                                  UnavailableReason = "None"
	UnavailableReasonSubscriptionIsDisabled                UnavailableReason = "SubscriptionIsDisabled"
	UnavailableReasonTooManyNamespaceInCurrentSubscription UnavailableReason = "TooManyNamespaceInCurrentSubscription"
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.