replicationprotectioncontainers

package
v0.20240209.1123314 Latest Latest
Warning

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

 Go to latest Published: Feb 9, 2024 License: MPL-2.0 Imports: 11 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservicessiterecovery/2023-04-01/replicationprotectioncontainers Documentation

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

Client Initialization

client := replicationprotectioncontainers.NewReplicationProtectionContainersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ReplicationProtectionContainersClient.Create

ctx := context.TODO()
id := replicationprotectioncontainers.NewReplicationProtectionContainerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "replicationFabricValue", "replicationProtectionContainerValue")

payload := replicationprotectioncontainers.CreateProtectionContainerInput{
	// ...
}


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

Example Usage: ReplicationProtectionContainersClient.Delete

ctx := context.TODO()
id := replicationprotectioncontainers.NewReplicationProtectionContainerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "replicationFabricValue", "replicationProtectionContainerValue")

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

Example Usage: ReplicationProtectionContainersClient.DiscoverProtectableItem

ctx := context.TODO()
id := replicationprotectioncontainers.NewReplicationProtectionContainerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "replicationFabricValue", "replicationProtectionContainerValue")

payload := replicationprotectioncontainers.DiscoverProtectableItemRequest{
	// ...
}


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

Example Usage: ReplicationProtectionContainersClient.Get

ctx := context.TODO()
id := replicationprotectioncontainers.NewReplicationProtectionContainerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "replicationFabricValue", "replicationProtectionContainerValue")

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

ctx := context.TODO()
id := replicationprotectioncontainers.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
}

Example Usage: ReplicationProtectionContainersClient.ListByReplicationFabrics

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

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

Example Usage: ReplicationProtectionContainersClient.SwitchProtection

ctx := context.TODO()
id := replicationprotectioncontainers.NewReplicationProtectionContainerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "replicationFabricValue", "replicationProtectionContainerValue")

payload := replicationprotectioncontainers.SwitchProtectionInput{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateReplicationFabricID 

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

ValidateReplicationFabricID checks that 'input' can be parsed as a Replication Fabric ID

func ValidateReplicationProtectionContainerID 

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

ValidateReplicationProtectionContainerID checks that 'input' can be parsed as a Replication Protection Container 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 A2AContainerCreationInput 

type A2AContainerCreationInput struct {
}

func (A2AContainerCreationInput) MarshalJSON 

func (s A2AContainerCreationInput) MarshalJSON() ([]byte, error)

type A2ACrossClusterMigrationContainerCreationInput 

type A2ACrossClusterMigrationContainerCreationInput struct {
}

func (A2ACrossClusterMigrationContainerCreationInput) MarshalJSON 

func (s A2ACrossClusterMigrationContainerCreationInput) MarshalJSON() ([]byte, error)

type A2ASwitchProtectionInput 

type A2ASwitchProtectionInput struct {
	DiskEncryptionInfo                 *DiskEncryptionInfo             `json:"diskEncryptionInfo,omitempty"`
	PolicyId                           *string                         `json:"policyId,omitempty"`
	RecoveryAvailabilitySetId          *string                         `json:"recoveryAvailabilitySetId,omitempty"`
	RecoveryAvailabilityZone           *string                         `json:"recoveryAvailabilityZone,omitempty"`
	RecoveryBootDiagStorageAccountId   *string                         `json:"recoveryBootDiagStorageAccountId,omitempty"`
	RecoveryCapacityReservationGroupId *string                         `json:"recoveryCapacityReservationGroupId,omitempty"`
	RecoveryCloudServiceId             *string                         `json:"recoveryCloudServiceId,omitempty"`
	RecoveryContainerId                *string                         `json:"recoveryContainerId,omitempty"`
	RecoveryProximityPlacementGroupId  *string                         `json:"recoveryProximityPlacementGroupId,omitempty"`
	RecoveryResourceGroupId            *string                         `json:"recoveryResourceGroupId,omitempty"`
	RecoveryVirtualMachineScaleSetId   *string                         `json:"recoveryVirtualMachineScaleSetId,omitempty"`
	VMDisks                            *[]A2AVMDiskInputDetails        `json:"vmDisks,omitempty"`
	VMManagedDisks                     *[]A2AVMManagedDiskInputDetails `json:"vmManagedDisks,omitempty"`
}

func (A2ASwitchProtectionInput) MarshalJSON 

func (s A2ASwitchProtectionInput) MarshalJSON() ([]byte, error)

type A2AVMDiskInputDetails 

type A2AVMDiskInputDetails struct {
	DiskUri                             string `json:"diskUri"`
	PrimaryStagingAzureStorageAccountId string `json:"primaryStagingAzureStorageAccountId"`
	RecoveryAzureStorageAccountId       string `json:"recoveryAzureStorageAccountId"`
}

type A2AVMManagedDiskInputDetails 

type A2AVMManagedDiskInputDetails struct {
	DiskEncryptionInfo                  *DiskEncryptionInfo `json:"diskEncryptionInfo,omitempty"`
	DiskId                              string              `json:"diskId"`
	PrimaryStagingAzureStorageAccountId string              `json:"primaryStagingAzureStorageAccountId"`
	RecoveryDiskEncryptionSetId         *string             `json:"recoveryDiskEncryptionSetId,omitempty"`
	RecoveryReplicaDiskAccountType      *string             `json:"recoveryReplicaDiskAccountType,omitempty"`
	RecoveryResourceGroupId             string              `json:"recoveryResourceGroupId"`
	RecoveryTargetDiskAccountType       *string             `json:"recoveryTargetDiskAccountType,omitempty"`
}

type CreateOperationResponse 

type CreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ProtectionContainer
}

