disasterrecoveryconfigs

package
v0.20240524.1090207 Latest Latest
Warning

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

Go to latest
Published: May 24, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/eventhub/2024-01-01/disasterrecoveryconfigs Documentation

The disasterrecoveryconfigs SDK allows for interaction with the Azure Resource Manager Service eventhub (API Version 2024-01-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/eventhub/2024-01-01/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", "disasterRecoveryConfigValue")

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.CreateOrUpdate

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

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", "disasterRecoveryConfigValue")

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", "disasterRecoveryConfigValue")

read, err := client.FailOver(ctx, id)
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", "disasterRecoveryConfigValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForProvisioningStateDR

func PossibleValuesForProvisioningStateDR() []string

func PossibleValuesForRoleDisasterRecovery

func PossibleValuesForRoleDisasterRecovery() []string

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 ArmDisasterRecovery

type ArmDisasterRecovery struct {
	Id         *string                        `json:"id,omitempty"`
	Location   *string                        `json:"location,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
	Location *string
	Name     *string
	Type     *string
}

func (ArmDisasterRecoveryOperationPredicate) Matches

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 BreakPairingOperationResponse

type BreakPairingOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type DisasterRecoveryConfigId

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

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

func NewDisasterRecoveryConfigID

func NewDisasterRecoveryConfigID(subscriptionId string, resourceGroupName string, namespaceName string, disasterRecoveryConfigName 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) FromParseResult

func (id *DisasterRecoveryConfigId) FromParseResult(input resourceids.ParseResult) error

func (DisasterRecoveryConfigId) ID

ID returns the formatted Disaster Recovery Config ID

func (DisasterRecoveryConfigId) Segments

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 *resourcemanager.Client
}

func NewDisasterRecoveryConfigsClientWithBaseURI

func NewDisasterRecoveryConfigsClientWithBaseURI(sdkApi sdkEnv.Api) (*DisasterRecoveryConfigsClient, error)

func (DisasterRecoveryConfigsClient) BreakPairing

BreakPairing ...

func (DisasterRecoveryConfigsClient) CreateOrUpdate

CreateOrUpdate ...

func (DisasterRecoveryConfigsClient) Delete

Delete ...

func (DisasterRecoveryConfigsClient) FailOver

FailOver ...

func (DisasterRecoveryConfigsClient) Get

Get ...

func (DisasterRecoveryConfigsClient) List

List ...

func (DisasterRecoveryConfigsClient) ListComplete

ListComplete retrieves all the results into a single object

func (DisasterRecoveryConfigsClient) ListCompleteMatchingPredicate

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type FailOverOperationResponse

type FailOverOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse

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

type ListCompleteResult

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ArmDisasterRecovery
}

type ListOperationResponse

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

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) FromParseResult

func (id *NamespaceId) FromParseResult(input resourceids.ParseResult) error

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"
)

func (*ProvisioningStateDR) UnmarshalJSON

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

type RoleDisasterRecovery

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

func (*RoleDisasterRecovery) UnmarshalJSON

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL