azurebackupjob

package
v0.20240110.1151535 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/dataprotection/2022-04-01/azurebackupjob Documentation

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

Client Initialization

client := azurebackupjob.NewAzureBackupJobClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AzureBackupJobClient.ExportJobsOperationResultGet

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

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

Example Usage: AzureBackupJobClient.ExportJobsTrigger

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

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

Example Usage: AzureBackupJobClient.JobsGet

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateBackupJobID 

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

ValidateBackupJobID checks that 'input' can be parsed as a Backup Job 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

func ValidateOperationIdID 

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

ValidateOperationIdID checks that 'input' can be parsed as a Operation Id ID

Types

type AzureBackupJob 

type AzureBackupJob struct {
	ActivityID                 string             `json:"activityID"`
	BackupInstanceFriendlyName string             `json:"backupInstanceFriendlyName"`
	BackupInstanceId           *string            `json:"backupInstanceId,omitempty"`
	DataSourceId               string             `json:"dataSourceId"`
	DataSourceLocation         string             `json:"dataSourceLocation"`
	DataSourceName             string             `json:"dataSourceName"`
	DataSourceSetName          *string            `json:"dataSourceSetName,omitempty"`
	DataSourceType             string             `json:"dataSourceType"`
	DestinationDataStoreName   *string            `json:"destinationDataStoreName,omitempty"`
	Duration                   *string            `json:"duration,omitempty"`
	EndTime                    *string            `json:"endTime,omitempty"`
	ErrorDetails               *[]UserFacingError `json:"errorDetails,omitempty"`
	Etag                       *string            `json:"etag,omitempty"`
	ExtendedInfo               *JobExtendedInfo   `json:"extendedInfo,omitempty"`
	IsUserTriggered            bool               `json:"isUserTriggered"`
	Operation                  string             `json:"operation"`
	OperationCategory          string             `json:"operationCategory"`
	PolicyId                   *string            `json:"policyId,omitempty"`
	PolicyName                 *string            `json:"policyName,omitempty"`
	ProgressEnabled            bool               `json:"progressEnabled"`
	ProgressUrl                *string            `json:"progressUrl,omitempty"`
	RestoreType                *string            `json:"restoreType,omitempty"`
	SourceDataStoreName        *string            `json:"sourceDataStoreName,omitempty"`
	SourceResourceGroup        string             `json:"sourceResourceGroup"`
	SourceSubscriptionID       string             `json:"sourceSubscriptionID"`
	StartTime                  string             `json:"startTime"`
	Status                     string             `json:"status"`
	SubscriptionId             string             `json:"subscriptionId"`
	SupportedActions           []string           `json:"supportedActions"`
	VaultName                  string             `json:"vaultName"`
}

func (*AzureBackupJob) GetEndTimeAsTime 

func (o *AzureBackupJob) GetEndTimeAsTime() (*time.Time, error)

func (*AzureBackupJob) GetStartTimeAsTime 

func (o *AzureBackupJob) GetStartTimeAsTime() (*time.Time, error)

func (*AzureBackupJob) SetEndTimeAsTime 

func (o *AzureBackupJob) SetEndTimeAsTime(input time.Time)

func (*AzureBackupJob) SetStartTimeAsTime 

func (o *AzureBackupJob) SetStartTimeAsTime(input time.Time)

type AzureBackupJobClient 

type AzureBackupJobClient struct {
	Client *resourcemanager.Client
}

func NewAzureBackupJobClientWithBaseURI 

func NewAzureBackupJobClientWithBaseURI(sdkApi sdkEnv.Api) (*AzureBackupJobClient, error)

func (AzureBackupJobClient) ExportJobsOperationResultGet 

func (c AzureBackupJobClient) ExportJobsOperationResultGet(ctx context.Context, id OperationIdId) (result ExportJobsOperationResultGetOperationResponse, err error)

ExportJobsOperationResultGet ...

func (AzureBackupJobClient) ExportJobsTrigger 

func (c AzureBackupJobClient) ExportJobsTrigger(ctx context.Context, id BackupVaultId) (result ExportJobsTriggerOperationResponse, err error)

ExportJobsTrigger ...

func (AzureBackupJobClient) ExportJobsTriggerThenPoll 

func (c AzureBackupJobClient) ExportJobsTriggerThenPoll(ctx context.Context, id BackupVaultId) error

ExportJobsTriggerThenPoll performs ExportJobsTrigger then polls until it's completed

func (AzureBackupJobClient) JobsGet 

func (c AzureBackupJobClient) JobsGet(ctx context.Context, id BackupJobId) (result JobsGetOperationResponse, err error)

JobsGet ...