type CreateProtectionContainerInput 

type CreateProtectionContainerInput struct {
	Properties *CreateProtectionContainerInputProperties `json:"properties,omitempty"`
}

type CreateProtectionContainerInputProperties 

type CreateProtectionContainerInputProperties struct {
	ProviderSpecificInput *[]ReplicationProviderSpecificContainerCreationInput `json:"providerSpecificInput,omitempty"`
}

func (*CreateProtectionContainerInputProperties) UnmarshalJSON 

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

type DeleteOperationResponse 

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

type DiscoverProtectableItemOperationResponse 

type DiscoverProtectableItemOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ProtectionContainer
}

type DiscoverProtectableItemRequest 

type DiscoverProtectableItemRequest struct {
	Properties *DiscoverProtectableItemRequestProperties `json:"properties,omitempty"`
}

type DiscoverProtectableItemRequestProperties 

type DiscoverProtectableItemRequestProperties struct {
	FriendlyName *string `json:"friendlyName,omitempty"`
	IPAddress    *string `json:"ipAddress,omitempty"`
	OsType       *string `json:"osType,omitempty"`
}

type DiskEncryptionInfo 

type DiskEncryptionInfo struct {
	DiskEncryptionKeyInfo *DiskEncryptionKeyInfo `json:"diskEncryptionKeyInfo,omitempty"`
	KeyEncryptionKeyInfo  *KeyEncryptionKeyInfo  `json:"keyEncryptionKeyInfo,omitempty"`
}

type DiskEncryptionKeyInfo 

type DiskEncryptionKeyInfo struct {
	KeyVaultResourceArmId *string `json:"keyVaultResourceArmId,omitempty"`
	SecretIdentifier      *string `json:"secretIdentifier,omitempty"`
}

type GetOperationResponse 

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

type KeyEncryptionKeyInfo 

type KeyEncryptionKeyInfo struct {
	KeyIdentifier         *string `json:"keyIdentifier,omitempty"`
	KeyVaultResourceArmId *string `json:"keyVaultResourceArmId,omitempty"`
}

type ListByReplicationFabricsCompleteResult 

type ListByReplicationFabricsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ProtectionContainer
}

type ListByReplicationFabricsOperationResponse 

type ListByReplicationFabricsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ProtectionContainer
}

type ListCompleteResult 

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

type ListOperationResponse 

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

type ProtectionContainer 

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

type ProtectionContainerFabricSpecificDetails 

type ProtectionContainerFabricSpecificDetails struct {
	InstanceType *string `json:"instanceType,omitempty"`
}

type ProtectionContainerOperationPredicate 

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

func (ProtectionContainerOperationPredicate) Matches 

func (p ProtectionContainerOperationPredicate) Matches(input ProtectionContainer) bool

type ProtectionContainerProperties 

type ProtectionContainerProperties struct {
	FabricFriendlyName    *string                                   `json:"fabricFriendlyName,omitempty"`
	FabricSpecificDetails *ProtectionContainerFabricSpecificDetails `json:"fabricSpecificDetails,omitempty"`
	FabricType            *string                                   `json:"fabricType,omitempty"`
	FriendlyName          *string                                   `json:"friendlyName,omitempty"`
	PairingStatus         *string                                   `json:"pairingStatus,omitempty"`
	ProtectedItemCount    *int64                                    `json:"protectedItemCount,omitempty"`
	Role                  *string                                   `json:"role,omitempty"`
}

