itemlevelrecoveryconnections

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservicesbackup/2024-02-01/itemlevelrecoveryconnections Documentation

The itemlevelrecoveryconnections SDK allows for interaction with Azure Resource Manager recoveryservicesbackup (API Version 2024-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/recoveryservicesbackup/2024-02-01/itemlevelrecoveryconnections"

Client Initialization

client := itemlevelrecoveryconnections.NewItemLevelRecoveryConnectionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ItemLevelRecoveryConnectionsClient.Provision

ctx := context.TODO()
id := itemlevelrecoveryconnections.NewRecoveryPointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultName", "backupFabricName", "protectionContainerName", "protectedItemName", "recoveryPointId")

payload := itemlevelrecoveryconnections.ILRRequestResource{
	// ...
}


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

Example Usage: ItemLevelRecoveryConnectionsClient.Revoke

ctx := context.TODO()
id := itemlevelrecoveryconnections.NewRecoveryPointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultName", "backupFabricName", "protectionContainerName", "protectedItemName", "recoveryPointId")

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

Documentation

Index

• func ValidateRecoveryPointID(input interface{}, key string) (warnings []string, errors []error)
• type AzureFileShareProvisionILRRequest
  • func (s AzureFileShareProvisionILRRequest) ILRRequest() BaseILRRequestImpl
  • func (s AzureFileShareProvisionILRRequest) MarshalJSON() ([]byte, error)
• type BaseILRRequestImpl
  • func (s BaseILRRequestImpl) ILRRequest() BaseILRRequestImpl
• type ILRRequest
  • func UnmarshalILRRequestImplementation(input []byte) (ILRRequest, error)
• type ILRRequestResource
  • func (s *ILRRequestResource) UnmarshalJSON(bytes []byte) error
• type IaasVMILRRegistrationRequest
  • func (s IaasVMILRRegistrationRequest) ILRRequest() BaseILRRequestImpl
  • func (s IaasVMILRRegistrationRequest) MarshalJSON() ([]byte, error)
• type ItemLevelRecoveryConnectionsClient
  • func NewItemLevelRecoveryConnectionsClientWithBaseURI(endpoint string) ItemLevelRecoveryConnectionsClient
  • func (c ItemLevelRecoveryConnectionsClient) Provision(ctx context.Context, id RecoveryPointId, input ILRRequestResource) (result ProvisionOperationResponse, err error)
  • func (c ItemLevelRecoveryConnectionsClient) Revoke(ctx context.Context, id RecoveryPointId) (result RevokeOperationResponse, err error)
• type ProvisionOperationResponse
• type RawILRRequestImpl
  • func (s RawILRRequestImpl) ILRRequest() BaseILRRequestImpl
• type RecoveryPointId
  • func NewRecoveryPointID(subscriptionId string, resourceGroupName string, vaultName string, ...) RecoveryPointId
  • func ParseRecoveryPointID(input string) (*RecoveryPointId, error)
  • func ParseRecoveryPointIDInsensitively(input string) (*RecoveryPointId, error)
  • func (id *RecoveryPointId) FromParseResult(input resourceids.ParseResult) error
  • func (id RecoveryPointId) ID() string
  • func (id RecoveryPointId) Segments() []resourceids.Segment
  • func (id RecoveryPointId) String() string
• type RevokeOperationResponse

Functions

func ValidateRecoveryPointID

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

ValidateRecoveryPointID checks that 'input' can be parsed as a Recovery Point ID

Types

type AzureFileShareProvisionILRRequest

type AzureFileShareProvisionILRRequest struct {
	RecoveryPointId  *string `json:"recoveryPointId,omitempty"`
	SourceResourceId *string `json:"sourceResourceId,omitempty"`

	ObjectType string `json:"objectType"`
}

func (AzureFileShareProvisionILRRequest) ILRRequest

func (s AzureFileShareProvisionILRRequest) ILRRequest() BaseILRRequestImpl

func (AzureFileShareProvisionILRRequest) MarshalJSON

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

type BaseILRRequestImpl

type BaseILRRequestImpl struct {
	ObjectType string `json:"objectType"`
}

func (BaseILRRequestImpl) ILRRequest

func (s BaseILRRequestImpl) ILRRequest() BaseILRRequestImpl

type ILRRequest

type ILRRequest interface {
	ILRRequest() BaseILRRequestImpl
}

func UnmarshalILRRequestImplementation

func UnmarshalILRRequestImplementation(input []byte) (ILRRequest, error)

type ILRRequestResource

type ILRRequestResource struct {
	ETag       *string            `json:"eTag,omitempty"`
	Id         *string            `json:"id,omitempty"`
	Location   *string            `json:"location,omitempty"`
	Name       *string            `json:"name,omitempty"`
	Properties ILRRequest         `json:"properties"`
	Tags       *map[string]string `json:"tags,omitempty"`
	Type       *string            `json:"type,omitempty"`
}

func (*ILRRequestResource) UnmarshalJSON

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

type IaasVMILRRegistrationRequest

type IaasVMILRRegistrationRequest struct {
	InitiatorName             *string `json:"initiatorName,omitempty"`
	RecoveryPointId           *string `json:"recoveryPointId,omitempty"`
	RenewExistingRegistration *bool   `json:"renewExistingRegistration,omitempty"`
	VirtualMachineId          *string `json:"virtualMachineId,omitempty"`

	ObjectType string `json:"objectType"`
}

func (IaasVMILRRegistrationRequest) ILRRequest

func (s IaasVMILRRegistrationRequest) ILRRequest() BaseILRRequestImpl

func (IaasVMILRRegistrationRequest) MarshalJSON

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

type ItemLevelRecoveryConnectionsClient

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

func NewItemLevelRecoveryConnectionsClientWithBaseURI

func NewItemLevelRecoveryConnectionsClientWithBaseURI(endpoint string) ItemLevelRecoveryConnectionsClient

func (ItemLevelRecoveryConnectionsClient) Provision

func (c ItemLevelRecoveryConnectionsClient) Provision(ctx context.Context, id RecoveryPointId, input ILRRequestResource) (result ProvisionOperationResponse, err error)

Provision ...

func (ItemLevelRecoveryConnectionsClient) Revoke

func (c ItemLevelRecoveryConnectionsClient) Revoke(ctx context.Context, id RecoveryPointId) (result RevokeOperationResponse, err error)

Revoke ...

type ProvisionOperationResponse

type ProvisionOperationResponse struct {
	HttpResponse *http.Response
}

type RawILRRequestImpl

type RawILRRequestImpl struct {
	Type   string
	Values map[string]interface{}
	// contains filtered or unexported fields
}

RawILRRequestImpl 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).

