backupstatus

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservicesbackup/2023-02-01/backupstatus Documentation

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

Client Initialization

client := backupstatus.NewBackupStatusClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BackupStatusClient.Get

ctx := context.TODO()
id := backupstatus.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

payload := backupstatus.BackupStatusRequest{
	// ...
}


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

Documentation

Index

• func PossibleValuesForDataSourceType() []string
• func PossibleValuesForFabricName() []string
• func PossibleValuesForProtectionStatus() []string
• func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• type BackupStatusClient
  • func NewBackupStatusClientWithBaseURI(endpoint string) BackupStatusClient
  • func (c BackupStatusClient) Get(ctx context.Context, id LocationId, input BackupStatusRequest) (result GetOperationResponse, err error)
• type BackupStatusRequest
• type BackupStatusResponse
• type DataSourceType
• type FabricName
• type GetOperationResponse
• type LocationId
  • func NewLocationID(subscriptionId string, locationName string) LocationId
  • func ParseLocationID(input string) (*LocationId, error)
  • func ParseLocationIDInsensitively(input string) (*LocationId, error)
  • func (id *LocationId) FromParseResult(input resourceids.ParseResult) error
  • func (id LocationId) ID() string
  • func (id LocationId) Segments() []resourceids.Segment
  • func (id LocationId) String() string
• type ProtectionStatus

Functions

func PossibleValuesForDataSourceType

func PossibleValuesForDataSourceType() []string

func PossibleValuesForFabricName

func PossibleValuesForFabricName() []string

func PossibleValuesForProtectionStatus

func PossibleValuesForProtectionStatus() []string

func ValidateLocationID

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type BackupStatusClient

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

func NewBackupStatusClientWithBaseURI

func NewBackupStatusClientWithBaseURI(endpoint string) BackupStatusClient

func (BackupStatusClient) Get

func (c BackupStatusClient) Get(ctx context.Context, id LocationId, input BackupStatusRequest) (result GetOperationResponse, err error)

Get ...

type BackupStatusRequest

type BackupStatusRequest struct {
	PoLogicalName *string         `json:"poLogicalName,omitempty"`
	ResourceId    *string         `json:"resourceId,omitempty"`
	ResourceType  *DataSourceType `json:"resourceType,omitempty"`
}

type BackupStatusResponse

type BackupStatusResponse struct {
	ContainerName      *string           `json:"containerName,omitempty"`
	ErrorCode          *string           `json:"errorCode,omitempty"`
	ErrorMessage       *string           `json:"errorMessage,omitempty"`
	FabricName         *FabricName       `json:"fabricName,omitempty"`
	PolicyName         *string           `json:"policyName,omitempty"`
	ProtectedItemName  *string           `json:"protectedItemName,omitempty"`
	ProtectionStatus   *ProtectionStatus `json:"protectionStatus,omitempty"`
	RegistrationStatus *string           `json:"registrationStatus,omitempty"`
	VaultId            *string           `json:"vaultId,omitempty"`
}

type DataSourceType

type DataSourceType string

const (
	DataSourceTypeAzureFileShare    DataSourceType = "AzureFileShare"
	DataSourceTypeAzureSqlDb        DataSourceType = "AzureSqlDb"
	DataSourceTypeClient            DataSourceType = "Client"
	DataSourceTypeExchange          DataSourceType = "Exchange"
	DataSourceTypeFileFolder        DataSourceType = "FileFolder"
	DataSourceTypeGenericDataSource DataSourceType = "GenericDataSource"
	DataSourceTypeInvalid           DataSourceType = "Invalid"
	DataSourceTypeSAPAseDatabase    DataSourceType = "SAPAseDatabase"
	DataSourceTypeSAPHanaDBInstance DataSourceType = "SAPHanaDBInstance"
	DataSourceTypeSAPHanaDatabase   DataSourceType = "SAPHanaDatabase"
	DataSourceTypeSQLDB             DataSourceType = "SQLDB"
	DataSourceTypeSQLDataBase       DataSourceType = "SQLDataBase"
	DataSourceTypeSharepoint        DataSourceType = "Sharepoint"
	DataSourceTypeSystemState       DataSourceType = "SystemState"
	DataSourceTypeVM                DataSourceType = "VM"
	DataSourceTypeVMwareVM          DataSourceType = "VMwareVM"
)

type FabricName

type FabricName string

const (
	FabricNameAzure   FabricName = "Azure"
	FabricNameInvalid FabricName = "Invalid"
)

type GetOperationResponse

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

type LocationId

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (*LocationId) FromParseResult

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

func (LocationId) ID

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments

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

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

func (LocationId) String

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type ProtectionStatus

type ProtectionStatus string

const (
	ProtectionStatusInvalid          ProtectionStatus = "Invalid"
	ProtectionStatusNotProtected     ProtectionStatus = "NotProtected"
	ProtectionStatusProtected        ProtectionStatus = "Protected"
	ProtectionStatusProtecting       ProtectionStatus = "Protecting"
	ProtectionStatusProtectionFailed ProtectionStatus = "ProtectionFailed"
)