deletedbackupinstances

package
v0.20240424.1114424 Latest Latest
Warning

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

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

README

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

The deletedbackupinstances 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/deletedbackupinstances"

Client Initialization

client := deletedbackupinstances.NewDeletedBackupInstancesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DeletedBackupInstancesClient.Get

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

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

ctx := context.TODO()
id := deletedbackupinstances.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: DeletedBackupInstancesClient.Undelete

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

if err := client.UndeleteThenPoll(ctx, id); 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 PossibleValuesForResourcePropertiesObjectType

func PossibleValuesForResourcePropertiesObjectType() []string

func PossibleValuesForSecretStoreType

func PossibleValuesForSecretStoreType() []string

func PossibleValuesForStatus

func PossibleValuesForStatus() []string

func PossibleValuesForValidationType

func PossibleValuesForValidationType() []string

func ValidateBackupVaultID

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

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

func ValidateDeletedBackupInstanceID

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

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

Types

type AuthCredentials

type AuthCredentials interface {
}

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 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 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 DeletedBackupInstance

type DeletedBackupInstance struct {
	CurrentProtectionState    *CurrentProtectionState  `json:"currentProtectionState,omitempty"`
	DataSourceInfo            Datasource               `json:"dataSourceInfo"`
	DataSourceSetInfo         *DatasourceSet           `json:"dataSourceSetInfo,omitempty"`
	DatasourceAuthCredentials AuthCredentials          `json:"datasourceAuthCredentials"`
	DeletionInfo              *DeletionInfo            `json:"deletionInfo,omitempty"`
	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 (*DeletedBackupInstance) UnmarshalJSON

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

type DeletedBackupInstanceId

type DeletedBackupInstanceId struct {
	SubscriptionId            string
	ResourceGroupName         string
	BackupVaultName           string
	DeletedBackupInstanceName string
}

DeletedBackupInstanceId is a struct representing the Resource ID for a Deleted Backup Instance

func NewDeletedBackupInstanceID

func NewDeletedBackupInstanceID(subscriptionId string, resourceGroupName string, backupVaultName string, deletedBackupInstanceName string) DeletedBackupInstanceId

NewDeletedBackupInstanceID returns a new DeletedBackupInstanceId struct

func ParseDeletedBackupInstanceID

func ParseDeletedBackupInstanceID(input string) (*DeletedBackupInstanceId, error)

ParseDeletedBackupInstanceID parses 'input' into a DeletedBackupInstanceId

func ParseDeletedBackupInstanceIDInsensitively

func ParseDeletedBackupInstanceIDInsensitively(input string) (*DeletedBackupInstanceId, error)

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

func (*DeletedBackupInstanceId) FromParseResult

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

func (DeletedBackupInstanceId) ID

ID returns the formatted Deleted Backup Instance ID

func (DeletedBackupInstanceId) Segments

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

func (DeletedBackupInstanceId) String

func (id DeletedBackupInstanceId) String() string

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

type DeletedBackupInstanceResource

type DeletedBackupInstanceResource struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *DeletedBackupInstance `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type DeletedBackupInstanceResourceOperationPredicate

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

func (DeletedBackupInstanceResourceOperationPredicate) Matches

type DeletedBackupInstancesClient

type DeletedBackupInstancesClient struct {
	Client *resourcemanager.Client
}

func NewDeletedBackupInstancesClientWithBaseURI

func NewDeletedBackupInstancesClientWithBaseURI(sdkApi sdkEnv.Api) (*DeletedBackupInstancesClient, error)

func (DeletedBackupInstancesClient) Get

Get ...

func (DeletedBackupInstancesClient) List

List ...

func (DeletedBackupInstancesClient) ListComplete

ListComplete retrieves all the results into a single object

func (DeletedBackupInstancesClient) ListCompleteMatchingPredicate

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DeletedBackupInstancesClient) Undelete

Undelete ...

func (DeletedBackupInstancesClient) UndeleteThenPoll

UndeleteThenPoll performs Undelete then polls until it's completed

type DeletionInfo

type DeletionInfo struct {
	BillingEndDate     *string `json:"billingEndDate,omitempty"`
	DeleteActivityID   *string `json:"deleteActivityID,omitempty"`
	DeletionTime       *string `json:"deletionTime,omitempty"`
	ScheduledPurgeTime *string `json:"scheduledPurgeTime,omitempty"`
}

type GetOperationResponse

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

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 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 ListCompleteResult

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

type ListOperationResponse

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

type NamespacedNameResource

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

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 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 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 ResourcePropertiesObjectType

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

func (*ResourcePropertiesObjectType) UnmarshalJSON

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

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 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 UndeleteOperationResponse

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

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 ValidationType

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

func (*ValidationType) UnmarshalJSON

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

Jump to

Keyboard shortcuts

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