backupinstances

package
v0.20240731.1212841 Latest Latest
Warning

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

Go to latest
Published: Jul 31, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/dataprotection/2023-05-01/backupinstances Documentation

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

Client Initialization

client := backupinstances.NewBackupInstancesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BackupInstancesClient.AdhocBackup

ctx := context.TODO()
id := backupinstances.NewBackupInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "backupVaultValue", "backupInstanceValue")

payload := backupinstances.TriggerBackupRequest{
	// ...
}


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

Example Usage: BackupInstancesClient.CreateOrUpdate

ctx := context.TODO()
id := backupinstances.NewBackupInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "backupVaultValue", "backupInstanceValue")

payload := backupinstances.BackupInstanceResource{
	// ...
}


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

Example Usage: BackupInstancesClient.Delete

ctx := context.TODO()
id := backupinstances.NewBackupInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "backupVaultValue", "backupInstanceValue")

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

Example Usage: BackupInstancesClient.Get

ctx := context.TODO()
id := backupinstances.NewBackupInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "backupVaultValue", "backupInstanceValue")

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

ctx := context.TODO()
id := backupinstances.NewBackupVaultID("12345678-1234-9876-4563-123456789012", "example-resource-group", "backupVaultValue")

// 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: BackupInstancesClient.ResumeBackups

ctx := context.TODO()
id := backupinstances.NewBackupInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "backupVaultValue", "backupInstanceValue")

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

Example Usage: BackupInstancesClient.ResumeProtection

ctx := context.TODO()
id := backupinstances.NewBackupInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "backupVaultValue", "backupInstanceValue")

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

Example Usage: BackupInstancesClient.StopProtection

ctx := context.TODO()
id := backupinstances.NewBackupInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "backupVaultValue", "backupInstanceValue")

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

Example Usage: BackupInstancesClient.SuspendBackups

ctx := context.TODO()
id := backupinstances.NewBackupInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "backupVaultValue", "backupInstanceValue")

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

Example Usage: BackupInstancesClient.SyncBackupInstance

ctx := context.TODO()
id := backupinstances.NewBackupInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "backupVaultValue", "backupInstanceValue")

payload := backupinstances.SyncBackupInstanceRequest{
	// ...
}


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

Example Usage: BackupInstancesClient.TriggerRehydrate

ctx := context.TODO()
id := backupinstances.NewBackupInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "backupVaultValue", "backupInstanceValue")

payload := backupinstances.AzureBackupRehydrationRequest{
	// ...
}


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

Example Usage: BackupInstancesClient.TriggerRestore

ctx := context.TODO()
id := backupinstances.NewBackupInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "backupVaultValue", "backupInstanceValue")

payload := backupinstances.AzureBackupRestoreRequest{
	// ...
}


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

Example Usage: BackupInstancesClient.ValidateForBackup

ctx := context.TODO()
id := backupinstances.NewBackupVaultID("12345678-1234-9876-4563-123456789012", "example-resource-group", "backupVaultValue")

payload := backupinstances.ValidateForBackupRequest{
	// ...
}


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

Example Usage: BackupInstancesClient.ValidateForRestore

ctx := context.TODO()
id := backupinstances.NewBackupInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "backupVaultValue", "backupInstanceValue")

payload := backupinstances.ValidateRestoreRequestObject{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForCurrentProtectionState

func PossibleValuesForCurrentProtectionState() []string

func PossibleValuesForDataStoreTypes

func PossibleValuesForDataStoreTypes() []string

func PossibleValuesForExistingResourcePolicy

func PossibleValuesForExistingResourcePolicy() []string

func PossibleValuesForPersistentVolumeRestoreMode

func PossibleValuesForPersistentVolumeRestoreMode() []string

func PossibleValuesForRecoveryOption

func PossibleValuesForRecoveryOption() []string

func PossibleValuesForRehydrationPriority

func PossibleValuesForRehydrationPriority() []string

func PossibleValuesForResourcePropertiesObjectType

func PossibleValuesForResourcePropertiesObjectType() []string

func PossibleValuesForRestoreTargetLocationType

func PossibleValuesForRestoreTargetLocationType() []string

func PossibleValuesForSecretStoreType

func PossibleValuesForSecretStoreType() []string

func PossibleValuesForSourceDataStoreType

func PossibleValuesForSourceDataStoreType() []string

func PossibleValuesForStatus

func PossibleValuesForStatus() []string

func PossibleValuesForSyncType

func PossibleValuesForSyncType() []string

func PossibleValuesForValidationType

func PossibleValuesForValidationType() []string

func ValidateBackupInstanceID

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

ValidateBackupInstanceID checks that 'input' can be parsed as a Backup Instance ID

func ValidateBackupVaultID

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

ValidateBackupVaultID checks that 'input' can be parsed as a Backup Vault ID

Types

type AdHocBackupRuleOptions

type AdHocBackupRuleOptions struct {
	RuleName      string                   `json:"ruleName"`
	TriggerOption AdhocBackupTriggerOption `json:"triggerOption"`
}

type AdhocBackupOperationResponse

type AdhocBackupOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *OperationJobExtendedInfo
}