type AzureBackupJobResource 

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

type BackupJobId 

type BackupJobId struct {
	SubscriptionId    string
	ResourceGroupName string
	BackupVaultName   string
	JobId             string
}

BackupJobId is a struct representing the Resource ID for a Backup Job

func NewBackupJobID 

func NewBackupJobID(subscriptionId string, resourceGroupName string, backupVaultName string, jobId string) BackupJobId

NewBackupJobID returns a new BackupJobId struct

func ParseBackupJobID 

func ParseBackupJobID(input string) (*BackupJobId, error)

ParseBackupJobID parses 'input' into a BackupJobId

func ParseBackupJobIDInsensitively 

func ParseBackupJobIDInsensitively(input string) (*BackupJobId, error)

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

func (*BackupJobId) FromParseResult added in v0.20231127.1171502 

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

func (BackupJobId) ID 

func (id BackupJobId) ID() string

ID returns the formatted Backup Job ID

func (BackupJobId) Segments 

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

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

func (BackupJobId) String 

func (id BackupJobId) String() string

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

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 added in v0.20231127.1171502 

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 ExportJobsOperationResultGetOperationResponse 

type ExportJobsOperationResultGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ExportJobsResult
}

type ExportJobsResult 

type ExportJobsResult struct {
	BlobSasKey          *string `json:"blobSasKey,omitempty"`
	BlobUrl             *string `json:"blobUrl,omitempty"`
	ExcelFileBlobSasKey *string `json:"excelFileBlobSasKey,omitempty"`
	ExcelFileBlobUrl    *string `json:"excelFileBlobUrl,omitempty"`
}

type ExportJobsTriggerOperationResponse 

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

type InnerError 

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

type JobExtendedInfo 

type JobExtendedInfo struct {
	AdditionalDetails      *map[string]string              `json:"additionalDetails,omitempty"`
	BackupInstanceState    *string                         `json:"backupInstanceState,omitempty"`
	DataTransferredInBytes *float64                        `json:"dataTransferredInBytes,omitempty"`
	RecoveryDestination    *string                         `json:"recoveryDestination,omitempty"`
	SourceRecoverPoint     *RestoreJobRecoveryPointDetails `json:"sourceRecoverPoint,omitempty"`
	SubTasks               *[]JobSubTask                   `json:"subTasks,omitempty"`
	TargetRecoverPoint     *RestoreJobRecoveryPointDetails `json:"targetRecoverPoint,omitempty"`
}

type JobSubTask 

type JobSubTask struct {
	AdditionalDetails *map[string]string `json:"additionalDetails,omitempty"`
	TaskId            int64              `json:"taskId"`
	TaskName          string             `json:"taskName"`
	TaskProgress      *string            `json:"taskProgress,omitempty"`
	TaskStatus        string             `json:"taskStatus"`
}

type JobsGetOperationResponse 

type JobsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AzureBackupJobResource
}

type OperationIdId 

type OperationIdId struct {
	SubscriptionId    string
	ResourceGroupName string
	BackupVaultName   string
	OperationId       string
}

OperationIdId is a struct representing the Resource ID for a Operation Id

func NewOperationIdID 

func NewOperationIdID(subscriptionId string, resourceGroupName string, backupVaultName string, operationId string) OperationIdId

NewOperationIdID returns a new OperationIdId struct

func ParseOperationIdID 

func ParseOperationIdID(input string) (*OperationIdId, error)

ParseOperationIdID parses 'input' into a OperationIdId

func ParseOperationIdIDInsensitively 

func ParseOperationIdIDInsensitively(input string) (*OperationIdId, error)

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

func (*OperationIdId) FromParseResult added in v0.20231127.1171502 

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

func (OperationIdId) ID 

func (id OperationIdId) ID() string

ID returns the formatted Operation Id ID

func (OperationIdId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Operation Id ID

func (OperationIdId) String 

func (id OperationIdId) String() string

String returns a human-readable description of this Operation Id ID

type RestoreJobRecoveryPointDetails 

type RestoreJobRecoveryPointDetails struct {
	RecoveryPointID   *string `json:"recoveryPointID,omitempty"`
	RecoveryPointTime *string `json:"recoveryPointTime,omitempty"`
}

func (*RestoreJobRecoveryPointDetails) GetRecoveryPointTimeAsTime 

func (o *RestoreJobRecoveryPointDetails) GetRecoveryPointTimeAsTime() (*time.Time, error)

func (*RestoreJobRecoveryPointDetails) SetRecoveryPointTimeAsTime 

func (o *RestoreJobRecoveryPointDetails) SetRecoveryPointTimeAsTime(input time.Time)

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"`
}

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.