type RawReplicationProviderSpecificContainerCreationInputImpl 

type RawReplicationProviderSpecificContainerCreationInputImpl struct {
	Type   string
	Values map[string]interface{}
}

RawReplicationProviderSpecificContainerCreationInputImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type RawSwitchProtectionProviderSpecificInputImpl 

type RawSwitchProtectionProviderSpecificInputImpl struct {
	Type   string
	Values map[string]interface{}
}

RawSwitchProtectionProviderSpecificInputImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type ReplicationFabricId 

type ReplicationFabricId struct {
	SubscriptionId        string
	ResourceGroupName     string
	VaultName             string
	ReplicationFabricName string
}

ReplicationFabricId is a struct representing the Resource ID for a Replication Fabric

func NewReplicationFabricID 

func NewReplicationFabricID(subscriptionId string, resourceGroupName string, vaultName string, replicationFabricName string) ReplicationFabricId

NewReplicationFabricID returns a new ReplicationFabricId struct

func ParseReplicationFabricID 

func ParseReplicationFabricID(input string) (*ReplicationFabricId, error)

ParseReplicationFabricID parses 'input' into a ReplicationFabricId

func ParseReplicationFabricIDInsensitively 

func ParseReplicationFabricIDInsensitively(input string) (*ReplicationFabricId, error)

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

func (*ReplicationFabricId) FromParseResult 

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

func (ReplicationFabricId) ID 

func (id ReplicationFabricId) ID() string

ID returns the formatted Replication Fabric ID