type AdhocBackupTriggerOption

type AdhocBackupTriggerOption struct {
	RetentionTagOverride *string `json:"retentionTagOverride,omitempty"`
}

type AuthCredentials

type AuthCredentials interface {
}

type AzureBackupRecoveryPointBasedRestoreRequest

type AzureBackupRecoveryPointBasedRestoreRequest struct {
	RecoveryPointId string `json:"recoveryPointId"`

	// Fields inherited from AzureBackupRestoreRequest
	IdentityDetails     *IdentityDetails      `json:"identityDetails,omitempty"`
	RestoreTargetInfo   RestoreTargetInfoBase `json:"restoreTargetInfo"`
	SourceDataStoreType SourceDataStoreType   `json:"sourceDataStoreType"`
	SourceResourceId    *string               `json:"sourceResourceId,omitempty"`
}

func (AzureBackupRecoveryPointBasedRestoreRequest) MarshalJSON

func (*AzureBackupRecoveryPointBasedRestoreRequest) UnmarshalJSON

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

type AzureBackupRecoveryTimeBasedRestoreRequest

type AzureBackupRecoveryTimeBasedRestoreRequest struct {
	RecoveryPointTime string `json:"recoveryPointTime"`

	// Fields inherited from AzureBackupRestoreRequest
	IdentityDetails     *IdentityDetails      `json:"identityDetails,omitempty"`
	RestoreTargetInfo   RestoreTargetInfoBase `json:"restoreTargetInfo"`
	SourceDataStoreType SourceDataStoreType   `json:"sourceDataStoreType"`
	SourceResourceId    *string               `json:"sourceResourceId,omitempty"`
}

func (AzureBackupRecoveryTimeBasedRestoreRequest) MarshalJSON

func (*AzureBackupRecoveryTimeBasedRestoreRequest) UnmarshalJSON

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

type AzureBackupRehydrationRequest

type AzureBackupRehydrationRequest struct {
	RecoveryPointId              string               `json:"recoveryPointId"`
	RehydrationPriority          *RehydrationPriority `json:"rehydrationPriority,omitempty"`
	RehydrationRetentionDuration string               `json:"rehydrationRetentionDuration"`
}

type AzureBackupRestoreRequest

type AzureBackupRestoreRequest interface {
}

type AzureBackupRestoreWithRehydrationRequest

type AzureBackupRestoreWithRehydrationRequest struct {
	RecoveryPointId              string              `json:"recoveryPointId"`
	RehydrationPriority          RehydrationPriority `json:"rehydrationPriority"`
	RehydrationRetentionDuration string              `json:"rehydrationRetentionDuration"`

	// Fields inherited from AzureBackupRestoreRequest
	IdentityDetails     *IdentityDetails      `json:"identityDetails,omitempty"`
	RestoreTargetInfo   RestoreTargetInfoBase `json:"restoreTargetInfo"`
	SourceDataStoreType SourceDataStoreType   `json:"sourceDataStoreType"`
	SourceResourceId    *string               `json:"sourceResourceId,omitempty"`
}

func (AzureBackupRestoreWithRehydrationRequest) MarshalJSON

func (*AzureBackupRestoreWithRehydrationRequest) UnmarshalJSON

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

type AzureOperationalStoreParameters

type AzureOperationalStoreParameters struct {
	ResourceGroupId *string `json:"resourceGroupId,omitempty"`

	// Fields inherited from DataStoreParameters
	DataStoreType DataStoreTypes `json:"dataStoreType"`
}

func (AzureOperationalStoreParameters) MarshalJSON

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

type BackupDatasourceParameters

type BackupDatasourceParameters interface {
}

type BackupInstance