func (RawILRRequestImpl) ILRRequest

func (s RawILRRequestImpl) ILRRequest() BaseILRRequestImpl

type RecoveryPointId

type RecoveryPointId struct {
	SubscriptionId          string
	ResourceGroupName       string
	VaultName               string
	BackupFabricName        string
	ProtectionContainerName string
	ProtectedItemName       string
	RecoveryPointId         string
}

RecoveryPointId is a struct representing the Resource ID for a Recovery Point

func NewRecoveryPointID

func NewRecoveryPointID(subscriptionId string, resourceGroupName string, vaultName string, backupFabricName string, protectionContainerName string, protectedItemName string, recoveryPointId string) RecoveryPointId

NewRecoveryPointID returns a new RecoveryPointId struct

func ParseRecoveryPointID

func ParseRecoveryPointID(input string) (*RecoveryPointId, error)

ParseRecoveryPointID parses 'input' into a RecoveryPointId

func ParseRecoveryPointIDInsensitively

func ParseRecoveryPointIDInsensitively(input string) (*RecoveryPointId, error)

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

func (*RecoveryPointId) FromParseResult

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

func (RecoveryPointId) ID

func (id RecoveryPointId) ID() string

ID returns the formatted Recovery Point ID

func (RecoveryPointId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Recovery Point ID

func (RecoveryPointId) String

func (id RecoveryPointId) String() string

String returns a human-readable description of this Recovery Point ID

type RevokeOperationResponse

type RevokeOperationResponse struct {
	HttpResponse *http.Response
}