func (ReplicationFabricId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Replication Fabric ID

func (ReplicationFabricId) String 

func (id ReplicationFabricId) String() string

String returns a human-readable description of this Replication Fabric ID

type ReplicationProtectionContainerId 

type ReplicationProtectionContainerId struct {
	SubscriptionId                     string
	ResourceGroupName                  string
	VaultName                          string
	ReplicationFabricName              string
	ReplicationProtectionContainerName string
}

ReplicationProtectionContainerId is a struct representing the Resource ID for a Replication Protection Container

func NewReplicationProtectionContainerID 

func NewReplicationProtectionContainerID(subscriptionId string, resourceGroupName string, vaultName string, replicationFabricName string, replicationProtectionContainerName string) ReplicationProtectionContainerId

NewReplicationProtectionContainerID returns a new ReplicationProtectionContainerId struct

func ParseReplicationProtectionContainerID 

func ParseReplicationProtectionContainerID(input string) (*ReplicationProtectionContainerId, error)

ParseReplicationProtectionContainerID parses 'input' into a ReplicationProtectionContainerId

func ParseReplicationProtectionContainerIDInsensitively 

func ParseReplicationProtectionContainerIDInsensitively(input string) (*ReplicationProtectionContainerId, error)

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

func (*ReplicationProtectionContainerId) FromParseResult 

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

func (ReplicationProtectionContainerId) ID 

func (id ReplicationProtectionContainerId) ID() string

ID returns the formatted Replication Protection Container ID

func (ReplicationProtectionContainerId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Replication Protection Container ID

func (ReplicationProtectionContainerId) String 

func (id ReplicationProtectionContainerId) String() string

String returns a human-readable description of this Replication Protection Container ID

type ReplicationProtectionContainersClient 

type ReplicationProtectionContainersClient struct {
	Client *resourcemanager.Client
}

func NewReplicationProtectionContainersClientWithBaseURI 

func NewReplicationProtectionContainersClientWithBaseURI(sdkApi sdkEnv.Api) (*ReplicationProtectionContainersClient, error)

func (ReplicationProtectionContainersClient) Create 

func (c ReplicationProtectionContainersClient) Create(ctx context.Context, id ReplicationProtectionContainerId, input CreateProtectionContainerInput) (result CreateOperationResponse, err error)

Create ...

func (ReplicationProtectionContainersClient) CreateThenPoll 

func (c ReplicationProtectionContainersClient) CreateThenPoll(ctx context.Context, id ReplicationProtectionContainerId, input CreateProtectionContainerInput) error

CreateThenPoll performs Create then polls until it's completed

func (ReplicationProtectionContainersClient) Delete 

func (c ReplicationProtectionContainersClient) Delete(ctx context.Context, id ReplicationProtectionContainerId) (result DeleteOperationResponse, err error)

Delete ...

func (ReplicationProtectionContainersClient) DeleteThenPoll 

func (c ReplicationProtectionContainersClient) DeleteThenPoll(ctx context.Context, id ReplicationProtectionContainerId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ReplicationProtectionContainersClient) DiscoverProtectableItem 

func (c ReplicationProtectionContainersClient) DiscoverProtectableItem(ctx context.Context, id ReplicationProtectionContainerId, input DiscoverProtectableItemRequest) (result DiscoverProtectableItemOperationResponse, err error)

DiscoverProtectableItem ...

func (ReplicationProtectionContainersClient) DiscoverProtectableItemThenPoll 

func (c ReplicationProtectionContainersClient) DiscoverProtectableItemThenPoll(ctx context.Context, id ReplicationProtectionContainerId, input DiscoverProtectableItemRequest) error

DiscoverProtectableItemThenPoll performs DiscoverProtectableItem then polls until it's completed

func (ReplicationProtectionContainersClient) Get 

func (c ReplicationProtectionContainersClient) Get(ctx context.Context, id ReplicationProtectionContainerId) (result GetOperationResponse, err error)

Get ...

func (ReplicationProtectionContainersClient) List 

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

List ...

func (ReplicationProtectionContainersClient) ListByReplicationFabrics 

func (c ReplicationProtectionContainersClient) ListByReplicationFabrics(ctx context.Context, id ReplicationFabricId) (result ListByReplicationFabricsOperationResponse, err error)

ListByReplicationFabrics ...

func (ReplicationProtectionContainersClient) ListByReplicationFabricsComplete 

func (c ReplicationProtectionContainersClient) ListByReplicationFabricsComplete(ctx context.Context, id ReplicationFabricId) (ListByReplicationFabricsCompleteResult, error)

ListByReplicationFabricsComplete retrieves all the results into a single object

func (ReplicationProtectionContainersClient) ListByReplicationFabricsCompleteMatchingPredicate 

func (c ReplicationProtectionContainersClient) ListByReplicationFabricsCompleteMatchingPredicate(ctx context.Context, id ReplicationFabricId, predicate ProtectionContainerOperationPredicate) (result ListByReplicationFabricsCompleteResult, err error)

ListByReplicationFabricsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ReplicationProtectionContainersClient) ListComplete 

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

ListComplete retrieves all the results into a single object

func (ReplicationProtectionContainersClient) ListCompleteMatchingPredicate 

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ReplicationProtectionContainersClient) SwitchProtection 

func (c ReplicationProtectionContainersClient) SwitchProtection(ctx context.Context, id ReplicationProtectionContainerId, input SwitchProtectionInput) (result SwitchProtectionOperationResponse, err error)

SwitchProtection ...

func (ReplicationProtectionContainersClient) SwitchProtectionThenPoll 

func (c ReplicationProtectionContainersClient) SwitchProtectionThenPoll(ctx context.Context, id ReplicationProtectionContainerId, input SwitchProtectionInput) error

SwitchProtectionThenPoll performs SwitchProtection then polls until it's completed

type ReplicationProviderSpecificContainerCreationInput 

type ReplicationProviderSpecificContainerCreationInput interface {
}

type SwitchProtectionInput 

type SwitchProtectionInput struct {
	Properties *SwitchProtectionInputProperties `json:"properties,omitempty"`
}

type SwitchProtectionInputProperties 

type SwitchProtectionInputProperties struct {
	ProviderSpecificDetails      SwitchProtectionProviderSpecificInput `json:"providerSpecificDetails"`
	ReplicationProtectedItemName *string                               `json:"replicationProtectedItemName,omitempty"`
}

func (*SwitchProtectionInputProperties) UnmarshalJSON 

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

type SwitchProtectionOperationResponse 

type SwitchProtectionOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ProtectionContainer
}

type SwitchProtectionProviderSpecificInput 

type SwitchProtectionProviderSpecificInput interface {
}

type VMwareCbtContainerCreationInput 

type VMwareCbtContainerCreationInput struct {
}

func (VMwareCbtContainerCreationInput) MarshalJSON 

func (s VMwareCbtContainerCreationInput) MarshalJSON() ([]byte, error)

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

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

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

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.