type BackupInstance struct {
	CurrentProtectionState    *CurrentProtectionState  `json:"currentProtectionState,omitempty"`
	DataSourceInfo            Datasource               `json:"dataSourceInfo"`
	DataSourceSetInfo         *DatasourceSet           `json:"dataSourceSetInfo,omitempty"`
	DatasourceAuthCredentials AuthCredentials          `json:"datasourceAuthCredentials"`
	FriendlyName              *string                  `json:"friendlyName,omitempty"`
	IdentityDetails           *IdentityDetails         `json:"identityDetails,omitempty"`
	ObjectType                string                   `json:"objectType"`
	PolicyInfo                PolicyInfo               `json:"policyInfo"`
	ProtectionErrorDetails    *UserFacingError         `json:"protectionErrorDetails,omitempty"`
	ProtectionStatus          *ProtectionStatusDetails `json:"protectionStatus,omitempty"`
	ProvisioningState         *string                  `json:"provisioningState,omitempty"`
	ValidationType            *ValidationType          `json:"validationType,omitempty"`
}

func (*BackupInstance) UnmarshalJSON

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

type BackupInstanceId

type BackupInstanceId struct {
	SubscriptionId     string
	ResourceGroupName  string
	BackupVaultName    string
	BackupInstanceName string
}

BackupInstanceId is a struct representing the Resource ID for a Backup Instance

func NewBackupInstanceID

func NewBackupInstanceID(subscriptionId string, resourceGroupName string, backupVaultName string, backupInstanceName string) BackupInstanceId

NewBackupInstanceID returns a new BackupInstanceId struct

func ParseBackupInstanceID

func ParseBackupInstanceID(input string) (*BackupInstanceId, error)

ParseBackupInstanceID parses 'input' into a BackupInstanceId

func ParseBackupInstanceIDInsensitively

func ParseBackupInstanceIDInsensitively(input string) (*BackupInstanceId, error)

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

func (*BackupInstanceId) FromParseResult

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

func (BackupInstanceId) ID

func (id BackupInstanceId) ID() string

ID returns the formatted Backup Instance ID

func (BackupInstanceId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Backup Instance ID

func (BackupInstanceId) String

func (id BackupInstanceId) String() string

String returns a human-readable description of this Backup Instance ID

type BackupInstanceResource

type BackupInstanceResource struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *BackupInstance        `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Tags       *map[string]string     `json:"tags,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type BackupInstanceResourceOperationPredicate

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

func (BackupInstanceResourceOperationPredicate) Matches

type BackupInstancesClient

type BackupInstancesClient struct {
	Client *resourcemanager.Client
}

func NewBackupInstancesClientWithBaseURI

func NewBackupInstancesClientWithBaseURI(sdkApi sdkEnv.Api) (*BackupInstancesClient, error)

func (BackupInstancesClient) AdhocBackup

AdhocBackup ...

func (BackupInstancesClient) AdhocBackupThenPoll

func (c BackupInstancesClient) AdhocBackupThenPoll(ctx context.Context, id BackupInstanceId, input TriggerBackupRequest) error

AdhocBackupThenPoll performs AdhocBackup then polls until it's completed

func (BackupInstancesClient) CreateOrUpdate

CreateOrUpdate ...

func (BackupInstancesClient) CreateOrUpdateThenPoll

func (c BackupInstancesClient) CreateOrUpdateThenPoll(ctx context.Context, id BackupInstanceId, input BackupInstanceResource) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (BackupInstancesClient) Delete

Delete ...

func (BackupInstancesClient) DeleteThenPoll

func (c BackupInstancesClient) DeleteThenPoll(ctx context.Context, id BackupInstanceId) error

DeleteThenPoll performs Delete then polls until it's completed

func (BackupInstancesClient) Get

Get ...

func (BackupInstancesClient) List

List ...

func (BackupInstancesClient) ListComplete

ListComplete retrieves all the results into a single object

func (BackupInstancesClient) ListCompleteMatchingPredicate

func (c BackupInstancesClient) ListCompleteMatchingPredicate(ctx context.Context, id BackupVaultId, predicate BackupInstanceResourceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (BackupInstancesClient) ResumeBackups

ResumeBackups ...

func (BackupInstancesClient) ResumeBackupsThenPoll

func (c BackupInstancesClient) ResumeBackupsThenPoll(ctx context.Context, id BackupInstanceId) error

ResumeBackupsThenPoll performs ResumeBackups then polls until it's completed

func (BackupInstancesClient) ResumeProtection

ResumeProtection ...

func (BackupInstancesClient) ResumeProtectionThenPoll

func (c BackupInstancesClient) ResumeProtectionThenPoll(ctx context.Context, id BackupInstanceId) error

ResumeProtectionThenPoll performs ResumeProtection then polls until it's completed

func (BackupInstancesClient) StopProtection

StopProtection ...

func (BackupInstancesClient) StopProtectionThenPoll

func (c BackupInstancesClient) StopProtectionThenPoll(ctx context.Context, id BackupInstanceId) error

StopProtectionThenPoll performs StopProtection then polls until it's completed

func (BackupInstancesClient) SuspendBackups

SuspendBackups ...

func (BackupInstancesClient) SuspendBackupsThenPoll

func (c BackupInstancesClient) SuspendBackupsThenPoll(ctx context.Context, id BackupInstanceId) error

SuspendBackupsThenPoll performs SuspendBackups then polls until it's completed

func (BackupInstancesClient) SyncBackupInstance

SyncBackupInstance ...

func (BackupInstancesClient) SyncBackupInstanceThenPoll

func (c BackupInstancesClient) SyncBackupInstanceThenPoll(ctx context.Context, id BackupInstanceId, input SyncBackupInstanceRequest) error

SyncBackupInstanceThenPoll performs SyncBackupInstance then polls until it's completed

func (BackupInstancesClient) TriggerRehydrate

TriggerRehydrate ...

func (BackupInstancesClient) TriggerRehydrateThenPoll

func (c BackupInstancesClient) TriggerRehydrateThenPoll(ctx context.Context, id BackupInstanceId, input AzureBackupRehydrationRequest) error

TriggerRehydrateThenPoll performs TriggerRehydrate then polls until it's completed

func (BackupInstancesClient) TriggerRestore

TriggerRestore ...

func (BackupInstancesClient) TriggerRestoreThenPoll

func (c BackupInstancesClient) TriggerRestoreThenPoll(ctx context.Context, id BackupInstanceId, input AzureBackupRestoreRequest) error

TriggerRestoreThenPoll performs TriggerRestore then polls until it's completed

func (BackupInstancesClient) ValidateForBackup

ValidateForBackup ...

func (BackupInstancesClient) ValidateForBackupThenPoll

func (c BackupInstancesClient) ValidateForBackupThenPoll(ctx context.Context, id BackupVaultId, input ValidateForBackupRequest) error

ValidateForBackupThenPoll performs ValidateForBackup then polls until it's completed

func (BackupInstancesClient) ValidateForRestore

ValidateForRestore ...

func (BackupInstancesClient) ValidateForRestoreThenPoll

func (c BackupInstancesClient) ValidateForRestoreThenPoll(ctx context.Context, id BackupInstanceId, input ValidateRestoreRequestObject) error

ValidateForRestoreThenPoll performs ValidateForRestore then polls until it's completed

type BackupVaultId

type BackupVaultId struct {
	SubscriptionId    string
	ResourceGroupName string
	BackupVaultName   string
}

BackupVaultId is a struct representing the Resource ID for a Backup Vault

func NewBackupVaultID

func NewBackupVaultID(subscriptionId string, resourceGroupName string, backupVaultName string) BackupVaultId

NewBackupVaultID returns a new BackupVaultId struct

func ParseBackupVaultID

func ParseBackupVaultID(input string) (*BackupVaultId, error)

ParseBackupVaultID parses 'input' into a BackupVaultId

func ParseBackupVaultIDInsensitively

func ParseBackupVaultIDInsensitively(input string) (*BackupVaultId, error)

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

func (*BackupVaultId) FromParseResult

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

func (BackupVaultId) ID

func (id BackupVaultId) ID() string

ID returns the formatted Backup Vault ID

func (BackupVaultId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Backup Vault ID

func (BackupVaultId) String

func (id BackupVaultId) String() string

String returns a human-readable description of this Backup Vault ID

type BaseResourceProperties

type BaseResourceProperties interface {
}

type BlobBackupDatasourceParameters

type BlobBackupDatasourceParameters struct {
	ContainersList []string `json:"containersList"`
}

func (BlobBackupDatasourceParameters) MarshalJSON

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

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *BackupInstanceResource
}

type CurrentProtectionState

type CurrentProtectionState string
const (
	CurrentProtectionStateBackupSchedulesSuspended    CurrentProtectionState = "BackupSchedulesSuspended"
	CurrentProtectionStateConfiguringProtection       CurrentProtectionState = "ConfiguringProtection"
	CurrentProtectionStateConfiguringProtectionFailed CurrentProtectionState = "ConfiguringProtectionFailed"
	CurrentProtectionStateInvalid                     CurrentProtectionState = "Invalid"
	CurrentProtectionStateNotProtected                CurrentProtectionState = "NotProtected"
	CurrentProtectionStateProtectionConfigured        CurrentProtectionState = "ProtectionConfigured"
	CurrentProtectionStateProtectionError             CurrentProtectionState = "ProtectionError"
	CurrentProtectionStateProtectionStopped           CurrentProtectionState = "ProtectionStopped"
	CurrentProtectionStateRetentionSchedulesSuspended CurrentProtectionState = "RetentionSchedulesSuspended"
	CurrentProtectionStateSoftDeleted                 CurrentProtectionState = "SoftDeleted"
	CurrentProtectionStateSoftDeleting                CurrentProtectionState = "SoftDeleting"
	CurrentProtectionStateUpdatingProtection          CurrentProtectionState = "UpdatingProtection"
)

func (*CurrentProtectionState) UnmarshalJSON

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

type DataStoreParameters

type DataStoreParameters interface {
}

type DataStoreTypes

type DataStoreTypes string
const (
	DataStoreTypesArchiveStore     DataStoreTypes = "ArchiveStore"
	DataStoreTypesOperationalStore DataStoreTypes = "OperationalStore"
	DataStoreTypesVaultStore       DataStoreTypes = "VaultStore"
)

func (*DataStoreTypes) UnmarshalJSON

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

type Datasource

type Datasource struct {
	DatasourceType     *string                `json:"datasourceType,omitempty"`
	ObjectType         *string                `json:"objectType,omitempty"`
	ResourceID         string                 `json:"resourceID"`
	ResourceLocation   *string                `json:"resourceLocation,omitempty"`
	ResourceName       *string                `json:"resourceName,omitempty"`
	ResourceProperties BaseResourceProperties `json:"resourceProperties"`
	ResourceType       *string                `json:"resourceType,omitempty"`
	ResourceUri        *string                `json:"resourceUri,omitempty"`
}

func (*Datasource) UnmarshalJSON

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

type DatasourceSet

type DatasourceSet struct {
	DatasourceType     *string                `json:"datasourceType,omitempty"`
	ObjectType         *string                `json:"objectType,omitempty"`
	ResourceID         string                 `json:"resourceID"`
	ResourceLocation   *string                `json:"resourceLocation,omitempty"`
	ResourceName       *string                `json:"resourceName,omitempty"`
	ResourceProperties BaseResourceProperties `json:"resourceProperties"`
	ResourceType       *string                `json:"resourceType,omitempty"`
	ResourceUri        *string                `json:"resourceUri,omitempty"`
}

func (*DatasourceSet) UnmarshalJSON

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

type DefaultResourceProperties

type DefaultResourceProperties struct {
}

func (DefaultResourceProperties) MarshalJSON

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

type DeleteOperationResponse

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

type ExistingResourcePolicy

type ExistingResourcePolicy string
const (
	ExistingResourcePolicyPatch ExistingResourcePolicy = "Patch"
	ExistingResourcePolicySkip  ExistingResourcePolicy = "Skip"
)

func (*ExistingResourcePolicy) UnmarshalJSON

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

type GetOperationResponse

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

type IdentityDetails

type IdentityDetails struct {
	UseSystemAssignedIdentity  *bool   `json:"useSystemAssignedIdentity,omitempty"`
	UserAssignedIdentityArmUrl *string `json:"userAssignedIdentityArmUrl,omitempty"`
}

type InnerError

type InnerError struct {
	AdditionalInfo     *map[string]string `json:"additionalInfo,omitempty"`
	Code               *string            `json:"code,omitempty"`
	EmbeddedInnerError *InnerError        `json:"embeddedInnerError,omitempty"`
}

type ItemLevelRestoreCriteria

type ItemLevelRestoreCriteria interface {
}

type ItemLevelRestoreTargetInfo

type ItemLevelRestoreTargetInfo struct {
	DatasourceAuthCredentials AuthCredentials            `json:"datasourceAuthCredentials"`
	DatasourceInfo            Datasource                 `json:"datasourceInfo"`
	DatasourceSetInfo         *DatasourceSet             `json:"datasourceSetInfo,omitempty"`
	RestoreCriteria           []ItemLevelRestoreCriteria `json:"restoreCriteria"`

	// Fields inherited from RestoreTargetInfoBase
	RecoveryOption  RecoveryOption `json:"recoveryOption"`
	RestoreLocation *string        `json:"restoreLocation,omitempty"`
}

func (ItemLevelRestoreTargetInfo) MarshalJSON

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

func (*ItemLevelRestoreTargetInfo) UnmarshalJSON

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

type ItemPathBasedRestoreCriteria

type ItemPathBasedRestoreCriteria struct {
	IsPathRelativeToBackupItem bool      `json:"isPathRelativeToBackupItem"`
	ItemPath                   string    `json:"itemPath"`
	SubItemPathPrefix          *[]string `json:"subItemPathPrefix,omitempty"`
}

func (ItemPathBasedRestoreCriteria) MarshalJSON

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

type KubernetesClusterBackupDatasourceParameters

type KubernetesClusterBackupDatasourceParameters struct {
	BackupHookReferences         *[]NamespacedNameResource `json:"backupHookReferences,omitempty"`
	ExcludedNamespaces           *[]string                 `json:"excludedNamespaces,omitempty"`
	ExcludedResourceTypes        *[]string                 `json:"excludedResourceTypes,omitempty"`
	IncludeClusterScopeResources bool                      `json:"includeClusterScopeResources"`
	IncludedNamespaces           *[]string                 `json:"includedNamespaces,omitempty"`
	IncludedResourceTypes        *[]string                 `json:"includedResourceTypes,omitempty"`
	LabelSelectors               *[]string                 `json:"labelSelectors,omitempty"`
	SnapshotVolumes              bool                      `json:"snapshotVolumes"`
}

func (KubernetesClusterBackupDatasourceParameters) MarshalJSON

type KubernetesClusterRestoreCriteria

type KubernetesClusterRestoreCriteria struct {
	ConflictPolicy               *ExistingResourcePolicy      `json:"conflictPolicy,omitempty"`
	ExcludedNamespaces           *[]string                    `json:"excludedNamespaces,omitempty"`
	ExcludedResourceTypes        *[]string                    `json:"excludedResourceTypes,omitempty"`
	IncludeClusterScopeResources bool                         `json:"includeClusterScopeResources"`
	IncludedNamespaces           *[]string                    `json:"includedNamespaces,omitempty"`
	IncludedResourceTypes        *[]string                    `json:"includedResourceTypes,omitempty"`
	LabelSelectors               *[]string                    `json:"labelSelectors,omitempty"`
	NamespaceMappings            *map[string]string           `json:"namespaceMappings,omitempty"`
	PersistentVolumeRestoreMode  *PersistentVolumeRestoreMode `json:"persistentVolumeRestoreMode,omitempty"`
	RestoreHookReferences        *[]NamespacedNameResource    `json:"restoreHookReferences,omitempty"`
}

func (KubernetesClusterRestoreCriteria) MarshalJSON

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

type KubernetesPVRestoreCriteria

type KubernetesPVRestoreCriteria struct {
	Name             *string `json:"name,omitempty"`
	StorageClassName *string `json:"storageClassName,omitempty"`
}

func (KubernetesPVRestoreCriteria) MarshalJSON

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

type KubernetesStorageClassRestoreCriteria

type KubernetesStorageClassRestoreCriteria struct {
	Provisioner              *string `json:"provisioner,omitempty"`
	SelectedStorageClassName *string `json:"selectedStorageClassName,omitempty"`
}

func (KubernetesStorageClassRestoreCriteria) MarshalJSON

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

type ListCompleteResult

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

type ListCustomPager added in v0.20240628.1153531

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationResponse

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

type NamespacedNameResource

type NamespacedNameResource struct {
	Name      *string `json:"name,omitempty"`
	Namespace *string `json:"namespace,omitempty"`
}

type OperationExtendedInfo

type OperationExtendedInfo interface {
}

type OperationJobExtendedInfo

type OperationJobExtendedInfo struct {
	JobId *string `json:"jobId,omitempty"`
}

func (OperationJobExtendedInfo) MarshalJSON

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

type PersistentVolumeRestoreMode

type PersistentVolumeRestoreMode string
const (
	PersistentVolumeRestoreModeRestoreWithVolumeData    PersistentVolumeRestoreMode = "RestoreWithVolumeData"
	PersistentVolumeRestoreModeRestoreWithoutVolumeData PersistentVolumeRestoreMode = "RestoreWithoutVolumeData"
)

func (*PersistentVolumeRestoreMode) UnmarshalJSON

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

type PolicyInfo

type PolicyInfo struct {
	PolicyId         string            `json:"policyId"`
	PolicyParameters *PolicyParameters `json:"policyParameters,omitempty"`
	PolicyVersion    *string           `json:"policyVersion,omitempty"`
}

type PolicyParameters

type PolicyParameters struct {
	BackupDatasourceParametersList *[]BackupDatasourceParameters `json:"backupDatasourceParametersList,omitempty"`
	DataStoreParametersList        *[]DataStoreParameters        `json:"dataStoreParametersList,omitempty"`
}

func (*PolicyParameters) UnmarshalJSON

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

type ProtectionStatusDetails

type ProtectionStatusDetails struct {
	ErrorDetails *UserFacingError `json:"errorDetails,omitempty"`
	Status       *Status          `json:"status,omitempty"`
}

type RangeBasedItemLevelRestoreCriteria

type RangeBasedItemLevelRestoreCriteria struct {
	MaxMatchingValue *string `json:"maxMatchingValue,omitempty"`
	MinMatchingValue *string `json:"minMatchingValue,omitempty"`
}

func (RangeBasedItemLevelRestoreCriteria) MarshalJSON

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

type RawAuthCredentialsImpl

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

RawAuthCredentialsImpl 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 RawAzureBackupRestoreRequestImpl

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

RawAzureBackupRestoreRequestImpl 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 RawBackupDatasourceParametersImpl

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

RawBackupDatasourceParametersImpl 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 RawBaseResourcePropertiesImpl

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

RawBaseResourcePropertiesImpl 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 RawDataStoreParametersImpl

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

RawDataStoreParametersImpl 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 RawItemLevelRestoreCriteriaImpl

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

RawItemLevelRestoreCriteriaImpl 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 RawOperationExtendedInfoImpl

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

RawOperationExtendedInfoImpl 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 RawRestoreTargetInfoBaseImpl

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

RawRestoreTargetInfoBaseImpl 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 RecoveryOption

type RecoveryOption string
const (
	RecoveryOptionFailIfExists RecoveryOption = "FailIfExists"
)

func (*RecoveryOption) UnmarshalJSON

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

type RehydrationPriority

type RehydrationPriority string
const (
	RehydrationPriorityHigh     RehydrationPriority = "High"
	RehydrationPriorityInvalid  RehydrationPriority = "Invalid"
	RehydrationPriorityStandard RehydrationPriority = "Standard"
)

func (*RehydrationPriority) UnmarshalJSON

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

type ResourcePropertiesObjectType

type ResourcePropertiesObjectType string
const (
	ResourcePropertiesObjectTypeDefaultResourceProperties ResourcePropertiesObjectType = "DefaultResourceProperties"
)

func (*ResourcePropertiesObjectType) UnmarshalJSON

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

type RestoreFilesTargetInfo

type RestoreFilesTargetInfo struct {
	TargetDetails TargetDetails `json:"targetDetails"`

	// Fields inherited from RestoreTargetInfoBase
	RecoveryOption  RecoveryOption `json:"recoveryOption"`
	RestoreLocation *string        `json:"restoreLocation,omitempty"`
}

func (RestoreFilesTargetInfo) MarshalJSON

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

type RestoreTargetInfo

type RestoreTargetInfo struct {
	DatasourceAuthCredentials AuthCredentials `json:"datasourceAuthCredentials"`
	DatasourceInfo            Datasource      `json:"datasourceInfo"`
	DatasourceSetInfo         *DatasourceSet  `json:"datasourceSetInfo,omitempty"`

	// Fields inherited from RestoreTargetInfoBase
	RecoveryOption  RecoveryOption `json:"recoveryOption"`
	RestoreLocation *string        `json:"restoreLocation,omitempty"`
}

func (RestoreTargetInfo) MarshalJSON

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

func (*RestoreTargetInfo) UnmarshalJSON

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

type RestoreTargetInfoBase

type RestoreTargetInfoBase interface {
}

type RestoreTargetLocationType

type RestoreTargetLocationType string
const (
	RestoreTargetLocationTypeAzureBlobs RestoreTargetLocationType = "AzureBlobs"
	RestoreTargetLocationTypeAzureFiles RestoreTargetLocationType = "AzureFiles"
	RestoreTargetLocationTypeInvalid    RestoreTargetLocationType = "Invalid"
)

func (*RestoreTargetLocationType) UnmarshalJSON

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

type ResumeBackupsOperationResponse

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

type ResumeProtectionOperationResponse

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

type SecretStoreBasedAuthCredentials

type SecretStoreBasedAuthCredentials struct {
	SecretStoreResource *SecretStoreResource `json:"secretStoreResource,omitempty"`
}

func (SecretStoreBasedAuthCredentials) MarshalJSON

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

type SecretStoreResource

type SecretStoreResource struct {
	SecretStoreType SecretStoreType `json:"secretStoreType"`
	Uri             *string         `json:"uri,omitempty"`
	Value           *string         `json:"value,omitempty"`
}

type SecretStoreType

type SecretStoreType string
const (
	SecretStoreTypeAzureKeyVault SecretStoreType = "AzureKeyVault"
	SecretStoreTypeInvalid       SecretStoreType = "Invalid"
)

func (*SecretStoreType) UnmarshalJSON

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

type SourceDataStoreType

type SourceDataStoreType string
const (
	SourceDataStoreTypeArchiveStore     SourceDataStoreType = "ArchiveStore"
	SourceDataStoreTypeOperationalStore SourceDataStoreType = "OperationalStore"
	SourceDataStoreTypeSnapshotStore    SourceDataStoreType = "SnapshotStore"
	SourceDataStoreTypeVaultStore       SourceDataStoreType = "VaultStore"
)

func (*SourceDataStoreType) UnmarshalJSON

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

type Status

type Status string
const (
	StatusConfiguringProtection       Status = "ConfiguringProtection"
	StatusConfiguringProtectionFailed Status = "ConfiguringProtectionFailed"
	StatusProtectionConfigured        Status = "ProtectionConfigured"
	StatusProtectionStopped           Status = "ProtectionStopped"
	StatusSoftDeleted                 Status = "SoftDeleted"
	StatusSoftDeleting                Status = "SoftDeleting"
)

func (*Status) UnmarshalJSON

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

type StopProtectionOperationResponse

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

type SuspendBackupsOperationResponse

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

type SyncBackupInstanceOperationResponse

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

type SyncBackupInstanceRequest

type SyncBackupInstanceRequest struct {
	SyncType *SyncType `json:"syncType,omitempty"`
}

type SyncType

type SyncType string
const (
	SyncTypeDefault     SyncType = "Default"
	SyncTypeForceResync SyncType = "ForceResync"
)

func (*SyncType) UnmarshalJSON

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

type TargetDetails

type TargetDetails struct {
	FilePrefix                string                    `json:"filePrefix"`
	RestoreTargetLocationType RestoreTargetLocationType `json:"restoreTargetLocationType"`
	TargetResourceArmId       *string                   `json:"targetResourceArmId,omitempty"`
	Url                       string                    `json:"url"`
}

type TriggerBackupRequest

type TriggerBackupRequest struct {
	BackupRuleOptions AdHocBackupRuleOptions `json:"backupRuleOptions"`
}

type TriggerRehydrateOperationResponse

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

type TriggerRestoreOperationResponse

type TriggerRestoreOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *OperationJobExtendedInfo
}

type UserFacingError

type UserFacingError struct {
	Code              *string            `json:"code,omitempty"`
	Details           *[]UserFacingError `json:"details,omitempty"`
	InnerError        *InnerError        `json:"innerError,omitempty"`
	IsRetryable       *bool              `json:"isRetryable,omitempty"`
	IsUserError       *bool              `json:"isUserError,omitempty"`
	Message           *string            `json:"message,omitempty"`
	Properties        *map[string]string `json:"properties,omitempty"`
	RecommendedAction *[]string          `json:"recommendedAction,omitempty"`
	Target            *string            `json:"target,omitempty"`
}

type ValidateForBackupOperationResponse

type ValidateForBackupOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *OperationJobExtendedInfo
}

type ValidateForBackupRequest

type ValidateForBackupRequest struct {
	BackupInstance BackupInstance `json:"backupInstance"`
}

type ValidateForRestoreOperationResponse

type ValidateForRestoreOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *OperationJobExtendedInfo
}

type ValidateRestoreRequestObject

type ValidateRestoreRequestObject struct {
	RestoreRequestObject AzureBackupRestoreRequest `json:"restoreRequestObject"`
}

func (*ValidateRestoreRequestObject) UnmarshalJSON

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

type ValidationType

type ValidationType string
const (
	ValidationTypeDeepValidation    ValidationType = "DeepValidation"
	ValidationTypeShallowValidation ValidationType = "ShallowValidation"
)

func (*ValidationType) UnmarshalJSON

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

Source Files

Jump to

Keyboard shortcuts

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