armdataprotection

package module
v3.1.0 Latest Latest
Warning

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

 Go to latest Published: Jul 25, 2024 License: MIT Imports: 15 Imported by: 3

README

Azure Backup Module for Go

PkgGoDev

The armdataprotection module provides operations for working with Azure Backup.

Source code

Getting started

Prerequisites

  • an Azure subscription
  • Go 1.18 or above (You could download and install the latest version of Go from here. It will replace the existing Go on your machine. If you want to install multiple Go versions on the same machine, you could refer this doc.)

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Backup module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/dataprotection/armdataprotection/v3

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Backup. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Client Factory

Azure Backup module consists of one or more clients. We provide a client factory which could be used to create any client in this module.

clientFactory, err := armdataprotection.NewClientFactory(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options := arm.ClientOptions {
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
clientFactory, err := armdataprotection.NewClientFactory(<subscription ID>, cred, &options)

Clients

A client groups a set of related APIs, providing access to its functionality. Create one or more clients to access the APIs you require using client factory.

client := clientFactory.NewBackupInstancesClient()

Fakes

The fake package contains types used for constructing in-memory fake servers used in unit tests. This allows writing tests to cover various success/error conditions without the need for connecting to a live service.

Please see https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/samples/fakes for details and examples on how to use fakes.

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Backup label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AbsoluteDeleteOption 

type AbsoluteDeleteOption struct {
	// REQUIRED; Duration of deletion after given timespan
	Duration *string

	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string
}

AbsoluteDeleteOption - Delete option with duration

func (*AbsoluteDeleteOption) GetDeleteOption 

func (a *AbsoluteDeleteOption) GetDeleteOption() *DeleteOption

GetDeleteOption implements the DeleteOptionClassification interface for type AbsoluteDeleteOption.

func (AbsoluteDeleteOption) MarshalJSON 

func (a AbsoluteDeleteOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AbsoluteDeleteOption.

func (*AbsoluteDeleteOption) UnmarshalJSON 

func (a *AbsoluteDeleteOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AbsoluteDeleteOption.

type AbsoluteMarker 

type AbsoluteMarker string
const (
	AbsoluteMarkerAllBackup    AbsoluteMarker = "AllBackup"
	AbsoluteMarkerFirstOfDay   AbsoluteMarker = "FirstOfDay"
	AbsoluteMarkerFirstOfMonth AbsoluteMarker = "FirstOfMonth"
	AbsoluteMarkerFirstOfWeek  AbsoluteMarker = "FirstOfWeek"
	AbsoluteMarkerFirstOfYear  AbsoluteMarker = "FirstOfYear"
)

func PossibleAbsoluteMarkerValues 

func PossibleAbsoluteMarkerValues() []AbsoluteMarker

PossibleAbsoluteMarkerValues returns the possible values for the AbsoluteMarker const type.

type AdHocBackupRuleOptions 

type AdHocBackupRuleOptions struct {
	// REQUIRED
	RuleName *string

	// REQUIRED; Adhoc backup trigger option
	TriggerOption *AdhocBackupTriggerOption
}

AdHocBackupRuleOptions - Adhoc backup rules

func (AdHocBackupRuleOptions) MarshalJSON 

func (a AdHocBackupRuleOptions) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AdHocBackupRuleOptions.

func (*AdHocBackupRuleOptions) UnmarshalJSON 

func (a *AdHocBackupRuleOptions) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AdHocBackupRuleOptions.

type AdhocBackupTriggerOption 

type AdhocBackupTriggerOption struct {
	RetentionTagOverride *string
}

AdhocBackupTriggerOption - Adhoc backup trigger option

func (AdhocBackupTriggerOption) MarshalJSON 

func (a AdhocBackupTriggerOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AdhocBackupTriggerOption.

func (*AdhocBackupTriggerOption) UnmarshalJSON 

func (a *AdhocBackupTriggerOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AdhocBackupTriggerOption.

type AdhocBasedTaggingCriteria 

type AdhocBasedTaggingCriteria struct {
	// Retention tag information
	TagInfo *RetentionTag
}

AdhocBasedTaggingCriteria - Adhoc backup tagging criteria

func (AdhocBasedTaggingCriteria) MarshalJSON 

func (a AdhocBasedTaggingCriteria) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AdhocBasedTaggingCriteria.

func (*AdhocBasedTaggingCriteria) UnmarshalJSON 

func (a *AdhocBasedTaggingCriteria) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AdhocBasedTaggingCriteria.

type AdhocBasedTriggerContext 

type AdhocBasedTriggerContext struct {
	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string

	// REQUIRED; Tagging Criteria containing retention tag for adhoc backup.
	TaggingCriteria *AdhocBasedTaggingCriteria
}

AdhocBasedTriggerContext - Adhoc trigger context

func (*AdhocBasedTriggerContext) GetTriggerContext 

func (a *AdhocBasedTriggerContext) GetTriggerContext() *TriggerContext

GetTriggerContext implements the TriggerContextClassification interface for type AdhocBasedTriggerContext.

func (AdhocBasedTriggerContext) MarshalJSON 

func (a AdhocBasedTriggerContext) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AdhocBasedTriggerContext.

func (*AdhocBasedTriggerContext) UnmarshalJSON 

func (a *AdhocBasedTriggerContext) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AdhocBasedTriggerContext.

type AlertsState 

type AlertsState string
const (
	AlertsStateDisabled AlertsState = "Disabled"
	AlertsStateEnabled  AlertsState = "Enabled"
)

func PossibleAlertsStateValues 

func PossibleAlertsStateValues() []AlertsState

PossibleAlertsStateValues returns the possible values for the AlertsState const type.

type AuthCredentials 

type AuthCredentials struct {
	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string
}

AuthCredentials - Base class for different types of authentication credentials.

func (*AuthCredentials) GetAuthCredentials 

func (a *AuthCredentials) GetAuthCredentials() *AuthCredentials

GetAuthCredentials implements the AuthCredentialsClassification interface for type AuthCredentials.

func (AuthCredentials) MarshalJSON 

func (a AuthCredentials) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AuthCredentials.

func (*AuthCredentials) UnmarshalJSON 

func (a *AuthCredentials) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AuthCredentials.

type AuthCredentialsClassification 

type AuthCredentialsClassification interface {
	// GetAuthCredentials returns the AuthCredentials content of the underlying type.
	GetAuthCredentials() *AuthCredentials
}

AuthCredentialsClassification provides polymorphic access to related types. Call the interface's GetAuthCredentials() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AuthCredentials, *SecretStoreBasedAuthCredentials

type AzureBackupDiscreteRecoveryPoint 

type AzureBackupDiscreteRecoveryPoint struct {
	// REQUIRED
	ObjectType *string

	// REQUIRED
	RecoveryPointTime              *time.Time
	FriendlyName                   *string
	PolicyName                     *string
	PolicyVersion                  *string
	RecoveryPointDataStoresDetails []*RecoveryPointDataStoreDetails
	RecoveryPointID                *string

	// Specifies recovery point completeness. Partial (i.e., only some of the intended items were backed up), or Completed (i.e.,
	// ALL intended items were backed up).
	RecoveryPointState  *RecoveryPointCompletionState
	RecoveryPointType   *string
	RetentionTagName    *string
	RetentionTagVersion *string

	// READ-ONLY
	ExpiryTime *time.Time
}

AzureBackupDiscreteRecoveryPoint - Azure backup discrete RecoveryPoint

func (*AzureBackupDiscreteRecoveryPoint) GetAzureBackupRecoveryPoint 

func (a *AzureBackupDiscreteRecoveryPoint) GetAzureBackupRecoveryPoint() *AzureBackupRecoveryPoint

GetAzureBackupRecoveryPoint implements the AzureBackupRecoveryPointClassification interface for type AzureBackupDiscreteRecoveryPoint.

func (AzureBackupDiscreteRecoveryPoint) MarshalJSON 

func (a AzureBackupDiscreteRecoveryPoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureBackupDiscreteRecoveryPoint.

func (*AzureBackupDiscreteRecoveryPoint) UnmarshalJSON 

func (a *AzureBackupDiscreteRecoveryPoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureBackupDiscreteRecoveryPoint.

type AzureBackupFindRestorableTimeRangesRequest 

type AzureBackupFindRestorableTimeRangesRequest struct {
	// REQUIRED; Gets or sets the type of the source data store.
	SourceDataStoreType *RestoreSourceDataStoreType

	// End time for the List Restore Ranges request. ISO 8601 format.
	EndTime *string

	// Start time for the List Restore Ranges request. ISO 8601 format.
	StartTime *string
}

AzureBackupFindRestorableTimeRangesRequest - List Restore Ranges Request

func (AzureBackupFindRestorableTimeRangesRequest) MarshalJSON 

func (a AzureBackupFindRestorableTimeRangesRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureBackupFindRestorableTimeRangesRequest.

func (*AzureBackupFindRestorableTimeRangesRequest) UnmarshalJSON 

func (a *AzureBackupFindRestorableTimeRangesRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureBackupFindRestorableTimeRangesRequest.

type AzureBackupFindRestorableTimeRangesRequestResource 

type AzureBackupFindRestorableTimeRangesRequestResource struct {
	// AzureBackupFindRestorableTimeRangesRequestResource content
	Content     *AzureBackupFindRestorableTimeRangesRequest
	CultureInfo *string
	HTTPMethod  *string

	// Dictionary of
	Headers map[string][]*string

	// Dictionary of
	Parameters             map[string]*string
	SubscriptionID         *string
	SupportedGroupVersions []*string
	URI                    *string
}

AzureBackupFindRestorableTimeRangesRequestResource - List Restore Ranges Request

func (AzureBackupFindRestorableTimeRangesRequestResource) MarshalJSON 

func (a AzureBackupFindRestorableTimeRangesRequestResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureBackupFindRestorableTimeRangesRequestResource.

func (*AzureBackupFindRestorableTimeRangesRequestResource) UnmarshalJSON 

func (a *AzureBackupFindRestorableTimeRangesRequestResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureBackupFindRestorableTimeRangesRequestResource.

type AzureBackupFindRestorableTimeRangesResponse 

type AzureBackupFindRestorableTimeRangesResponse struct {
	ObjectType *string

	// Returns the Restore Ranges available on the Backup Instance.
	RestorableTimeRanges []*RestorableTimeRange
}

AzureBackupFindRestorableTimeRangesResponse - List Restore Ranges Response

func (AzureBackupFindRestorableTimeRangesResponse) MarshalJSON 

func (a AzureBackupFindRestorableTimeRangesResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureBackupFindRestorableTimeRangesResponse.

func (*AzureBackupFindRestorableTimeRangesResponse) UnmarshalJSON 

func (a *AzureBackupFindRestorableTimeRangesResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureBackupFindRestorableTimeRangesResponse.

type AzureBackupFindRestorableTimeRangesResponseResource 

type AzureBackupFindRestorableTimeRangesResponseResource struct {
	// AzureBackupFindRestorableTimeRangesResponseResource properties
	Properties *AzureBackupFindRestorableTimeRangesResponse

	// READ-ONLY; Resource Id represents the complete path to the resource.
	ID *string

	// READ-ONLY; Resource name associated with the resource.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…
	Type *string
}

AzureBackupFindRestorableTimeRangesResponseResource - List Restore Ranges Response

func (AzureBackupFindRestorableTimeRangesResponseResource) MarshalJSON 

func (a AzureBackupFindRestorableTimeRangesResponseResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureBackupFindRestorableTimeRangesResponseResource.

func (*AzureBackupFindRestorableTimeRangesResponseResource) UnmarshalJSON 

func (a *AzureBackupFindRestorableTimeRangesResponseResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureBackupFindRestorableTimeRangesResponseResource.

type AzureBackupJob 

type AzureBackupJob struct {
	// REQUIRED; Job Activity Id
	ActivityID *string

	// REQUIRED; Name of the Backup Instance
	BackupInstanceFriendlyName *string

	// REQUIRED; ARM ID of the DataSource
	DataSourceID *string

	// REQUIRED; Location of the DataSource
	DataSourceLocation *string

	// REQUIRED; User Friendly Name of the DataSource
	DataSourceName *string

	// REQUIRED; Type of DataSource
	DataSourceType *string

	// REQUIRED; Indicated that whether the job is adhoc(true) or scheduled(false)
	IsUserTriggered *bool

	// REQUIRED; It indicates the type of Job i.e. Backup:full/log/diff ;Restore:ALR/OLR; Tiering:Backup/Archive ; Management:ConfigureProtection/UnConfigure
	Operation *string

	// REQUIRED; It indicates the type of Job i.e. Backup/Restore/Tiering/Management
	OperationCategory *string

	// REQUIRED; Indicated whether progress is enabled for the job
	ProgressEnabled *bool

	// REQUIRED; Resource Group Name of the Datasource
	SourceResourceGroup *string

	// REQUIRED; SubscriptionId corresponding to the DataSource
	SourceSubscriptionID *string

	// REQUIRED; StartTime of the job(in UTC)
	StartTime *time.Time

	// REQUIRED; Status of the job like InProgress/Success/Failed/Cancelled/SuccessWithWarning
	Status *string

	// REQUIRED; Subscription Id of the corresponding backup vault
	SubscriptionID *string

	// REQUIRED; List of supported actions
	SupportedActions []*string

	// REQUIRED; Name of the vault
	VaultName *string

	// Data Source Set Name of the DataSource
	DataSourceSetName        *string
	DestinationDataStoreName *string

	// Total run time of the job. ISO 8601 format.
	Duration            *string
	Etag                *string
	SourceDataStoreName *string

	// READ-ONLY; ARM ID of the Backup Instance
	BackupInstanceID *string

	// READ-ONLY; EndTime of the job(in UTC)
	EndTime *time.Time

	// READ-ONLY; A List, detailing the errors related to the job
	ErrorDetails []*UserFacingError

	// READ-ONLY; Extended Information about the job
	ExtendedInfo *JobExtendedInfo

	// READ-ONLY; ARM ID of the policy
	PolicyID *string

	// READ-ONLY; Name of the policy
	PolicyName *string

	// READ-ONLY; Url which contains job's progress
	ProgressURL *string

	// READ-ONLY; Priority to be used for rehydration
	RehydrationPriority *string

	// READ-ONLY; It indicates the sub type of operation i.e. in case of Restore it can be ALR/OLR
	RestoreType *string
}

AzureBackupJob - AzureBackup Job Class

func (AzureBackupJob) MarshalJSON 

func (a AzureBackupJob) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureBackupJob.

func (*AzureBackupJob) UnmarshalJSON 

func (a *AzureBackupJob) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureBackupJob.

type AzureBackupJobResource 

type AzureBackupJobResource struct {
	// AzureBackupJobResource properties
	Properties *AzureBackupJob

	// READ-ONLY; Resource Id represents the complete path to the resource.
	ID *string

	// READ-ONLY; Resource name associated with the resource.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…
	Type *string
}

AzureBackupJobResource - AzureBackup Job Resource Class

func (AzureBackupJobResource) MarshalJSON 

func (a AzureBackupJobResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureBackupJobResource.

func (*AzureBackupJobResource) UnmarshalJSON 

func (a *AzureBackupJobResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureBackupJobResource.

type AzureBackupJobResourceList 

type AzureBackupJobResourceList struct {
	// The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
	NextLink *string

	// List of resources.
	Value []*AzureBackupJobResource
}

AzureBackupJobResourceList - List of AzureBackup Job resources

func (AzureBackupJobResourceList) MarshalJSON 

func (a AzureBackupJobResourceList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureBackupJobResourceList.

func (*AzureBackupJobResourceList) UnmarshalJSON 

func (a *AzureBackupJobResourceList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureBackupJobResourceList.

type AzureBackupParams 

type AzureBackupParams struct {
	// REQUIRED; BackupType ; Full/Incremental etc
	BackupType *string

	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string
}

AzureBackupParams - Azure backup parameters

func (*AzureBackupParams) GetBackupParameters 

func (a *AzureBackupParams) GetBackupParameters() *BackupParameters

GetBackupParameters implements the BackupParametersClassification interface for type AzureBackupParams.

func (AzureBackupParams) MarshalJSON 

func (a AzureBackupParams) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureBackupParams.

func (*AzureBackupParams) UnmarshalJSON 

func (a *AzureBackupParams) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureBackupParams.

type AzureBackupRecoveryPoint 

type AzureBackupRecoveryPoint struct {
	// REQUIRED
	ObjectType *string
}

AzureBackupRecoveryPoint - Azure backup recoveryPoint

func (*AzureBackupRecoveryPoint) GetAzureBackupRecoveryPoint 

func (a *AzureBackupRecoveryPoint) GetAzureBackupRecoveryPoint() *AzureBackupRecoveryPoint

GetAzureBackupRecoveryPoint implements the AzureBackupRecoveryPointClassification interface for type AzureBackupRecoveryPoint.

func (AzureBackupRecoveryPoint) MarshalJSON 

func (a AzureBackupRecoveryPoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureBackupRecoveryPoint.

func (*AzureBackupRecoveryPoint) UnmarshalJSON 

func (a *AzureBackupRecoveryPoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureBackupRecoveryPoint.

type AzureBackupRecoveryPointBasedRestoreRequest 

type AzureBackupRecoveryPointBasedRestoreRequest struct {
	// REQUIRED
	ObjectType *string

	// REQUIRED
	RecoveryPointID *string

	// REQUIRED; Gets or sets the restore target information.
	RestoreTargetInfo RestoreTargetInfoBaseClassification

	// REQUIRED; Gets or sets the type of the source data store.
	SourceDataStoreType *SourceDataStoreType

	// Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
	IdentityDetails *IdentityDetails

	// ResourceGuardOperationRequests on which LAC check will be performed
	ResourceGuardOperationRequests []*string

	// Fully qualified Azure Resource Manager ID of the datasource which is being recovered.
	SourceResourceID *string
}

AzureBackupRecoveryPointBasedRestoreRequest - Azure backup recoveryPoint based restore request

func (*AzureBackupRecoveryPointBasedRestoreRequest) GetAzureBackupRecoveryPointBasedRestoreRequest 

func (a *AzureBackupRecoveryPointBasedRestoreRequest) GetAzureBackupRecoveryPointBasedRestoreRequest() *AzureBackupRecoveryPointBasedRestoreRequest

GetAzureBackupRecoveryPointBasedRestoreRequest implements the AzureBackupRecoveryPointBasedRestoreRequestClassification interface for type AzureBackupRecoveryPointBasedRestoreRequest.

func (*AzureBackupRecoveryPointBasedRestoreRequest) GetAzureBackupRestoreRequest 

func (a *AzureBackupRecoveryPointBasedRestoreRequest) GetAzureBackupRestoreRequest() *AzureBackupRestoreRequest

GetAzureBackupRestoreRequest implements the AzureBackupRestoreRequestClassification interface for type AzureBackupRecoveryPointBasedRestoreRequest.

func (AzureBackupRecoveryPointBasedRestoreRequest) MarshalJSON 

func (a AzureBackupRecoveryPointBasedRestoreRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureBackupRecoveryPointBasedRestoreRequest.

func (*AzureBackupRecoveryPointBasedRestoreRequest) UnmarshalJSON 

func (a *AzureBackupRecoveryPointBasedRestoreRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureBackupRecoveryPointBasedRestoreRequest.

type AzureBackupRecoveryPointBasedRestoreRequestClassification 

type AzureBackupRecoveryPointBasedRestoreRequestClassification interface {
	AzureBackupRestoreRequestClassification
	// GetAzureBackupRecoveryPointBasedRestoreRequest returns the AzureBackupRecoveryPointBasedRestoreRequest content of the underlying type.
	GetAzureBackupRecoveryPointBasedRestoreRequest() *AzureBackupRecoveryPointBasedRestoreRequest
}

AzureBackupRecoveryPointBasedRestoreRequestClassification provides polymorphic access to related types. Call the interface's GetAzureBackupRecoveryPointBasedRestoreRequest() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AzureBackupRecoveryPointBasedRestoreRequest, *AzureBackupRestoreWithRehydrationRequest

type AzureBackupRecoveryPointClassification 

type AzureBackupRecoveryPointClassification interface {
	// GetAzureBackupRecoveryPoint returns the AzureBackupRecoveryPoint content of the underlying type.
	GetAzureBackupRecoveryPoint() *AzureBackupRecoveryPoint
}

AzureBackupRecoveryPointClassification provides polymorphic access to related types. Call the interface's GetAzureBackupRecoveryPoint() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AzureBackupDiscreteRecoveryPoint, *AzureBackupRecoveryPoint

type AzureBackupRecoveryPointResource 

type AzureBackupRecoveryPointResource struct {
	// AzureBackupRecoveryPointResource properties
	Properties AzureBackupRecoveryPointClassification

	// READ-ONLY; Resource Id represents the complete path to the resource.
	ID *string

	// READ-ONLY; Resource name associated with the resource.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…
	Type *string
}

AzureBackupRecoveryPointResource - Azure backup recoveryPoint resource

func (AzureBackupRecoveryPointResource) MarshalJSON 

func (a AzureBackupRecoveryPointResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureBackupRecoveryPointResource.

func (*AzureBackupRecoveryPointResource) UnmarshalJSON 

func (a *AzureBackupRecoveryPointResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureBackupRecoveryPointResource.

type AzureBackupRecoveryPointResourceList 

type AzureBackupRecoveryPointResourceList struct {
	// The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
	NextLink *string

	// List of resources.
	Value []*AzureBackupRecoveryPointResource
}

AzureBackupRecoveryPointResourceList - Azure backup recoveryPoint resource list

func (AzureBackupRecoveryPointResourceList) MarshalJSON 

func (a AzureBackupRecoveryPointResourceList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureBackupRecoveryPointResourceList.

func (*AzureBackupRecoveryPointResourceList) UnmarshalJSON 

func (a *AzureBackupRecoveryPointResourceList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureBackupRecoveryPointResourceList.

type AzureBackupRecoveryTimeBasedRestoreRequest 

type AzureBackupRecoveryTimeBasedRestoreRequest struct {
	// REQUIRED
	ObjectType *string

	// REQUIRED; The recovery time in ISO 8601 format example - 2020-08-14T17:30:00.0000000Z.
	RecoveryPointTime *string

	// REQUIRED; Gets or sets the restore target information.
	RestoreTargetInfo RestoreTargetInfoBaseClassification

	// REQUIRED; Gets or sets the type of the source data store.
	SourceDataStoreType *SourceDataStoreType

	// Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
	IdentityDetails *IdentityDetails

	// ResourceGuardOperationRequests on which LAC check will be performed
	ResourceGuardOperationRequests []*string

	// Fully qualified Azure Resource Manager ID of the datasource which is being recovered.
	SourceResourceID *string
}

AzureBackupRecoveryTimeBasedRestoreRequest - AzureBackup RecoveryPointTime Based Restore Request

func (*AzureBackupRecoveryTimeBasedRestoreRequest) GetAzureBackupRestoreRequest 

func (a *AzureBackupRecoveryTimeBasedRestoreRequest) GetAzureBackupRestoreRequest() *AzureBackupRestoreRequest

GetAzureBackupRestoreRequest implements the AzureBackupRestoreRequestClassification interface for type AzureBackupRecoveryTimeBasedRestoreRequest.

func (AzureBackupRecoveryTimeBasedRestoreRequest) MarshalJSON 

func (a AzureBackupRecoveryTimeBasedRestoreRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureBackupRecoveryTimeBasedRestoreRequest.

func (*AzureBackupRecoveryTimeBasedRestoreRequest) UnmarshalJSON 

func (a *AzureBackupRecoveryTimeBasedRestoreRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureBackupRecoveryTimeBasedRestoreRequest.

type AzureBackupRehydrationRequest 

type AzureBackupRehydrationRequest struct {
	// REQUIRED; Id of the recovery point to be recovered
	RecoveryPointID *string

	// REQUIRED; Retention duration in ISO 8601 format i.e P10D .
	RehydrationRetentionDuration *string

	// Priority to be used for rehydration. Values High or Standard
	RehydrationPriority *RehydrationPriority
}

AzureBackupRehydrationRequest - Azure Backup Rehydrate Request

func (AzureBackupRehydrationRequest) MarshalJSON 

func (a AzureBackupRehydrationRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureBackupRehydrationRequest.

func (*AzureBackupRehydrationRequest) UnmarshalJSON 

func (a *AzureBackupRehydrationRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureBackupRehydrationRequest.

type AzureBackupRestoreRequest 

type AzureBackupRestoreRequest struct {
	// REQUIRED
	ObjectType *string

	// REQUIRED; Gets or sets the restore target information.
	RestoreTargetInfo RestoreTargetInfoBaseClassification

	// REQUIRED; Gets or sets the type of the source data store.
	SourceDataStoreType *SourceDataStoreType

	// Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
	IdentityDetails *IdentityDetails

	// ResourceGuardOperationRequests on which LAC check will be performed
	ResourceGuardOperationRequests []*string

	// Fully qualified Azure Resource Manager ID of the datasource which is being recovered.
	SourceResourceID *string
}

AzureBackupRestoreRequest - Azure backup restore request

func (*AzureBackupRestoreRequest) GetAzureBackupRestoreRequest 

func (a *AzureBackupRestoreRequest) GetAzureBackupRestoreRequest() *AzureBackupRestoreRequest

GetAzureBackupRestoreRequest implements the AzureBackupRestoreRequestClassification interface for type AzureBackupRestoreRequest.

func (AzureBackupRestoreRequest) MarshalJSON 

func (a AzureBackupRestoreRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureBackupRestoreRequest.

func (*AzureBackupRestoreRequest) UnmarshalJSON 

func (a *AzureBackupRestoreRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureBackupRestoreRequest.

type AzureBackupRestoreRequestClassification 

type AzureBackupRestoreRequestClassification interface {
	// GetAzureBackupRestoreRequest returns the AzureBackupRestoreRequest content of the underlying type.
	GetAzureBackupRestoreRequest() *AzureBackupRestoreRequest
}

AzureBackupRestoreRequestClassification provides polymorphic access to related types. Call the interface's GetAzureBackupRestoreRequest() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AzureBackupRecoveryPointBasedRestoreRequest, *AzureBackupRecoveryTimeBasedRestoreRequest, *AzureBackupRestoreRequest, - *AzureBackupRestoreWithRehydrationRequest

type AzureBackupRestoreWithRehydrationRequest 

type AzureBackupRestoreWithRehydrationRequest struct {
	// REQUIRED
	ObjectType *string

	// REQUIRED
	RecoveryPointID *string

	// REQUIRED; Priority to be used for rehydration. Values High or Standard
	RehydrationPriority *RehydrationPriority

	// REQUIRED; Retention duration in ISO 8601 format i.e P10D .
	RehydrationRetentionDuration *string

	// REQUIRED; Gets or sets the restore target information.
	RestoreTargetInfo RestoreTargetInfoBaseClassification

	// REQUIRED; Gets or sets the type of the source data store.
	SourceDataStoreType *SourceDataStoreType

	// Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
	IdentityDetails *IdentityDetails

	// ResourceGuardOperationRequests on which LAC check will be performed
	ResourceGuardOperationRequests []*string

	// Fully qualified Azure Resource Manager ID of the datasource which is being recovered.
	SourceResourceID *string
}

AzureBackupRestoreWithRehydrationRequest - AzureBackup Restore with Rehydration Request

func (*AzureBackupRestoreWithRehydrationRequest) GetAzureBackupRecoveryPointBasedRestoreRequest 

func (a *AzureBackupRestoreWithRehydrationRequest) GetAzureBackupRecoveryPointBasedRestoreRequest() *AzureBackupRecoveryPointBasedRestoreRequest

GetAzureBackupRecoveryPointBasedRestoreRequest implements the AzureBackupRecoveryPointBasedRestoreRequestClassification interface for type AzureBackupRestoreWithRehydrationRequest.

func (*AzureBackupRestoreWithRehydrationRequest) GetAzureBackupRestoreRequest 

func (a *AzureBackupRestoreWithRehydrationRequest) GetAzureBackupRestoreRequest() *AzureBackupRestoreRequest

GetAzureBackupRestoreRequest implements the AzureBackupRestoreRequestClassification interface for type AzureBackupRestoreWithRehydrationRequest.

func (AzureBackupRestoreWithRehydrationRequest) MarshalJSON 

func (a AzureBackupRestoreWithRehydrationRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureBackupRestoreWithRehydrationRequest.

func (*AzureBackupRestoreWithRehydrationRequest) UnmarshalJSON 

func (a *AzureBackupRestoreWithRehydrationRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureBackupRestoreWithRehydrationRequest.

type AzureBackupRule 

type AzureBackupRule struct {
	// REQUIRED; DataStoreInfo base
	DataStore *DataStoreInfoBase

	// REQUIRED
	Name *string

	// REQUIRED
	ObjectType *string

	// REQUIRED; Trigger context
	Trigger TriggerContextClassification

	// BackupParameters base
	BackupParameters BackupParametersClassification
}

AzureBackupRule - Azure backup rule

func (*AzureBackupRule) GetBasePolicyRule 

func (a *AzureBackupRule) GetBasePolicyRule() *BasePolicyRule

GetBasePolicyRule implements the BasePolicyRuleClassification interface for type AzureBackupRule.

func (AzureBackupRule) MarshalJSON 

func (a AzureBackupRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureBackupRule.

func (*AzureBackupRule) UnmarshalJSON 

func (a *AzureBackupRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureBackupRule.

type AzureMonitorAlertSettings 

type AzureMonitorAlertSettings struct {
	AlertsForAllJobFailures *AlertsState
}

AzureMonitorAlertSettings - Settings for Azure Monitor based alerts

func (AzureMonitorAlertSettings) MarshalJSON 

func (a AzureMonitorAlertSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureMonitorAlertSettings.

func (*AzureMonitorAlertSettings) UnmarshalJSON 

func (a *AzureMonitorAlertSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureMonitorAlertSettings.

type AzureOperationalStoreParameters 

type AzureOperationalStoreParameters struct {
	// REQUIRED; type of datastore; Operational/Vault/Archive
	DataStoreType *DataStoreTypes

	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string

	// Gets or sets the Snapshot Resource Group Uri.
	ResourceGroupID *string
}

AzureOperationalStoreParameters - Parameters for Operational-Tier DataStore

func (*AzureOperationalStoreParameters) GetDataStoreParameters 

func (a *AzureOperationalStoreParameters) GetDataStoreParameters() *DataStoreParameters

GetDataStoreParameters implements the DataStoreParametersClassification interface for type AzureOperationalStoreParameters.

func (AzureOperationalStoreParameters) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AzureOperationalStoreParameters.

func (*AzureOperationalStoreParameters) UnmarshalJSON 

func (a *AzureOperationalStoreParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureOperationalStoreParameters.

type AzureRetentionRule 

type AzureRetentionRule struct {
	// REQUIRED
	Lifecycles []*SourceLifeCycle

	// REQUIRED
	Name *string

	// REQUIRED
	ObjectType *string
	IsDefault  *bool
}

AzureRetentionRule - Azure retention rule

func (*AzureRetentionRule) GetBasePolicyRule 

func (a *AzureRetentionRule) GetBasePolicyRule() *BasePolicyRule

GetBasePolicyRule implements the BasePolicyRuleClassification interface for type AzureRetentionRule.

func (AzureRetentionRule) MarshalJSON 

func (a AzureRetentionRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureRetentionRule.

func (*AzureRetentionRule) UnmarshalJSON 

func (a *AzureRetentionRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureRetentionRule.

type BCDRSecurityLevel added in v3.1.0 

type BCDRSecurityLevel string

BCDRSecurityLevel - Security Level of Backup Vault 

const (
	BCDRSecurityLevelExcellent    BCDRSecurityLevel = "Excellent"
	BCDRSecurityLevelFair         BCDRSecurityLevel = "Fair"
	BCDRSecurityLevelGood         BCDRSecurityLevel = "Good"
	BCDRSecurityLevelNotSupported BCDRSecurityLevel = "NotSupported"
	BCDRSecurityLevelPoor         BCDRSecurityLevel = "Poor"
)

func PossibleBCDRSecurityLevelValues added in v3.1.0 

func PossibleBCDRSecurityLevelValues() []BCDRSecurityLevel

PossibleBCDRSecurityLevelValues returns the possible values for the BCDRSecurityLevel const type.

type BackupCriteria 

type BackupCriteria struct {
	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string
}

BackupCriteria base class

func (*BackupCriteria) GetBackupCriteria 

func (b *BackupCriteria) GetBackupCriteria() *BackupCriteria

GetBackupCriteria implements the BackupCriteriaClassification interface for type BackupCriteria.

func (BackupCriteria) MarshalJSON 

func (b BackupCriteria) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackupCriteria.

func (*BackupCriteria) UnmarshalJSON 

func (b *BackupCriteria) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackupCriteria.

type BackupCriteriaClassification 

type BackupCriteriaClassification interface {
	// GetBackupCriteria returns the BackupCriteria content of the underlying type.
	GetBackupCriteria() *BackupCriteria
}

BackupCriteriaClassification provides polymorphic access to related types. Call the interface's GetBackupCriteria() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *BackupCriteria, *ScheduleBasedBackupCriteria

type BackupDatasourceParameters 

type BackupDatasourceParameters struct {
	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string
}

BackupDatasourceParameters - Parameters for Backup Datasource

func (*BackupDatasourceParameters) GetBackupDatasourceParameters 

func (b *BackupDatasourceParameters) GetBackupDatasourceParameters() *BackupDatasourceParameters

GetBackupDatasourceParameters implements the BackupDatasourceParametersClassification interface for type BackupDatasourceParameters.

func (BackupDatasourceParameters) MarshalJSON 

func (b BackupDatasourceParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackupDatasourceParameters.

func (*BackupDatasourceParameters) UnmarshalJSON 

func (b *BackupDatasourceParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackupDatasourceParameters.

type BackupDatasourceParametersClassification 

type BackupDatasourceParametersClassification interface {
	// GetBackupDatasourceParameters returns the BackupDatasourceParameters content of the underlying type.
	GetBackupDatasourceParameters() *BackupDatasourceParameters
}

BackupDatasourceParametersClassification provides polymorphic access to related types. Call the interface's GetBackupDatasourceParameters() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *BackupDatasourceParameters, *BlobBackupDatasourceParameters, *KubernetesClusterBackupDatasourceParameters

type BackupInstance 

type BackupInstance struct {
	// REQUIRED; Gets or sets the data source information.
	DataSourceInfo *Datasource

	// REQUIRED
	ObjectType *string

	// REQUIRED; Gets or sets the policy information.
	PolicyInfo *PolicyInfo

	// Gets or sets the data source set information.
	DataSourceSetInfo *DatasourceSet

	// Credentials to use to authenticate with data source provider.
	DatasourceAuthCredentials AuthCredentialsClassification

	// Gets or sets the Backup Instance friendly name.
	FriendlyName *string

	// Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
	IdentityDetails *IdentityDetails

	// ResourceGuardOperationRequests on which LAC check will be performed
	ResourceGuardOperationRequests []*string

	// Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again.
	ValidationType *ValidationType

	// READ-ONLY; Specifies the current protection state of the resource
	CurrentProtectionState *CurrentProtectionState

	// READ-ONLY; Specifies the protection error of the resource
	ProtectionErrorDetails *UserFacingError

	// READ-ONLY; Specifies the protection status of the resource
	ProtectionStatus *ProtectionStatusDetails

	// READ-ONLY; Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed
	ProvisioningState *string
}

BackupInstance - Backup Instance

func (BackupInstance) MarshalJSON 

func (b BackupInstance) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackupInstance.

func (*BackupInstance) UnmarshalJSON 

func (b *BackupInstance) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackupInstance.

type BackupInstanceResource 

type BackupInstanceResource struct {
	// BackupInstanceResource properties
	Properties *BackupInstance

	// Proxy Resource tags.
	Tags map[string]*string

	// READ-ONLY; Proxy Resource Id represents the complete path to the resource.
	ID *string

	// READ-ONLY; Proxy Resource name associated with the resource.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; Proxy Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…
	Type *string
}

BackupInstanceResource - BackupInstance Resource

func (BackupInstanceResource) MarshalJSON 

func (b BackupInstanceResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackupInstanceResource.

func (*BackupInstanceResource) UnmarshalJSON 

func (b *BackupInstanceResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackupInstanceResource.

type BackupInstanceResourceList 

type BackupInstanceResourceList struct {
	// The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
	NextLink *string

	// List of resources.
	Value []*BackupInstanceResource
}

BackupInstanceResourceList - BackupInstance Resource list response

func (BackupInstanceResourceList) MarshalJSON 

func (b BackupInstanceResourceList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackupInstanceResourceList.

func (*BackupInstanceResourceList) UnmarshalJSON 

func (b *BackupInstanceResourceList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackupInstanceResourceList.

type BackupInstancesClient 

type BackupInstancesClient struct {
	// contains filtered or unexported fields
}

BackupInstancesClient contains the methods for the BackupInstances group. Don't use this type directly, use NewBackupInstancesClient() instead.

func NewBackupInstancesClient 

func NewBackupInstancesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*BackupInstancesClient, error)

NewBackupInstancesClient creates a new instance of BackupInstancesClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*BackupInstancesClient) BeginAdhocBackup 

func (client *BackupInstancesClient) BeginAdhocBackup(ctx context.Context, resourceGroupName string, vaultName string, backupInstanceName string, parameters TriggerBackupRequest, options *BackupInstancesClientBeginAdhocBackupOptions) (*runtime.Poller[BackupInstancesClientAdhocBackupResponse], error)

BeginAdhocBackup - Trigger adhoc backup If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • backupInstanceName - The name of the backup instance.
  • parameters - Request body for operation
  • options - BackupInstancesClientBeginAdhocBackupOptions contains the optional parameters for the BackupInstancesClient.BeginAdhocBackup method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/TriggerBackup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupInstancesClient().BeginAdhocBackup(ctx, "000pikumar", "PratikPrivatePreviewVault1", "testInstance1", armdataprotection.TriggerBackupRequest{
	BackupRuleOptions: &armdataprotection.AdHocBackupRuleOptions{
		RuleName: to.Ptr("BackupWeekly"),
		TriggerOption: &armdataprotection.AdhocBackupTriggerOption{
			RetentionTagOverride: to.Ptr("yearly"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.OperationJobExtendedInfo = armdataprotection.OperationJobExtendedInfo{
// 	ObjectType: to.Ptr("OperationJobExtendedInfo"),
// 	JobID: to.Ptr("c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
// }

Output:

func (*BackupInstancesClient) BeginCreateOrUpdate 

func (client *BackupInstancesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, vaultName string, backupInstanceName string, parameters BackupInstanceResource, options *BackupInstancesClientBeginCreateOrUpdateOptions) (*runtime.Poller[BackupInstancesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update a backup instance in a backup vault If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • backupInstanceName - The name of the backup instance.
  • parameters - Request body for operation
  • options - BackupInstancesClientBeginCreateOrUpdateOptions contains the optional parameters for the BackupInstancesClient.BeginCreateOrUpdate method.
Example (CreateBackupInstance)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/PutBackupInstance.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupInstancesClient().BeginCreateOrUpdate(ctx, "000pikumar", "PratikPrivatePreviewVault1", "testInstance1", armdataprotection.BackupInstanceResource{
	Tags: map[string]*string{
		"key1": to.Ptr("val1"),
	},
	Properties: &armdataprotection.BackupInstance{
		DataSourceInfo: &armdataprotection.Datasource{
			DatasourceType:   to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
			ObjectType:       to.Ptr("Datasource"),
			ResourceID:       to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"),
			ResourceLocation: to.Ptr(""),
			ResourceName:     to.Ptr("testdb"),
			ResourceType:     to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
			ResourceURI:      to.Ptr(""),
		},
		DataSourceSetInfo: &armdataprotection.DatasourceSet{
			DatasourceType:   to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
			ObjectType:       to.Ptr("DatasourceSet"),
			ResourceID:       to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest"),
			ResourceLocation: to.Ptr(""),
			ResourceName:     to.Ptr("viveksipgtest"),
			ResourceType:     to.Ptr("Microsoft.DBforPostgreSQL/servers"),
			ResourceURI:      to.Ptr(""),
		},
		DatasourceAuthCredentials: &armdataprotection.SecretStoreBasedAuthCredentials{
			ObjectType: to.Ptr("SecretStoreBasedAuthCredentials"),
			SecretStoreResource: &armdataprotection.SecretStoreResource{
				SecretStoreType: to.Ptr(armdataprotection.SecretStoreTypeAzureKeyVault),
				URI:             to.Ptr("https://samplevault.vault.azure.net/secrets/credentials"),
			},
		},
		FriendlyName: to.Ptr("harshitbi2"),
		ObjectType:   to.Ptr("BackupInstance"),
		PolicyInfo: &armdataprotection.PolicyInfo{
			PolicyID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"),
			PolicyParameters: &armdataprotection.PolicyParameters{
				DataStoreParametersList: []armdataprotection.DataStoreParametersClassification{
					&armdataprotection.AzureOperationalStoreParameters{
						DataStoreType:   to.Ptr(armdataprotection.DataStoreTypesOperationalStore),
						ObjectType:      to.Ptr("AzureOperationalStoreParameters"),
						ResourceGroupID: to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest"),
					}},
			},
		},
		ValidationType: to.Ptr(armdataprotection.ValidationTypeShallowValidation),
	},
}, &armdataprotection.BackupInstancesClientBeginCreateOrUpdateOptions{XMSAuthorizationAuxiliary: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.BackupInstanceResource = armdataprotection.BackupInstanceResource{
// 	Name: to.Ptr("harshitbi2"),
// 	Type: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances"),
// 	ID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2"),
// 	Tags: map[string]*string{
// 		"key1": to.Ptr("val1"),
// 	},
// 	Properties: &armdataprotection.BackupInstance{
// 		DataSourceInfo: &armdataprotection.Datasource{
// 			DatasourceType: to.Ptr("OssDB"),
// 			ObjectType: to.Ptr("Datasource"),
// 			ResourceID: to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"),
// 			ResourceLocation: to.Ptr(""),
// 			ResourceName: to.Ptr("testdb"),
// 			ResourceType: to.Ptr("OssDB"),
// 			ResourceURI: to.Ptr(""),
// 		},
// 		DataSourceSetInfo: &armdataprotection.DatasourceSet{
// 			DatasourceType: to.Ptr("OssDB"),
// 			ObjectType: to.Ptr("DatasourceSet"),
// 			ResourceID: to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest"),
// 			ResourceLocation: to.Ptr(""),
// 			ResourceName: to.Ptr("viveksipgtest"),
// 			ResourceType: to.Ptr("OssDB"),
// 			ResourceURI: to.Ptr(""),
// 		},
// 		FriendlyName: to.Ptr("harshitbi2"),
// 		ObjectType: to.Ptr("BackupInstance"),
// 		PolicyInfo: &armdataprotection.PolicyInfo{
// 			PolicyID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"),
// 			PolicyParameters: &armdataprotection.PolicyParameters{
// 				DataStoreParametersList: []armdataprotection.DataStoreParametersClassification{
// 					&armdataprotection.AzureOperationalStoreParameters{
// 						DataStoreType: to.Ptr(armdataprotection.DataStoreTypesOperationalStore),
// 						ObjectType: to.Ptr("AzureOperationalStoreParameters"),
// 						ResourceGroupID: to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest"),
// 				}},
// 			},
// 			PolicyVersion: to.Ptr("3.2"),
// 		},
// 		ProtectionStatus: &armdataprotection.ProtectionStatusDetails{
// 			Status: to.Ptr(armdataprotection.Status("NotProtected")),
// 		},
// 		ProvisioningState: to.Ptr("Succeeded"),
// 	},
// }

Output:
Example (CreateBackupInstanceToPerformCriticalOperationWithMua)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/PutBackupInstance_ResourceGuardEnabled.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupInstancesClient().BeginCreateOrUpdate(ctx, "000pikumar", "PratikPrivatePreviewVault1", "testInstance1", armdataprotection.BackupInstanceResource{
	Tags: map[string]*string{
		"key1": to.Ptr("val1"),
	},
	Properties: &armdataprotection.BackupInstance{
		DataSourceInfo: &armdataprotection.Datasource{
			DatasourceType:   to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
			ObjectType:       to.Ptr("Datasource"),
			ResourceID:       to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"),
			ResourceLocation: to.Ptr(""),
			ResourceName:     to.Ptr("testdb"),
			ResourceType:     to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
			ResourceURI:      to.Ptr(""),
		},
		DataSourceSetInfo: &armdataprotection.DatasourceSet{
			DatasourceType:   to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
			ObjectType:       to.Ptr("DatasourceSet"),
			ResourceID:       to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest"),
			ResourceLocation: to.Ptr(""),
			ResourceName:     to.Ptr("viveksipgtest"),
			ResourceType:     to.Ptr("Microsoft.DBforPostgreSQL/servers"),
			ResourceURI:      to.Ptr(""),
		},
		DatasourceAuthCredentials: &armdataprotection.SecretStoreBasedAuthCredentials{
			ObjectType: to.Ptr("SecretStoreBasedAuthCredentials"),
			SecretStoreResource: &armdataprotection.SecretStoreResource{
				SecretStoreType: to.Ptr(armdataprotection.SecretStoreTypeAzureKeyVault),
				URI:             to.Ptr("https://samplevault.vault.azure.net/secrets/credentials"),
			},
		},
		FriendlyName: to.Ptr("harshitbi2"),
		ObjectType:   to.Ptr("BackupInstance"),
		PolicyInfo: &armdataprotection.PolicyInfo{
			PolicyID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"),
			PolicyParameters: &armdataprotection.PolicyParameters{
				DataStoreParametersList: []armdataprotection.DataStoreParametersClassification{
					&armdataprotection.AzureOperationalStoreParameters{
						DataStoreType:   to.Ptr(armdataprotection.DataStoreTypesOperationalStore),
						ObjectType:      to.Ptr("AzureOperationalStoreParameters"),
						ResourceGroupID: to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest"),
					}},
			},
		},
		ResourceGuardOperationRequests: []*string{
			to.Ptr("/subscriptions/38304e13-357e-405e-9e9a-220351dcce8c/resourcegroups/ankurResourceGuard1/providers/Microsoft.DataProtection/resourceGuards/ResourceGuard38-1/dppModifyPolicy/default")},
		ValidationType: to.Ptr(armdataprotection.ValidationTypeShallowValidation),
	},
}, &armdataprotection.BackupInstancesClientBeginCreateOrUpdateOptions{XMSAuthorizationAuxiliary: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.BackupInstanceResource = armdataprotection.BackupInstanceResource{
// 	Name: to.Ptr("harshitbi2"),
// 	Type: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances"),
// 	ID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2"),
// 	Tags: map[string]*string{
// 		"key1": to.Ptr("val1"),
// 	},
// 	Properties: &armdataprotection.BackupInstance{
// 		DataSourceInfo: &armdataprotection.Datasource{
// 			DatasourceType: to.Ptr("OssDB"),
// 			ObjectType: to.Ptr("Datasource"),
// 			ResourceID: to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"),
// 			ResourceLocation: to.Ptr(""),
// 			ResourceName: to.Ptr("testdb"),
// 			ResourceType: to.Ptr("OssDB"),
// 			ResourceURI: to.Ptr(""),
// 		},
// 		DataSourceSetInfo: &armdataprotection.DatasourceSet{
// 			DatasourceType: to.Ptr("OssDB"),
// 			ObjectType: to.Ptr("DatasourceSet"),
// 			ResourceID: to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest"),
// 			ResourceLocation: to.Ptr(""),
// 			ResourceName: to.Ptr("viveksipgtest"),
// 			ResourceType: to.Ptr("OssDB"),
// 			ResourceURI: to.Ptr(""),
// 		},
// 		FriendlyName: to.Ptr("harshitbi2"),
// 		ObjectType: to.Ptr("BackupInstance"),
// 		PolicyInfo: &armdataprotection.PolicyInfo{
// 			PolicyID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"),
// 			PolicyParameters: &armdataprotection.PolicyParameters{
// 				DataStoreParametersList: []armdataprotection.DataStoreParametersClassification{
// 					&armdataprotection.AzureOperationalStoreParameters{
// 						DataStoreType: to.Ptr(armdataprotection.DataStoreTypesOperationalStore),
// 						ObjectType: to.Ptr("AzureOperationalStoreParameters"),
// 						ResourceGroupID: to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest"),
// 				}},
// 			},
// 			PolicyVersion: to.Ptr("3.2"),
// 		},
// 		ProtectionStatus: &armdataprotection.ProtectionStatusDetails{
// 			Status: to.Ptr(armdataprotection.Status("NotProtected")),
// 		},
// 		ProvisioningState: to.Ptr("Succeeded"),
// 	},
// }

Output:

func (*BackupInstancesClient) BeginDelete 

func (client *BackupInstancesClient) BeginDelete(ctx context.Context, resourceGroupName string, vaultName string, backupInstanceName string, options *BackupInstancesClientBeginDeleteOptions) (*runtime.Poller[BackupInstancesClientDeleteResponse], error)

BeginDelete - Delete a backup instance in a backup vault If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • backupInstanceName - The name of the backup instance.
  • options - BackupInstancesClientBeginDeleteOptions contains the optional parameters for the BackupInstancesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/DeleteBackupInstance.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupInstancesClient().BeginDelete(ctx, "000pikumar", "PratikPrivatePreviewVault1", "testInstance1", &armdataprotection.BackupInstancesClientBeginDeleteOptions{XMSAuthorizationAuxiliary: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*BackupInstancesClient) BeginResumeBackups 

func (client *BackupInstancesClient) BeginResumeBackups(ctx context.Context, resourceGroupName string, vaultName string, backupInstanceName string, options *BackupInstancesClientBeginResumeBackupsOptions) (*runtime.Poller[BackupInstancesClientResumeBackupsResponse], error)

BeginResumeBackups - This operation will resume backups for backup instance If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • backupInstanceName - The name of the backup instance.
  • options - BackupInstancesClientBeginResumeBackupsOptions contains the optional parameters for the BackupInstancesClient.BeginResumeBackups method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/ResumeBackups.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupInstancesClient().BeginResumeBackups(ctx, "testrg", "testvault", "testbi", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*BackupInstancesClient) BeginResumeProtection 

func (client *BackupInstancesClient) BeginResumeProtection(ctx context.Context, resourceGroupName string, vaultName string, backupInstanceName string, options *BackupInstancesClientBeginResumeProtectionOptions) (*runtime.Poller[BackupInstancesClientResumeProtectionResponse], error)

BeginResumeProtection - This operation will resume protection for a stopped backup instance If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • backupInstanceName - The name of the backup instance.
  • options - BackupInstancesClientBeginResumeProtectionOptions contains the optional parameters for the BackupInstancesClient.BeginResumeProtection method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/ResumeProtection.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupInstancesClient().BeginResumeProtection(ctx, "testrg", "testvault", "testbi", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*BackupInstancesClient) BeginStopProtection 

func (client *BackupInstancesClient) BeginStopProtection(ctx context.Context, resourceGroupName string, vaultName string, backupInstanceName string, options *BackupInstancesClientBeginStopProtectionOptions) (*runtime.Poller[BackupInstancesClientStopProtectionResponse], error)

BeginStopProtection - This operation will stop protection of a backup instance and data will be held forever If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • backupInstanceName - The name of the backup instance.
  • options - BackupInstancesClientBeginStopProtectionOptions contains the optional parameters for the BackupInstancesClient.BeginStopProtection method.
Example (StopProtection)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/StopProtection.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupInstancesClient().BeginStopProtection(ctx, "testrg", "testvault", "testbi", &armdataprotection.BackupInstancesClientBeginStopProtectionOptions{XMSAuthorizationAuxiliary: nil,
	Parameters: nil,
})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (StopProtectionWithMua)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/StopProtection_ResourceGuardEnabled.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupInstancesClient().BeginStopProtection(ctx, "testrg", "testvault", "testbi", &armdataprotection.BackupInstancesClientBeginStopProtectionOptions{XMSAuthorizationAuxiliary: nil,
	Parameters: &armdataprotection.StopProtectionRequest{
		ResourceGuardOperationRequests: []*string{
			to.Ptr("/subscriptions/754ec39f-8d2a-44cf-bfbf-13107ac85c36/resourcegroups/mua-testing/providers/Microsoft.DataProtection/resourceGuards/gvjreddy-test-ecy-rg-reader/dppDisableStopProtectionRequests/default")},
	},
})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*BackupInstancesClient) BeginSuspendBackups 

func (client *BackupInstancesClient) BeginSuspendBackups(ctx context.Context, resourceGroupName string, vaultName string, backupInstanceName string, options *BackupInstancesClientBeginSuspendBackupsOptions) (*runtime.Poller[BackupInstancesClientSuspendBackupsResponse], error)

BeginSuspendBackups - This operation will stop backup for a backup instance and retains the backup data as per the policy (except latest Recovery point, which will be retained forever) If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • backupInstanceName - The name of the backup instance.
  • options - BackupInstancesClientBeginSuspendBackupsOptions contains the optional parameters for the BackupInstancesClient.BeginSuspendBackups method.
Example (SuspendBackups)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/SuspendBackups.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupInstancesClient().BeginSuspendBackups(ctx, "testrg", "testvault", "testbi", &armdataprotection.BackupInstancesClientBeginSuspendBackupsOptions{XMSAuthorizationAuxiliary: nil,
	Parameters: nil,
})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (SuspendBackupsWithMua)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/SuspendBackup_ResourceGuardEnabled.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupInstancesClient().BeginSuspendBackups(ctx, "testrg", "testvault", "testbi", &armdataprotection.BackupInstancesClientBeginSuspendBackupsOptions{XMSAuthorizationAuxiliary: nil,
	Parameters: &armdataprotection.SuspendBackupRequest{
		ResourceGuardOperationRequests: []*string{
			to.Ptr("/subscriptions/754ec39f-8d2a-44cf-bfbf-13107ac85c36/resourcegroups/mua-testing/providers/Microsoft.DataProtection/resourceGuards/gvjreddy-test-ecy-rg-reader/dppDisableSuspendBackupsRequests/default")},
	},
})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*BackupInstancesClient) BeginSyncBackupInstance 

func (client *BackupInstancesClient) BeginSyncBackupInstance(ctx context.Context, resourceGroupName string, vaultName string, backupInstanceName string, parameters SyncBackupInstanceRequest, options *BackupInstancesClientBeginSyncBackupInstanceOptions) (*runtime.Poller[BackupInstancesClientSyncBackupInstanceResponse], error)

BeginSyncBackupInstance - Sync backup instance again in case of failure This action will retry last failed operation and will bring backup instance to valid state If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • backupInstanceName - The name of the backup instance.
  • parameters - Request body for operation
  • options - BackupInstancesClientBeginSyncBackupInstanceOptions contains the optional parameters for the BackupInstancesClient.BeginSyncBackupInstance method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/SyncBackupInstance.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupInstancesClient().BeginSyncBackupInstance(ctx, "testrg", "testvault", "testbi", armdataprotection.SyncBackupInstanceRequest{
	SyncType: to.Ptr(armdataprotection.SyncTypeDefault),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*BackupInstancesClient) BeginTriggerCrossRegionRestore 

func (client *BackupInstancesClient) BeginTriggerCrossRegionRestore(ctx context.Context, resourceGroupName string, location string, parameters CrossRegionRestoreRequestObject, options *BackupInstancesClientBeginTriggerCrossRegionRestoreOptions) (*runtime.Poller[BackupInstancesClientTriggerCrossRegionRestoreResponse], error)

BeginTriggerCrossRegionRestore - Triggers Cross Region Restore for BackupInstance. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • location - The name of the Azure region.
  • parameters - Request body for trigger CRR operation
  • options - BackupInstancesClientBeginTriggerCrossRegionRestoreOptions contains the optional parameters for the BackupInstancesClient.BeginTriggerCrossRegionRestore method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/CrossRegionRestore/TriggerCrossRegionRestore.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupInstancesClient().BeginTriggerCrossRegionRestore(ctx, "000pikumar", "EastAsia", armdataprotection.CrossRegionRestoreRequestObject{
	CrossRegionRestoreDetails: &armdataprotection.CrossRegionRestoreDetails{
		SourceBackupInstanceID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/BackupInstances/harshitbi1"),
		SourceRegion:           to.Ptr("east asia"),
	},
	RestoreRequestObject: &armdataprotection.AzureBackupRecoveryPointBasedRestoreRequest{
		ObjectType: to.Ptr("AzureBackupRecoveryPointBasedRestoreRequest"),
		RestoreTargetInfo: &armdataprotection.RestoreTargetInfo{
			ObjectType:      to.Ptr("RestoreTargetInfo"),
			RecoveryOption:  to.Ptr(armdataprotection.RecoveryOptionFailIfExists),
			RestoreLocation: to.Ptr("southeastasia"),
			DatasourceAuthCredentials: &armdataprotection.SecretStoreBasedAuthCredentials{
				ObjectType: to.Ptr("SecretStoreBasedAuthCredentials"),
				SecretStoreResource: &armdataprotection.SecretStoreResource{
					SecretStoreType: to.Ptr(armdataprotection.SecretStoreTypeAzureKeyVault),
					URI:             to.Ptr("https://samplevault.vault.azure.net/secrets/credentials"),
				},
			},
			DatasourceInfo: &armdataprotection.Datasource{
				DatasourceType:   to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
				ObjectType:       to.Ptr("Datasource"),
				ResourceID:       to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb"),
				ResourceLocation: to.Ptr(""),
				ResourceName:     to.Ptr("targetdb"),
				ResourceType:     to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
				ResourceURI:      to.Ptr(""),
			},
			DatasourceSetInfo: &armdataprotection.DatasourceSet{
				DatasourceType:   to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
				ObjectType:       to.Ptr("DatasourceSet"),
				ResourceID:       to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest"),
				ResourceLocation: to.Ptr(""),
				ResourceName:     to.Ptr("viveksipgtest"),
				ResourceType:     to.Ptr("Microsoft.DBforPostgreSQL/servers"),
				ResourceURI:      to.Ptr(""),
			},
		},
		SourceDataStoreType: to.Ptr(armdataprotection.SourceDataStoreTypeVaultStore),
		SourceResourceID:    to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"),
		RecoveryPointID:     to.Ptr("hardcodedRP"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.OperationJobExtendedInfo = armdataprotection.OperationJobExtendedInfo{
// 	ObjectType: to.Ptr("OperationJobExtendedInfo"),
// 	JobID: to.Ptr("c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
// }

Output:

func (*BackupInstancesClient) BeginTriggerRehydrate 

func (client *BackupInstancesClient) BeginTriggerRehydrate(ctx context.Context, resourceGroupName string, vaultName string, backupInstanceName string, parameters AzureBackupRehydrationRequest, options *BackupInstancesClientBeginTriggerRehydrateOptions) (*runtime.Poller[BackupInstancesClientTriggerRehydrateResponse], error)

BeginTriggerRehydrate - rehydrate recovery point for restore for a BackupInstance If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • backupInstanceName - The name of the backup instance.
  • parameters - Request body for operation
  • options - BackupInstancesClientBeginTriggerRehydrateOptions contains the optional parameters for the BackupInstancesClient.BeginTriggerRehydrate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/TriggerRehydrate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupInstancesClient().BeginTriggerRehydrate(ctx, "000pikumar", "PratikPrivatePreviewVault1", "testInstance1", armdataprotection.AzureBackupRehydrationRequest{
	RecoveryPointID:              to.Ptr("hardcodedRP"),
	RehydrationPriority:          to.Ptr(armdataprotection.RehydrationPriorityHigh),
	RehydrationRetentionDuration: to.Ptr("7D"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*BackupInstancesClient) BeginTriggerRestore 

func (client *BackupInstancesClient) BeginTriggerRestore(ctx context.Context, resourceGroupName string, vaultName string, backupInstanceName string, parameters AzureBackupRestoreRequestClassification, options *BackupInstancesClientBeginTriggerRestoreOptions) (*runtime.Poller[BackupInstancesClientTriggerRestoreResponse], error)

BeginTriggerRestore - Triggers restore for a BackupInstance If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • backupInstanceName - The name of the backup instance.
  • parameters - Request body for operation
  • options - BackupInstancesClientBeginTriggerRestoreOptions contains the optional parameters for the BackupInstancesClient.BeginTriggerRestore method.
Example (TriggerRestore)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/TriggerRestore.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupInstancesClient().BeginTriggerRestore(ctx, "000pikumar", "PratikPrivatePreviewVault1", "testInstance1", &armdataprotection.AzureBackupRecoveryPointBasedRestoreRequest{
	ObjectType: to.Ptr("AzureBackupRecoveryPointBasedRestoreRequest"),
	RestoreTargetInfo: &armdataprotection.RestoreTargetInfo{
		ObjectType:      to.Ptr("RestoreTargetInfo"),
		RecoveryOption:  to.Ptr(armdataprotection.RecoveryOptionFailIfExists),
		RestoreLocation: to.Ptr("southeastasia"),
		DatasourceAuthCredentials: &armdataprotection.SecretStoreBasedAuthCredentials{
			ObjectType: to.Ptr("SecretStoreBasedAuthCredentials"),
			SecretStoreResource: &armdataprotection.SecretStoreResource{
				SecretStoreType: to.Ptr(armdataprotection.SecretStoreTypeAzureKeyVault),
				URI:             to.Ptr("https://samplevault.vault.azure.net/secrets/credentials"),
			},
		},
		DatasourceInfo: &armdataprotection.Datasource{
			DatasourceType:   to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
			ObjectType:       to.Ptr("Datasource"),
			ResourceID:       to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb"),
			ResourceLocation: to.Ptr(""),
			ResourceName:     to.Ptr("targetdb"),
			ResourceType:     to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
			ResourceURI:      to.Ptr(""),
		},
		DatasourceSetInfo: &armdataprotection.DatasourceSet{
			DatasourceType:   to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
			ObjectType:       to.Ptr("DatasourceSet"),
			ResourceID:       to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest"),
			ResourceLocation: to.Ptr(""),
			ResourceName:     to.Ptr("viveksipgtest"),
			ResourceType:     to.Ptr("Microsoft.DBforPostgreSQL/servers"),
			ResourceURI:      to.Ptr(""),
		},
	},
	SourceDataStoreType: to.Ptr(armdataprotection.SourceDataStoreTypeVaultStore),
	SourceResourceID:    to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"),
	RecoveryPointID:     to.Ptr("hardcodedRP"),
}, &armdataprotection.BackupInstancesClientBeginTriggerRestoreOptions{XMSAuthorizationAuxiliary: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.OperationJobExtendedInfo = armdataprotection.OperationJobExtendedInfo{
// 	ObjectType: to.Ptr("OperationJobExtendedInfo"),
// 	JobID: to.Ptr("c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
// }

Output:
Example (TriggerRestoreAsFiles)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupInstancesClient().BeginTriggerRestore(ctx, "000pikumar", "PrivatePreviewVault1", "testInstance1", &armdataprotection.AzureBackupRecoveryPointBasedRestoreRequest{
	ObjectType: to.Ptr("AzureBackupRecoveryPointBasedRestoreRequest"),
	RestoreTargetInfo: &armdataprotection.RestoreFilesTargetInfo{
		ObjectType:      to.Ptr("RestoreFilesTargetInfo"),
		RecoveryOption:  to.Ptr(armdataprotection.RecoveryOptionFailIfExists),
		RestoreLocation: to.Ptr("southeastasia"),
		TargetDetails: &armdataprotection.TargetDetails{
			FilePrefix:                to.Ptr("restoredblob"),
			RestoreTargetLocationType: to.Ptr(armdataprotection.RestoreTargetLocationTypeAzureBlobs),
			URL:                       to.Ptr("https://teststorage.blob.core.windows.net/restoretest"),
		},
	},
	SourceDataStoreType: to.Ptr(armdataprotection.SourceDataStoreTypeVaultStore),
	SourceResourceID:    to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"),
	RecoveryPointID:     to.Ptr("hardcodedRP"),
}, &armdataprotection.BackupInstancesClientBeginTriggerRestoreOptions{XMSAuthorizationAuxiliary: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.OperationJobExtendedInfo = armdataprotection.OperationJobExtendedInfo{
// 	ObjectType: to.Ptr("OperationJobExtendedInfo"),
// 	JobID: to.Ptr("c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
// }

Output:
Example (TriggerRestoreWithRehydration)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupInstancesClient().BeginTriggerRestore(ctx, "000pikumar", "PratikPrivatePreviewVault1", "testInstance1", &armdataprotection.AzureBackupRestoreWithRehydrationRequest{
	ObjectType: to.Ptr("AzureBackupRestoreWithRehydrationRequest"),
	RestoreTargetInfo: &armdataprotection.RestoreTargetInfo{
		ObjectType:      to.Ptr("RestoreTargetInfo"),
		RecoveryOption:  to.Ptr(armdataprotection.RecoveryOptionFailIfExists),
		RestoreLocation: to.Ptr("southeastasia"),
		DatasourceInfo: &armdataprotection.Datasource{
			DatasourceType:   to.Ptr("OssDB"),
			ObjectType:       to.Ptr("Datasource"),
			ResourceID:       to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"),
			ResourceLocation: to.Ptr(""),
			ResourceName:     to.Ptr("testdb"),
			ResourceType:     to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
			ResourceURI:      to.Ptr(""),
		},
		DatasourceSetInfo: &armdataprotection.DatasourceSet{
			DatasourceType:   to.Ptr("OssDB"),
			ObjectType:       to.Ptr("DatasourceSet"),
			ResourceID:       to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest"),
			ResourceLocation: to.Ptr(""),
			ResourceName:     to.Ptr("viveksipgtest"),
			ResourceType:     to.Ptr("Microsoft.DBforPostgreSQL/servers"),
			ResourceURI:      to.Ptr(""),
		},
	},
	SourceDataStoreType:          to.Ptr(armdataprotection.SourceDataStoreTypeVaultStore),
	SourceResourceID:             to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"),
	RecoveryPointID:              to.Ptr("hardcodedRP"),
	RehydrationPriority:          to.Ptr(armdataprotection.RehydrationPriorityHigh),
	RehydrationRetentionDuration: to.Ptr("7D"),
}, &armdataprotection.BackupInstancesClientBeginTriggerRestoreOptions{XMSAuthorizationAuxiliary: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.OperationJobExtendedInfo = armdataprotection.OperationJobExtendedInfo{
// 	ObjectType: to.Ptr("OperationJobExtendedInfo"),
// 	JobID: to.Ptr("c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
// }

Output:

func (*BackupInstancesClient) BeginValidateCrossRegionRestore 

func (client *BackupInstancesClient) BeginValidateCrossRegionRestore(ctx context.Context, resourceGroupName string, location string, parameters ValidateCrossRegionRestoreRequestObject, options *BackupInstancesClientBeginValidateCrossRegionRestoreOptions) (*runtime.Poller[BackupInstancesClientValidateCrossRegionRestoreResponse], error)

BeginValidateCrossRegionRestore - Validates whether Cross Region Restore can be triggered for DataSource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • location - The name of the Azure region.
  • parameters - Request body for operation
  • options - BackupInstancesClientBeginValidateCrossRegionRestoreOptions contains the optional parameters for the BackupInstancesClient.BeginValidateCrossRegionRestore method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/CrossRegionRestore/ValidateCrossRegionRestore.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupInstancesClient().BeginValidateCrossRegionRestore(ctx, "000pikumar", "EastAsia", armdataprotection.ValidateCrossRegionRestoreRequestObject{
	CrossRegionRestoreDetails: &armdataprotection.CrossRegionRestoreDetails{
		SourceBackupInstanceID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/BackupInstances/harshitbi1"),
		SourceRegion:           to.Ptr("east asia"),
	},
	RestoreRequestObject: &armdataprotection.AzureBackupRecoveryPointBasedRestoreRequest{
		ObjectType: to.Ptr("AzureBackupRecoveryPointBasedRestoreRequest"),
		RestoreTargetInfo: &armdataprotection.RestoreTargetInfo{
			ObjectType:      to.Ptr("RestoreTargetInfo"),
			RecoveryOption:  to.Ptr(armdataprotection.RecoveryOptionFailIfExists),
			RestoreLocation: to.Ptr("southeastasia"),
			DatasourceAuthCredentials: &armdataprotection.SecretStoreBasedAuthCredentials{
				ObjectType: to.Ptr("SecretStoreBasedAuthCredentials"),
				SecretStoreResource: &armdataprotection.SecretStoreResource{
					SecretStoreType: to.Ptr(armdataprotection.SecretStoreTypeAzureKeyVault),
					URI:             to.Ptr("https://samplevault.vault.azure.net/secrets/credentials"),
				},
			},
			DatasourceInfo: &armdataprotection.Datasource{
				DatasourceType:   to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
				ObjectType:       to.Ptr("Datasource"),
				ResourceID:       to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb"),
				ResourceLocation: to.Ptr(""),
				ResourceName:     to.Ptr("targetdb"),
				ResourceType:     to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
				ResourceURI:      to.Ptr(""),
			},
			DatasourceSetInfo: &armdataprotection.DatasourceSet{
				DatasourceType:   to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
				ObjectType:       to.Ptr("DatasourceSet"),
				ResourceID:       to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest"),
				ResourceLocation: to.Ptr(""),
				ResourceName:     to.Ptr("viveksipgtest"),
				ResourceType:     to.Ptr("Microsoft.DBforPostgreSQL/servers"),
				ResourceURI:      to.Ptr(""),
			},
		},
		SourceDataStoreType: to.Ptr(armdataprotection.SourceDataStoreTypeVaultStore),
		SourceResourceID:    to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"),
		RecoveryPointID:     to.Ptr("hardcodedRP"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.OperationJobExtendedInfo = armdataprotection.OperationJobExtendedInfo{
// 	ObjectType: to.Ptr("OperationJobExtendedInfo"),
// 	JobID: to.Ptr("c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
// }

Output:

func (*BackupInstancesClient) BeginValidateForBackup 

func (client *BackupInstancesClient) BeginValidateForBackup(ctx context.Context, resourceGroupName string, vaultName string, parameters ValidateForBackupRequest, options *BackupInstancesClientBeginValidateForBackupOptions) (*runtime.Poller[BackupInstancesClientValidateForBackupResponse], error)

BeginValidateForBackup - Validate whether adhoc backup will be successful or not If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • parameters - Request body for operation
  • options - BackupInstancesClientBeginValidateForBackupOptions contains the optional parameters for the BackupInstancesClient.BeginValidateForBackup method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/ValidateForBackup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupInstancesClient().BeginValidateForBackup(ctx, "000pikumar", "PratikPrivatePreviewVault1", armdataprotection.ValidateForBackupRequest{
	BackupInstance: &armdataprotection.BackupInstance{
		DataSourceInfo: &armdataprotection.Datasource{
			DatasourceType:   to.Ptr("OssDB"),
			ObjectType:       to.Ptr("Datasource"),
			ResourceID:       to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"),
			ResourceLocation: to.Ptr(""),
			ResourceName:     to.Ptr("testdb"),
			ResourceType:     to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
			ResourceURI:      to.Ptr(""),
		},
		DataSourceSetInfo: &armdataprotection.DatasourceSet{
			DatasourceType:   to.Ptr("OssDB"),
			ObjectType:       to.Ptr("DatasourceSet"),
			ResourceID:       to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest"),
			ResourceLocation: to.Ptr(""),
			ResourceName:     to.Ptr("viveksipgtest"),
			ResourceType:     to.Ptr("Microsoft.DBforPostgreSQL/servers"),
			ResourceURI:      to.Ptr(""),
		},
		DatasourceAuthCredentials: &armdataprotection.SecretStoreBasedAuthCredentials{
			ObjectType: to.Ptr("SecretStoreBasedAuthCredentials"),
			SecretStoreResource: &armdataprotection.SecretStoreResource{
				SecretStoreType: to.Ptr(armdataprotection.SecretStoreTypeAzureKeyVault),
				URI:             to.Ptr("https://samplevault.vault.azure.net/secrets/credentials"),
			},
		},
		FriendlyName: to.Ptr("harshitbi2"),
		ObjectType:   to.Ptr("BackupInstance"),
		PolicyInfo: &armdataprotection.PolicyInfo{
			PolicyID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.OperationJobExtendedInfo = armdataprotection.OperationJobExtendedInfo{
// 	ObjectType: to.Ptr("OperationJobExtendedInfo"),
// 	JobID: to.Ptr("c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
// }

Output:

func (*BackupInstancesClient) BeginValidateForRestore 

func (client *BackupInstancesClient) BeginValidateForRestore(ctx context.Context, resourceGroupName string, vaultName string, backupInstanceName string, parameters ValidateRestoreRequestObject, options *BackupInstancesClientBeginValidateForRestoreOptions) (*runtime.Poller[BackupInstancesClientValidateForRestoreResponse], error)

BeginValidateForRestore - Validates if Restore can be triggered for a DataSource If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • backupInstanceName - The name of the backup instance.
  • parameters - Request body for operation
  • options - BackupInstancesClientBeginValidateForRestoreOptions contains the optional parameters for the BackupInstancesClient.BeginValidateForRestore method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/ValidateRestore.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupInstancesClient().BeginValidateForRestore(ctx, "000pikumar", "PratikPrivatePreviewVault1", "testInstance1", armdataprotection.ValidateRestoreRequestObject{
	RestoreRequestObject: &armdataprotection.AzureBackupRecoveryPointBasedRestoreRequest{
		ObjectType: to.Ptr("AzureBackupRecoveryPointBasedRestoreRequest"),
		RestoreTargetInfo: &armdataprotection.RestoreTargetInfo{
			ObjectType:      to.Ptr("RestoreTargetInfo"),
			RecoveryOption:  to.Ptr(armdataprotection.RecoveryOptionFailIfExists),
			RestoreLocation: to.Ptr("southeastasia"),
			DatasourceAuthCredentials: &armdataprotection.SecretStoreBasedAuthCredentials{
				ObjectType: to.Ptr("SecretStoreBasedAuthCredentials"),
				SecretStoreResource: &armdataprotection.SecretStoreResource{
					SecretStoreType: to.Ptr(armdataprotection.SecretStoreTypeAzureKeyVault),
					URI:             to.Ptr("https://samplevault.vault.azure.net/secrets/credentials"),
				},
			},
			DatasourceInfo: &armdataprotection.Datasource{
				DatasourceType:   to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
				ObjectType:       to.Ptr("Datasource"),
				ResourceID:       to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb"),
				ResourceLocation: to.Ptr(""),
				ResourceName:     to.Ptr("targetdb"),
				ResourceType:     to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
				ResourceURI:      to.Ptr(""),
			},
			DatasourceSetInfo: &armdataprotection.DatasourceSet{
				DatasourceType:   to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
				ObjectType:       to.Ptr("DatasourceSet"),
				ResourceID:       to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest"),
				ResourceLocation: to.Ptr(""),
				ResourceName:     to.Ptr("viveksipgtest"),
				ResourceType:     to.Ptr("Microsoft.DBforPostgreSQL/servers"),
				ResourceURI:      to.Ptr(""),
			},
		},
		SourceDataStoreType: to.Ptr(armdataprotection.SourceDataStoreTypeVaultStore),
		SourceResourceID:    to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"),
		RecoveryPointID:     to.Ptr("hardcodedRP"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.OperationJobExtendedInfo = armdataprotection.OperationJobExtendedInfo{
// 	ObjectType: to.Ptr("OperationJobExtendedInfo"),
// 	JobID: to.Ptr("c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
// }

Output:

func (*BackupInstancesClient) Get 

func (client *BackupInstancesClient) Get(ctx context.Context, resourceGroupName string, vaultName string, backupInstanceName string, options *BackupInstancesClientGetOptions) (BackupInstancesClientGetResponse, error)

Get - Gets a backup instance with name in a backup vault If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • backupInstanceName - The name of the backup instance.
  • options - BackupInstancesClientGetOptions contains the optional parameters for the BackupInstancesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/GetBackupInstance.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBackupInstancesClient().Get(ctx, "000pikumar", "PratikPrivatePreviewVault1", "testInstance1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.BackupInstanceResource = armdataprotection.BackupInstanceResource{
// 	Name: to.Ptr("harshitbi2"),
// 	Type: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances"),
// 	ID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2"),
// 	Tags: map[string]*string{
// 		"key1": to.Ptr("val1"),
// 	},
// 	Properties: &armdataprotection.BackupInstance{
// 		DataSourceInfo: &armdataprotection.Datasource{
// 			DatasourceType: to.Ptr("OssDB"),
// 			ObjectType: to.Ptr("Datasource"),
// 			ResourceID: to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"),
// 			ResourceLocation: to.Ptr(""),
// 			ResourceName: to.Ptr("testdb"),
// 			ResourceType: to.Ptr("OssDB"),
// 			ResourceURI: to.Ptr(""),
// 		},
// 		DataSourceSetInfo: &armdataprotection.DatasourceSet{
// 			DatasourceType: to.Ptr("OssDB"),
// 			ObjectType: to.Ptr("DatasourceSet"),
// 			ResourceID: to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest"),
// 			ResourceLocation: to.Ptr(""),
// 			ResourceName: to.Ptr("viveksipgtest"),
// 			ResourceType: to.Ptr("OssDB"),
// 			ResourceURI: to.Ptr(""),
// 		},
// 		FriendlyName: to.Ptr("harshitbi2"),
// 		ObjectType: to.Ptr("BackupInstance"),
// 		PolicyInfo: &armdataprotection.PolicyInfo{
// 			PolicyID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"),
// 			PolicyVersion: to.Ptr("3.2"),
// 		},
// 		ProtectionStatus: &armdataprotection.ProtectionStatusDetails{
// 			Status: to.Ptr(armdataprotection.Status("NotProtected")),
// 		},
// 		ProvisioningState: to.Ptr("Succeeded"),
// 	},
// }

Output:

func (*BackupInstancesClient) GetBackupInstanceOperationResult 

func (client *BackupInstancesClient) GetBackupInstanceOperationResult(ctx context.Context, resourceGroupName string, vaultName string, backupInstanceName string, operationID string, options *BackupInstancesClientGetBackupInstanceOperationResultOptions) (BackupInstancesClientGetBackupInstanceOperationResultResponse, error)

GetBackupInstanceOperationResult - Get result of backup instance creation operation If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • backupInstanceName - The name of the backup instance.
  • options - BackupInstancesClientGetBackupInstanceOperationResultOptions contains the optional parameters for the BackupInstancesClient.GetBackupInstanceOperationResult method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBackupInstancesClient().GetBackupInstanceOperationResult(ctx, "SampleResourceGroup", "swaggerExample", "testInstance1", "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.BackupInstanceResource = armdataprotection.BackupInstanceResource{
// 	Name: to.Ptr("testInstance1"),
// 	Type: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances"),
// 	ID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/backupInstances/testInstance1"),
// 	Properties: &armdataprotection.BackupInstance{
// 		DataSourceInfo: &armdataprotection.Datasource{
// 			DatasourceType: to.Ptr("OssDB"),
// 			ObjectType: to.Ptr("Datasource"),
// 			ResourceID: to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"),
// 			ResourceLocation: to.Ptr(""),
// 			ResourceName: to.Ptr("testdb"),
// 			ResourceType: to.Ptr("OssDB"),
// 			ResourceURI: to.Ptr(""),
// 		},
// 		DataSourceSetInfo: &armdataprotection.DatasourceSet{
// 			DatasourceType: to.Ptr("OssDB"),
// 			ObjectType: to.Ptr("DatasourceSet"),
// 			ResourceID: to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest"),
// 			ResourceLocation: to.Ptr(""),
// 			ResourceName: to.Ptr("viveksipgtest"),
// 			ResourceType: to.Ptr("OssDB"),
// 			ResourceURI: to.Ptr(""),
// 		},
// 		FriendlyName: to.Ptr("testInstance1"),
// 		ObjectType: to.Ptr("BackupInstance"),
// 		PolicyInfo: &armdataprotection.PolicyInfo{
// 			PolicyID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/backupPolicies/PratikPolicy1"),
// 			PolicyVersion: to.Ptr("3.2"),
// 		},
// 		ProtectionStatus: &armdataprotection.ProtectionStatusDetails{
// 			Status: to.Ptr(armdataprotection.StatusConfiguringProtection),
// 		},
// 		ProvisioningState: to.Ptr("Succeeded"),
// 	},
// }

Output:

func (*BackupInstancesClient) NewListPager 

func (client *BackupInstancesClient) NewListPager(resourceGroupName string, vaultName string, options *BackupInstancesClientListOptions) *runtime.Pager[BackupInstancesClientListResponse]

NewListPager - Gets a backup instances belonging to a backup vault

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • options - BackupInstancesClientListOptions contains the optional parameters for the BackupInstancesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/ListBackupInstances.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewBackupInstancesClient().NewListPager("000pikumar", "PratikPrivatePreviewVault1", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.BackupInstanceResourceList = armdataprotection.BackupInstanceResourceList{
	// 	Value: []*armdataprotection.BackupInstanceResource{
	// 		{
	// 			Name: to.Ptr("harshitbi2"),
	// 			Type: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances"),
	// 			ID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2"),
	// 			Tags: map[string]*string{
	// 				"key1": to.Ptr("val1"),
	// 			},
	// 			Properties: &armdataprotection.BackupInstance{
	// 				DataSourceInfo: &armdataprotection.Datasource{
	// 					DatasourceType: to.Ptr("OssDB"),
	// 					ObjectType: to.Ptr("Datasource"),
	// 					ResourceID: to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"),
	// 					ResourceLocation: to.Ptr(""),
	// 					ResourceName: to.Ptr("testdb"),
	// 					ResourceType: to.Ptr("OssDB"),
	// 					ResourceURI: to.Ptr(""),
	// 				},
	// 				DataSourceSetInfo: &armdataprotection.DatasourceSet{
	// 					DatasourceType: to.Ptr("OssDB"),
	// 					ObjectType: to.Ptr("DatasourceSet"),
	// 					ResourceID: to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest"),
	// 					ResourceLocation: to.Ptr(""),
	// 					ResourceName: to.Ptr("viveksipgtest"),
	// 					ResourceType: to.Ptr("OssDB"),
	// 					ResourceURI: to.Ptr(""),
	// 				},
	// 				FriendlyName: to.Ptr("harshitbi2"),
	// 				ObjectType: to.Ptr("BackupInstance"),
	// 				PolicyInfo: &armdataprotection.PolicyInfo{
	// 					PolicyID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"),
	// 					PolicyVersion: to.Ptr("3.2"),
	// 				},
	// 				ProtectionStatus: &armdataprotection.ProtectionStatusDetails{
	// 					Status: to.Ptr(armdataprotection.Status("NotProtected")),
	// 				},
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 			},
	// 	}},
	// }
}

Output:

type BackupInstancesClientAdhocBackupResponse 

type BackupInstancesClientAdhocBackupResponse struct {
	// Operation Job Extended Info
	OperationJobExtendedInfo
}

BackupInstancesClientAdhocBackupResponse contains the response from method BackupInstancesClient.BeginAdhocBackup.

type BackupInstancesClientBeginAdhocBackupOptions 

type BackupInstancesClientBeginAdhocBackupOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

BackupInstancesClientBeginAdhocBackupOptions contains the optional parameters for the BackupInstancesClient.BeginAdhocBackup method.

type BackupInstancesClientBeginCreateOrUpdateOptions 

type BackupInstancesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken               string
	XMSAuthorizationAuxiliary *string
}

BackupInstancesClientBeginCreateOrUpdateOptions contains the optional parameters for the BackupInstancesClient.BeginCreateOrUpdate method.

type BackupInstancesClientBeginDeleteOptions 

type BackupInstancesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken               string
	XMSAuthorizationAuxiliary *string
}

BackupInstancesClientBeginDeleteOptions contains the optional parameters for the BackupInstancesClient.BeginDelete method.

type BackupInstancesClientBeginResumeBackupsOptions 

type BackupInstancesClientBeginResumeBackupsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

BackupInstancesClientBeginResumeBackupsOptions contains the optional parameters for the BackupInstancesClient.BeginResumeBackups method.

type BackupInstancesClientBeginResumeProtectionOptions 

type BackupInstancesClientBeginResumeProtectionOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

BackupInstancesClientBeginResumeProtectionOptions contains the optional parameters for the BackupInstancesClient.BeginResumeProtection method.

type BackupInstancesClientBeginStopProtectionOptions 

type BackupInstancesClientBeginStopProtectionOptions struct {
	// Request body for operation
	Parameters *StopProtectionRequest

	// Resumes the LRO from the provided token.
	ResumeToken               string
	XMSAuthorizationAuxiliary *string
}

BackupInstancesClientBeginStopProtectionOptions contains the optional parameters for the BackupInstancesClient.BeginStopProtection method.

type BackupInstancesClientBeginSuspendBackupsOptions 

type BackupInstancesClientBeginSuspendBackupsOptions struct {
	// Request body for operation
	Parameters *SuspendBackupRequest

	// Resumes the LRO from the provided token.
	ResumeToken               string
	XMSAuthorizationAuxiliary *string
}

BackupInstancesClientBeginSuspendBackupsOptions contains the optional parameters for the BackupInstancesClient.BeginSuspendBackups method.

type BackupInstancesClientBeginSyncBackupInstanceOptions 

type BackupInstancesClientBeginSyncBackupInstanceOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

BackupInstancesClientBeginSyncBackupInstanceOptions contains the optional parameters for the BackupInstancesClient.BeginSyncBackupInstance method.

type BackupInstancesClientBeginTriggerCrossRegionRestoreOptions 

type BackupInstancesClientBeginTriggerCrossRegionRestoreOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

BackupInstancesClientBeginTriggerCrossRegionRestoreOptions contains the optional parameters for the BackupInstancesClient.BeginTriggerCrossRegionRestore method.

type BackupInstancesClientBeginTriggerRehydrateOptions 

type BackupInstancesClientBeginTriggerRehydrateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

BackupInstancesClientBeginTriggerRehydrateOptions contains the optional parameters for the BackupInstancesClient.BeginTriggerRehydrate method.

type BackupInstancesClientBeginTriggerRestoreOptions 

type BackupInstancesClientBeginTriggerRestoreOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken               string
	XMSAuthorizationAuxiliary *string
}

BackupInstancesClientBeginTriggerRestoreOptions contains the optional parameters for the BackupInstancesClient.BeginTriggerRestore method.

type BackupInstancesClientBeginValidateCrossRegionRestoreOptions 

type BackupInstancesClientBeginValidateCrossRegionRestoreOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

BackupInstancesClientBeginValidateCrossRegionRestoreOptions contains the optional parameters for the BackupInstancesClient.BeginValidateCrossRegionRestore method.

type BackupInstancesClientBeginValidateForBackupOptions 

type BackupInstancesClientBeginValidateForBackupOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

BackupInstancesClientBeginValidateForBackupOptions contains the optional parameters for the BackupInstancesClient.BeginValidateForBackup method.

type BackupInstancesClientBeginValidateForRestoreOptions 

type BackupInstancesClientBeginValidateForRestoreOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

BackupInstancesClientBeginValidateForRestoreOptions contains the optional parameters for the BackupInstancesClient.BeginValidateForRestore method.

type BackupInstancesClientCreateOrUpdateResponse 

type BackupInstancesClientCreateOrUpdateResponse struct {
	// BackupInstance Resource
	BackupInstanceResource
}

BackupInstancesClientCreateOrUpdateResponse contains the response from method BackupInstancesClient.BeginCreateOrUpdate.

type BackupInstancesClientDeleteResponse 

type BackupInstancesClientDeleteResponse struct {
}

BackupInstancesClientDeleteResponse contains the response from method BackupInstancesClient.BeginDelete.

type BackupInstancesClientGetBackupInstanceOperationResultOptions 

type BackupInstancesClientGetBackupInstanceOperationResultOptions struct {
}

BackupInstancesClientGetBackupInstanceOperationResultOptions contains the optional parameters for the BackupInstancesClient.GetBackupInstanceOperationResult method.

type BackupInstancesClientGetBackupInstanceOperationResultResponse 

type BackupInstancesClientGetBackupInstanceOperationResultResponse struct {
	// BackupInstance Resource
	BackupInstanceResource
}

BackupInstancesClientGetBackupInstanceOperationResultResponse contains the response from method BackupInstancesClient.GetBackupInstanceOperationResult.

type BackupInstancesClientGetOptions 

type BackupInstancesClientGetOptions struct {
}

BackupInstancesClientGetOptions contains the optional parameters for the BackupInstancesClient.Get method.

type BackupInstancesClientGetResponse 

type BackupInstancesClientGetResponse struct {
	// BackupInstance Resource
	BackupInstanceResource
}

BackupInstancesClientGetResponse contains the response from method BackupInstancesClient.Get.

type BackupInstancesClientListOptions 

type BackupInstancesClientListOptions struct {
}

BackupInstancesClientListOptions contains the optional parameters for the BackupInstancesClient.NewListPager method.

type BackupInstancesClientListResponse 

type BackupInstancesClientListResponse struct {
	// BackupInstance Resource list response
	BackupInstanceResourceList
}

BackupInstancesClientListResponse contains the response from method BackupInstancesClient.NewListPager.

type BackupInstancesClientResumeBackupsResponse 

type BackupInstancesClientResumeBackupsResponse struct {
}

BackupInstancesClientResumeBackupsResponse contains the response from method BackupInstancesClient.BeginResumeBackups.

type BackupInstancesClientResumeProtectionResponse 

type BackupInstancesClientResumeProtectionResponse struct {
}

BackupInstancesClientResumeProtectionResponse contains the response from method BackupInstancesClient.BeginResumeProtection.

type BackupInstancesClientStopProtectionResponse 

type BackupInstancesClientStopProtectionResponse struct {
}

BackupInstancesClientStopProtectionResponse contains the response from method BackupInstancesClient.BeginStopProtection.

type BackupInstancesClientSuspendBackupsResponse 

type BackupInstancesClientSuspendBackupsResponse struct {
}

BackupInstancesClientSuspendBackupsResponse contains the response from method BackupInstancesClient.BeginSuspendBackups.

type BackupInstancesClientSyncBackupInstanceResponse 

type BackupInstancesClientSyncBackupInstanceResponse struct {
}

BackupInstancesClientSyncBackupInstanceResponse contains the response from method BackupInstancesClient.BeginSyncBackupInstance.

type BackupInstancesClientTriggerCrossRegionRestoreResponse 

type BackupInstancesClientTriggerCrossRegionRestoreResponse struct {
	// Operation Job Extended Info
	OperationJobExtendedInfo
}

BackupInstancesClientTriggerCrossRegionRestoreResponse contains the response from method BackupInstancesClient.BeginTriggerCrossRegionRestore.

type BackupInstancesClientTriggerRehydrateResponse 

type BackupInstancesClientTriggerRehydrateResponse struct {
}

BackupInstancesClientTriggerRehydrateResponse contains the response from method BackupInstancesClient.BeginTriggerRehydrate.

type BackupInstancesClientTriggerRestoreResponse 

type BackupInstancesClientTriggerRestoreResponse struct {
	// Operation Job Extended Info
	OperationJobExtendedInfo
}

BackupInstancesClientTriggerRestoreResponse contains the response from method BackupInstancesClient.BeginTriggerRestore.

type BackupInstancesClientValidateCrossRegionRestoreResponse 

type BackupInstancesClientValidateCrossRegionRestoreResponse struct {
	// Operation Job Extended Info
	OperationJobExtendedInfo
}

BackupInstancesClientValidateCrossRegionRestoreResponse contains the response from method BackupInstancesClient.BeginValidateCrossRegionRestore.

type BackupInstancesClientValidateForBackupResponse 

type BackupInstancesClientValidateForBackupResponse struct {
	// Operation Job Extended Info
	OperationJobExtendedInfo
}

BackupInstancesClientValidateForBackupResponse contains the response from method BackupInstancesClient.BeginValidateForBackup.

type BackupInstancesClientValidateForRestoreResponse 

type BackupInstancesClientValidateForRestoreResponse struct {
	// Operation Job Extended Info
	OperationJobExtendedInfo
}

BackupInstancesClientValidateForRestoreResponse contains the response from method BackupInstancesClient.BeginValidateForRestore.

type BackupInstancesExtensionRoutingClient added in v3.1.0 

type BackupInstancesExtensionRoutingClient struct {
	// contains filtered or unexported fields
}

BackupInstancesExtensionRoutingClient contains the methods for the BackupInstancesExtensionRouting group. Don't use this type directly, use NewBackupInstancesExtensionRoutingClient() instead.

func NewBackupInstancesExtensionRoutingClient added in v3.1.0 

func NewBackupInstancesExtensionRoutingClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*BackupInstancesExtensionRoutingClient, error)

NewBackupInstancesExtensionRoutingClient creates a new instance of BackupInstancesExtensionRoutingClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*BackupInstancesExtensionRoutingClient) NewListPager added in v3.1.0 

func (client *BackupInstancesExtensionRoutingClient) NewListPager(resourceID string, options *BackupInstancesExtensionRoutingClientListOptions) *runtime.Pager[BackupInstancesExtensionRoutingClientListResponse]

NewListPager - Gets a list of backup instances associated with a tracked resource

Generated from API version 2024-04-01

  • resourceID - ARM path of the resource to be protected using Microsoft.DataProtection
  • options - BackupInstancesExtensionRoutingClientListOptions contains the optional parameters for the BackupInstancesExtensionRoutingClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/ListBackupInstancesExtensionRouting.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewBackupInstancesExtensionRoutingClient().NewListPager("subscriptions/36d32b25-3dc7-41b0-bde1-397500644591/resourceGroups/testRG/providers/Microsoft.Compute/disks/testDisk", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.BackupInstanceResourceList = armdataprotection.BackupInstanceResourceList{
	// 	Value: []*armdataprotection.BackupInstanceResource{
	// 		{
	// 			Name: to.Ptr("testDiskBI1-testDiskBI1-7664c12f-4d0a-440f-a0dc-b64f708b10e3"),
	// 			Type: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances"),
	// 			ID: to.Ptr("/subscriptions/36d32b25-3dc7-41b0-bde1-397500644591/resourceGroups/testRG/providers/Microsoft.Compute/disks/testDisk/providers/Microsoft.DataProtection/backupInstances/testDiskBI1-testDiskBI1-7664c12f-4d0a-440f-a0dc-b64f708b10e3"),
	// 			Properties: &armdataprotection.BackupInstance{
	// 				CurrentProtectionState: to.Ptr(armdataprotection.CurrentProtectionStateProtectionConfigured),
	// 				DataSourceInfo: &armdataprotection.Datasource{
	// 					DatasourceType: to.Ptr("Microsoft.Compute/disks"),
	// 					ObjectType: to.Ptr("Datasource"),
	// 					ResourceID: to.Ptr("/subscriptions/36d32b25-3dc7-41b0-bde1-397500644591/resourceGroups/testRG/providers/Microsoft.Compute/disks/testDisk"),
	// 					ResourceLocation: to.Ptr("eastus2euap"),
	// 					ResourceName: to.Ptr("testDisk"),
	// 					ResourceType: to.Ptr("Microsoft.Compute/disks"),
	// 					ResourceURI: to.Ptr("/subscriptions/36d32b25-3dc7-41b0-bde1-397500644591/resourceGroups/testRG/providers/Microsoft.Compute/disks/testDisk"),
	// 				},
	// 				DataSourceSetInfo: &armdataprotection.DatasourceSet{
	// 					DatasourceType: to.Ptr("Microsoft.Compute/disks"),
	// 					ObjectType: to.Ptr("DatasourceSet"),
	// 					ResourceID: to.Ptr("/subscriptions/36d32b25-3dc7-41b0-bde1-397500644591/resourceGroups/testRG/providers/Microsoft.Compute/disks/testDisk"),
	// 					ResourceLocation: to.Ptr("eastus2euap"),
	// 					ResourceName: to.Ptr("testDisk"),
	// 					ResourceType: to.Ptr("Microsoft.Compute/disks"),
	// 					ResourceURI: to.Ptr("/subscriptions/36d32b25-3dc7-41b0-bde1-397500644591/resourceGroups/testRG/providers/Microsoft.Compute/disks/testDisk"),
	// 				},
	// 				FriendlyName: to.Ptr("testDisk"),
	// 				ObjectType: to.Ptr("BackupInstance"),
	// 				PolicyInfo: &armdataprotection.PolicyInfo{
	// 					PolicyID: to.Ptr("/subscriptions/36d32b25-3dc7-41b0-bde1-397500644591/resourceGroups/policyRG/providers/Microsoft.DataProtection/backupVaults/jeczrsecy/backupPolicies/disk"),
	// 					PolicyParameters: &armdataprotection.PolicyParameters{
	// 						DataStoreParametersList: []armdataprotection.DataStoreParametersClassification{
	// 							&armdataprotection.AzureOperationalStoreParameters{
	// 								DataStoreType: to.Ptr(armdataprotection.DataStoreTypesOperationalStore),
	// 								ObjectType: to.Ptr("AzureOperationalStoreParameters"),
	// 								ResourceGroupID: to.Ptr("/subscriptions/36d32b25-3dc7-41b0-bde1-397500644591/resourceGroups/policyRG"),
	// 						}},
	// 					},
	// 					PolicyVersion: to.Ptr(""),
	// 				},
	// 				ProtectionStatus: &armdataprotection.ProtectionStatusDetails{
	// 					Status: to.Ptr(armdataprotection.StatusProtectionConfigured),
	// 				},
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 			},
	// 	}},
	// }
}

Output:

type BackupInstancesExtensionRoutingClientListOptions added in v3.1.0 

type BackupInstancesExtensionRoutingClientListOptions struct {
}

BackupInstancesExtensionRoutingClientListOptions contains the optional parameters for the BackupInstancesExtensionRoutingClient.NewListPager method.

type BackupInstancesExtensionRoutingClientListResponse added in v3.1.0 

type BackupInstancesExtensionRoutingClientListResponse struct {
	// BackupInstance Resource list response
	BackupInstanceResourceList
}

BackupInstancesExtensionRoutingClientListResponse contains the response from method BackupInstancesExtensionRoutingClient.NewListPager.

type BackupParameters 

type BackupParameters struct {
	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string
}

BackupParameters base

func (*BackupParameters) GetBackupParameters 

func (b *BackupParameters) GetBackupParameters() *BackupParameters

GetBackupParameters implements the BackupParametersClassification interface for type BackupParameters.

func (BackupParameters) MarshalJSON 

func (b BackupParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackupParameters.

func (*BackupParameters) UnmarshalJSON 

func (b *BackupParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackupParameters.

type BackupParametersClassification 

type BackupParametersClassification interface {
	// GetBackupParameters returns the BackupParameters content of the underlying type.
	GetBackupParameters() *BackupParameters
}

BackupParametersClassification provides polymorphic access to related types. Call the interface's GetBackupParameters() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AzureBackupParams, *BackupParameters

type BackupPoliciesClient 

type BackupPoliciesClient struct {
	// contains filtered or unexported fields
}

BackupPoliciesClient contains the methods for the BackupPolicies group. Don't use this type directly, use NewBackupPoliciesClient() instead.

func NewBackupPoliciesClient 

func NewBackupPoliciesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*BackupPoliciesClient, error)

NewBackupPoliciesClient creates a new instance of BackupPoliciesClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*BackupPoliciesClient) CreateOrUpdate 

func (client *BackupPoliciesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, vaultName string, backupPolicyName string, parameters BaseBackupPolicyResource, options *BackupPoliciesClientCreateOrUpdateOptions) (BackupPoliciesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or Updates a backup policy belonging to a backup vault If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • backupPolicyName - Name of the policy
  • parameters - Request body for operation
  • options - BackupPoliciesClientCreateOrUpdateOptions contains the optional parameters for the BackupPoliciesClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBackupPoliciesClient().CreateOrUpdate(ctx, "000pikumar", "PrivatePreviewVault", "OSSDBPolicy", armdataprotection.BaseBackupPolicyResource{
	Properties: &armdataprotection.BackupPolicy{
		DatasourceTypes: []*string{
			to.Ptr("OssDB")},
		ObjectType: to.Ptr("BackupPolicy"),
		PolicyRules: []armdataprotection.BasePolicyRuleClassification{
			&armdataprotection.AzureBackupRule{
				Name:       to.Ptr("BackupWeekly"),
				ObjectType: to.Ptr("AzureBackupRule"),
				BackupParameters: &armdataprotection.AzureBackupParams{
					ObjectType: to.Ptr("AzureBackupParams"),
					BackupType: to.Ptr("Full"),
				},
				DataStore: &armdataprotection.DataStoreInfoBase{
					DataStoreType: to.Ptr(armdataprotection.DataStoreTypesVaultStore),
					ObjectType:    to.Ptr("DataStoreInfoBase"),
				},
				Trigger: &armdataprotection.ScheduleBasedTriggerContext{
					ObjectType: to.Ptr("ScheduleBasedTriggerContext"),
					Schedule: &armdataprotection.BackupSchedule{
						RepeatingTimeIntervals: []*string{
							to.Ptr("R/2019-11-20T08:00:00-08:00/P1W")},
					},
					TaggingCriteria: []*armdataprotection.TaggingCriteria{
						{
							IsDefault: to.Ptr(true),
							TagInfo: &armdataprotection.RetentionTag{
								TagName: to.Ptr("Default"),
							},
							TaggingPriority: to.Ptr[int64](99),
						},
						{
							Criteria: []armdataprotection.BackupCriteriaClassification{
								&armdataprotection.ScheduleBasedBackupCriteria{
									ObjectType: to.Ptr("ScheduleBasedBackupCriteria"),
									DaysOfTheWeek: []*armdataprotection.DayOfWeek{
										to.Ptr(armdataprotection.DayOfWeekSunday)},
									ScheduleTimes: []*time.Time{
										to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00.000Z"); return t }())},
								}},
							IsDefault: to.Ptr(false),
							TagInfo: &armdataprotection.RetentionTag{
								TagName: to.Ptr("Weekly"),
							},
							TaggingPriority: to.Ptr[int64](20),
						}},
				},
			},
			&armdataprotection.AzureRetentionRule{
				Name:       to.Ptr("Default"),
				ObjectType: to.Ptr("AzureRetentionRule"),
				IsDefault:  to.Ptr(true),
				Lifecycles: []*armdataprotection.SourceLifeCycle{
					{
						DeleteAfter: &armdataprotection.AbsoluteDeleteOption{
							Duration:   to.Ptr("P1W"),
							ObjectType: to.Ptr("AbsoluteDeleteOption"),
						},
						SourceDataStore: &armdataprotection.DataStoreInfoBase{
							DataStoreType: to.Ptr(armdataprotection.DataStoreTypesVaultStore),
							ObjectType:    to.Ptr("DataStoreInfoBase"),
						},
					}},
			},
			&armdataprotection.AzureRetentionRule{
				Name:       to.Ptr("Weekly"),
				ObjectType: to.Ptr("AzureRetentionRule"),
				IsDefault:  to.Ptr(false),
				Lifecycles: []*armdataprotection.SourceLifeCycle{
					{
						DeleteAfter: &armdataprotection.AbsoluteDeleteOption{
							Duration:   to.Ptr("P12W"),
							ObjectType: to.Ptr("AbsoluteDeleteOption"),
						},
						SourceDataStore: &armdataprotection.DataStoreInfoBase{
							DataStoreType: to.Ptr(armdataprotection.DataStoreTypesVaultStore),
							ObjectType:    to.Ptr("DataStoreInfoBase"),
						},
					}},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.BaseBackupPolicyResource = armdataprotection.BaseBackupPolicyResource{
// 	Name: to.Ptr("OSSDBPolicy"),
// 	Type: to.Ptr("Microsoft.DataProtection/backupVaults/backupPolicies"),
// 	ID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy"),
// 	Properties: &armdataprotection.BackupPolicy{
// 		DatasourceTypes: []*string{
// 			to.Ptr("OssDB")},
// 			ObjectType: to.Ptr("BackupPolicy"),
// 			PolicyRules: []armdataprotection.BasePolicyRuleClassification{
// 				&armdataprotection.AzureBackupRule{
// 					Name: to.Ptr("BackupWeekly"),
// 					ObjectType: to.Ptr("AzureBackupRule"),
// 					BackupParameters: &armdataprotection.AzureBackupParams{
// 						ObjectType: to.Ptr("AzureBackupParams"),
// 						BackupType: to.Ptr("Full"),
// 					},
// 					DataStore: &armdataprotection.DataStoreInfoBase{
// 						DataStoreType: to.Ptr(armdataprotection.DataStoreTypesVaultStore),
// 						ObjectType: to.Ptr("DataStoreInfoBase"),
// 					},
// 					Trigger: &armdataprotection.ScheduleBasedTriggerContext{
// 						ObjectType: to.Ptr("ScheduleBasedTriggerContext"),
// 						Schedule: &armdataprotection.BackupSchedule{
// 							RepeatingTimeIntervals: []*string{
// 								to.Ptr("R/2019-11-20T08:00:00-08:00/P1W")},
// 							},
// 							TaggingCriteria: []*armdataprotection.TaggingCriteria{
// 								{
// 									IsDefault: to.Ptr(true),
// 									TagInfo: &armdataprotection.RetentionTag{
// 										ID: to.Ptr("Default_"),
// 										TagName: to.Ptr("Default"),
// 									},
// 									TaggingPriority: to.Ptr[int64](99),
// 								},
// 								{
// 									Criteria: []armdataprotection.BackupCriteriaClassification{
// 										&armdataprotection.ScheduleBasedBackupCriteria{
// 											ObjectType: to.Ptr("ScheduleBasedBackupCriteria"),
// 											DaysOfTheWeek: []*armdataprotection.DayOfWeek{
// 												to.Ptr(armdataprotection.DayOfWeekSunday)},
// 												ScheduleTimes: []*time.Time{
// 													to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00.000Z"); return t}())},
// 											}},
// 											IsDefault: to.Ptr(false),
// 											TagInfo: &armdataprotection.RetentionTag{
// 												ID: to.Ptr("Weekly_"),
// 												TagName: to.Ptr("Weekly"),
// 											},
// 											TaggingPriority: to.Ptr[int64](20),
// 									}},
// 								},
// 							},
// 							&armdataprotection.AzureRetentionRule{
// 								Name: to.Ptr("Default"),
// 								ObjectType: to.Ptr("AzureRetentionRule"),
// 								IsDefault: to.Ptr(true),
// 								Lifecycles: []*armdataprotection.SourceLifeCycle{
// 									{
// 										DeleteAfter: &armdataprotection.AbsoluteDeleteOption{
// 											Duration: to.Ptr("P1W"),
// 											ObjectType: to.Ptr("AbsoluteDeleteOption"),
// 										},
// 										SourceDataStore: &armdataprotection.DataStoreInfoBase{
// 											DataStoreType: to.Ptr(armdataprotection.DataStoreTypesVaultStore),
// 											ObjectType: to.Ptr("DataStoreInfoBase"),
// 										},
// 								}},
// 							},
// 							&armdataprotection.AzureRetentionRule{
// 								Name: to.Ptr("Weekly"),
// 								ObjectType: to.Ptr("AzureRetentionRule"),
// 								IsDefault: to.Ptr(false),
// 								Lifecycles: []*armdataprotection.SourceLifeCycle{
// 									{
// 										DeleteAfter: &armdataprotection.AbsoluteDeleteOption{
// 											Duration: to.Ptr("P12W"),
// 											ObjectType: to.Ptr("AbsoluteDeleteOption"),
// 										},
// 										SourceDataStore: &armdataprotection.DataStoreInfoBase{
// 											DataStoreType: to.Ptr(armdataprotection.DataStoreTypesVaultStore),
// 											ObjectType: to.Ptr("DataStoreInfoBase"),
// 										},
// 								}},
// 						}},
// 					},
// 				}

Output:

func (*BackupPoliciesClient) Delete 

func (client *BackupPoliciesClient) Delete(ctx context.Context, resourceGroupName string, vaultName string, backupPolicyName string, options *BackupPoliciesClientDeleteOptions) (BackupPoliciesClientDeleteResponse, error)

Delete - Deletes a backup policy belonging to a backup vault If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • options - BackupPoliciesClientDeleteOptions contains the optional parameters for the BackupPoliciesClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/PolicyCRUD/DeleteBackupPolicy.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = clientFactory.NewBackupPoliciesClient().Delete(ctx, "000pikumar", "PrivatePreviewVault", "OSSDBPolicy", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}

Output:

func (*BackupPoliciesClient) Get 

func (client *BackupPoliciesClient) Get(ctx context.Context, resourceGroupName string, vaultName string, backupPolicyName string, options *BackupPoliciesClientGetOptions) (BackupPoliciesClientGetResponse, error)

Get - Gets a backup policy belonging to a backup vault If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • options - BackupPoliciesClientGetOptions contains the optional parameters for the BackupPoliciesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/PolicyCRUD/GetBackupPolicy.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBackupPoliciesClient().Get(ctx, "000pikumar", "PrivatePreviewVault", "OSSDBPolicy", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.BaseBackupPolicyResource = armdataprotection.BaseBackupPolicyResource{
// 	Name: to.Ptr("OSSDBPolicy"),
// 	Type: to.Ptr("Microsoft.DataProtection/backupVaults/backupPolicies"),
// 	ID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy"),
// 	Properties: &armdataprotection.BackupPolicy{
// 		DatasourceTypes: []*string{
// 			to.Ptr("OssDB")},
// 			ObjectType: to.Ptr("BackupPolicy"),
// 			PolicyRules: []armdataprotection.BasePolicyRuleClassification{
// 				&armdataprotection.AzureBackupRule{
// 					Name: to.Ptr("BackupWeekly"),
// 					ObjectType: to.Ptr("AzureBackupRule"),
// 					BackupParameters: &armdataprotection.AzureBackupParams{
// 						ObjectType: to.Ptr("AzureBackupParams"),
// 						BackupType: to.Ptr("Full"),
// 					},
// 					DataStore: &armdataprotection.DataStoreInfoBase{
// 						DataStoreType: to.Ptr(armdataprotection.DataStoreTypesVaultStore),
// 						ObjectType: to.Ptr("DataStoreInfoBase"),
// 					},
// 					Trigger: &armdataprotection.ScheduleBasedTriggerContext{
// 						ObjectType: to.Ptr("ScheduleBasedTriggerContext"),
// 						Schedule: &armdataprotection.BackupSchedule{
// 							RepeatingTimeIntervals: []*string{
// 								to.Ptr("R/2019-11-20T08:00:00-08:00/P1W")},
// 							},
// 							TaggingCriteria: []*armdataprotection.TaggingCriteria{
// 								{
// 									IsDefault: to.Ptr(true),
// 									TagInfo: &armdataprotection.RetentionTag{
// 										ID: to.Ptr("Default_"),
// 										TagName: to.Ptr("Default"),
// 									},
// 									TaggingPriority: to.Ptr[int64](99),
// 								},
// 								{
// 									Criteria: []armdataprotection.BackupCriteriaClassification{
// 										&armdataprotection.ScheduleBasedBackupCriteria{
// 											ObjectType: to.Ptr("ScheduleBasedBackupCriteria"),
// 											DaysOfTheWeek: []*armdataprotection.DayOfWeek{
// 												to.Ptr(armdataprotection.DayOfWeekSunday)},
// 												ScheduleTimes: []*time.Time{
// 													to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00.000Z"); return t}())},
// 											}},
// 											IsDefault: to.Ptr(false),
// 											TagInfo: &armdataprotection.RetentionTag{
// 												ID: to.Ptr("Weekly_"),
// 												TagName: to.Ptr("Weekly"),
// 											},
// 											TaggingPriority: to.Ptr[int64](20),
// 									}},
// 								},
// 							},
// 							&armdataprotection.AzureRetentionRule{
// 								Name: to.Ptr("Default"),
// 								ObjectType: to.Ptr("AzureRetentionRule"),
// 								IsDefault: to.Ptr(true),
// 								Lifecycles: []*armdataprotection.SourceLifeCycle{
// 									{
// 										DeleteAfter: &armdataprotection.AbsoluteDeleteOption{
// 											Duration: to.Ptr("P1W"),
// 											ObjectType: to.Ptr("AbsoluteDeleteOption"),
// 										},
// 										SourceDataStore: &armdataprotection.DataStoreInfoBase{
// 											DataStoreType: to.Ptr(armdataprotection.DataStoreTypesVaultStore),
// 											ObjectType: to.Ptr("DataStoreInfoBase"),
// 										},
// 								}},
// 							},
// 							&armdataprotection.AzureRetentionRule{
// 								Name: to.Ptr("Weekly"),
// 								ObjectType: to.Ptr("AzureRetentionRule"),
// 								IsDefault: to.Ptr(false),
// 								Lifecycles: []*armdataprotection.SourceLifeCycle{
// 									{
// 										DeleteAfter: &armdataprotection.AbsoluteDeleteOption{
// 											Duration: to.Ptr("P12W"),
// 											ObjectType: to.Ptr("AbsoluteDeleteOption"),
// 										},
// 										SourceDataStore: &armdataprotection.DataStoreInfoBase{
// 											DataStoreType: to.Ptr(armdataprotection.DataStoreTypesVaultStore),
// 											ObjectType: to.Ptr("DataStoreInfoBase"),
// 										},
// 								}},
// 						}},
// 					},
// 				}

Output:

func (*BackupPoliciesClient) NewListPager 

func (client *BackupPoliciesClient) NewListPager(resourceGroupName string, vaultName string, options *BackupPoliciesClientListOptions) *runtime.Pager[BackupPoliciesClientListResponse]

NewListPager - Returns list of backup policies belonging to a backup vault

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • options - BackupPoliciesClientListOptions contains the optional parameters for the BackupPoliciesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/PolicyCRUD/ListBackupPolicy.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewBackupPoliciesClient().NewListPager("000pikumar", "PrivatePreviewVault", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.BaseBackupPolicyResourceList = armdataprotection.BaseBackupPolicyResourceList{
	// 	Value: []*armdataprotection.BaseBackupPolicyResource{
	// 		{
	// 			Name: to.Ptr("OSSDBPolicy"),
	// 			Type: to.Ptr("Microsoft.DataProtection/backupVaults/backupPolicies"),
	// 			ID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy"),
	// 			Properties: &armdataprotection.BackupPolicy{
	// 				DatasourceTypes: []*string{
	// 					to.Ptr("OssDB")},
	// 					ObjectType: to.Ptr("BackupPolicy"),
	// 					PolicyRules: []armdataprotection.BasePolicyRuleClassification{
	// 						&armdataprotection.AzureBackupRule{
	// 							Name: to.Ptr("BackupWeekly"),
	// 							ObjectType: to.Ptr("AzureBackupRule"),
	// 							BackupParameters: &armdataprotection.AzureBackupParams{
	// 								ObjectType: to.Ptr("AzureBackupParams"),
	// 								BackupType: to.Ptr("Full"),
	// 							},
	// 							DataStore: &armdataprotection.DataStoreInfoBase{
	// 								DataStoreType: to.Ptr(armdataprotection.DataStoreTypesVaultStore),
	// 								ObjectType: to.Ptr("DataStoreInfoBase"),
	// 							},
	// 							Trigger: &armdataprotection.ScheduleBasedTriggerContext{
	// 								ObjectType: to.Ptr("ScheduleBasedTriggerContext"),
	// 								Schedule: &armdataprotection.BackupSchedule{
	// 									RepeatingTimeIntervals: []*string{
	// 										to.Ptr("R/2019-11-20T08:00:00-08:00/P1W")},
	// 									},
	// 									TaggingCriteria: []*armdataprotection.TaggingCriteria{
	// 										{
	// 											IsDefault: to.Ptr(true),
	// 											TagInfo: &armdataprotection.RetentionTag{
	// 												ID: to.Ptr("Default_"),
	// 												TagName: to.Ptr("Default"),
	// 											},
	// 											TaggingPriority: to.Ptr[int64](99),
	// 										},
	// 										{
	// 											Criteria: []armdataprotection.BackupCriteriaClassification{
	// 												&armdataprotection.ScheduleBasedBackupCriteria{
	// 													ObjectType: to.Ptr("ScheduleBasedBackupCriteria"),
	// 													DaysOfTheWeek: []*armdataprotection.DayOfWeek{
	// 														to.Ptr(armdataprotection.DayOfWeekSunday)},
	// 														ScheduleTimes: []*time.Time{
	// 															to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00.000Z"); return t}())},
	// 													}},
	// 													IsDefault: to.Ptr(false),
	// 													TagInfo: &armdataprotection.RetentionTag{
	// 														ID: to.Ptr("Weekly_"),
	// 														TagName: to.Ptr("Weekly"),
	// 													},
	// 													TaggingPriority: to.Ptr[int64](20),
	// 											}},
	// 										},
	// 									},
	// 									&armdataprotection.AzureRetentionRule{
	// 										Name: to.Ptr("Default"),
	// 										ObjectType: to.Ptr("AzureRetentionRule"),
	// 										IsDefault: to.Ptr(true),
	// 										Lifecycles: []*armdataprotection.SourceLifeCycle{
	// 											{
	// 												DeleteAfter: &armdataprotection.AbsoluteDeleteOption{
	// 													Duration: to.Ptr("P1W"),
	// 													ObjectType: to.Ptr("AbsoluteDeleteOption"),
	// 												},
	// 												SourceDataStore: &armdataprotection.DataStoreInfoBase{
	// 													DataStoreType: to.Ptr(armdataprotection.DataStoreTypesVaultStore),
	// 													ObjectType: to.Ptr("DataStoreInfoBase"),
	// 												},
	// 										}},
	// 									},
	// 									&armdataprotection.AzureRetentionRule{
	// 										Name: to.Ptr("Weekly"),
	// 										ObjectType: to.Ptr("AzureRetentionRule"),
	// 										IsDefault: to.Ptr(false),
	// 										Lifecycles: []*armdataprotection.SourceLifeCycle{
	// 											{
	// 												DeleteAfter: &armdataprotection.AbsoluteDeleteOption{
	// 													Duration: to.Ptr("P12W"),
	// 													ObjectType: to.Ptr("AbsoluteDeleteOption"),
	// 												},
	// 												SourceDataStore: &armdataprotection.DataStoreInfoBase{
	// 													DataStoreType: to.Ptr(armdataprotection.DataStoreTypesVaultStore),
	// 													ObjectType: to.Ptr("DataStoreInfoBase"),
	// 												},
	// 										}},
	// 								}},
	// 							},
	// 					}},
	// 				}
}

Output:

type BackupPoliciesClientCreateOrUpdateOptions 

type BackupPoliciesClientCreateOrUpdateOptions struct {
}

BackupPoliciesClientCreateOrUpdateOptions contains the optional parameters for the BackupPoliciesClient.CreateOrUpdate method.

type BackupPoliciesClientCreateOrUpdateResponse 

type BackupPoliciesClientCreateOrUpdateResponse struct {
	// BaseBackupPolicy resource
	BaseBackupPolicyResource
}

BackupPoliciesClientCreateOrUpdateResponse contains the response from method BackupPoliciesClient.CreateOrUpdate.

type BackupPoliciesClientDeleteOptions 

type BackupPoliciesClientDeleteOptions struct {
}

BackupPoliciesClientDeleteOptions contains the optional parameters for the BackupPoliciesClient.Delete method.

type BackupPoliciesClientDeleteResponse 

type BackupPoliciesClientDeleteResponse struct {
}

BackupPoliciesClientDeleteResponse contains the response from method BackupPoliciesClient.Delete.

type BackupPoliciesClientGetOptions 

type BackupPoliciesClientGetOptions struct {
}

BackupPoliciesClientGetOptions contains the optional parameters for the BackupPoliciesClient.Get method.

type BackupPoliciesClientGetResponse 

type BackupPoliciesClientGetResponse struct {
	// BaseBackupPolicy resource
	BaseBackupPolicyResource
}

BackupPoliciesClientGetResponse contains the response from method BackupPoliciesClient.Get.

type BackupPoliciesClientListOptions 

type BackupPoliciesClientListOptions struct {
}

BackupPoliciesClientListOptions contains the optional parameters for the BackupPoliciesClient.NewListPager method.

type BackupPoliciesClientListResponse 

type BackupPoliciesClientListResponse struct {
	// List of BaseBackupPolicy resources
	BaseBackupPolicyResourceList
}

BackupPoliciesClientListResponse contains the response from method BackupPoliciesClient.NewListPager.

type BackupPolicy 

type BackupPolicy struct {
	// REQUIRED; Type of datasource for the backup management
	DatasourceTypes []*string

	// REQUIRED
	ObjectType *string

	// REQUIRED; Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc
	PolicyRules []BasePolicyRuleClassification
}

BackupPolicy - Rule based backup policy

func (*BackupPolicy) GetBaseBackupPolicy 

func (b *BackupPolicy) GetBaseBackupPolicy() *BaseBackupPolicy

GetBaseBackupPolicy implements the BaseBackupPolicyClassification interface for type BackupPolicy.

func (BackupPolicy) MarshalJSON 

func (b BackupPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackupPolicy.

func (*BackupPolicy) UnmarshalJSON 

func (b *BackupPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackupPolicy.

type BackupSchedule 

type BackupSchedule struct {
	// REQUIRED; ISO 8601 repeating time interval format
	RepeatingTimeIntervals []*string

	// Time zone for a schedule. Example: Pacific Standard Time
	TimeZone *string
}

BackupSchedule - Schedule for backup

func (BackupSchedule) MarshalJSON 

func (b BackupSchedule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackupSchedule.

func (*BackupSchedule) UnmarshalJSON 

func (b *BackupSchedule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackupSchedule.

type BackupVault 

type BackupVault struct {
	// REQUIRED; Storage Settings
	StorageSettings []*StorageSetting

	// Feature Settings
	FeatureSettings *FeatureSettings

	// Monitoring Settings
	MonitoringSettings *MonitoringSettings

	// List of replicated regions for Backup Vault
	ReplicatedRegions []*string

	// ResourceGuardOperationRequests on which LAC check will be performed
	ResourceGuardOperationRequests []*string

	// Security Settings
	SecuritySettings *SecuritySettings

	// READ-ONLY; Security Level of Backup Vault
	BcdrSecurityLevel *BCDRSecurityLevel

	// READ-ONLY; Is vault protected by resource guard
	IsVaultProtectedByResourceGuard *bool

	// READ-ONLY; Provisioning state of the BackupVault resource
	ProvisioningState *ProvisioningState

	// READ-ONLY; Resource move details for backup vault
	ResourceMoveDetails *ResourceMoveDetails

	// READ-ONLY; Resource move state for backup vault
	ResourceMoveState *ResourceMoveState

	// READ-ONLY; Secure Score of Backup Vault
	SecureScore *SecureScoreLevel
}

BackupVault - Backup Vault

func (BackupVault) MarshalJSON 

func (b BackupVault) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackupVault.

func (*BackupVault) UnmarshalJSON 

func (b *BackupVault) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackupVault.

type BackupVaultOperationResultsClient 

type BackupVaultOperationResultsClient struct {
	// contains filtered or unexported fields
}

BackupVaultOperationResultsClient contains the methods for the BackupVaultOperationResults group. Don't use this type directly, use NewBackupVaultOperationResultsClient() instead.

func NewBackupVaultOperationResultsClient 

func NewBackupVaultOperationResultsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*BackupVaultOperationResultsClient, error)

NewBackupVaultOperationResultsClient creates a new instance of BackupVaultOperationResultsClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*BackupVaultOperationResultsClient) Get 

func (client *BackupVaultOperationResultsClient) Get(ctx context.Context, resourceGroupName string, vaultName string, operationID string, options *BackupVaultOperationResultsClientGetOptions) (BackupVaultOperationResultsClientGetResponse, error)

Get - If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • options - BackupVaultOperationResultsClientGetOptions contains the optional parameters for the BackupVaultOperationResultsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/VaultCRUD/GetOperationResultPatch.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBackupVaultOperationResultsClient().Get(ctx, "SampleResourceGroup", "swaggerExample", "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.BackupVaultResource = armdataprotection.BackupVaultResource{
// 	Name: to.Ptr("swaggerExample"),
// 	Type: to.Ptr("Microsoft.DataProtection/Backupvaults"),
// 	ID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample"),
// 	Location: to.Ptr("WestUS"),
// 	Tags: map[string]*string{
// 		"key1": to.Ptr("val1"),
// 	},
// 	Identity: &armdataprotection.DppIdentityDetails{
// 		Type: to.Ptr("None"),
// 	},
// 	Properties: &armdataprotection.BackupVault{
// 		ProvisioningState: to.Ptr(armdataprotection.ProvisioningStateSucceeded),
// 		StorageSettings: []*armdataprotection.StorageSetting{
// 			{
// 				Type: to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
// 				DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
// 		}},
// 	},
// }

Output:

type BackupVaultOperationResultsClientGetOptions 

type BackupVaultOperationResultsClientGetOptions struct {
}

BackupVaultOperationResultsClientGetOptions contains the optional parameters for the BackupVaultOperationResultsClient.Get method.

type BackupVaultOperationResultsClientGetResponse 

type BackupVaultOperationResultsClientGetResponse struct {
	// Backup Vault Resource
	BackupVaultResource

	// AzureAsyncOperation contains the information returned from the Azure-AsyncOperation header response.
	AzureAsyncOperation *string

	// Location contains the information returned from the Location header response.
	Location *string

	// RetryAfter contains the information returned from the Retry-After header response.
	RetryAfter *int32
}

BackupVaultOperationResultsClientGetResponse contains the response from method BackupVaultOperationResultsClient.Get.

type BackupVaultResource 

type BackupVaultResource struct {
	// REQUIRED; BackupVaultResource properties
	Properties *BackupVault

	// Optional ETag.
	ETag *string

	// Input Managed Identity Details
	Identity *DppIdentityDetails

	// Resource location.
	Location *string

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Resource Id represents the complete path to the resource.
	ID *string

	// READ-ONLY; Resource name associated with the resource.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…
	Type *string
}

BackupVaultResource - Backup Vault Resource

func (BackupVaultResource) MarshalJSON 

func (b BackupVaultResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackupVaultResource.

func (*BackupVaultResource) UnmarshalJSON 

func (b *BackupVaultResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackupVaultResource.

type BackupVaultResourceList 

type BackupVaultResourceList struct {
	// The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
	NextLink *string

	// List of resources.
	Value []*BackupVaultResource
}

BackupVaultResourceList - List of BackupVault resources

func (BackupVaultResourceList) MarshalJSON 

func (b BackupVaultResourceList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackupVaultResourceList.

func (*BackupVaultResourceList) UnmarshalJSON 

func (b *BackupVaultResourceList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackupVaultResourceList.

type BackupVaultsClient 

type BackupVaultsClient struct {
	// contains filtered or unexported fields
}

BackupVaultsClient contains the methods for the BackupVaults group. Don't use this type directly, use NewBackupVaultsClient() instead.

func NewBackupVaultsClient 

func NewBackupVaultsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*BackupVaultsClient, error)

NewBackupVaultsClient creates a new instance of BackupVaultsClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*BackupVaultsClient) BeginCreateOrUpdate 

func (client *BackupVaultsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, vaultName string, parameters BackupVaultResource, options *BackupVaultsClientBeginCreateOrUpdateOptions) (*runtime.Poller[BackupVaultsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a BackupVault resource belonging to a resource group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • parameters - Request body for operation
  • options - BackupVaultsClientBeginCreateOrUpdateOptions contains the optional parameters for the BackupVaultsClient.BeginCreateOrUpdate method.
Example (CreateBackupVault)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/VaultCRUD/PutBackupVault.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupVaultsClient().BeginCreateOrUpdate(ctx, "SampleResourceGroup", "swaggerExample", armdataprotection.BackupVaultResource{
	Location: to.Ptr("WestUS"),
	Tags: map[string]*string{
		"key1": to.Ptr("val1"),
	},
	Identity: &armdataprotection.DppIdentityDetails{
		Type: to.Ptr("None"),
	},
	Properties: &armdataprotection.BackupVault{
		FeatureSettings: &armdataprotection.FeatureSettings{
			CrossRegionRestoreSettings: &armdataprotection.CrossRegionRestoreSettings{
				State: to.Ptr(armdataprotection.CrossRegionRestoreStateEnabled),
			},
		},
		MonitoringSettings: &armdataprotection.MonitoringSettings{
			AzureMonitorAlertSettings: &armdataprotection.AzureMonitorAlertSettings{
				AlertsForAllJobFailures: to.Ptr(armdataprotection.AlertsStateEnabled),
			},
		},
		SecuritySettings: &armdataprotection.SecuritySettings{
			SoftDeleteSettings: &armdataprotection.SoftDeleteSettings{
				RetentionDurationInDays: to.Ptr[float64](14),
				State:                   to.Ptr(armdataprotection.SoftDeleteState("Enabled")),
			},
		},
		StorageSettings: []*armdataprotection.StorageSetting{
			{
				Type:          to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
				DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
			}},
	},
}, &armdataprotection.BackupVaultsClientBeginCreateOrUpdateOptions{XMSAuthorizationAuxiliary: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.BackupVaultResource = armdataprotection.BackupVaultResource{
// 	Name: to.Ptr("swaggerExample"),
// 	Type: to.Ptr("Microsoft.DataProtection/Backupvaults"),
// 	ID: to.Ptr("/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample"),
// 	Location: to.Ptr("WestUS"),
// 	Tags: map[string]*string{
// 		"key1": to.Ptr("val1"),
// 	},
// 	Identity: &armdataprotection.DppIdentityDetails{
// 		Type: to.Ptr("None"),
// 	},
// 	Properties: &armdataprotection.BackupVault{
// 		FeatureSettings: &armdataprotection.FeatureSettings{
// 			CrossRegionRestoreSettings: &armdataprotection.CrossRegionRestoreSettings{
// 				State: to.Ptr(armdataprotection.CrossRegionRestoreStateEnabled),
// 			},
// 		},
// 		MonitoringSettings: &armdataprotection.MonitoringSettings{
// 			AzureMonitorAlertSettings: &armdataprotection.AzureMonitorAlertSettings{
// 				AlertsForAllJobFailures: to.Ptr(armdataprotection.AlertsStateEnabled),
// 			},
// 		},
// 		ProvisioningState: to.Ptr(armdataprotection.ProvisioningStateSucceeded),
// 		SecureScore: to.Ptr(armdataprotection.SecureScoreLevelAdequate),
// 		SecuritySettings: &armdataprotection.SecuritySettings{
// 			SoftDeleteSettings: &armdataprotection.SoftDeleteSettings{
// 				RetentionDurationInDays: to.Ptr[float64](14),
// 				State: to.Ptr(armdataprotection.SoftDeleteState("Enabled")),
// 			},
// 		},
// 		StorageSettings: []*armdataprotection.StorageSetting{
// 			{
// 				Type: to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
// 				DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
// 		}},
// 	},
// }

Output:
Example (CreateBackupVaultWithCmk)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/VaultCRUD/PutBackupVaultWithCMK.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupVaultsClient().BeginCreateOrUpdate(ctx, "SampleResourceGroup", "swaggerExample", armdataprotection.BackupVaultResource{
	Location: to.Ptr("WestUS"),
	Tags: map[string]*string{
		"key1": to.Ptr("val1"),
	},
	Identity: &armdataprotection.DppIdentityDetails{
		Type: to.Ptr("None"),
	},
	Properties: &armdataprotection.BackupVault{
		MonitoringSettings: &armdataprotection.MonitoringSettings{
			AzureMonitorAlertSettings: &armdataprotection.AzureMonitorAlertSettings{
				AlertsForAllJobFailures: to.Ptr(armdataprotection.AlertsStateEnabled),
			},
		},
		SecuritySettings: &armdataprotection.SecuritySettings{
			EncryptionSettings: &armdataprotection.EncryptionSettings{
				InfrastructureEncryption: to.Ptr(armdataprotection.InfrastructureEncryptionStateEnabled),
				KekIdentity: &armdataprotection.CmkKekIdentity{
					IdentityID:   to.Ptr("/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi"),
					IdentityType: to.Ptr(armdataprotection.IdentityTypeUserAssigned),
				},
				KeyVaultProperties: &armdataprotection.CmkKeyVaultProperties{
					KeyURI: to.Ptr("https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3"),
				},
				State: to.Ptr(armdataprotection.EncryptionStateEnabled),
			},
			ImmutabilitySettings: &armdataprotection.ImmutabilitySettings{
				State: to.Ptr(armdataprotection.ImmutabilityStateDisabled),
			},
			SoftDeleteSettings: &armdataprotection.SoftDeleteSettings{
				RetentionDurationInDays: to.Ptr[float64](0),
				State:                   to.Ptr(armdataprotection.SoftDeleteStateOff),
			},
		},
		StorageSettings: []*armdataprotection.StorageSetting{
			{
				Type:          to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
				DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
			}},
	},
}, &armdataprotection.BackupVaultsClientBeginCreateOrUpdateOptions{XMSAuthorizationAuxiliary: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.BackupVaultResource = armdataprotection.BackupVaultResource{
// 	Name: to.Ptr("swaggerExample"),
// 	Type: to.Ptr("Microsoft.DataProtection/Backupvaults"),
// 	ID: to.Ptr("/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample"),
// 	Location: to.Ptr("WestUS"),
// 	Tags: map[string]*string{
// 		"key1": to.Ptr("val1"),
// 	},
// 	Identity: &armdataprotection.DppIdentityDetails{
// 		Type: to.Ptr("None"),
// 	},
// 	Properties: &armdataprotection.BackupVault{
// 		MonitoringSettings: &armdataprotection.MonitoringSettings{
// 			AzureMonitorAlertSettings: &armdataprotection.AzureMonitorAlertSettings{
// 				AlertsForAllJobFailures: to.Ptr(armdataprotection.AlertsStateEnabled),
// 			},
// 		},
// 		ProvisioningState: to.Ptr(armdataprotection.ProvisioningStateSucceeded),
// 		StorageSettings: []*armdataprotection.StorageSetting{
// 			{
// 				Type: to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
// 				DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
// 		}},
// 	},
// }

Output:
Example (CreateBackupVaultWithMsi)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/VaultCRUD/PutBackupVaultWithMSI.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupVaultsClient().BeginCreateOrUpdate(ctx, "SampleResourceGroup", "swaggerExample", armdataprotection.BackupVaultResource{
	Location: to.Ptr("WestUS"),
	Tags: map[string]*string{
		"key1": to.Ptr("val1"),
	},
	Identity: &armdataprotection.DppIdentityDetails{
		Type: to.Ptr("systemAssigned"),
	},
	Properties: &armdataprotection.BackupVault{
		FeatureSettings: &armdataprotection.FeatureSettings{
			CrossRegionRestoreSettings: &armdataprotection.CrossRegionRestoreSettings{
				State: to.Ptr(armdataprotection.CrossRegionRestoreStateEnabled),
			},
		},
		MonitoringSettings: &armdataprotection.MonitoringSettings{
			AzureMonitorAlertSettings: &armdataprotection.AzureMonitorAlertSettings{
				AlertsForAllJobFailures: to.Ptr(armdataprotection.AlertsStateEnabled),
			},
		},
		SecuritySettings: &armdataprotection.SecuritySettings{
			SoftDeleteSettings: &armdataprotection.SoftDeleteSettings{
				RetentionDurationInDays: to.Ptr[float64](14),
				State:                   to.Ptr(armdataprotection.SoftDeleteState("Enabled")),
			},
		},
		StorageSettings: []*armdataprotection.StorageSetting{
			{
				Type:          to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
				DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
			}},
	},
}, &armdataprotection.BackupVaultsClientBeginCreateOrUpdateOptions{XMSAuthorizationAuxiliary: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.BackupVaultResource = armdataprotection.BackupVaultResource{
// 	Name: to.Ptr("swaggerExample"),
// 	Type: to.Ptr("Microsoft.DataProtection/Backupvaults"),
// 	ID: to.Ptr("/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample"),
// 	Location: to.Ptr("WestUS"),
// 	Tags: map[string]*string{
// 		"key1": to.Ptr("val1"),
// 	},
// 	Identity: &armdataprotection.DppIdentityDetails{
// 		Type: to.Ptr("SystemAssigned"),
// 		PrincipalID: to.Ptr("c009b9a0-0024-417c-83cd-025d3776045d"),
// 		TenantID: to.Ptr("83abe5cd-bcc3-441a-bd86-e6a75360cecc"),
// 	},
// 	Properties: &armdataprotection.BackupVault{
// 		FeatureSettings: &armdataprotection.FeatureSettings{
// 			CrossRegionRestoreSettings: &armdataprotection.CrossRegionRestoreSettings{
// 				State: to.Ptr(armdataprotection.CrossRegionRestoreStateEnabled),
// 			},
// 		},
// 		MonitoringSettings: &armdataprotection.MonitoringSettings{
// 			AzureMonitorAlertSettings: &armdataprotection.AzureMonitorAlertSettings{
// 				AlertsForAllJobFailures: to.Ptr(armdataprotection.AlertsStateEnabled),
// 			},
// 		},
// 		ProvisioningState: to.Ptr(armdataprotection.ProvisioningStateSucceeded),
// 		SecureScore: to.Ptr(armdataprotection.SecureScoreLevelAdequate),
// 		SecuritySettings: &armdataprotection.SecuritySettings{
// 			SoftDeleteSettings: &armdataprotection.SoftDeleteSettings{
// 				RetentionDurationInDays: to.Ptr[float64](14),
// 				State: to.Ptr(armdataprotection.SoftDeleteState("Enabled")),
// 			},
// 		},
// 		StorageSettings: []*armdataprotection.StorageSetting{
// 			{
// 				Type: to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
// 				DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
// 		}},
// 	},
// }

Output:

func (*BackupVaultsClient) BeginDelete 

func (client *BackupVaultsClient) BeginDelete(ctx context.Context, resourceGroupName string, vaultName string, options *BackupVaultsClientBeginDeleteOptions) (*runtime.Poller[BackupVaultsClientDeleteResponse], error)

BeginDelete - Deletes a BackupVault resource from the resource group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • options - BackupVaultsClientBeginDeleteOptions contains the optional parameters for the BackupVaultsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/VaultCRUD/DeleteBackupVault.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupVaultsClient().BeginDelete(ctx, "SampleResourceGroup", "swaggerExample", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*BackupVaultsClient) BeginUpdate 

func (client *BackupVaultsClient) BeginUpdate(ctx context.Context, resourceGroupName string, vaultName string, parameters PatchResourceRequestInput, options *BackupVaultsClientBeginUpdateOptions) (*runtime.Poller[BackupVaultsClientUpdateResponse], error)

BeginUpdate - Updates a BackupVault resource belonging to a resource group. For example, updating tags for a resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • parameters - Request body for operation
  • options - BackupVaultsClientBeginUpdateOptions contains the optional parameters for the BackupVaultsClient.BeginUpdate method.
Example (PatchBackupVault)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/VaultCRUD/PatchBackupVault.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupVaultsClient().BeginUpdate(ctx, "SampleResourceGroup", "swaggerExample", armdataprotection.PatchResourceRequestInput{
	Properties: &armdataprotection.PatchBackupVaultInput{
		MonitoringSettings: &armdataprotection.MonitoringSettings{
			AzureMonitorAlertSettings: &armdataprotection.AzureMonitorAlertSettings{
				AlertsForAllJobFailures: to.Ptr(armdataprotection.AlertsStateEnabled),
			},
		},
	},
	Tags: map[string]*string{
		"newKey": to.Ptr("newVal"),
	},
}, &armdataprotection.BackupVaultsClientBeginUpdateOptions{XMSAuthorizationAuxiliary: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.BackupVaultResource = armdataprotection.BackupVaultResource{
// 	Name: to.Ptr("swaggerExample"),
// 	Type: to.Ptr("Microsoft.DataProtection/Backupvaults"),
// 	ID: to.Ptr("/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample"),
// 	Location: to.Ptr("WestUS"),
// 	Tags: map[string]*string{
// 		"newKey": to.Ptr("newVal"),
// 	},
// 	Properties: &armdataprotection.BackupVault{
// 		MonitoringSettings: &armdataprotection.MonitoringSettings{
// 			AzureMonitorAlertSettings: &armdataprotection.AzureMonitorAlertSettings{
// 				AlertsForAllJobFailures: to.Ptr(armdataprotection.AlertsStateEnabled),
// 			},
// 		},
// 		ProvisioningState: to.Ptr(armdataprotection.ProvisioningStateSucceeded),
// 		StorageSettings: []*armdataprotection.StorageSetting{
// 			{
// 				Type: to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
// 				DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
// 		}},
// 	},
// }

Output:
Example (PatchBackupVaultWithCmk)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/VaultCRUD/PatchBackupVaultWithCMK.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBackupVaultsClient().BeginUpdate(ctx, "SampleResourceGroup", "swaggerExample", armdataprotection.PatchResourceRequestInput{
	Properties: &armdataprotection.PatchBackupVaultInput{
		MonitoringSettings: &armdataprotection.MonitoringSettings{
			AzureMonitorAlertSettings: &armdataprotection.AzureMonitorAlertSettings{
				AlertsForAllJobFailures: to.Ptr(armdataprotection.AlertsStateEnabled),
			},
		},
		SecuritySettings: &armdataprotection.SecuritySettings{
			EncryptionSettings: &armdataprotection.EncryptionSettings{
				InfrastructureEncryption: to.Ptr(armdataprotection.InfrastructureEncryptionStateEnabled),
				KekIdentity: &armdataprotection.CmkKekIdentity{
					IdentityType: to.Ptr(armdataprotection.IdentityTypeSystemAssigned),
				},
				KeyVaultProperties: &armdataprotection.CmkKeyVaultProperties{
					KeyURI: to.Ptr("https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3"),
				},
				State: to.Ptr(armdataprotection.EncryptionStateEnabled),
			},
			ImmutabilitySettings: &armdataprotection.ImmutabilitySettings{
				State: to.Ptr(armdataprotection.ImmutabilityStateDisabled),
			},
			SoftDeleteSettings: &armdataprotection.SoftDeleteSettings{
				RetentionDurationInDays: to.Ptr[float64](90),
				State:                   to.Ptr(armdataprotection.SoftDeleteStateOn),
			},
		},
	},
	Tags: map[string]*string{
		"newKey": to.Ptr("newVal"),
	},
}, &armdataprotection.BackupVaultsClientBeginUpdateOptions{XMSAuthorizationAuxiliary: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.BackupVaultResource = armdataprotection.BackupVaultResource{
// 	Name: to.Ptr("swaggerExample"),
// 	Type: to.Ptr("Microsoft.DataProtection/Backupvaults"),
// 	ID: to.Ptr("/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample"),
// 	Location: to.Ptr("WestUS"),
// 	Tags: map[string]*string{
// 		"newKey": to.Ptr("newVal"),
// 	},
// 	Properties: &armdataprotection.BackupVault{
// 		MonitoringSettings: &armdataprotection.MonitoringSettings{
// 			AzureMonitorAlertSettings: &armdataprotection.AzureMonitorAlertSettings{
// 				AlertsForAllJobFailures: to.Ptr(armdataprotection.AlertsStateEnabled),
// 			},
// 		},
// 		ProvisioningState: to.Ptr(armdataprotection.ProvisioningStateSucceeded),
// 		SecuritySettings: &armdataprotection.SecuritySettings{
// 			EncryptionSettings: &armdataprotection.EncryptionSettings{
// 				InfrastructureEncryption: to.Ptr(armdataprotection.InfrastructureEncryptionStateEnabled),
// 				KekIdentity: &armdataprotection.CmkKekIdentity{
// 					IdentityType: to.Ptr(armdataprotection.IdentityTypeSystemAssigned),
// 				},
// 				KeyVaultProperties: &armdataprotection.CmkKeyVaultProperties{
// 					KeyURI: to.Ptr("https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3"),
// 				},
// 			},
// 			ImmutabilitySettings: &armdataprotection.ImmutabilitySettings{
// 				State: to.Ptr(armdataprotection.ImmutabilityStateDisabled),
// 			},
// 			SoftDeleteSettings: &armdataprotection.SoftDeleteSettings{
// 				RetentionDurationInDays: to.Ptr[float64](90),
// 				State: to.Ptr(armdataprotection.SoftDeleteStateOn),
// 			},
// 		},
// 		StorageSettings: []*armdataprotection.StorageSetting{
// 			{
// 				Type: to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
// 				DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
// 		}},
// 	},
// }

Output:

func (*BackupVaultsClient) CheckNameAvailability 

func (client *BackupVaultsClient) CheckNameAvailability(ctx context.Context, resourceGroupName string, location string, parameters CheckNameAvailabilityRequest, options *BackupVaultsClientCheckNameAvailabilityOptions) (BackupVaultsClientCheckNameAvailabilityResponse, error)

CheckNameAvailability - API to check for resource name availability If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • location - The location in which uniqueness will be verified.
  • parameters - Check name availability request
  • options - BackupVaultsClientCheckNameAvailabilityOptions contains the optional parameters for the BackupVaultsClient.CheckNameAvailability method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBackupVaultsClient().CheckNameAvailability(ctx, "SampleResourceGroup", "westus", armdataprotection.CheckNameAvailabilityRequest{
	Name: to.Ptr("swaggerExample"),
	Type: to.Ptr("Microsoft.DataProtection/BackupVaults"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.CheckNameAvailabilityResult = armdataprotection.CheckNameAvailabilityResult{
// 	NameAvailable: to.Ptr(true),
// }

Output:

func (*BackupVaultsClient) Get 

func (client *BackupVaultsClient) Get(ctx context.Context, resourceGroupName string, vaultName string, options *BackupVaultsClientGetOptions) (BackupVaultsClientGetResponse, error)

Get - Returns a resource belonging to a resource group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • options - BackupVaultsClientGetOptions contains the optional parameters for the BackupVaultsClient.Get method.
Example (GetBackupVault)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/VaultCRUD/GetBackupVault.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBackupVaultsClient().Get(ctx, "SampleResourceGroup", "swaggerExample", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.BackupVaultResource = armdataprotection.BackupVaultResource{
// 	Name: to.Ptr("swaggerExample"),
// 	Type: to.Ptr("Microsoft.DataProtection/Backupvaults"),
// 	ID: to.Ptr("/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample"),
// 	Location: to.Ptr("WestUS"),
// 	Tags: map[string]*string{
// 		"key1": to.Ptr("val1"),
// 	},
// 	Identity: &armdataprotection.DppIdentityDetails{
// 		Type: to.Ptr("None"),
// 	},
// 	Properties: &armdataprotection.BackupVault{
// 		BcdrSecurityLevel: to.Ptr(armdataprotection.BCDRSecurityLevelGood),
// 		FeatureSettings: &armdataprotection.FeatureSettings{
// 			CrossRegionRestoreSettings: &armdataprotection.CrossRegionRestoreSettings{
// 				State: to.Ptr(armdataprotection.CrossRegionRestoreStateEnabled),
// 			},
// 		},
// 		MonitoringSettings: &armdataprotection.MonitoringSettings{
// 			AzureMonitorAlertSettings: &armdataprotection.AzureMonitorAlertSettings{
// 				AlertsForAllJobFailures: to.Ptr(armdataprotection.AlertsStateEnabled),
// 			},
// 		},
// 		ProvisioningState: to.Ptr(armdataprotection.ProvisioningStateSucceeded),
// 		SecureScore: to.Ptr(armdataprotection.SecureScoreLevelAdequate),
// 		SecuritySettings: &armdataprotection.SecuritySettings{
// 			SoftDeleteSettings: &armdataprotection.SoftDeleteSettings{
// 				RetentionDurationInDays: to.Ptr[float64](14),
// 				State: to.Ptr(armdataprotection.SoftDeleteState("Enabled")),
// 			},
// 		},
// 		StorageSettings: []*armdataprotection.StorageSetting{
// 			{
// 				Type: to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
// 				DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
// 		}},
// 	},
// }

Output:
Example (GetBackupVaultWithCmk)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/VaultCRUD/GetBackupVaultWithCMK.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBackupVaultsClient().Get(ctx, "SampleResourceGroup", "swaggerExample", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.BackupVaultResource = armdataprotection.BackupVaultResource{
// 	Name: to.Ptr("swaggerExample"),
// 	Type: to.Ptr("Microsoft.DataProtection/Backupvaults"),
// 	ID: to.Ptr("/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample"),
// 	Location: to.Ptr("WestUS"),
// 	Tags: map[string]*string{
// 		"key1": to.Ptr("val1"),
// 	},
// 	Identity: &armdataprotection.DppIdentityDetails{
// 		Type: to.Ptr("SystemAssigned"),
// 		PrincipalID: to.Ptr("c009b9a0-0024-417c-83cd-025d3776045d"),
// 		TenantID: to.Ptr("83abe5cd-bcc3-441a-bd86-e6a75360cecc"),
// 	},
// 	Properties: &armdataprotection.BackupVault{
// 		ProvisioningState: to.Ptr(armdataprotection.ProvisioningStateSucceeded),
// 		SecuritySettings: &armdataprotection.SecuritySettings{
// 			EncryptionSettings: &armdataprotection.EncryptionSettings{
// 				InfrastructureEncryption: to.Ptr(armdataprotection.InfrastructureEncryptionStateDisabled),
// 				KekIdentity: &armdataprotection.CmkKekIdentity{
// 					IdentityID: to.Ptr("/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi"),
// 					IdentityType: to.Ptr(armdataprotection.IdentityTypeUserAssigned),
// 				},
// 				KeyVaultProperties: &armdataprotection.CmkKeyVaultProperties{
// 					KeyURI: to.Ptr("https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3"),
// 				},
// 				State: to.Ptr(armdataprotection.EncryptionStateEnabled),
// 			},
// 			ImmutabilitySettings: &armdataprotection.ImmutabilitySettings{
// 				State: to.Ptr(armdataprotection.ImmutabilityStateDisabled),
// 			},
// 			SoftDeleteSettings: &armdataprotection.SoftDeleteSettings{
// 				RetentionDurationInDays: to.Ptr[float64](0),
// 				State: to.Ptr(armdataprotection.SoftDeleteStateOff),
// 			},
// 		},
// 		StorageSettings: []*armdataprotection.StorageSetting{
// 			{
// 				Type: to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
// 				DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
// 		}},
// 	},
// }

Output:
Example (GetBackupVaultWithMsi)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/VaultCRUD/GetBackupVaultWithMSI.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBackupVaultsClient().Get(ctx, "SampleResourceGroup", "swaggerExample", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.BackupVaultResource = armdataprotection.BackupVaultResource{
// 	Name: to.Ptr("swaggerExample"),
// 	Type: to.Ptr("Microsoft.DataProtection/Backupvaults"),
// 	ID: to.Ptr("/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample"),
// 	Location: to.Ptr("WestUS"),
// 	Tags: map[string]*string{
// 		"key1": to.Ptr("val1"),
// 	},
// 	Identity: &armdataprotection.DppIdentityDetails{
// 		Type: to.Ptr("SystemAssigned"),
// 		PrincipalID: to.Ptr("c009b9a0-0024-417c-83cd-025d3776045d"),
// 		TenantID: to.Ptr("83abe5cd-bcc3-441a-bd86-e6a75360cecc"),
// 	},
// 	Properties: &armdataprotection.BackupVault{
// 		BcdrSecurityLevel: to.Ptr(armdataprotection.BCDRSecurityLevelGood),
// 		FeatureSettings: &armdataprotection.FeatureSettings{
// 			CrossRegionRestoreSettings: &armdataprotection.CrossRegionRestoreSettings{
// 				State: to.Ptr(armdataprotection.CrossRegionRestoreStateEnabled),
// 			},
// 		},
// 		ProvisioningState: to.Ptr(armdataprotection.ProvisioningStateSucceeded),
// 		SecureScore: to.Ptr(armdataprotection.SecureScoreLevelAdequate),
// 		SecuritySettings: &armdataprotection.SecuritySettings{
// 			SoftDeleteSettings: &armdataprotection.SoftDeleteSettings{
// 				RetentionDurationInDays: to.Ptr[float64](14),
// 				State: to.Ptr(armdataprotection.SoftDeleteState("Enabled")),
// 			},
// 		},
// 		StorageSettings: []*armdataprotection.StorageSetting{
// 			{
// 				Type: to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
// 				DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
// 		}},
// 	},
// }

Output:

func (*BackupVaultsClient) NewGetInResourceGroupPager 

func (client *BackupVaultsClient) NewGetInResourceGroupPager(resourceGroupName string, options *BackupVaultsClientGetInResourceGroupOptions) *runtime.Pager[BackupVaultsClientGetInResourceGroupResponse]

NewGetInResourceGroupPager - Returns resource collection belonging to a resource group.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - BackupVaultsClientGetInResourceGroupOptions contains the optional parameters for the BackupVaultsClient.NewGetInResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewBackupVaultsClient().NewGetInResourceGroupPager("SampleResourceGroup", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.BackupVaultResourceList = armdataprotection.BackupVaultResourceList{
	// 	Value: []*armdataprotection.BackupVaultResource{
	// 		{
	// 			Name: to.Ptr("ExampleVault1"),
	// 			Type: to.Ptr("Microsoft.DataProtection/BackupVaults"),
	// 			ID: to.Ptr("/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault1"),
	// 			Location: to.Ptr("WestUS"),
	// 			Tags: map[string]*string{
	// 				"key1": to.Ptr("val1"),
	// 			},
	// 			Identity: &armdataprotection.DppIdentityDetails{
	// 				Type: to.Ptr("None"),
	// 			},
	// 			Properties: &armdataprotection.BackupVault{
	// 				BcdrSecurityLevel: to.Ptr(armdataprotection.BCDRSecurityLevelGood),
	// 				FeatureSettings: &armdataprotection.FeatureSettings{
	// 					CrossRegionRestoreSettings: &armdataprotection.CrossRegionRestoreSettings{
	// 						State: to.Ptr(armdataprotection.CrossRegionRestoreStateEnabled),
	// 					},
	// 				},
	// 				ProvisioningState: to.Ptr(armdataprotection.ProvisioningStateSucceeded),
	// 				SecureScore: to.Ptr(armdataprotection.SecureScoreLevelAdequate),
	// 				SecuritySettings: &armdataprotection.SecuritySettings{
	// 					SoftDeleteSettings: &armdataprotection.SoftDeleteSettings{
	// 						RetentionDurationInDays: to.Ptr[float64](14),
	// 						State: to.Ptr(armdataprotection.SoftDeleteState("Enabled")),
	// 					},
	// 				},
	// 				StorageSettings: []*armdataprotection.StorageSetting{
	// 					{
	// 						Type: to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
	// 						DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
	// 				}},
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("ExampleVault2"),
	// 			Type: to.Ptr("Microsoft.DataProtection/BackupVaults"),
	// 			ID: to.Ptr("/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault2"),
	// 			Location: to.Ptr("WestUS"),
	// 			Tags: map[string]*string{
	// 				"key1": to.Ptr("val1"),
	// 			},
	// 			Identity: &armdataprotection.DppIdentityDetails{
	// 				Type: to.Ptr("SystemAssigned"),
	// 				PrincipalID: to.Ptr("c009b9a0-0024-417c-83cd-025d3776045d"),
	// 				TenantID: to.Ptr("83abe5cd-bcc3-441a-bd86-e6a75360cecc"),
	// 			},
	// 			Properties: &armdataprotection.BackupVault{
	// 				BcdrSecurityLevel: to.Ptr(armdataprotection.BCDRSecurityLevelGood),
	// 				FeatureSettings: &armdataprotection.FeatureSettings{
	// 					CrossRegionRestoreSettings: &armdataprotection.CrossRegionRestoreSettings{
	// 						State: to.Ptr(armdataprotection.CrossRegionRestoreStateEnabled),
	// 					},
	// 				},
	// 				MonitoringSettings: &armdataprotection.MonitoringSettings{
	// 					AzureMonitorAlertSettings: &armdataprotection.AzureMonitorAlertSettings{
	// 						AlertsForAllJobFailures: to.Ptr(armdataprotection.AlertsStateEnabled),
	// 					},
	// 				},
	// 				ProvisioningState: to.Ptr(armdataprotection.ProvisioningStateSucceeded),
	// 				SecureScore: to.Ptr(armdataprotection.SecureScoreLevelAdequate),
	// 				SecuritySettings: &armdataprotection.SecuritySettings{
	// 					SoftDeleteSettings: &armdataprotection.SoftDeleteSettings{
	// 						RetentionDurationInDays: to.Ptr[float64](14),
	// 						State: to.Ptr(armdataprotection.SoftDeleteState("Enabled")),
	// 					},
	// 				},
	// 				StorageSettings: []*armdataprotection.StorageSetting{
	// 					{
	// 						Type: to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
	// 						DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
	// 				}},
	// 			},
	// 	}},
	// }
}

Output:

func (*BackupVaultsClient) NewGetInSubscriptionPager 

func (client *BackupVaultsClient) NewGetInSubscriptionPager(options *BackupVaultsClientGetInSubscriptionOptions) *runtime.Pager[BackupVaultsClientGetInSubscriptionResponse]

NewGetInSubscriptionPager - Returns resource collection belonging to a subscription.

Generated from API version 2024-04-01

  • options - BackupVaultsClientGetInSubscriptionOptions contains the optional parameters for the BackupVaultsClient.NewGetInSubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/VaultCRUD/GetBackupVaultsInSubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewBackupVaultsClient().NewGetInSubscriptionPager(nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.BackupVaultResourceList = armdataprotection.BackupVaultResourceList{
	// 	Value: []*armdataprotection.BackupVaultResource{
	// 		{
	// 			Name: to.Ptr("ExampleVault1"),
	// 			Type: to.Ptr("Microsoft.DataProtection/BackupVaults"),
	// 			ID: to.Ptr("/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup2/providers/Microsoft.DataProtection/BackupVaults/ExampleVault1"),
	// 			Location: to.Ptr("WestUS"),
	// 			Tags: map[string]*string{
	// 				"key1": to.Ptr("val1"),
	// 			},
	// 			Identity: &armdataprotection.DppIdentityDetails{
	// 				Type: to.Ptr("None"),
	// 			},
	// 			Properties: &armdataprotection.BackupVault{
	// 				BcdrSecurityLevel: to.Ptr(armdataprotection.BCDRSecurityLevelGood),
	// 				FeatureSettings: &armdataprotection.FeatureSettings{
	// 					CrossRegionRestoreSettings: &armdataprotection.CrossRegionRestoreSettings{
	// 						State: to.Ptr(armdataprotection.CrossRegionRestoreStateEnabled),
	// 					},
	// 				},
	// 				ProvisioningState: to.Ptr(armdataprotection.ProvisioningStateSucceeded),
	// 				SecureScore: to.Ptr(armdataprotection.SecureScoreLevelAdequate),
	// 				SecuritySettings: &armdataprotection.SecuritySettings{
	// 					SoftDeleteSettings: &armdataprotection.SoftDeleteSettings{
	// 						RetentionDurationInDays: to.Ptr[float64](14),
	// 						State: to.Ptr(armdataprotection.SoftDeleteState("Enabled")),
	// 					},
	// 				},
	// 				StorageSettings: []*armdataprotection.StorageSetting{
	// 					{
	// 						Type: to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
	// 						DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
	// 				}},
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("ExampleVault2"),
	// 			Type: to.Ptr("Microsoft.DataProtection/BackupVaults"),
	// 			ID: to.Ptr("/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault2"),
	// 			Location: to.Ptr("WestUS"),
	// 			Tags: map[string]*string{
	// 				"key1": to.Ptr("val1"),
	// 			},
	// 			Identity: &armdataprotection.DppIdentityDetails{
	// 				Type: to.Ptr("None"),
	// 			},
	// 			Properties: &armdataprotection.BackupVault{
	// 				BcdrSecurityLevel: to.Ptr(armdataprotection.BCDRSecurityLevelGood),
	// 				FeatureSettings: &armdataprotection.FeatureSettings{
	// 					CrossRegionRestoreSettings: &armdataprotection.CrossRegionRestoreSettings{
	// 						State: to.Ptr(armdataprotection.CrossRegionRestoreStateEnabled),
	// 					},
	// 				},
	// 				ProvisioningState: to.Ptr(armdataprotection.ProvisioningStateSucceeded),
	// 				SecureScore: to.Ptr(armdataprotection.SecureScoreLevelAdequate),
	// 				SecuritySettings: &armdataprotection.SecuritySettings{
	// 					SoftDeleteSettings: &armdataprotection.SoftDeleteSettings{
	// 						RetentionDurationInDays: to.Ptr[float64](14),
	// 						State: to.Ptr(armdataprotection.SoftDeleteState("Enabled")),
	// 					},
	// 				},
	// 				StorageSettings: []*armdataprotection.StorageSetting{
	// 					{
	// 						Type: to.Ptr(armdataprotection.StorageSettingTypesLocallyRedundant),
	// 						DatastoreType: to.Ptr(armdataprotection.StorageSettingStoreTypesVaultStore),
	// 				}},
	// 			},
	// 	}},
	// }
}

Output:

type BackupVaultsClientBeginCreateOrUpdateOptions 

type BackupVaultsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken               string
	XMSAuthorizationAuxiliary *string
}

BackupVaultsClientBeginCreateOrUpdateOptions contains the optional parameters for the BackupVaultsClient.BeginCreateOrUpdate method.

type BackupVaultsClientBeginDeleteOptions 

type BackupVaultsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

BackupVaultsClientBeginDeleteOptions contains the optional parameters for the BackupVaultsClient.BeginDelete method.

type BackupVaultsClientBeginUpdateOptions 

type BackupVaultsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken               string
	XMSAuthorizationAuxiliary *string
}

BackupVaultsClientBeginUpdateOptions contains the optional parameters for the BackupVaultsClient.BeginUpdate method.

type BackupVaultsClientCheckNameAvailabilityOptions 

type BackupVaultsClientCheckNameAvailabilityOptions struct {
}

BackupVaultsClientCheckNameAvailabilityOptions contains the optional parameters for the BackupVaultsClient.CheckNameAvailability method.

type BackupVaultsClientCheckNameAvailabilityResponse 

type BackupVaultsClientCheckNameAvailabilityResponse struct {
	// CheckNameAvailability Result
	CheckNameAvailabilityResult
}

BackupVaultsClientCheckNameAvailabilityResponse contains the response from method BackupVaultsClient.CheckNameAvailability.

type BackupVaultsClientCreateOrUpdateResponse 

type BackupVaultsClientCreateOrUpdateResponse struct {
	// Backup Vault Resource
	BackupVaultResource
}

BackupVaultsClientCreateOrUpdateResponse contains the response from method BackupVaultsClient.BeginCreateOrUpdate.

type BackupVaultsClientDeleteResponse 

type BackupVaultsClientDeleteResponse struct {
}

BackupVaultsClientDeleteResponse contains the response from method BackupVaultsClient.BeginDelete.

type BackupVaultsClientGetInResourceGroupOptions 

type BackupVaultsClientGetInResourceGroupOptions struct {
}

BackupVaultsClientGetInResourceGroupOptions contains the optional parameters for the BackupVaultsClient.NewGetInResourceGroupPager method.

type BackupVaultsClientGetInResourceGroupResponse 

type BackupVaultsClientGetInResourceGroupResponse struct {
	// List of BackupVault resources
	BackupVaultResourceList
}

BackupVaultsClientGetInResourceGroupResponse contains the response from method BackupVaultsClient.NewGetInResourceGroupPager.

type BackupVaultsClientGetInSubscriptionOptions 

type BackupVaultsClientGetInSubscriptionOptions struct {
}

BackupVaultsClientGetInSubscriptionOptions contains the optional parameters for the BackupVaultsClient.NewGetInSubscriptionPager method.

type BackupVaultsClientGetInSubscriptionResponse 

type BackupVaultsClientGetInSubscriptionResponse struct {
	// List of BackupVault resources
	BackupVaultResourceList
}

BackupVaultsClientGetInSubscriptionResponse contains the response from method BackupVaultsClient.NewGetInSubscriptionPager.

type BackupVaultsClientGetOptions 

type BackupVaultsClientGetOptions struct {
}

BackupVaultsClientGetOptions contains the optional parameters for the BackupVaultsClient.Get method.

type BackupVaultsClientGetResponse 

type BackupVaultsClientGetResponse struct {
	// Backup Vault Resource
	BackupVaultResource
}

BackupVaultsClientGetResponse contains the response from method BackupVaultsClient.Get.

type BackupVaultsClientUpdateResponse 

type BackupVaultsClientUpdateResponse struct {
	// Backup Vault Resource
	BackupVaultResource
}

BackupVaultsClientUpdateResponse contains the response from method BackupVaultsClient.BeginUpdate.

type BaseBackupPolicy 

type BaseBackupPolicy struct {
	// REQUIRED; Type of datasource for the backup management
	DatasourceTypes []*string

	// REQUIRED
	ObjectType *string
}

BaseBackupPolicy - BackupPolicy base

func (*BaseBackupPolicy) GetBaseBackupPolicy 

func (b *BaseBackupPolicy) GetBaseBackupPolicy() *BaseBackupPolicy

GetBaseBackupPolicy implements the BaseBackupPolicyClassification interface for type BaseBackupPolicy.

func (BaseBackupPolicy) MarshalJSON 

func (b BaseBackupPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BaseBackupPolicy.

func (*BaseBackupPolicy) UnmarshalJSON 

func (b *BaseBackupPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BaseBackupPolicy.

type BaseBackupPolicyClassification 

type BaseBackupPolicyClassification interface {
	// GetBaseBackupPolicy returns the BaseBackupPolicy content of the underlying type.
	GetBaseBackupPolicy() *BaseBackupPolicy
}

BaseBackupPolicyClassification provides polymorphic access to related types. Call the interface's GetBaseBackupPolicy() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *BackupPolicy, *BaseBackupPolicy

type BaseBackupPolicyResource 

type BaseBackupPolicyResource struct {
	// BaseBackupPolicyResource properties
	Properties BaseBackupPolicyClassification

	// READ-ONLY; Resource Id represents the complete path to the resource.
	ID *string

	// READ-ONLY; Resource name associated with the resource.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…
	Type *string
}

BaseBackupPolicyResource - BaseBackupPolicy resource

func (BaseBackupPolicyResource) MarshalJSON 

func (b BaseBackupPolicyResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BaseBackupPolicyResource.

func (*BaseBackupPolicyResource) UnmarshalJSON 

func (b *BaseBackupPolicyResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BaseBackupPolicyResource.

type BaseBackupPolicyResourceList 

type BaseBackupPolicyResourceList struct {
	// The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
	NextLink *string

	// List of resources.
	Value []*BaseBackupPolicyResource
}

BaseBackupPolicyResourceList - List of BaseBackupPolicy resources

func (BaseBackupPolicyResourceList) MarshalJSON 

func (b BaseBackupPolicyResourceList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BaseBackupPolicyResourceList.

func (*BaseBackupPolicyResourceList) UnmarshalJSON 

func (b *BaseBackupPolicyResourceList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BaseBackupPolicyResourceList.

type BasePolicyRule 

type BasePolicyRule struct {
	// REQUIRED
	Name *string

	// REQUIRED
	ObjectType *string
}

BasePolicyRule - BasePolicy Rule

func (*BasePolicyRule) GetBasePolicyRule 

func (b *BasePolicyRule) GetBasePolicyRule() *BasePolicyRule

GetBasePolicyRule implements the BasePolicyRuleClassification interface for type BasePolicyRule.

func (BasePolicyRule) MarshalJSON 

func (b BasePolicyRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BasePolicyRule.

func (*BasePolicyRule) UnmarshalJSON 

func (b *BasePolicyRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BasePolicyRule.

type BasePolicyRuleClassification 

type BasePolicyRuleClassification interface {
	// GetBasePolicyRule returns the BasePolicyRule content of the underlying type.
	GetBasePolicyRule() *BasePolicyRule
}

BasePolicyRuleClassification provides polymorphic access to related types. Call the interface's GetBasePolicyRule() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AzureBackupRule, *AzureRetentionRule, *BasePolicyRule

type BaseResourceProperties 

type BaseResourceProperties struct {
	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *ResourcePropertiesObjectType
}

BaseResourceProperties - Properties which are specific to datasource/datasourceSets

func (*BaseResourceProperties) GetBaseResourceProperties 

func (b *BaseResourceProperties) GetBaseResourceProperties() *BaseResourceProperties

GetBaseResourceProperties implements the BaseResourcePropertiesClassification interface for type BaseResourceProperties.

func (BaseResourceProperties) MarshalJSON 

func (b BaseResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BaseResourceProperties.

func (*BaseResourceProperties) UnmarshalJSON 

func (b *BaseResourceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BaseResourceProperties.

type BaseResourcePropertiesClassification 

type BaseResourcePropertiesClassification interface {
	// GetBaseResourceProperties returns the BaseResourceProperties content of the underlying type.
	GetBaseResourceProperties() *BaseResourceProperties
}

BaseResourcePropertiesClassification provides polymorphic access to related types. Call the interface's GetBaseResourceProperties() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *BaseResourceProperties, *DefaultResourceProperties

type BlobBackupDatasourceParameters 

type BlobBackupDatasourceParameters struct {
	// REQUIRED; List of containers to be backed up during configuration of backup of blobs
	ContainersList []*string

	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string
}

BlobBackupDatasourceParameters - Parameters to be used during configuration of backup of blobs

func (*BlobBackupDatasourceParameters) GetBackupDatasourceParameters 

func (b *BlobBackupDatasourceParameters) GetBackupDatasourceParameters() *BackupDatasourceParameters

GetBackupDatasourceParameters implements the BackupDatasourceParametersClassification interface for type BlobBackupDatasourceParameters.

func (BlobBackupDatasourceParameters) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BlobBackupDatasourceParameters.

func (*BlobBackupDatasourceParameters) UnmarshalJSON 

func (b *BlobBackupDatasourceParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BlobBackupDatasourceParameters.

type CheckNameAvailabilityRequest 

type CheckNameAvailabilityRequest struct {
	// Resource name for which availability needs to be checked
	Name *string

	// Describes the Resource type: Microsoft.DataProtection/BackupVaults
	Type *string
}

CheckNameAvailabilityRequest - CheckNameAvailability Request

func (CheckNameAvailabilityRequest) MarshalJSON 

func (c CheckNameAvailabilityRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CheckNameAvailabilityRequest.

func (*CheckNameAvailabilityRequest) UnmarshalJSON 

func (c *CheckNameAvailabilityRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CheckNameAvailabilityRequest.

type CheckNameAvailabilityResult 

type CheckNameAvailabilityResult struct {
	// Gets or sets the message.
	Message *string

	// Gets or sets a value indicating whether [name available].
	NameAvailable *bool

	// Gets or sets the reason.
	Reason *string
}

CheckNameAvailabilityResult - CheckNameAvailability Result

func (CheckNameAvailabilityResult) MarshalJSON 

func (c CheckNameAvailabilityResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CheckNameAvailabilityResult.

func (*CheckNameAvailabilityResult) UnmarshalJSON 

func (c *CheckNameAvailabilityResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CheckNameAvailabilityResult.

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client contains the methods for the DataProtection group. Don't use this type directly, use NewClient() instead.

func NewClient 

func NewClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*Client, error)

NewClient creates a new instance of Client with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*Client) CheckFeatureSupport 

func (client *Client) CheckFeatureSupport(ctx context.Context, location string, parameters FeatureValidationRequestBaseClassification, options *ClientCheckFeatureSupportOptions) (ClientCheckFeatureSupportResponse, error)

CheckFeatureSupport - Validates if a feature is supported If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • parameters - Feature support request object
  • options - ClientCheckFeatureSupportOptions contains the optional parameters for the Client.CheckFeatureSupport method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/CheckfeatureSupport.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewClient().CheckFeatureSupport(ctx, "WestUS", &armdataprotection.FeatureValidationRequest{
	ObjectType:  to.Ptr("FeatureValidationRequest"),
	FeatureType: to.Ptr(armdataprotection.FeatureTypeDataSourceType),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armdataprotection.ClientCheckFeatureSupportResponse{
// 	                            FeatureValidationResponseBaseClassification: &armdataprotection.FeatureValidationResponse{
// 		ObjectType: to.Ptr("FeatureValidationResponse"),
// 		FeatureType: to.Ptr(armdataprotection.FeatureTypeDataSourceType),
// 		Features: []*armdataprotection.SupportedFeature{
// 			{
// 				ExposureControlledFeatures: []*string{
// 				},
// 				FeatureName: to.Ptr("Microsoft.Storage/storageAccounts/blobServices"),
// 				SupportStatus: to.Ptr(armdataprotection.FeatureSupportStatusPrivatePreview),
// 			},
// 			{
// 				ExposureControlledFeatures: []*string{
// 				},
// 				FeatureName: to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
// 				SupportStatus: to.Ptr(armdataprotection.FeatureSupportStatusPublicPreview),
// 		}},
// 	},
// 	                        }

Output:

type ClientCheckFeatureSupportOptions 

type ClientCheckFeatureSupportOptions struct {
}

ClientCheckFeatureSupportOptions contains the optional parameters for the Client.CheckFeatureSupport method.

type ClientCheckFeatureSupportResponse 

type ClientCheckFeatureSupportResponse struct {
	// Base class for Backup Feature support
	FeatureValidationResponseBaseClassification
}

ClientCheckFeatureSupportResponse contains the response from method Client.CheckFeatureSupport.

func (*ClientCheckFeatureSupportResponse) UnmarshalJSON 

func (c *ClientCheckFeatureSupportResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClientCheckFeatureSupportResponse.

type ClientDiscoveryDisplay 

type ClientDiscoveryDisplay struct {
	// Description of the operation having details of what operation is about.
	Description *string

	// Operations Name itself.
	Operation *string

	// Name of the provider for display purposes
	Provider *string

	// ResourceType for which this Operation can be performed.
	Resource *string
}

ClientDiscoveryDisplay - Localized display information of an operation.

func (ClientDiscoveryDisplay) MarshalJSON 

func (c ClientDiscoveryDisplay) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClientDiscoveryDisplay.

func (*ClientDiscoveryDisplay) UnmarshalJSON 

func (c *ClientDiscoveryDisplay) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClientDiscoveryDisplay.

type ClientDiscoveryForLogSpecification 

type ClientDiscoveryForLogSpecification struct {
	// blob duration of shoebox log specification
	BlobDuration *string

	// Localized display name
	DisplayName *string

	// Name for shoebox log specification.
	Name *string
}

ClientDiscoveryForLogSpecification - Class to represent shoebox log specification in json client discovery.

func (ClientDiscoveryForLogSpecification) MarshalJSON 

func (c ClientDiscoveryForLogSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClientDiscoveryForLogSpecification.

func (*ClientDiscoveryForLogSpecification) UnmarshalJSON 

func (c *ClientDiscoveryForLogSpecification) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClientDiscoveryForLogSpecification.

type ClientDiscoveryForProperties 

type ClientDiscoveryForProperties struct {
	// Operation properties.
	ServiceSpecification *ClientDiscoveryForServiceSpecification
}

ClientDiscoveryForProperties - Class to represent shoebox properties in json client discovery.

func (ClientDiscoveryForProperties) MarshalJSON 

func (c ClientDiscoveryForProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClientDiscoveryForProperties.

func (*ClientDiscoveryForProperties) UnmarshalJSON 

func (c *ClientDiscoveryForProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClientDiscoveryForProperties.

type ClientDiscoveryForServiceSpecification 

type ClientDiscoveryForServiceSpecification struct {
	// List of log specifications of this operation.
	LogSpecifications []*ClientDiscoveryForLogSpecification
}

ClientDiscoveryForServiceSpecification - Class to represent shoebox service specification in json client discovery.

func (ClientDiscoveryForServiceSpecification) MarshalJSON 

func (c ClientDiscoveryForServiceSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClientDiscoveryForServiceSpecification.

func (*ClientDiscoveryForServiceSpecification) UnmarshalJSON 

func (c *ClientDiscoveryForServiceSpecification) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClientDiscoveryForServiceSpecification.

type ClientDiscoveryResponse 

type ClientDiscoveryResponse struct {
	// Link to the next chunk of Response.
	NextLink *string

	// List of available operations.
	Value []*ClientDiscoveryValueForSingleAPI
}

ClientDiscoveryResponse - Operations List response which contains list of available APIs.

func (ClientDiscoveryResponse) MarshalJSON 

func (c ClientDiscoveryResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClientDiscoveryResponse.

func (*ClientDiscoveryResponse) UnmarshalJSON 

func (c *ClientDiscoveryResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClientDiscoveryResponse.

type ClientDiscoveryValueForSingleAPI 

type ClientDiscoveryValueForSingleAPI struct {
	// Contains the localized display information for this particular operation
	Display *ClientDiscoveryDisplay

	// Indicates whether the operation is a data action
	IsDataAction *bool

	// Name of the Operation.
	Name *string

	// The intended executor of the operation;governs the display of the operation in the RBAC UX and the audit logs UX
	Origin *string

	// Properties for the given operation.
	Properties *ClientDiscoveryForProperties
}

ClientDiscoveryValueForSingleAPI - Available operation details.

func (ClientDiscoveryValueForSingleAPI) MarshalJSON 

func (c ClientDiscoveryValueForSingleAPI) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClientDiscoveryValueForSingleAPI.

func (*ClientDiscoveryValueForSingleAPI) UnmarshalJSON 

func (c *ClientDiscoveryValueForSingleAPI) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClientDiscoveryValueForSingleAPI.

type ClientFactory 

type ClientFactory struct {
	// contains filtered or unexported fields
}

ClientFactory is a client factory used to create any client in this module. Don't use this type directly, use NewClientFactory instead.

func NewClientFactory 

func NewClientFactory(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ClientFactory, error)

NewClientFactory creates a new instance of ClientFactory with the specified values. The parameter values will be propagated to any client created from this factory.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClientFactory) NewBackupInstancesClient 

func (c *ClientFactory) NewBackupInstancesClient() *BackupInstancesClient

NewBackupInstancesClient creates a new instance of BackupInstancesClient.

func (*ClientFactory) NewBackupInstancesExtensionRoutingClient added in v3.1.0 

func (c *ClientFactory) NewBackupInstancesExtensionRoutingClient() *BackupInstancesExtensionRoutingClient

NewBackupInstancesExtensionRoutingClient creates a new instance of BackupInstancesExtensionRoutingClient.

func (*ClientFactory) NewBackupPoliciesClient 

func (c *ClientFactory) NewBackupPoliciesClient() *BackupPoliciesClient

NewBackupPoliciesClient creates a new instance of BackupPoliciesClient.

func (*ClientFactory) NewBackupVaultOperationResultsClient 

func (c *ClientFactory) NewBackupVaultOperationResultsClient() *BackupVaultOperationResultsClient

NewBackupVaultOperationResultsClient creates a new instance of BackupVaultOperationResultsClient.

func (*ClientFactory) NewBackupVaultsClient 

func (c *ClientFactory) NewBackupVaultsClient() *BackupVaultsClient

NewBackupVaultsClient creates a new instance of BackupVaultsClient.

func (*ClientFactory) NewClient 

func (c *ClientFactory) NewClient() *Client

NewClient creates a new instance of Client.

func (*ClientFactory) NewDeletedBackupInstancesClient 

func (c *ClientFactory) NewDeletedBackupInstancesClient() *DeletedBackupInstancesClient

NewDeletedBackupInstancesClient creates a new instance of DeletedBackupInstancesClient.

func (*ClientFactory) NewDppResourceGuardProxyClient 

func (c *ClientFactory) NewDppResourceGuardProxyClient() *DppResourceGuardProxyClient

NewDppResourceGuardProxyClient creates a new instance of DppResourceGuardProxyClient.

func (*ClientFactory) NewExportJobsClient 

func (c *ClientFactory) NewExportJobsClient() *ExportJobsClient

NewExportJobsClient creates a new instance of ExportJobsClient.

func (*ClientFactory) NewExportJobsOperationResultClient 

func (c *ClientFactory) NewExportJobsOperationResultClient() *ExportJobsOperationResultClient

NewExportJobsOperationResultClient creates a new instance of ExportJobsOperationResultClient.

func (*ClientFactory) NewFetchCrossRegionRestoreJobClient 

func (c *ClientFactory) NewFetchCrossRegionRestoreJobClient() *FetchCrossRegionRestoreJobClient

NewFetchCrossRegionRestoreJobClient creates a new instance of FetchCrossRegionRestoreJobClient.

func (*ClientFactory) NewFetchCrossRegionRestoreJobsClient 

func (c *ClientFactory) NewFetchCrossRegionRestoreJobsClient() *FetchCrossRegionRestoreJobsClient

NewFetchCrossRegionRestoreJobsClient creates a new instance of FetchCrossRegionRestoreJobsClient.

func (*ClientFactory) NewFetchSecondaryRecoveryPointsClient 

func (c *ClientFactory) NewFetchSecondaryRecoveryPointsClient() *FetchSecondaryRecoveryPointsClient

NewFetchSecondaryRecoveryPointsClient creates a new instance of FetchSecondaryRecoveryPointsClient.

func (*ClientFactory) NewJobsClient 

func (c *ClientFactory) NewJobsClient() *JobsClient

NewJobsClient creates a new instance of JobsClient.

func (*ClientFactory) NewOperationResultClient 

func (c *ClientFactory) NewOperationResultClient() *OperationResultClient

NewOperationResultClient creates a new instance of OperationResultClient.

func (*ClientFactory) NewOperationStatusBackupVaultContextClient 

func (c *ClientFactory) NewOperationStatusBackupVaultContextClient() *OperationStatusBackupVaultContextClient

NewOperationStatusBackupVaultContextClient creates a new instance of OperationStatusBackupVaultContextClient.

func (*ClientFactory) NewOperationStatusClient 

func (c *ClientFactory) NewOperationStatusClient() *OperationStatusClient

NewOperationStatusClient creates a new instance of OperationStatusClient.

func (*ClientFactory) NewOperationStatusResourceGroupContextClient 

func (c *ClientFactory) NewOperationStatusResourceGroupContextClient() *OperationStatusResourceGroupContextClient

NewOperationStatusResourceGroupContextClient creates a new instance of OperationStatusResourceGroupContextClient.

func (*ClientFactory) NewOperationsClient 

func (c *ClientFactory) NewOperationsClient() *OperationsClient

NewOperationsClient creates a new instance of OperationsClient.

func (*ClientFactory) NewRecoveryPointsClient 

func (c *ClientFactory) NewRecoveryPointsClient() *RecoveryPointsClient

NewRecoveryPointsClient creates a new instance of RecoveryPointsClient.

func (*ClientFactory) NewResourceGuardsClient 

func (c *ClientFactory) NewResourceGuardsClient() *ResourceGuardsClient

NewResourceGuardsClient creates a new instance of ResourceGuardsClient.

func (*ClientFactory) NewRestorableTimeRangesClient 

func (c *ClientFactory) NewRestorableTimeRangesClient() *RestorableTimeRangesClient

NewRestorableTimeRangesClient creates a new instance of RestorableTimeRangesClient.

type CmkKekIdentity added in v3.1.0 

type CmkKekIdentity struct {
	// The managed identity to be used which has access permissions to the Key Vault. Provide a value here in case identity types:
	// 'UserAssigned' only.
	IdentityID *string

	// The identity type. 'SystemAssigned' and 'UserAssigned' are mutually exclusive. 'SystemAssigned' will use implicitly created
	// managed identity.
	IdentityType *IdentityType
}

CmkKekIdentity - The details of the managed identity used for CMK

func (CmkKekIdentity) MarshalJSON added in v3.1.0 

func (c CmkKekIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CmkKekIdentity.

func (*CmkKekIdentity) UnmarshalJSON added in v3.1.0 

func (c *CmkKekIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CmkKekIdentity.

type CmkKeyVaultProperties added in v3.1.0 

type CmkKeyVaultProperties struct {
	// The key uri of the Customer Managed Key
	KeyURI *string
}

CmkKeyVaultProperties - The properties of the Key Vault which hosts CMK

func (CmkKeyVaultProperties) MarshalJSON added in v3.1.0 

func (c CmkKeyVaultProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CmkKeyVaultProperties.

func (*CmkKeyVaultProperties) UnmarshalJSON added in v3.1.0 

func (c *CmkKeyVaultProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CmkKeyVaultProperties.

type CopyOnExpiryOption 

type CopyOnExpiryOption struct {
	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string
}

CopyOnExpiryOption - Copy on Expiry Option

func (*CopyOnExpiryOption) GetCopyOption 

func (c *CopyOnExpiryOption) GetCopyOption() *CopyOption

GetCopyOption implements the CopyOptionClassification interface for type CopyOnExpiryOption.

func (CopyOnExpiryOption) MarshalJSON 

func (c CopyOnExpiryOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CopyOnExpiryOption.

func (*CopyOnExpiryOption) UnmarshalJSON 

func (c *CopyOnExpiryOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CopyOnExpiryOption.

type CopyOption 

type CopyOption struct {
	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string
}

CopyOption - Options to copy

func (*CopyOption) GetCopyOption 

func (c *CopyOption) GetCopyOption() *CopyOption

GetCopyOption implements the CopyOptionClassification interface for type CopyOption.

func (CopyOption) MarshalJSON 

func (c CopyOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CopyOption.

func (*CopyOption) UnmarshalJSON 

func (c *CopyOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CopyOption.

type CopyOptionClassification 

type CopyOptionClassification interface {
	// GetCopyOption returns the CopyOption content of the underlying type.
	GetCopyOption() *CopyOption
}

CopyOptionClassification provides polymorphic access to related types. Call the interface's GetCopyOption() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *CopyOnExpiryOption, *CopyOption, *CustomCopyOption, *ImmediateCopyOption

type CreatedByType 

type CreatedByType string

CreatedByType - The type of identity that created the resource. 

const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

type CrossRegionRestoreDetails 

type CrossRegionRestoreDetails struct {
	// REQUIRED
	SourceBackupInstanceID *string

	// REQUIRED
	SourceRegion *string
}

CrossRegionRestoreDetails - Cross Region Restore details

func (CrossRegionRestoreDetails) MarshalJSON 

func (c CrossRegionRestoreDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CrossRegionRestoreDetails.

func (*CrossRegionRestoreDetails) UnmarshalJSON 

func (c *CrossRegionRestoreDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CrossRegionRestoreDetails.

type CrossRegionRestoreJobRequest 

type CrossRegionRestoreJobRequest struct {
	// REQUIRED
	JobID *string

	// REQUIRED
	SourceBackupVaultID *string

	// REQUIRED
	SourceRegion *string
}

CrossRegionRestoreJobRequest - Details of CRR Job to be fetched

func (CrossRegionRestoreJobRequest) MarshalJSON 

func (c CrossRegionRestoreJobRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CrossRegionRestoreJobRequest.

func (*CrossRegionRestoreJobRequest) UnmarshalJSON 

func (c *CrossRegionRestoreJobRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CrossRegionRestoreJobRequest.

type CrossRegionRestoreJobsRequest 

type CrossRegionRestoreJobsRequest struct {
	// REQUIRED
	SourceBackupVaultID *string

	// REQUIRED
	SourceRegion *string
}

CrossRegionRestoreJobsRequest - Details of Backup Vault for which CRR Jobs are to be fetched

func (CrossRegionRestoreJobsRequest) MarshalJSON 

func (c CrossRegionRestoreJobsRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CrossRegionRestoreJobsRequest.

func (*CrossRegionRestoreJobsRequest) UnmarshalJSON 

func (c *CrossRegionRestoreJobsRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CrossRegionRestoreJobsRequest.

type CrossRegionRestoreRequestObject 

type CrossRegionRestoreRequestObject struct {
	// REQUIRED; Cross region restore details.
	CrossRegionRestoreDetails *CrossRegionRestoreDetails

	// REQUIRED; Gets or sets the restore request object.
	RestoreRequestObject AzureBackupRestoreRequestClassification
}

CrossRegionRestoreRequestObject - Cross Region Restore Request Object

func (CrossRegionRestoreRequestObject) MarshalJSON 

func (c CrossRegionRestoreRequestObject) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CrossRegionRestoreRequestObject.

func (*CrossRegionRestoreRequestObject) UnmarshalJSON 

func (c *CrossRegionRestoreRequestObject) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CrossRegionRestoreRequestObject.

type CrossRegionRestoreSettings 

type CrossRegionRestoreSettings struct {
	// CrossRegionRestore state
	State *CrossRegionRestoreState
}

func (CrossRegionRestoreSettings) MarshalJSON 

func (c CrossRegionRestoreSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CrossRegionRestoreSettings.

func (*CrossRegionRestoreSettings) UnmarshalJSON 

func (c *CrossRegionRestoreSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CrossRegionRestoreSettings.

type CrossRegionRestoreState 

type CrossRegionRestoreState string

CrossRegionRestoreState - CrossRegionRestore state 

const (
	CrossRegionRestoreStateDisabled CrossRegionRestoreState = "Disabled"
	CrossRegionRestoreStateEnabled  CrossRegionRestoreState = "Enabled"
)

func PossibleCrossRegionRestoreStateValues 

func PossibleCrossRegionRestoreStateValues() []CrossRegionRestoreState

PossibleCrossRegionRestoreStateValues returns the possible values for the CrossRegionRestoreState const type.

type CrossSubscriptionRestoreSettings 

type CrossSubscriptionRestoreSettings struct {
	// CrossSubscriptionRestore state
	State *CrossSubscriptionRestoreState
}

CrossSubscriptionRestoreSettings - CrossSubscriptionRestore Settings

func (CrossSubscriptionRestoreSettings) MarshalJSON 

func (c CrossSubscriptionRestoreSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CrossSubscriptionRestoreSettings.

func (*CrossSubscriptionRestoreSettings) UnmarshalJSON 

func (c *CrossSubscriptionRestoreSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CrossSubscriptionRestoreSettings.

type CrossSubscriptionRestoreState 

type CrossSubscriptionRestoreState string

CrossSubscriptionRestoreState - CrossSubscriptionRestore state 

const (
	CrossSubscriptionRestoreStateDisabled            CrossSubscriptionRestoreState = "Disabled"
	CrossSubscriptionRestoreStateEnabled             CrossSubscriptionRestoreState = "Enabled"
	CrossSubscriptionRestoreStatePermanentlyDisabled CrossSubscriptionRestoreState = "PermanentlyDisabled"
)

func PossibleCrossSubscriptionRestoreStateValues 

func PossibleCrossSubscriptionRestoreStateValues() []CrossSubscriptionRestoreState

PossibleCrossSubscriptionRestoreStateValues returns the possible values for the CrossSubscriptionRestoreState const type.

type CurrentProtectionState 

type CurrentProtectionState string

CurrentProtectionState - Specifies the current protection state of the resource 

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 PossibleCurrentProtectionStateValues 

func PossibleCurrentProtectionStateValues() []CurrentProtectionState

PossibleCurrentProtectionStateValues returns the possible values for the CurrentProtectionState const type.

type CustomCopyOption 

type CustomCopyOption struct {
	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string

	// Data copied after given timespan
	Duration *string
}

CustomCopyOption - Duration based custom options to copy

func (*CustomCopyOption) GetCopyOption 

func (c *CustomCopyOption) GetCopyOption() *CopyOption

GetCopyOption implements the CopyOptionClassification interface for type CustomCopyOption.

func (CustomCopyOption) MarshalJSON 

func (c CustomCopyOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CustomCopyOption.

func (*CustomCopyOption) UnmarshalJSON 

func (c *CustomCopyOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CustomCopyOption.

type DataStoreInfoBase 

type DataStoreInfoBase struct {
	// REQUIRED; type of datastore; Operational/Vault/Archive
	DataStoreType *DataStoreTypes

	// REQUIRED; Type of Datasource object, used to initialize the right inherited type
	ObjectType *string
}

DataStoreInfoBase - DataStoreInfo base

func (DataStoreInfoBase) MarshalJSON 

func (d DataStoreInfoBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataStoreInfoBase.

func (*DataStoreInfoBase) UnmarshalJSON 

func (d *DataStoreInfoBase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataStoreInfoBase.

type DataStoreParameters 

type DataStoreParameters struct {
	// REQUIRED; type of datastore; Operational/Vault/Archive
	DataStoreType *DataStoreTypes

	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string
}

DataStoreParameters - Parameters for DataStore

func (*DataStoreParameters) GetDataStoreParameters 

func (d *DataStoreParameters) GetDataStoreParameters() *DataStoreParameters

GetDataStoreParameters implements the DataStoreParametersClassification interface for type DataStoreParameters.

func (DataStoreParameters) MarshalJSON 

func (d DataStoreParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataStoreParameters.

func (*DataStoreParameters) UnmarshalJSON 

func (d *DataStoreParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataStoreParameters.

type DataStoreParametersClassification 

type DataStoreParametersClassification interface {
	// GetDataStoreParameters returns the DataStoreParameters content of the underlying type.
	GetDataStoreParameters() *DataStoreParameters
}

DataStoreParametersClassification provides polymorphic access to related types. Call the interface's GetDataStoreParameters() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AzureOperationalStoreParameters, *DataStoreParameters

type DataStoreTypes 

type DataStoreTypes string

DataStoreTypes - type of datastore; Operational/Vault/Archive 

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

func PossibleDataStoreTypesValues 

func PossibleDataStoreTypesValues() []DataStoreTypes

PossibleDataStoreTypesValues returns the possible values for the DataStoreTypes const type.

type Datasource 

type Datasource struct {
	// REQUIRED; Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID
	// created by backup service via Fabric/Vault.
	ResourceID *string

	// DatasourceType of the resource.
	DatasourceType *string

	// Type of Datasource object, used to initialize the right inherited type
	ObjectType *string

	// Location of datasource.
	ResourceLocation *string

	// Unique identifier of the resource in the context of parent.
	ResourceName *string

	// Properties specific to data source
	ResourceProperties BaseResourcePropertiesClassification

	// Resource Type of Datasource.
	ResourceType *string

	// Uri of the resource.
	ResourceURI *string
}

Datasource to be backed up

func (Datasource) MarshalJSON 

func (d Datasource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Datasource.

func (*Datasource) UnmarshalJSON 

func (d *Datasource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Datasource.

type DatasourceSet 

type DatasourceSet struct {
	// REQUIRED; Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID
	// created by backup service via Fabric/Vault.
	ResourceID *string

	// DatasourceType of the resource.
	DatasourceType *string

	// Type of Datasource object, used to initialize the right inherited type
	ObjectType *string

	// Location of datasource.
	ResourceLocation *string

	// Unique identifier of the resource in the context of parent.
	ResourceName *string

	// Properties specific to data source set
	ResourceProperties BaseResourcePropertiesClassification

	// Resource Type of Datasource.
	ResourceType *string

	// Uri of the resource.
	ResourceURI *string
}

DatasourceSet details of datasource to be backed up

func (DatasourceSet) MarshalJSON 

func (d DatasourceSet) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DatasourceSet.

func (*DatasourceSet) UnmarshalJSON 

func (d *DatasourceSet) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DatasourceSet.

type Day 

type Day struct {
	// Date of the month
	Date *int32

	// Whether Date is last date of month
	IsLast *bool
}

Day of the week

func (Day) MarshalJSON 

func (d Day) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Day.

func (*Day) UnmarshalJSON 

func (d *Day) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Day.

type DayOfWeek 

type DayOfWeek string
const (
	DayOfWeekFriday    DayOfWeek = "Friday"
	DayOfWeekMonday    DayOfWeek = "Monday"
	DayOfWeekSaturday  DayOfWeek = "Saturday"
	DayOfWeekSunday    DayOfWeek = "Sunday"
	DayOfWeekThursday  DayOfWeek = "Thursday"
	DayOfWeekTuesday   DayOfWeek = "Tuesday"
	DayOfWeekWednesday DayOfWeek = "Wednesday"
)

func PossibleDayOfWeekValues 

func PossibleDayOfWeekValues() []DayOfWeek

PossibleDayOfWeekValues returns the possible values for the DayOfWeek const type.

type DefaultResourceProperties 

type DefaultResourceProperties struct {
	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *ResourcePropertiesObjectType
}

DefaultResourceProperties - Default source properties

func (*DefaultResourceProperties) GetBaseResourceProperties 

func (d *DefaultResourceProperties) GetBaseResourceProperties() *BaseResourceProperties

GetBaseResourceProperties implements the BaseResourcePropertiesClassification interface for type DefaultResourceProperties.

func (DefaultResourceProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DefaultResourceProperties.

func (*DefaultResourceProperties) UnmarshalJSON 

func (d *DefaultResourceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultResourceProperties.

type DeleteOption 

type DeleteOption struct {
	// REQUIRED; Duration of deletion after given timespan
	Duration *string

	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string
}

DeleteOption - Delete Option

func (*DeleteOption) GetDeleteOption 

func (d *DeleteOption) GetDeleteOption() *DeleteOption

GetDeleteOption implements the DeleteOptionClassification interface for type DeleteOption.

func (DeleteOption) MarshalJSON 

func (d DeleteOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeleteOption.

func (*DeleteOption) UnmarshalJSON 

func (d *DeleteOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeleteOption.

type DeleteOptionClassification 

type DeleteOptionClassification interface {
	// GetDeleteOption returns the DeleteOption content of the underlying type.
	GetDeleteOption() *DeleteOption
}

DeleteOptionClassification provides polymorphic access to related types. Call the interface's GetDeleteOption() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AbsoluteDeleteOption, *DeleteOption

type DeletedBackupInstance 

type DeletedBackupInstance struct {
	// REQUIRED; Gets or sets the data source information.
	DataSourceInfo *Datasource

	// REQUIRED
	ObjectType *string

	// REQUIRED; Gets or sets the policy information.
	PolicyInfo *PolicyInfo

	// Gets or sets the data source set information.
	DataSourceSetInfo *DatasourceSet

	// Credentials to use to authenticate with data source provider.
	DatasourceAuthCredentials AuthCredentialsClassification

	// Gets or sets the Backup Instance friendly name.
	FriendlyName *string

	// Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
	IdentityDetails *IdentityDetails

	// ResourceGuardOperationRequests on which LAC check will be performed
	ResourceGuardOperationRequests []*string

	// Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again.
	ValidationType *ValidationType

	// READ-ONLY; Specifies the current protection state of the resource
	CurrentProtectionState *CurrentProtectionState

	// READ-ONLY; Deletion info of Backup Instance
	DeletionInfo *DeletionInfo

	// READ-ONLY; Specifies the protection error of the resource
	ProtectionErrorDetails *UserFacingError

	// READ-ONLY; Specifies the protection status of the resource
	ProtectionStatus *ProtectionStatusDetails

	// READ-ONLY; Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed
	ProvisioningState *string
}

DeletedBackupInstance - Deleted Backup Instance

func (DeletedBackupInstance) MarshalJSON 

func (d DeletedBackupInstance) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeletedBackupInstance.

func (*DeletedBackupInstance) UnmarshalJSON 

func (d *DeletedBackupInstance) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeletedBackupInstance.

type DeletedBackupInstanceResource 

type DeletedBackupInstanceResource struct {
	// DeletedBackupInstanceResource properties
	Properties *DeletedBackupInstance

	// READ-ONLY; Resource Id represents the complete path to the resource.
	ID *string

	// READ-ONLY; Resource name associated with the resource.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…
	Type *string
}

DeletedBackupInstanceResource - Deleted Backup Instance

func (DeletedBackupInstanceResource) MarshalJSON 

func (d DeletedBackupInstanceResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeletedBackupInstanceResource.

func (*DeletedBackupInstanceResource) UnmarshalJSON 

func (d *DeletedBackupInstanceResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeletedBackupInstanceResource.

type DeletedBackupInstanceResourceList 

type DeletedBackupInstanceResourceList struct {
	// The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
	NextLink *string

	// List of resources.
	Value []*DeletedBackupInstanceResource
}

DeletedBackupInstanceResourceList - List of DeletedBackupInstance resources

func (DeletedBackupInstanceResourceList) MarshalJSON 

func (d DeletedBackupInstanceResourceList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeletedBackupInstanceResourceList.

func (*DeletedBackupInstanceResourceList) UnmarshalJSON 

func (d *DeletedBackupInstanceResourceList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeletedBackupInstanceResourceList.

type DeletedBackupInstancesClient 

type DeletedBackupInstancesClient struct {
	// contains filtered or unexported fields
}

DeletedBackupInstancesClient contains the methods for the DeletedBackupInstances group. Don't use this type directly, use NewDeletedBackupInstancesClient() instead.

func NewDeletedBackupInstancesClient 

func NewDeletedBackupInstancesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DeletedBackupInstancesClient, error)

NewDeletedBackupInstancesClient creates a new instance of DeletedBackupInstancesClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*DeletedBackupInstancesClient) BeginUndelete 

func (client *DeletedBackupInstancesClient) BeginUndelete(ctx context.Context, resourceGroupName string, vaultName string, backupInstanceName string, options *DeletedBackupInstancesClientBeginUndeleteOptions) (*runtime.Poller[DeletedBackupInstancesClientUndeleteResponse], error)

BeginUndelete - If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • backupInstanceName - The name of the deleted backup instance
  • options - DeletedBackupInstancesClientBeginUndeleteOptions contains the optional parameters for the DeletedBackupInstancesClient.BeginUndelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/DeletedBackupInstanceOperations/UndeleteDeletedBackupInstance.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeletedBackupInstancesClient().BeginUndelete(ctx, "testrg", "testvault", "testbi", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*DeletedBackupInstancesClient) Get 

func (client *DeletedBackupInstancesClient) Get(ctx context.Context, resourceGroupName string, vaultName string, backupInstanceName string, options *DeletedBackupInstancesClientGetOptions) (DeletedBackupInstancesClientGetResponse, error)

Get - Gets a deleted backup instance with name in a backup vault If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • backupInstanceName - The name of the deleted backup instance
  • options - DeletedBackupInstancesClientGetOptions contains the optional parameters for the DeletedBackupInstancesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/DeletedBackupInstanceOperations/GetDeletedBackupInstance.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDeletedBackupInstancesClient().Get(ctx, "000pikumar", "PratikPrivatePreviewVault1", "testInstance1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeletedBackupInstanceResource = armdataprotection.DeletedBackupInstanceResource{
// 	Name: to.Ptr("testInstance1"),
// 	Type: to.Ptr("Microsoft.DataProtection/backupVaults/deletedBackupInstances"),
// 	ID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/deletedBackupInstances/testInstance1"),
// 	Properties: &armdataprotection.DeletedBackupInstance{
// 		DataSourceInfo: &armdataprotection.Datasource{
// 			DatasourceType: to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
// 			ObjectType: to.Ptr("Datasource"),
// 			ResourceID: to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"),
// 			ResourceLocation: to.Ptr(""),
// 			ResourceName: to.Ptr("testdb"),
// 			ResourceType: to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
// 			ResourceURI: to.Ptr(""),
// 		},
// 		DataSourceSetInfo: &armdataprotection.DatasourceSet{
// 			DatasourceType: to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
// 			ObjectType: to.Ptr("DatasourceSet"),
// 			ResourceID: to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest"),
// 			ResourceLocation: to.Ptr(""),
// 			ResourceName: to.Ptr("viveksipgtest"),
// 			ResourceType: to.Ptr("Microsoft.DBforPostgreSQL/servers"),
// 			ResourceURI: to.Ptr(""),
// 		},
// 		FriendlyName: to.Ptr("testInstance1"),
// 		ObjectType: to.Ptr("DeletedBackupInstance"),
// 		PolicyInfo: &armdataprotection.PolicyInfo{
// 			PolicyID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"),
// 		},
// 		ProtectionStatus: &armdataprotection.ProtectionStatusDetails{
// 			Status: to.Ptr(armdataprotection.StatusSoftDeleted),
// 		},
// 		ProvisioningState: to.Ptr("Succeeded"),
// 		DeletionInfo: &armdataprotection.DeletionInfo{
// 			BillingEndDate: to.Ptr("2022-05-06T00:00:36.6660445Z"),
// 			DeleteActivityID: to.Ptr("1e9ec790-d198-4efb-bbd7-e4669d5351a4"),
// 			DeletionTime: to.Ptr("2022-05-04T00:00:36.6660445Z"),
// 			ScheduledPurgeTime: to.Ptr("2022-05-20T00:00:36.6660445Z"),
// 		},
// 	},
// }

Output:

func (*DeletedBackupInstancesClient) NewListPager 

func (client *DeletedBackupInstancesClient) NewListPager(resourceGroupName string, vaultName string, options *DeletedBackupInstancesClientListOptions) *runtime.Pager[DeletedBackupInstancesClientListResponse]

NewListPager - Gets deleted backup instances belonging to a backup vault

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • options - DeletedBackupInstancesClientListOptions contains the optional parameters for the DeletedBackupInstancesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/DeletedBackupInstanceOperations/ListDeletedBackupInstances.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewDeletedBackupInstancesClient().NewListPager("000pikumar", "PratikPrivatePreviewVault1", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.DeletedBackupInstanceResourceList = armdataprotection.DeletedBackupInstanceResourceList{
	// 	Value: []*armdataprotection.DeletedBackupInstanceResource{
	// 		{
	// 			Name: to.Ptr("testInstance1"),
	// 			Type: to.Ptr("Microsoft.DataProtection/backupVaults/deletedBackupInstances"),
	// 			ID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/deletedBackupInstances/testInstance1"),
	// 			Properties: &armdataprotection.DeletedBackupInstance{
	// 				DataSourceInfo: &armdataprotection.Datasource{
	// 					DatasourceType: to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
	// 					ObjectType: to.Ptr("Datasource"),
	// 					ResourceID: to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"),
	// 					ResourceLocation: to.Ptr(""),
	// 					ResourceName: to.Ptr("testdb"),
	// 					ResourceType: to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
	// 					ResourceURI: to.Ptr(""),
	// 				},
	// 				DataSourceSetInfo: &armdataprotection.DatasourceSet{
	// 					DatasourceType: to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
	// 					ObjectType: to.Ptr("DatasourceSet"),
	// 					ResourceID: to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest"),
	// 					ResourceLocation: to.Ptr(""),
	// 					ResourceName: to.Ptr("viveksipgtest"),
	// 					ResourceType: to.Ptr("Microsoft.DBforPostgreSQL/servers"),
	// 					ResourceURI: to.Ptr(""),
	// 				},
	// 				FriendlyName: to.Ptr("testInstance1"),
	// 				ObjectType: to.Ptr("DeletedBackupInstance"),
	// 				PolicyInfo: &armdataprotection.PolicyInfo{
	// 					PolicyID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"),
	// 				},
	// 				ProtectionStatus: &armdataprotection.ProtectionStatusDetails{
	// 					Status: to.Ptr(armdataprotection.StatusSoftDeleted),
	// 				},
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				DeletionInfo: &armdataprotection.DeletionInfo{
	// 					BillingEndDate: to.Ptr("2022-05-06T00:00:36.6660445Z"),
	// 					DeleteActivityID: to.Ptr("1e9ec790-d198-4efb-bbd7-e4669d5351a4"),
	// 					DeletionTime: to.Ptr("2022-05-04T00:00:36.6660445Z"),
	// 					ScheduledPurgeTime: to.Ptr("2022-05-20T00:00:36.6660445Z"),
	// 				},
	// 			},
	// 	}},
	// }
}

Output:

type DeletedBackupInstancesClientBeginUndeleteOptions 

type DeletedBackupInstancesClientBeginUndeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DeletedBackupInstancesClientBeginUndeleteOptions contains the optional parameters for the DeletedBackupInstancesClient.BeginUndelete method.

type DeletedBackupInstancesClientGetOptions 

type DeletedBackupInstancesClientGetOptions struct {
}

DeletedBackupInstancesClientGetOptions contains the optional parameters for the DeletedBackupInstancesClient.Get method.

type DeletedBackupInstancesClientGetResponse 

type DeletedBackupInstancesClientGetResponse struct {
	// Deleted Backup Instance
	DeletedBackupInstanceResource
}

DeletedBackupInstancesClientGetResponse contains the response from method DeletedBackupInstancesClient.Get.

type DeletedBackupInstancesClientListOptions 

type DeletedBackupInstancesClientListOptions struct {
}

DeletedBackupInstancesClientListOptions contains the optional parameters for the DeletedBackupInstancesClient.NewListPager method.

type DeletedBackupInstancesClientListResponse 

type DeletedBackupInstancesClientListResponse struct {
	// List of DeletedBackupInstance resources
	DeletedBackupInstanceResourceList
}

DeletedBackupInstancesClientListResponse contains the response from method DeletedBackupInstancesClient.NewListPager.

type DeletedBackupInstancesClientUndeleteResponse 

type DeletedBackupInstancesClientUndeleteResponse struct {
}

DeletedBackupInstancesClientUndeleteResponse contains the response from method DeletedBackupInstancesClient.BeginUndelete.

type DeletionInfo 

type DeletionInfo struct {
	// READ-ONLY; Specifies billing end date
	BillingEndDate *string

	// READ-ONLY; Delete activity ID for troubleshooting purpose
	DeleteActivityID *string

	// READ-ONLY; Specifies time of deletion
	DeletionTime *string

	// READ-ONLY; Specifies purge time
	ScheduledPurgeTime *string
}

DeletionInfo - Deletion Info

func (DeletionInfo) MarshalJSON 

func (d DeletionInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeletionInfo.

func (*DeletionInfo) UnmarshalJSON 

func (d *DeletionInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeletionInfo.

type DppBaseResource 

type DppBaseResource struct {
	// READ-ONLY; Resource Id represents the complete path to the resource.
	ID *string

	// READ-ONLY; Resource name associated with the resource.
	Name *string

	// READ-ONLY; Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…
	Type *string
}

DppBaseResource - Base resource under Microsoft.DataProtection provider namespace

func (DppBaseResource) MarshalJSON 

func (d DppBaseResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DppBaseResource.

func (*DppBaseResource) UnmarshalJSON 

func (d *DppBaseResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DppBaseResource.

type DppBaseResourceList 

type DppBaseResourceList struct {
	// The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
	NextLink *string

	// List of Dpp resources.
	Value []*DppBaseResource
}

DppBaseResourceList - Base for all lists of V2 resources.

func (DppBaseResourceList) MarshalJSON 

func (d DppBaseResourceList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DppBaseResourceList.

func (*DppBaseResourceList) UnmarshalJSON 

func (d *DppBaseResourceList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DppBaseResourceList.

type DppBaseTrackedResource 

type DppBaseTrackedResource struct {
	// Optional ETag.
	ETag *string

	// Resource location.
	Location *string

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Resource Id represents the complete path to the resource.
	ID *string

	// READ-ONLY; Resource name associated with the resource.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…
	Type *string
}

func (DppBaseTrackedResource) MarshalJSON 

func (d DppBaseTrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DppBaseTrackedResource.

func (*DppBaseTrackedResource) UnmarshalJSON 

func (d *DppBaseTrackedResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DppBaseTrackedResource.

type DppIdentityDetails 

type DppIdentityDetails struct {
	// The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None
	Type *string

	// Gets or sets the user assigned identities.
	UserAssignedIdentities map[string]*UserAssignedIdentity

	// READ-ONLY; The object ID of the service principal object for the managed identity that is used to grant role-based access
	// to an Azure resource.
	PrincipalID *string

	// READ-ONLY; A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member.
	TenantID *string
}

DppIdentityDetails - Identity details

func (DppIdentityDetails) MarshalJSON 

func (d DppIdentityDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DppIdentityDetails.

func (*DppIdentityDetails) UnmarshalJSON 

func (d *DppIdentityDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DppIdentityDetails.

type DppProxyResource 

type DppProxyResource struct {
	// Proxy Resource tags.
	Tags map[string]*string

	// READ-ONLY; Proxy Resource Id represents the complete path to the resource.
	ID *string

	// READ-ONLY; Proxy Resource name associated with the resource.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; Proxy Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…
	Type *string
}

func (DppProxyResource) MarshalJSON 

func (d DppProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DppProxyResource.

func (*DppProxyResource) UnmarshalJSON 

func (d *DppProxyResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DppProxyResource.

type DppResource 

type DppResource struct {
	// READ-ONLY; Resource Id represents the complete path to the resource.
	ID *string

	// READ-ONLY; Resource name associated with the resource.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…
	Type *string
}

DppResource - Resource class

func (DppResource) MarshalJSON 

func (d DppResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DppResource.

func (*DppResource) UnmarshalJSON 

func (d *DppResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DppResource.

type DppResourceGuardProxyClient 

type DppResourceGuardProxyClient struct {
	// contains filtered or unexported fields
}

DppResourceGuardProxyClient contains the methods for the DppResourceGuardProxy group. Don't use this type directly, use NewDppResourceGuardProxyClient() instead.

func NewDppResourceGuardProxyClient 

func NewDppResourceGuardProxyClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DppResourceGuardProxyClient, error)

NewDppResourceGuardProxyClient creates a new instance of DppResourceGuardProxyClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*DppResourceGuardProxyClient) CreateOrUpdate 

func (client *DppResourceGuardProxyClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, vaultName string, resourceGuardProxyName string, parameters ResourceGuardProxyBaseResource, options *DppResourceGuardProxyClientCreateOrUpdateOptions) (DppResourceGuardProxyClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or Updates a ResourceGuardProxy If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • resourceGuardProxyName - name of the resource guard proxy
  • parameters - Request body for operation
  • options - DppResourceGuardProxyClientCreateOrUpdateOptions contains the optional parameters for the DppResourceGuardProxyClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardProxyCRUD/PutResourceGuardProxy.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDppResourceGuardProxyClient().CreateOrUpdate(ctx, "SampleResourceGroup", "sampleVault", "swaggerExample", armdataprotection.ResourceGuardProxyBaseResource{
	Properties: &armdataprotection.ResourceGuardProxyBase{
		ResourceGuardResourceID: to.Ptr("/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ResourceGuardProxyBaseResource = armdataprotection.ResourceGuardProxyBaseResource{
// 	Name: to.Ptr("swaggerExample"),
// 	Type: to.Ptr("Microsoft.DataProtection/vaults/backupResourceGuardProxies"),
// 	ID: to.Ptr("/subscriptions/5e13b949-1218-4d18-8b99-7e12155ec4f7/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/sampleVault/backupResourceGuardProxies/swaggerExample"),
// 	Properties: &armdataprotection.ResourceGuardProxyBase{
// 		Description: to.Ptr("Please take JIT access before performing any of the critical operation"),
// 		LastUpdatedTime: to.Ptr("2022-09-16T11:44:37.6130487Z"),
// 		ResourceGuardOperationDetails: []*armdataprotection.ResourceGuardOperationDetail{
// 			{
// 				DefaultResourceRequest: to.Ptr("/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource/deleteBackupInstanceRequests/default"),
// 				VaultCriticalOperation: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances/delete"),
// 			},
// 			{
// 				DefaultResourceRequest: to.Ptr("/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource/deleteResourceGuardProxyRequests/default"),
// 				VaultCriticalOperation: to.Ptr("Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/delete"),
// 		}},
// 		ResourceGuardResourceID: to.Ptr("/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource"),
// 	},
// }

Output:

func (*DppResourceGuardProxyClient) Delete 

func (client *DppResourceGuardProxyClient) Delete(ctx context.Context, resourceGroupName string, vaultName string, resourceGuardProxyName string, options *DppResourceGuardProxyClientDeleteOptions) (DppResourceGuardProxyClientDeleteResponse, error)

Delete - Deletes the ResourceGuardProxy If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • resourceGuardProxyName - name of the resource guard proxy
  • options - DppResourceGuardProxyClientDeleteOptions contains the optional parameters for the DppResourceGuardProxyClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardProxyCRUD/DeleteResourceGuardProxy.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = clientFactory.NewDppResourceGuardProxyClient().Delete(ctx, "SampleResourceGroup", "sampleVault", "swaggerExample", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}

Output:

func (*DppResourceGuardProxyClient) Get 

func (client *DppResourceGuardProxyClient) Get(ctx context.Context, resourceGroupName string, vaultName string, resourceGuardProxyName string, options *DppResourceGuardProxyClientGetOptions) (DppResourceGuardProxyClientGetResponse, error)

Get - Returns the ResourceGuardProxy object associated with the vault, and that matches the name in the request If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • resourceGuardProxyName - name of the resource guard proxy
  • options - DppResourceGuardProxyClientGetOptions contains the optional parameters for the DppResourceGuardProxyClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardProxyCRUD/GetResourceGuardProxy.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDppResourceGuardProxyClient().Get(ctx, "SampleResourceGroup", "sampleVault", "swaggerExample", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ResourceGuardProxyBaseResource = armdataprotection.ResourceGuardProxyBaseResource{
// 	Name: to.Ptr("swaggerExample"),
// 	Type: to.Ptr("Microsoft.DataProtection/vaults/backupResourceGuardProxies"),
// 	ID: to.Ptr("/subscriptions/5e13b949-1218-4d18-8b99-7e12155ec4f7/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/sampleVault/backupResourceGuardProxies/swaggerExample"),
// 	Properties: &armdataprotection.ResourceGuardProxyBase{
// 		Description: to.Ptr("Please take JIT access before performing any of the critical operation"),
// 		LastUpdatedTime: to.Ptr("2022-09-16T11:44:37.6130487Z"),
// 		ResourceGuardOperationDetails: []*armdataprotection.ResourceGuardOperationDetail{
// 			{
// 				DefaultResourceRequest: to.Ptr("/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource/deleteBackupInstanceRequests/default"),
// 				VaultCriticalOperation: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances/delete"),
// 			},
// 			{
// 				DefaultResourceRequest: to.Ptr("/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource/deleteResourceGuardProxyRequests/default"),
// 				VaultCriticalOperation: to.Ptr("Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/delete"),
// 		}},
// 		ResourceGuardResourceID: to.Ptr("/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource"),
// 	},
// }

Output:

func (*DppResourceGuardProxyClient) NewListPager 

func (client *DppResourceGuardProxyClient) NewListPager(resourceGroupName string, vaultName string, options *DppResourceGuardProxyClientListOptions) *runtime.Pager[DppResourceGuardProxyClientListResponse]

NewListPager - Returns the list of ResourceGuardProxies associated with the vault

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • options - DppResourceGuardProxyClientListOptions contains the optional parameters for the DppResourceGuardProxyClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardProxyCRUD/ListResourceGuardProxy.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewDppResourceGuardProxyClient().NewListPager("SampleResourceGroup", "sampleVault", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ResourceGuardProxyBaseResourceList = armdataprotection.ResourceGuardProxyBaseResourceList{
	// 	Value: []*armdataprotection.ResourceGuardProxyBaseResource{
	// 		{
	// 			Name: to.Ptr("swaggerExample"),
	// 			Type: to.Ptr("Microsoft.DataProtection/vaults/backupResourceGuardProxies"),
	// 			ID: to.Ptr("/subscriptions/5e13b949-1218-4d18-8b99-7e12155ec4f7/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/sampleVault/backupResourceGuardProxies/swaggerExample"),
	// 			Properties: &armdataprotection.ResourceGuardProxyBase{
	// 				Description: to.Ptr("Please take JIT access before performing any of the critical operation"),
	// 				LastUpdatedTime: to.Ptr("2022-09-16T11:44:37.6130487Z"),
	// 				ResourceGuardOperationDetails: []*armdataprotection.ResourceGuardOperationDetail{
	// 					{
	// 						DefaultResourceRequest: to.Ptr("/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource/deleteBackupInstanceRequests/default"),
	// 						VaultCriticalOperation: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances/delete"),
	// 					},
	// 					{
	// 						DefaultResourceRequest: to.Ptr("/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource/deleteResourceGuardProxyRequests/default"),
	// 						VaultCriticalOperation: to.Ptr("Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/delete"),
	// 				}},
	// 				ResourceGuardResourceID: to.Ptr("/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource"),
	// 			},
	// 	}},
	// }
}

Output:

func (*DppResourceGuardProxyClient) UnlockDelete 

func (client *DppResourceGuardProxyClient) UnlockDelete(ctx context.Context, resourceGroupName string, vaultName string, resourceGuardProxyName string, parameters UnlockDeleteRequest, options *DppResourceGuardProxyClientUnlockDeleteOptions) (DppResourceGuardProxyClientUnlockDeleteResponse, error)

UnlockDelete - UnlockDelete call for ResourceGuardProxy, executed before one can delete it If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • resourceGuardProxyName - name of the resource guard proxy
  • parameters - Request body for operation
  • options - DppResourceGuardProxyClientUnlockDeleteOptions contains the optional parameters for the DppResourceGuardProxyClient.UnlockDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardProxyCRUD/UnlockDeleteResourceGuardProxy.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDppResourceGuardProxyClient().UnlockDelete(ctx, "SampleResourceGroup", "sampleVault", "swaggerExample", armdataprotection.UnlockDeleteRequest{
	ResourceGuardOperationRequests: []*string{
		to.Ptr("/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource/deleteBackupInstanceRequests/default")},
	ResourceToBeDeleted: to.Ptr("/subscriptions/5e13b949-1218-4d18-8b99-7e12155ec4f7/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/sampleVault/backupInstances/TestBI9779f4de"),
}, &armdataprotection.DppResourceGuardProxyClientUnlockDeleteOptions{XMSAuthorizationAuxiliary: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.UnlockDeleteResponse = armdataprotection.UnlockDeleteResponse{
// 	UnlockDeleteExpiryTime: to.Ptr("2022-09-16T12:50:10.7039695Z"),
// }

Output:

type DppResourceGuardProxyClientCreateOrUpdateOptions 

type DppResourceGuardProxyClientCreateOrUpdateOptions struct {
}

DppResourceGuardProxyClientCreateOrUpdateOptions contains the optional parameters for the DppResourceGuardProxyClient.CreateOrUpdate method.

type DppResourceGuardProxyClientCreateOrUpdateResponse 

type DppResourceGuardProxyClientCreateOrUpdateResponse struct {
	// ResourceGuardProxyBaseResource object, used for response and request bodies for ResourceGuardProxy APIs
	ResourceGuardProxyBaseResource
}

DppResourceGuardProxyClientCreateOrUpdateResponse contains the response from method DppResourceGuardProxyClient.CreateOrUpdate.

type DppResourceGuardProxyClientDeleteOptions 

type DppResourceGuardProxyClientDeleteOptions struct {
}

DppResourceGuardProxyClientDeleteOptions contains the optional parameters for the DppResourceGuardProxyClient.Delete method.

type DppResourceGuardProxyClientDeleteResponse 

type DppResourceGuardProxyClientDeleteResponse struct {
}

DppResourceGuardProxyClientDeleteResponse contains the response from method DppResourceGuardProxyClient.Delete.

type DppResourceGuardProxyClientGetOptions 

type DppResourceGuardProxyClientGetOptions struct {
}

DppResourceGuardProxyClientGetOptions contains the optional parameters for the DppResourceGuardProxyClient.Get method.

type DppResourceGuardProxyClientGetResponse 

type DppResourceGuardProxyClientGetResponse struct {
	// ResourceGuardProxyBaseResource object, used for response and request bodies for ResourceGuardProxy APIs
	ResourceGuardProxyBaseResource
}

DppResourceGuardProxyClientGetResponse contains the response from method DppResourceGuardProxyClient.Get.

type DppResourceGuardProxyClientListOptions 

type DppResourceGuardProxyClientListOptions struct {
}

DppResourceGuardProxyClientListOptions contains the optional parameters for the DppResourceGuardProxyClient.NewListPager method.

type DppResourceGuardProxyClientListResponse 

type DppResourceGuardProxyClientListResponse struct {
	// List of ResourceGuardProxyBase resources
	ResourceGuardProxyBaseResourceList
}

DppResourceGuardProxyClientListResponse contains the response from method DppResourceGuardProxyClient.NewListPager.

type DppResourceGuardProxyClientUnlockDeleteOptions 

type DppResourceGuardProxyClientUnlockDeleteOptions struct {
	XMSAuthorizationAuxiliary *string
}

DppResourceGuardProxyClientUnlockDeleteOptions contains the optional parameters for the DppResourceGuardProxyClient.UnlockDelete method.

type DppResourceGuardProxyClientUnlockDeleteResponse 

type DppResourceGuardProxyClientUnlockDeleteResponse struct {
	// Response of Unlock Delete API.
	UnlockDeleteResponse
}

DppResourceGuardProxyClientUnlockDeleteResponse contains the response from method DppResourceGuardProxyClient.UnlockDelete.

type DppResourceList 

type DppResourceList struct {
	// The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
	NextLink *string
}

DppResourceList - ListResource

func (DppResourceList) MarshalJSON 

func (d DppResourceList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DppResourceList.

func (*DppResourceList) UnmarshalJSON 

func (d *DppResourceList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DppResourceList.

type DppTrackedResource 

type DppTrackedResource struct {
	// Optional ETag.
	ETag *string

	// Input Managed Identity Details
	Identity *DppIdentityDetails

	// Resource location.
	Location *string

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Resource Id represents the complete path to the resource.
	ID *string

	// READ-ONLY; Resource name associated with the resource.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…
	Type *string
}

func (DppTrackedResource) MarshalJSON 

func (d DppTrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DppTrackedResource.

func (*DppTrackedResource) UnmarshalJSON 

func (d *DppTrackedResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DppTrackedResource.

type DppTrackedResourceList 

type DppTrackedResourceList struct {
	// The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
	NextLink *string
}

func (DppTrackedResourceList) MarshalJSON 

func (d DppTrackedResourceList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DppTrackedResourceList.

func (*DppTrackedResourceList) UnmarshalJSON 

func (d *DppTrackedResourceList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DppTrackedResourceList.

type DppWorkerRequest 

type DppWorkerRequest struct {
	CultureInfo *string
	HTTPMethod  *string

	// Dictionary of
	Headers map[string][]*string

	// Dictionary of
	Parameters             map[string]*string
	SubscriptionID         *string
	SupportedGroupVersions []*string
	URI                    *string
}

func (DppWorkerRequest) MarshalJSON 

func (d DppWorkerRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DppWorkerRequest.

func (*DppWorkerRequest) UnmarshalJSON 

func (d *DppWorkerRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DppWorkerRequest.

type EncryptionSettings added in v3.1.0 

type EncryptionSettings struct {
	// Enabling/Disabling the Double Encryption state
	InfrastructureEncryption *InfrastructureEncryptionState

	// The details of the managed identity used for CMK
	KekIdentity *CmkKekIdentity

	// The properties of the Key Vault which hosts CMK
	KeyVaultProperties *CmkKeyVaultProperties

	// Encryption state of the Backup Vault.
	State *EncryptionState
}

EncryptionSettings - Customer Managed Key details of the resource.

func (EncryptionSettings) MarshalJSON added in v3.1.0 

func (e EncryptionSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EncryptionSettings.

func (*EncryptionSettings) UnmarshalJSON added in v3.1.0 

func (e *EncryptionSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EncryptionSettings.

type EncryptionState added in v3.1.0 

type EncryptionState string

EncryptionState - Encryption state of the Backup Vault. 

const (
	// EncryptionStateDisabled - CMK encryption is disabled on the Backup Vault. User can not set this state once Encryption State
	// is 'Enabled'.
	EncryptionStateDisabled EncryptionState = "Disabled"
	// EncryptionStateEnabled - CMK encryption is enabled on the Backup Vault
	EncryptionStateEnabled EncryptionState = "Enabled"
	// EncryptionStateInconsistent - CMK encryption is in inconsistent state on the Backup Vault. This state indicates that user
	// needs to retry the encryption settings operation immediately to correct the state.
	EncryptionStateInconsistent EncryptionState = "Inconsistent"
)

func PossibleEncryptionStateValues added in v3.1.0 

func PossibleEncryptionStateValues() []EncryptionState

PossibleEncryptionStateValues returns the possible values for the EncryptionState const type.

type Error 

type Error struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo

	// READ-ONLY; The error code.
	Code *string

	// READ-ONLY; The error details.
	Details []*Error

	// READ-ONLY; The error message.
	Message *string

	// READ-ONLY; The error target.
	Target *string
}

Error - The resource management error response.

func (Error) MarshalJSON 

func (e Error) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Error.

func (*Error) UnmarshalJSON 

func (e *Error) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Error.

type ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info any

	// READ-ONLY; The additional info type.
	Type *string
}

ErrorAdditionalInfo - The resource management error additional info.

func (ErrorAdditionalInfo) MarshalJSON 

func (e ErrorAdditionalInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorAdditionalInfo.

func (*ErrorAdditionalInfo) UnmarshalJSON 

func (e *ErrorAdditionalInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorAdditionalInfo.

type ErrorDetail 

type ErrorDetail struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo

	// READ-ONLY; The error code.
	Code *string

	// READ-ONLY; The error details.
	Details []*ErrorDetail

	// READ-ONLY; The error message.
	Message *string

	// READ-ONLY; The error target.
	Target *string
}

ErrorDetail - The error detail.

func (ErrorDetail) MarshalJSON 

func (e ErrorDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorDetail.

func (*ErrorDetail) UnmarshalJSON 

func (e *ErrorDetail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorDetail.

type ErrorResponse 

type ErrorResponse struct {
	// The error object.
	Error *ErrorDetail
}

ErrorResponse - Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

func (ErrorResponse) MarshalJSON 

func (e ErrorResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorResponse.

func (*ErrorResponse) UnmarshalJSON 

func (e *ErrorResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponse.

type ExistingResourcePolicy 

type ExistingResourcePolicy string

ExistingResourcePolicy - Gets or sets the Conflict Policy property. This property sets policy during conflict of resources during restore. 

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

func PossibleExistingResourcePolicyValues 

func PossibleExistingResourcePolicyValues() []ExistingResourcePolicy

PossibleExistingResourcePolicyValues returns the possible values for the ExistingResourcePolicy const type.

type ExportJobsClient 

type ExportJobsClient struct {
	// contains filtered or unexported fields
}

ExportJobsClient contains the methods for the ExportJobs group. Don't use this type directly, use NewExportJobsClient() instead.

func NewExportJobsClient 

func NewExportJobsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ExportJobsClient, error)

NewExportJobsClient creates a new instance of ExportJobsClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ExportJobsClient) BeginTrigger 

func (client *ExportJobsClient) BeginTrigger(ctx context.Context, resourceGroupName string, vaultName string, options *ExportJobsClientBeginTriggerOptions) (*runtime.Poller[ExportJobsClientTriggerResponse], error)

BeginTrigger - Triggers export of jobs and returns an OperationID to track. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • options - ExportJobsClientBeginTriggerOptions contains the optional parameters for the ExportJobsClient.BeginTrigger method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/JobCRUD/TriggerExportJobs.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewExportJobsClient().BeginTrigger(ctx, "SwaggerTestRg", "NetSDKTestRsVault", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

type ExportJobsClientBeginTriggerOptions 

type ExportJobsClientBeginTriggerOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExportJobsClientBeginTriggerOptions contains the optional parameters for the ExportJobsClient.BeginTrigger method.

type ExportJobsClientTriggerResponse 

type ExportJobsClientTriggerResponse struct {
}

ExportJobsClientTriggerResponse contains the response from method ExportJobsClient.BeginTrigger.

type ExportJobsOperationResultClient 

type ExportJobsOperationResultClient struct {
	// contains filtered or unexported fields
}

ExportJobsOperationResultClient contains the methods for the ExportJobsOperationResult group. Don't use this type directly, use NewExportJobsOperationResultClient() instead.

func NewExportJobsOperationResultClient 

func NewExportJobsOperationResultClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ExportJobsOperationResultClient, error)

NewExportJobsOperationResultClient creates a new instance of ExportJobsOperationResultClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ExportJobsOperationResultClient) Get 

func (client *ExportJobsOperationResultClient) Get(ctx context.Context, resourceGroupName string, vaultName string, operationID string, options *ExportJobsOperationResultClientGetOptions) (ExportJobsOperationResultClientGetResponse, error)

Get - Gets the operation result of operation triggered by Export Jobs API. If the operation is successful, then it also contains URL of a Blob and a SAS key to access the same. The blob contains exported jobs in JSON serialized format. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • operationID - OperationID which represents the export job.
  • options - ExportJobsOperationResultClientGetOptions contains the optional parameters for the ExportJobsOperationResultClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/JobCRUD/GetExportJobsOperationResult.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewExportJobsOperationResultClient().Get(ctx, "SwaggerTestRg", "NetSDKTestRsVault", "00000000-0000-0000-0000-000000000000", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ExportJobsResult = armdataprotection.ExportJobsResult{
// 	BlobSasKey: to.Ptr("someKey"),
// 	BlobURL: to.Ptr("https://azureblob.blob.core.windows.net/reportcontainer/exportjobsreport00000000-0000-0000-0000-000000000000"),
// 	ExcelFileBlobSasKey: to.Ptr("someKey"),
// 	ExcelFileBlobURL: to.Ptr("https://azureblob.blob.core.windows.net/reportcontainer/exportjobsreport00000000-0000-0000-0000-000000000000_ExcelFile.xlsx"),
// }

Output:

type ExportJobsOperationResultClientGetOptions 

type ExportJobsOperationResultClientGetOptions struct {
}

ExportJobsOperationResultClientGetOptions contains the optional parameters for the ExportJobsOperationResultClient.Get method.

type ExportJobsOperationResultClientGetResponse 

type ExportJobsOperationResultClientGetResponse struct {
	// The result for export jobs containing blob details.
	ExportJobsResult
}

ExportJobsOperationResultClientGetResponse contains the response from method ExportJobsOperationResultClient.Get.

type ExportJobsResult 

type ExportJobsResult struct {
	// READ-ONLY; SAS key to access the blob.
	BlobSasKey *string

	// READ-ONLY; URL of the blob into which the serialized string of list of jobs is exported.
	BlobURL *string

	// READ-ONLY; SAS key to access the ExcelFile blob.
	ExcelFileBlobSasKey *string

	// READ-ONLY; URL of the blob into which the ExcelFile is uploaded.
	ExcelFileBlobURL *string
}

ExportJobsResult - The result for export jobs containing blob details.

func (ExportJobsResult) MarshalJSON 

func (e ExportJobsResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExportJobsResult.

func (*ExportJobsResult) UnmarshalJSON 

func (e *ExportJobsResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExportJobsResult.

type FeatureSettings 

type FeatureSettings struct {
	CrossRegionRestoreSettings *CrossRegionRestoreSettings

	// CrossSubscriptionRestore Settings
	CrossSubscriptionRestoreSettings *CrossSubscriptionRestoreSettings
}

FeatureSettings - Class containing feature settings of vault

func (FeatureSettings) MarshalJSON 

func (f FeatureSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FeatureSettings.

func (*FeatureSettings) UnmarshalJSON 

func (f *FeatureSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FeatureSettings.

type FeatureSupportStatus 

type FeatureSupportStatus string

FeatureSupportStatus - feature support status 

const (
	FeatureSupportStatusAlphaPreview       FeatureSupportStatus = "AlphaPreview"
	FeatureSupportStatusGenerallyAvailable FeatureSupportStatus = "GenerallyAvailable"
	FeatureSupportStatusInvalid            FeatureSupportStatus = "Invalid"
	FeatureSupportStatusNotSupported       FeatureSupportStatus = "NotSupported"
	FeatureSupportStatusPrivatePreview     FeatureSupportStatus = "PrivatePreview"
	FeatureSupportStatusPublicPreview      FeatureSupportStatus = "PublicPreview"
)

func PossibleFeatureSupportStatusValues 

func PossibleFeatureSupportStatusValues() []FeatureSupportStatus

PossibleFeatureSupportStatusValues returns the possible values for the FeatureSupportStatus const type.

type FeatureType 

type FeatureType string

FeatureType - backup support feature type. 

const (
	FeatureTypeDataSourceType FeatureType = "DataSourceType"
	FeatureTypeInvalid        FeatureType = "Invalid"
)

func PossibleFeatureTypeValues 

func PossibleFeatureTypeValues() []FeatureType

PossibleFeatureTypeValues returns the possible values for the FeatureType const type.

type FeatureValidationRequest 

type FeatureValidationRequest struct {
	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string

	// backup support feature name.
	FeatureName *string

	// backup support feature type.
	FeatureType *FeatureType
}

FeatureValidationRequest - Base class for feature object

func (*FeatureValidationRequest) GetFeatureValidationRequestBase 

func (f *FeatureValidationRequest) GetFeatureValidationRequestBase() *FeatureValidationRequestBase

GetFeatureValidationRequestBase implements the FeatureValidationRequestBaseClassification interface for type FeatureValidationRequest.

func (FeatureValidationRequest) MarshalJSON 

func (f FeatureValidationRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FeatureValidationRequest.

func (*FeatureValidationRequest) UnmarshalJSON 

func (f *FeatureValidationRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FeatureValidationRequest.

type FeatureValidationRequestBase 

type FeatureValidationRequestBase struct {
	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string
}

FeatureValidationRequestBase - Base class for Backup Feature support

func (*FeatureValidationRequestBase) GetFeatureValidationRequestBase 

func (f *FeatureValidationRequestBase) GetFeatureValidationRequestBase() *FeatureValidationRequestBase

GetFeatureValidationRequestBase implements the FeatureValidationRequestBaseClassification interface for type FeatureValidationRequestBase.

func (FeatureValidationRequestBase) MarshalJSON 

func (f FeatureValidationRequestBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FeatureValidationRequestBase.

func (*FeatureValidationRequestBase) UnmarshalJSON 

func (f *FeatureValidationRequestBase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FeatureValidationRequestBase.

type FeatureValidationRequestBaseClassification 

type FeatureValidationRequestBaseClassification interface {
	// GetFeatureValidationRequestBase returns the FeatureValidationRequestBase content of the underlying type.
	GetFeatureValidationRequestBase() *FeatureValidationRequestBase
}

FeatureValidationRequestBaseClassification provides polymorphic access to related types. Call the interface's GetFeatureValidationRequestBase() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *FeatureValidationRequest, *FeatureValidationRequestBase

type FeatureValidationResponse 

type FeatureValidationResponse struct {
	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string

	// backup support feature type.
	FeatureType *FeatureType

	// Response features
	Features []*SupportedFeature
}

FeatureValidationResponse - Feature Validation Response

func (*FeatureValidationResponse) GetFeatureValidationResponseBase 

func (f *FeatureValidationResponse) GetFeatureValidationResponseBase() *FeatureValidationResponseBase

GetFeatureValidationResponseBase implements the FeatureValidationResponseBaseClassification interface for type FeatureValidationResponse.

func (FeatureValidationResponse) MarshalJSON 

func (f FeatureValidationResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FeatureValidationResponse.

func (*FeatureValidationResponse) UnmarshalJSON 

func (f *FeatureValidationResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FeatureValidationResponse.

type FeatureValidationResponseBase 

type FeatureValidationResponseBase struct {
	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string
}

FeatureValidationResponseBase - Base class for Backup Feature support

func (*FeatureValidationResponseBase) GetFeatureValidationResponseBase 

func (f *FeatureValidationResponseBase) GetFeatureValidationResponseBase() *FeatureValidationResponseBase

GetFeatureValidationResponseBase implements the FeatureValidationResponseBaseClassification interface for type FeatureValidationResponseBase.

func (FeatureValidationResponseBase) MarshalJSON 

func (f FeatureValidationResponseBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FeatureValidationResponseBase.

func (*FeatureValidationResponseBase) UnmarshalJSON 

func (f *FeatureValidationResponseBase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FeatureValidationResponseBase.

type FeatureValidationResponseBaseClassification 

type FeatureValidationResponseBaseClassification interface {
	// GetFeatureValidationResponseBase returns the FeatureValidationResponseBase content of the underlying type.
	GetFeatureValidationResponseBase() *FeatureValidationResponseBase
}

FeatureValidationResponseBaseClassification provides polymorphic access to related types. Call the interface's GetFeatureValidationResponseBase() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *FeatureValidationResponse, *FeatureValidationResponseBase

type FetchCrossRegionRestoreJobClient 

type FetchCrossRegionRestoreJobClient struct {
	// contains filtered or unexported fields
}

FetchCrossRegionRestoreJobClient contains the methods for the FetchCrossRegionRestoreJob group. Don't use this type directly, use NewFetchCrossRegionRestoreJobClient() instead.

func NewFetchCrossRegionRestoreJobClient 

func NewFetchCrossRegionRestoreJobClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*FetchCrossRegionRestoreJobClient, error)

NewFetchCrossRegionRestoreJobClient creates a new instance of FetchCrossRegionRestoreJobClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*FetchCrossRegionRestoreJobClient) Get 

func (client *FetchCrossRegionRestoreJobClient) Get(ctx context.Context, resourceGroupName string, location string, parameters CrossRegionRestoreJobRequest, options *FetchCrossRegionRestoreJobClientGetOptions) (FetchCrossRegionRestoreJobClientGetResponse, error)

Get - Fetches the Cross Region Restore Job If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • location - The name of the Azure region.
  • parameters - Request body for operation
  • options - FetchCrossRegionRestoreJobClientGetOptions contains the optional parameters for the FetchCrossRegionRestoreJobClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/CrossRegionRestore/FetchCrossRegionRestoreJob.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewFetchCrossRegionRestoreJobClient().Get(ctx, "BugBash1", "west us", armdataprotection.CrossRegionRestoreJobRequest{
	JobID:               to.Ptr("3c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
	SourceBackupVaultID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11"),
	SourceRegion:        to.Ptr("east us"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.AzureBackupJobResource = armdataprotection.AzureBackupJobResource{
// 	Name: to.Ptr("3c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
// 	Type: to.Ptr("Microsoft.DataProtection/Backupvaults/backupJobs"),
// 	ID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/3c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
// 	Properties: &armdataprotection.AzureBackupJob{
// 		ActivityID: to.Ptr("c4344fb4-7c11-43a4-8307-7ae7c7fb09b9"),
// 		BackupInstanceFriendlyName: to.Ptr("mabtestingccybasicv11\\bugbashdb2"),
// 		BackupInstanceID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/28460a9d-707a-45f3-ace6-b16284c2900e"),
// 		DataSourceID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb2"),
// 		DataSourceLocation: to.Ptr("east us"),
// 		DataSourceName: to.Ptr("bugbashdb2"),
// 		DataSourceSetName: to.Ptr("mabtestingccybasicv11"),
// 		DataSourceType: to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
// 		Duration: to.Ptr("00:00:00"),
// 		ExtendedInfo: &armdataprotection.JobExtendedInfo{
// 			AdditionalDetails: map[string]*string{
// 				"PolicyRuleName": to.Ptr("BackupWeekly"),
// 				"RetentionTag": to.Ptr("Default"),
// 				"TaskId": to.Ptr("c4344fb4-7c11-43a4-8307-7ae7c7fb09b9"),
// 			},
// 			SubTasks: []*armdataprotection.JobSubTask{
// 				{
// 					TaskID: to.Ptr[int32](1),
// 					TaskName: to.Ptr("Trigger Backup"),
// 					TaskStatus: to.Ptr("Started"),
// 			}},
// 		},
// 		IsUserTriggered: to.Ptr(false),
// 		Operation: to.Ptr("Backup"),
// 		OperationCategory: to.Ptr("Backup"),
// 		PolicyID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetdailypolicy"),
// 		PolicyName: to.Ptr("jakavetdailypolicy"),
// 		ProgressEnabled: to.Ptr(false),
// 		SourceResourceGroup: to.Ptr("DppPostgresTestingCcy"),
// 		SourceSubscriptionID: to.Ptr("62b829ee-7936-40c9-a1c9-47a93f9f3965"),
// 		StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-17T03:00:03.760Z"); return t}()),
// 		Status: to.Ptr("Started"),
// 		SubscriptionID: to.Ptr("62b829ee-7936-40c9-a1c9-47a93f9f3965"),
// 		SupportedActions: []*string{
// 		},
// 		VaultName: to.Ptr("BugBashVaultForCCYv11"),
// 	},
// }

Output:

type FetchCrossRegionRestoreJobClientGetOptions 

type FetchCrossRegionRestoreJobClientGetOptions struct {
}

FetchCrossRegionRestoreJobClientGetOptions contains the optional parameters for the FetchCrossRegionRestoreJobClient.Get method.

type FetchCrossRegionRestoreJobClientGetResponse 

type FetchCrossRegionRestoreJobClientGetResponse struct {
	// AzureBackup Job Resource Class
	AzureBackupJobResource
}

FetchCrossRegionRestoreJobClientGetResponse contains the response from method FetchCrossRegionRestoreJobClient.Get.

type FetchCrossRegionRestoreJobsClient 

type FetchCrossRegionRestoreJobsClient struct {
	// contains filtered or unexported fields
}

FetchCrossRegionRestoreJobsClient contains the methods for the FetchCrossRegionRestoreJobs group. Don't use this type directly, use NewFetchCrossRegionRestoreJobsClient() instead.

func NewFetchCrossRegionRestoreJobsClient 

func NewFetchCrossRegionRestoreJobsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*FetchCrossRegionRestoreJobsClient, error)

NewFetchCrossRegionRestoreJobsClient creates a new instance of FetchCrossRegionRestoreJobsClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*FetchCrossRegionRestoreJobsClient) NewListPager 

func (client *FetchCrossRegionRestoreJobsClient) NewListPager(resourceGroupName string, location string, parameters CrossRegionRestoreJobsRequest, options *FetchCrossRegionRestoreJobsClientListOptions) *runtime.Pager[FetchCrossRegionRestoreJobsClientListResponse]

NewListPager - Fetches list of Cross Region Restore job belonging to the vault

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • location - The name of the Azure region.
  • parameters - Request body for operation
  • options - FetchCrossRegionRestoreJobsClientListOptions contains the optional parameters for the FetchCrossRegionRestoreJobsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/CrossRegionRestore/FetchCrossRegionRestoreJobs.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewFetchCrossRegionRestoreJobsClient().NewListPager("BugBash1", "east us", armdataprotection.CrossRegionRestoreJobsRequest{
	SourceBackupVaultID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11"),
	SourceRegion:        to.Ptr("east us"),
}, &armdataprotection.FetchCrossRegionRestoreJobsClientListOptions{Filter: nil})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.AzureBackupJobResourceList = armdataprotection.AzureBackupJobResourceList{
	// 	Value: []*armdataprotection.AzureBackupJobResource{
	// 		{
	// 			Name: to.Ptr("8989416e-7573-4836-8cf1-0e90954f1002"),
	// 			Type: to.Ptr("Microsoft.DataProtection/Backupvaults/backupJobs"),
	// 			ID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/8989416e-7573-4836-8cf1-0e90954f1002"),
	// 			Properties: &armdataprotection.AzureBackupJob{
	// 				ActivityID: to.Ptr("932925c4-3d81-4550-8105-c7f7b0a934c5"),
	// 				BackupInstanceFriendlyName: to.Ptr("mabtestingccybasicv11\\bugbashdb4"),
	// 				BackupInstanceID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/3048870f-b1b7-44c4-b078-368da3fd000e"),
	// 				DataSourceID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb4"),
	// 				DataSourceLocation: to.Ptr("centraluseuap"),
	// 				DataSourceName: to.Ptr("bugbashdb4"),
	// 				DataSourceSetName: to.Ptr("mabtestingccybasicv11"),
	// 				DataSourceType: to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
	// 				Duration: to.Ptr("00:00:00"),
	// 				IsUserTriggered: to.Ptr(false),
	// 				Operation: to.Ptr("Backup"),
	// 				OperationCategory: to.Ptr("Backup"),
	// 				PolicyID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy2"),
	// 				PolicyName: to.Ptr("jakavetPolicy2"),
	// 				ProgressEnabled: to.Ptr(false),
	// 				SourceResourceGroup: to.Ptr("DppPostgresTestingCcy"),
	// 				SourceSubscriptionID: to.Ptr("62b829ee-7936-40c9-a1c9-47a93f9f3965"),
	// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-16T05:00:08.174Z"); return t}()),
	// 				Status: to.Ptr("Started"),
	// 				SubscriptionID: to.Ptr("62b829ee-7936-40c9-a1c9-47a93f9f3965"),
	// 				SupportedActions: []*string{
	// 				},
	// 				VaultName: to.Ptr("BugBashVaultForCCYv11"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("ad218c05-242a-47c2-b7b7-c16bd0f8870c"),
	// 			Type: to.Ptr("Microsoft.DataProtection/Backupvaults/backupJobs"),
	// 			ID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/ad218c05-242a-47c2-b7b7-c16bd0f8870c"),
	// 			Properties: &armdataprotection.AzureBackupJob{
	// 				ActivityID: to.Ptr("b4f32e03-ded0-46fc-9afc-91853878efcd"),
	// 				BackupInstanceFriendlyName: to.Ptr("mabtestingccybasicv11\\bugbashdb5"),
	// 				BackupInstanceID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/943c60db-c033-4d93-bb00-66048474e00e"),
	// 				DataSourceID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb5"),
	// 				DataSourceLocation: to.Ptr("centraluseuap"),
	// 				DataSourceName: to.Ptr("bugbashdb5"),
	// 				DataSourceSetName: to.Ptr("mabtestingccybasicv11"),
	// 				DataSourceType: to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
	// 				Duration: to.Ptr("00:00:00"),
	// 				IsUserTriggered: to.Ptr(false),
	// 				Operation: to.Ptr("Backup"),
	// 				OperationCategory: to.Ptr("Backup"),
	// 				PolicyID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy3"),
	// 				PolicyName: to.Ptr("jakavetPolicy3"),
	// 				ProgressEnabled: to.Ptr(false),
	// 				SourceResourceGroup: to.Ptr("DppPostgresTestingCcy"),
	// 				SourceSubscriptionID: to.Ptr("62b829ee-7936-40c9-a1c9-47a93f9f3965"),
	// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-16T18:00:03.666Z"); return t}()),
	// 				Status: to.Ptr("Started"),
	// 				SubscriptionID: to.Ptr("62b829ee-7936-40c9-a1c9-47a93f9f3965"),
	// 				SupportedActions: []*string{
	// 				},
	// 				VaultName: to.Ptr("BugBashVaultForCCYv11"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("3c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
	// 			Type: to.Ptr("Microsoft.DataProtection/Backupvaults/backupJobs"),
	// 			ID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/3c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
	// 			Properties: &armdataprotection.AzureBackupJob{
	// 				ActivityID: to.Ptr("c4344fb4-7c11-43a4-8307-7ae7c7fb09b9"),
	// 				BackupInstanceFriendlyName: to.Ptr("mabtestingccybasicv11\\bugbashdb2"),
	// 				BackupInstanceID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/28460a9d-707a-45f3-ace6-b16284c2900e"),
	// 				DataSourceID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb2"),
	// 				DataSourceLocation: to.Ptr("centraluseuap"),
	// 				DataSourceName: to.Ptr("bugbashdb2"),
	// 				DataSourceSetName: to.Ptr("mabtestingccybasicv11"),
	// 				DataSourceType: to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
	// 				Duration: to.Ptr("00:00:00"),
	// 				IsUserTriggered: to.Ptr(false),
	// 				Operation: to.Ptr("Backup"),
	// 				OperationCategory: to.Ptr("Backup"),
	// 				PolicyID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetdailypolicy"),
	// 				PolicyName: to.Ptr("jakavetdailypolicy"),
	// 				ProgressEnabled: to.Ptr(false),
	// 				SourceResourceGroup: to.Ptr("DppPostgresTestingCcy"),
	// 				SourceSubscriptionID: to.Ptr("62b829ee-7936-40c9-a1c9-47a93f9f3965"),
	// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-17T03:00:03.760Z"); return t}()),
	// 				Status: to.Ptr("Started"),
	// 				SubscriptionID: to.Ptr("62b829ee-7936-40c9-a1c9-47a93f9f3965"),
	// 				SupportedActions: []*string{
	// 				},
	// 				VaultName: to.Ptr("BugBashVaultForCCYv11"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("43252662-1b43-44fd-a856-0055665cb097"),
	// 			Type: to.Ptr("Microsoft.DataProtection/Backupvaults/backupJobs"),
	// 			ID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/43252662-1b43-44fd-a856-0055665cb097"),
	// 			Properties: &armdataprotection.AzureBackupJob{
	// 				ActivityID: to.Ptr("94052cf1-a47f-4c1b-93e7-79e07b2bd008-Tue Mar 17 2021 11:11:48 GMT+0530 (India Standard Time)-Ibz"),
	// 				BackupInstanceFriendlyName: to.Ptr("mabtestingccybasicv11\\bugbashdb3"),
	// 				BackupInstanceID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/0b247869-b8be-4885-b832-8ac4cdf5b00e"),
	// 				DataSourceID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb3"),
	// 				DataSourceLocation: to.Ptr("centraluseuap"),
	// 				DataSourceName: to.Ptr("bugbashdb3"),
	// 				DataSourceSetName: to.Ptr("mabtestingccybasicv11"),
	// 				DataSourceType: to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
	// 				Duration: to.Ptr("00:02:11.9724387"),
	// 				EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-17T11:14:02.531Z"); return t}()),
	// 				IsUserTriggered: to.Ptr(true),
	// 				Operation: to.Ptr("Backup"),
	// 				OperationCategory: to.Ptr("Backup"),
	// 				PolicyID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy1"),
	// 				PolicyName: to.Ptr("jakavetPolicy1"),
	// 				ProgressEnabled: to.Ptr(false),
	// 				SourceResourceGroup: to.Ptr("DppPostgresTestingCcy"),
	// 				SourceSubscriptionID: to.Ptr("62b829ee-7936-40c9-a1c9-47a93f9f3965"),
	// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-17T11:11:50.559Z"); return t}()),
	// 				Status: to.Ptr("Succeeded"),
	// 				SubscriptionID: to.Ptr("62b829ee-7936-40c9-a1c9-47a93f9f3965"),
	// 				SupportedActions: []*string{
	// 					to.Ptr("")},
	// 					VaultName: to.Ptr("BugBashVaultForCCYv11"),
	// 				},
	// 		}},
	// 	}
}

Output:

type FetchCrossRegionRestoreJobsClientListOptions 

type FetchCrossRegionRestoreJobsClientListOptions struct {
	// OData filter options.
	Filter *string
}

FetchCrossRegionRestoreJobsClientListOptions contains the optional parameters for the FetchCrossRegionRestoreJobsClient.NewListPager method.

type FetchCrossRegionRestoreJobsClientListResponse 

type FetchCrossRegionRestoreJobsClientListResponse struct {
	// List of AzureBackup Job resources
	AzureBackupJobResourceList
}

FetchCrossRegionRestoreJobsClientListResponse contains the response from method FetchCrossRegionRestoreJobsClient.NewListPager.

type FetchSecondaryRPsRequestParameters 

type FetchSecondaryRPsRequestParameters struct {
	// ARM Path of BackupInstance
	SourceBackupInstanceID *string

	// Source region in which BackupInstance is located
	SourceRegion *string
}

FetchSecondaryRPsRequestParameters - Information about BI whose secondary RecoveryPoints are requested Source region and BI ARM path

func (FetchSecondaryRPsRequestParameters) MarshalJSON 

func (f FetchSecondaryRPsRequestParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FetchSecondaryRPsRequestParameters.

func (*FetchSecondaryRPsRequestParameters) UnmarshalJSON 

func (f *FetchSecondaryRPsRequestParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FetchSecondaryRPsRequestParameters.

type FetchSecondaryRecoveryPointsClient 

type FetchSecondaryRecoveryPointsClient struct {
	// contains filtered or unexported fields
}

FetchSecondaryRecoveryPointsClient contains the methods for the FetchSecondaryRecoveryPoints group. Don't use this type directly, use NewFetchSecondaryRecoveryPointsClient() instead.

func NewFetchSecondaryRecoveryPointsClient 

func NewFetchSecondaryRecoveryPointsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*FetchSecondaryRecoveryPointsClient, error)

NewFetchSecondaryRecoveryPointsClient creates a new instance of FetchSecondaryRecoveryPointsClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*FetchSecondaryRecoveryPointsClient) NewListPager 

func (client *FetchSecondaryRecoveryPointsClient) NewListPager(resourceGroupName string, location string, parameters FetchSecondaryRPsRequestParameters, options *FetchSecondaryRecoveryPointsClientListOptions) *runtime.Pager[FetchSecondaryRecoveryPointsClientListResponse]

NewListPager - Returns a list of Secondary Recovery Points for a DataSource in a vault, that can be used for Cross Region Restore.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • location - The name of the Azure region.
  • parameters - Request body for operation
  • options - FetchSecondaryRecoveryPointsClientListOptions contains the optional parameters for the FetchSecondaryRecoveryPointsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/CrossRegionRestore/FetchSecondaryRPs.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewFetchSecondaryRecoveryPointsClient().NewListPager("000pikumar", "WestUS", armdataprotection.FetchSecondaryRPsRequestParameters{
	SourceBackupInstanceID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34"),
	SourceRegion:           to.Ptr("EastUS"),
}, &armdataprotection.FetchSecondaryRecoveryPointsClientListOptions{Filter: nil,
	SkipToken: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.AzureBackupRecoveryPointResourceList = armdataprotection.AzureBackupRecoveryPointResourceList{
	// 	Value: []*armdataprotection.AzureBackupRecoveryPointResource{
	// 		{
	// 			Name: to.Ptr("7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5e35"),
	// 			Type: to.Ptr("microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints"),
	// 			ID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25"),
	// 			Properties: &armdataprotection.AzureBackupDiscreteRecoveryPoint{
	// 				ObjectType: to.Ptr("AzureBackupDiscreteRecoveryPoint"),
	// 				ExpiryTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-03-01T13:00:00.000Z"); return t}()),
	// 				FriendlyName: to.Ptr("panbha4"),
	// 				RecoveryPointDataStoresDetails: []*armdataprotection.RecoveryPointDataStoreDetails{
	// 					{
	// 						Type: to.Ptr("Snapshot"),
	// 						CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00.000Z"); return t}()),
	// 						ID: to.Ptr("0ff03512-b333-4509-a6c7-12164c8b1dce"),
	// 						MetaData: to.Ptr("123456"),
	// 					},
	// 					{
	// 						Type: to.Ptr("BackupStorage"),
	// 						CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00.000Z"); return t}()),
	// 						ID: to.Ptr("5d8cfd30-722e-4bab-85f6-4a9d01ffc6f1"),
	// 						MetaData: to.Ptr("123456"),
	// 				}},
	// 				RecoveryPointTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00.000Z"); return t}()),
	// 				RecoveryPointType: to.Ptr("Full"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25"),
	// 			Type: to.Ptr("microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints"),
	// 			ID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25"),
	// 			Properties: &armdataprotection.AzureBackupDiscreteRecoveryPoint{
	// 				ObjectType: to.Ptr("AzureBackupDiscreteRecoveryPoint"),
	// 				FriendlyName: to.Ptr("panbha4"),
	// 				RecoveryPointDataStoresDetails: []*armdataprotection.RecoveryPointDataStoreDetails{
	// 					{
	// 						Type: to.Ptr("Snapshot"),
	// 						CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00.000Z"); return t}()),
	// 						ID: to.Ptr("808cfd30-722e-4bab-85f6-4a9d01ffc6f2"),
	// 						MetaData: to.Ptr("123456"),
	// 					},
	// 					{
	// 						Type: to.Ptr("BackupStorage"),
	// 						CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00.000Z"); return t}()),
	// 						ID: to.Ptr("798cfd30-722e-4bab-85f6-4a9d01ffc6f3"),
	// 						MetaData: to.Ptr("123456"),
	// 				}},
	// 				RecoveryPointTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00.000Z"); return t}()),
	// 				RecoveryPointType: to.Ptr("Full"),
	// 			},
	// 	}},
	// }
}

Output:

type FetchSecondaryRecoveryPointsClientListOptions 

type FetchSecondaryRecoveryPointsClientListOptions struct {
	// OData filter options.
	Filter *string

	// skipToken Filter.
	SkipToken *string
}

FetchSecondaryRecoveryPointsClientListOptions contains the optional parameters for the FetchSecondaryRecoveryPointsClient.NewListPager method.

type FetchSecondaryRecoveryPointsClientListResponse 

type FetchSecondaryRecoveryPointsClientListResponse struct {
	// Azure backup recoveryPoint resource list
	AzureBackupRecoveryPointResourceList
}

FetchSecondaryRecoveryPointsClientListResponse contains the response from method FetchSecondaryRecoveryPointsClient.NewListPager.

type IdentityDetails 

type IdentityDetails struct {
	// Specifies if the BI is protected by System Identity.
	UseSystemAssignedIdentity *bool

	// ARM URL for User Assigned Identity.
	UserAssignedIdentityArmURL *string
}

func (IdentityDetails) MarshalJSON 

func (i IdentityDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IdentityDetails.

func (*IdentityDetails) UnmarshalJSON 

func (i *IdentityDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IdentityDetails.

type IdentityType added in v3.1.0 

type IdentityType string

IdentityType - The identity type. 'SystemAssigned' and 'UserAssigned' are mutually exclusive. 'SystemAssigned' will use implicitly created managed identity. 

const (
	IdentityTypeSystemAssigned IdentityType = "SystemAssigned"
	IdentityTypeUserAssigned   IdentityType = "UserAssigned"
)

func PossibleIdentityTypeValues added in v3.1.0 

func PossibleIdentityTypeValues() []IdentityType

PossibleIdentityTypeValues returns the possible values for the IdentityType const type.

type ImmediateCopyOption 

type ImmediateCopyOption struct {
	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string
}

ImmediateCopyOption - Immediate copy Option

func (*ImmediateCopyOption) GetCopyOption 

func (i *ImmediateCopyOption) GetCopyOption() *CopyOption

GetCopyOption implements the CopyOptionClassification interface for type ImmediateCopyOption.

func (ImmediateCopyOption) MarshalJSON 

func (i ImmediateCopyOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ImmediateCopyOption.

func (*ImmediateCopyOption) UnmarshalJSON 

func (i *ImmediateCopyOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ImmediateCopyOption.

type ImmutabilitySettings 

type ImmutabilitySettings struct {
	// Immutability state
	State *ImmutabilityState
}

ImmutabilitySettings - Immutability Settings at vault level

func (ImmutabilitySettings) MarshalJSON 

func (i ImmutabilitySettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ImmutabilitySettings.

func (*ImmutabilitySettings) UnmarshalJSON 

func (i *ImmutabilitySettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ImmutabilitySettings.

type ImmutabilityState 

type ImmutabilityState string

ImmutabilityState - Immutability state 

const (
	ImmutabilityStateDisabled ImmutabilityState = "Disabled"
	ImmutabilityStateLocked   ImmutabilityState = "Locked"
	ImmutabilityStateUnlocked ImmutabilityState = "Unlocked"
)

func PossibleImmutabilityStateValues 

func PossibleImmutabilityStateValues() []ImmutabilityState

PossibleImmutabilityStateValues returns the possible values for the ImmutabilityState const type.

type InfrastructureEncryptionState added in v3.1.0 

type InfrastructureEncryptionState string

InfrastructureEncryptionState - Enabling/Disabling the Double Encryption state 

const (
	InfrastructureEncryptionStateDisabled InfrastructureEncryptionState = "Disabled"
	InfrastructureEncryptionStateEnabled  InfrastructureEncryptionState = "Enabled"
)

func PossibleInfrastructureEncryptionStateValues added in v3.1.0 

func PossibleInfrastructureEncryptionStateValues() []InfrastructureEncryptionState

PossibleInfrastructureEncryptionStateValues returns the possible values for the InfrastructureEncryptionState const type.

type InnerError 

type InnerError struct {
	// Any Key value pairs that can be provided to the client for additional verbose information.
	AdditionalInfo map[string]*string

	// Unique code for this error
	Code *string

	// Child Inner Error, to allow Nesting.
	EmbeddedInnerError *InnerError
}

InnerError - Inner Error

func (InnerError) MarshalJSON 

func (i InnerError) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InnerError.

func (*InnerError) UnmarshalJSON 

func (i *InnerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InnerError.

type ItemLevelRestoreCriteria 

type ItemLevelRestoreCriteria struct {
	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string
}

ItemLevelRestoreCriteria - Class to contain criteria for item level restore

func (*ItemLevelRestoreCriteria) GetItemLevelRestoreCriteria 

func (i *ItemLevelRestoreCriteria) GetItemLevelRestoreCriteria() *ItemLevelRestoreCriteria

GetItemLevelRestoreCriteria implements the ItemLevelRestoreCriteriaClassification interface for type ItemLevelRestoreCriteria.

func (ItemLevelRestoreCriteria) MarshalJSON 

func (i ItemLevelRestoreCriteria) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ItemLevelRestoreCriteria.

func (*ItemLevelRestoreCriteria) UnmarshalJSON 

func (i *ItemLevelRestoreCriteria) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ItemLevelRestoreCriteria.

type ItemLevelRestoreCriteriaClassification 

type ItemLevelRestoreCriteriaClassification interface {
	// GetItemLevelRestoreCriteria returns the ItemLevelRestoreCriteria content of the underlying type.
	GetItemLevelRestoreCriteria() *ItemLevelRestoreCriteria
}

ItemLevelRestoreCriteriaClassification provides polymorphic access to related types. Call the interface's GetItemLevelRestoreCriteria() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *ItemLevelRestoreCriteria, *ItemPathBasedRestoreCriteria, *KubernetesClusterRestoreCriteria, *KubernetesClusterVaultTierRestoreCriteria, - *KubernetesPVRestoreCriteria, *KubernetesStorageClassRestoreCriteria, *RangeBasedItemLevelRestoreCriteria

type ItemLevelRestoreTargetInfo 

type ItemLevelRestoreTargetInfo struct {
	// REQUIRED; Information of target DS
	DatasourceInfo *Datasource

	// REQUIRED; Type of Datasource object, used to initialize the right inherited type
	ObjectType *string

	// REQUIRED; Recovery Option
	RecoveryOption *RecoveryOption

	// REQUIRED; Restore Criteria
	RestoreCriteria []ItemLevelRestoreCriteriaClassification

	// Credentials to use to authenticate with data source provider.
	DatasourceAuthCredentials AuthCredentialsClassification

	// Information of target DS Set
	DatasourceSetInfo *DatasourceSet

	// Target Restore region
	RestoreLocation *string
}

ItemLevelRestoreTargetInfo - Restore target info for Item level restore operation

func (*ItemLevelRestoreTargetInfo) GetRestoreTargetInfoBase 

func (i *ItemLevelRestoreTargetInfo) GetRestoreTargetInfoBase() *RestoreTargetInfoBase

GetRestoreTargetInfoBase implements the RestoreTargetInfoBaseClassification interface for type ItemLevelRestoreTargetInfo.

func (ItemLevelRestoreTargetInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ItemLevelRestoreTargetInfo.

func (*ItemLevelRestoreTargetInfo) UnmarshalJSON 

func (i *ItemLevelRestoreTargetInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ItemLevelRestoreTargetInfo.

type ItemPathBasedRestoreCriteria 

type ItemPathBasedRestoreCriteria struct {
	// REQUIRED; Flag to specify if the path is relative to backup item or full path
	IsPathRelativeToBackupItem *bool

	// REQUIRED; The path of the item to be restored. It could be the full path of the item or the path relative to the backup
	// item
	ItemPath *string

	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string

	// The list of prefix strings to be used as filter criteria during restore. These are relative to the item path specified.
	SubItemPathPrefix []*string
}

ItemPathBasedRestoreCriteria - Prefix criteria to be used to during restore

func (*ItemPathBasedRestoreCriteria) GetItemLevelRestoreCriteria 

func (i *ItemPathBasedRestoreCriteria) GetItemLevelRestoreCriteria() *ItemLevelRestoreCriteria

GetItemLevelRestoreCriteria implements the ItemLevelRestoreCriteriaClassification interface for type ItemPathBasedRestoreCriteria.

func (ItemPathBasedRestoreCriteria) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ItemPathBasedRestoreCriteria.

func (*ItemPathBasedRestoreCriteria) UnmarshalJSON 

func (i *ItemPathBasedRestoreCriteria) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ItemPathBasedRestoreCriteria.

type JobExtendedInfo 

type JobExtendedInfo struct {
	// Job's Additional Details
	AdditionalDetails map[string]*string

	// READ-ONLY; State of the Backup Instance
	BackupInstanceState *string

	// READ-ONLY; Number of bytes transferred
	DataTransferredInBytes *float64

	// READ-ONLY; Destination where restore is done
	RecoveryDestination *string

	// READ-ONLY; Details of the Source Recovery Point
	SourceRecoverPoint *RestoreJobRecoveryPointDetails

	// READ-ONLY; List of Sub Tasks of the job
	SubTasks []*JobSubTask

	// READ-ONLY; Details of the Target Recovery Point
	TargetRecoverPoint *RestoreJobRecoveryPointDetails

	// READ-ONLY; A List, detailing the warnings related to the job
	WarningDetails []*UserFacingWarningDetail
}

JobExtendedInfo - Extended Information about the job

func (JobExtendedInfo) MarshalJSON 

func (j JobExtendedInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobExtendedInfo.

func (*JobExtendedInfo) UnmarshalJSON 

func (j *JobExtendedInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobExtendedInfo.

type JobSubTask 

type JobSubTask struct {
	// REQUIRED; Task Id of the Sub Task
	TaskID *int32

	// REQUIRED; Name of the Sub Task
	TaskName *string

	// REQUIRED; Status of the Sub Task
	TaskStatus *string

	// Additional details of Sub Tasks
	AdditionalDetails map[string]*string

	// READ-ONLY; Progress of the Sub Task
	TaskProgress *string
}

JobSubTask - Details of Job's Sub Task

func (JobSubTask) MarshalJSON 

func (j JobSubTask) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobSubTask.

func (*JobSubTask) UnmarshalJSON 

func (j *JobSubTask) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobSubTask.

type JobsClient 

type JobsClient struct {
	// contains filtered or unexported fields
}

JobsClient contains the methods for the Jobs group. Don't use this type directly, use NewJobsClient() instead.

func NewJobsClient 

func NewJobsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*JobsClient, error)

NewJobsClient creates a new instance of JobsClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*JobsClient) Get 

func (client *JobsClient) Get(ctx context.Context, resourceGroupName string, vaultName string, jobID string, options *JobsClientGetOptions) (JobsClientGetResponse, error)

Get - Gets a job with id in a backup vault If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • jobID - The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
  • options - JobsClientGetOptions contains the optional parameters for the JobsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/JobCRUD/GetJob.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewJobsClient().Get(ctx, "BugBash1", "BugBashVaultForCCYv11", "3c60cb49-63e8-4b21-b9bd-26277b3fdfae", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.AzureBackupJobResource = armdataprotection.AzureBackupJobResource{
// 	Name: to.Ptr("3c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
// 	Type: to.Ptr("Microsoft.DataProtection/Backupvaults/backupJobs"),
// 	ID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/3c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
// 	Properties: &armdataprotection.AzureBackupJob{
// 		ActivityID: to.Ptr("c4344fb4-7c11-43a4-8307-7ae7c7fb09b9"),
// 		BackupInstanceFriendlyName: to.Ptr("mabtestingccybasicv11\\bugbashdb2"),
// 		BackupInstanceID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/28460a9d-707a-45f3-ace6-b16284c2900e"),
// 		DataSourceID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb2"),
// 		DataSourceLocation: to.Ptr("centraluseuap"),
// 		DataSourceName: to.Ptr("bugbashdb2"),
// 		DataSourceSetName: to.Ptr("mabtestingccybasicv11"),
// 		DataSourceType: to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
// 		Duration: to.Ptr("00:00:00"),
// 		ExtendedInfo: &armdataprotection.JobExtendedInfo{
// 			AdditionalDetails: map[string]*string{
// 				"PolicyRuleName": to.Ptr("BackupWeekly"),
// 				"RetentionTag": to.Ptr("Default"),
// 				"TaskId": to.Ptr("c4344fb4-7c11-43a4-8307-7ae7c7fb09b9"),
// 			},
// 			SubTasks: []*armdataprotection.JobSubTask{
// 				{
// 					TaskID: to.Ptr[int32](1),
// 					TaskName: to.Ptr("Trigger Backup"),
// 					TaskStatus: to.Ptr("Started"),
// 			}},
// 		},
// 		IsUserTriggered: to.Ptr(false),
// 		Operation: to.Ptr("Backup"),
// 		OperationCategory: to.Ptr("Backup"),
// 		PolicyID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetdailypolicy"),
// 		PolicyName: to.Ptr("jakavetdailypolicy"),
// 		ProgressEnabled: to.Ptr(false),
// 		SourceResourceGroup: to.Ptr("DppPostgresTestingCcy"),
// 		SourceSubscriptionID: to.Ptr("62b829ee-7936-40c9-a1c9-47a93f9f3965"),
// 		StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-17T03:00:03.760Z"); return t}()),
// 		Status: to.Ptr("Started"),
// 		SubscriptionID: to.Ptr("62b829ee-7936-40c9-a1c9-47a93f9f3965"),
// 		SupportedActions: []*string{
// 		},
// 		VaultName: to.Ptr("BugBashVaultForCCYv11"),
// 	},
// }

Output:

func (*JobsClient) NewListPager 

func (client *JobsClient) NewListPager(resourceGroupName string, vaultName string, options *JobsClientListOptions) *runtime.Pager[JobsClientListResponse]

NewListPager - Returns list of jobs belonging to a backup vault

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • options - JobsClientListOptions contains the optional parameters for the JobsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/JobCRUD/ListJobs.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewJobsClient().NewListPager("BugBash1", "BugBashVaultForCCYv11", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.AzureBackupJobResourceList = armdataprotection.AzureBackupJobResourceList{
	// 	Value: []*armdataprotection.AzureBackupJobResource{
	// 		{
	// 			Name: to.Ptr("8989416e-7573-4836-8cf1-0e90954f1002"),
	// 			Type: to.Ptr("Microsoft.DataProtection/Backupvaults/backupJobs"),
	// 			ID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/8989416e-7573-4836-8cf1-0e90954f1002"),
	// 			Properties: &armdataprotection.AzureBackupJob{
	// 				ActivityID: to.Ptr("932925c4-3d81-4550-8105-c7f7b0a934c5"),
	// 				BackupInstanceFriendlyName: to.Ptr("mabtestingccybasicv11\\bugbashdb4"),
	// 				BackupInstanceID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/3048870f-b1b7-44c4-b078-368da3fd000e"),
	// 				DataSourceID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb4"),
	// 				DataSourceLocation: to.Ptr("centraluseuap"),
	// 				DataSourceName: to.Ptr("bugbashdb4"),
	// 				DataSourceSetName: to.Ptr("mabtestingccybasicv11"),
	// 				DataSourceType: to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
	// 				Duration: to.Ptr("00:00:00"),
	// 				IsUserTriggered: to.Ptr(false),
	// 				Operation: to.Ptr("Backup"),
	// 				OperationCategory: to.Ptr("Backup"),
	// 				PolicyID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy2"),
	// 				PolicyName: to.Ptr("jakavetPolicy2"),
	// 				ProgressEnabled: to.Ptr(false),
	// 				SourceResourceGroup: to.Ptr("DppPostgresTestingCcy"),
	// 				SourceSubscriptionID: to.Ptr("62b829ee-7936-40c9-a1c9-47a93f9f3965"),
	// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-16T05:00:08.174Z"); return t}()),
	// 				Status: to.Ptr("Started"),
	// 				SubscriptionID: to.Ptr("62b829ee-7936-40c9-a1c9-47a93f9f3965"),
	// 				SupportedActions: []*string{
	// 				},
	// 				VaultName: to.Ptr("BugBashVaultForCCYv11"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("ad218c05-242a-47c2-b7b7-c16bd0f8870c"),
	// 			Type: to.Ptr("Microsoft.DataProtection/Backupvaults/backupJobs"),
	// 			ID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/ad218c05-242a-47c2-b7b7-c16bd0f8870c"),
	// 			Properties: &armdataprotection.AzureBackupJob{
	// 				ActivityID: to.Ptr("b4f32e03-ded0-46fc-9afc-91853878efcd"),
	// 				BackupInstanceFriendlyName: to.Ptr("mabtestingccybasicv11\\bugbashdb5"),
	// 				BackupInstanceID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/943c60db-c033-4d93-bb00-66048474e00e"),
	// 				DataSourceID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb5"),
	// 				DataSourceLocation: to.Ptr("centraluseuap"),
	// 				DataSourceName: to.Ptr("bugbashdb5"),
	// 				DataSourceSetName: to.Ptr("mabtestingccybasicv11"),
	// 				DataSourceType: to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
	// 				Duration: to.Ptr("00:00:00"),
	// 				IsUserTriggered: to.Ptr(false),
	// 				Operation: to.Ptr("Backup"),
	// 				OperationCategory: to.Ptr("Backup"),
	// 				PolicyID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy3"),
	// 				PolicyName: to.Ptr("jakavetPolicy3"),
	// 				ProgressEnabled: to.Ptr(false),
	// 				SourceResourceGroup: to.Ptr("DppPostgresTestingCcy"),
	// 				SourceSubscriptionID: to.Ptr("62b829ee-7936-40c9-a1c9-47a93f9f3965"),
	// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-16T18:00:03.666Z"); return t}()),
	// 				Status: to.Ptr("Started"),
	// 				SubscriptionID: to.Ptr("62b829ee-7936-40c9-a1c9-47a93f9f3965"),
	// 				SupportedActions: []*string{
	// 				},
	// 				VaultName: to.Ptr("BugBashVaultForCCYv11"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("3c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
	// 			Type: to.Ptr("Microsoft.DataProtection/Backupvaults/backupJobs"),
	// 			ID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/3c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
	// 			Properties: &armdataprotection.AzureBackupJob{
	// 				ActivityID: to.Ptr("c4344fb4-7c11-43a4-8307-7ae7c7fb09b9"),
	// 				BackupInstanceFriendlyName: to.Ptr("mabtestingccybasicv11\\bugbashdb2"),
	// 				BackupInstanceID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/28460a9d-707a-45f3-ace6-b16284c2900e"),
	// 				DataSourceID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb2"),
	// 				DataSourceLocation: to.Ptr("centraluseuap"),
	// 				DataSourceName: to.Ptr("bugbashdb2"),
	// 				DataSourceSetName: to.Ptr("mabtestingccybasicv11"),
	// 				DataSourceType: to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
	// 				Duration: to.Ptr("00:00:00"),
	// 				IsUserTriggered: to.Ptr(false),
	// 				Operation: to.Ptr("Backup"),
	// 				OperationCategory: to.Ptr("Backup"),
	// 				PolicyID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetdailypolicy"),
	// 				PolicyName: to.Ptr("jakavetdailypolicy"),
	// 				ProgressEnabled: to.Ptr(false),
	// 				SourceResourceGroup: to.Ptr("DppPostgresTestingCcy"),
	// 				SourceSubscriptionID: to.Ptr("62b829ee-7936-40c9-a1c9-47a93f9f3965"),
	// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-17T03:00:03.760Z"); return t}()),
	// 				Status: to.Ptr("Started"),
	// 				SubscriptionID: to.Ptr("62b829ee-7936-40c9-a1c9-47a93f9f3965"),
	// 				SupportedActions: []*string{
	// 				},
	// 				VaultName: to.Ptr("BugBashVaultForCCYv11"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("43252662-1b43-44fd-a856-0055665cb097"),
	// 			Type: to.Ptr("Microsoft.DataProtection/Backupvaults/backupJobs"),
	// 			ID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/43252662-1b43-44fd-a856-0055665cb097"),
	// 			Properties: &armdataprotection.AzureBackupJob{
	// 				ActivityID: to.Ptr("94052cf1-a47f-4c1b-93e7-79e07b2bd008-Tue Mar 17 2021 11:11:48 GMT+0530 (India Standard Time)-Ibz"),
	// 				BackupInstanceFriendlyName: to.Ptr("mabtestingccybasicv11\\bugbashdb3"),
	// 				BackupInstanceID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/0b247869-b8be-4885-b832-8ac4cdf5b00e"),
	// 				DataSourceID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb3"),
	// 				DataSourceLocation: to.Ptr("centraluseuap"),
	// 				DataSourceName: to.Ptr("bugbashdb3"),
	// 				DataSourceSetName: to.Ptr("mabtestingccybasicv11"),
	// 				DataSourceType: to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
	// 				Duration: to.Ptr("00:02:11.9724387"),
	// 				EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-17T11:14:02.531Z"); return t}()),
	// 				IsUserTriggered: to.Ptr(true),
	// 				Operation: to.Ptr("Backup"),
	// 				OperationCategory: to.Ptr("Backup"),
	// 				PolicyID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy1"),
	// 				PolicyName: to.Ptr("jakavetPolicy1"),
	// 				ProgressEnabled: to.Ptr(false),
	// 				SourceResourceGroup: to.Ptr("DppPostgresTestingCcy"),
	// 				SourceSubscriptionID: to.Ptr("62b829ee-7936-40c9-a1c9-47a93f9f3965"),
	// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-17T11:11:50.559Z"); return t}()),
	// 				Status: to.Ptr("Succeeded"),
	// 				SubscriptionID: to.Ptr("62b829ee-7936-40c9-a1c9-47a93f9f3965"),
	// 				SupportedActions: []*string{
	// 					to.Ptr("")},
	// 					VaultName: to.Ptr("BugBashVaultForCCYv11"),
	// 				},
	// 		}},
	// 	}
}

Output:

type JobsClientGetOptions 

type JobsClientGetOptions struct {
}

JobsClientGetOptions contains the optional parameters for the JobsClient.Get method.

type JobsClientGetResponse 

type JobsClientGetResponse struct {
	// AzureBackup Job Resource Class
	AzureBackupJobResource
}

JobsClientGetResponse contains the response from method JobsClient.Get.

type JobsClientListOptions 

type JobsClientListOptions struct {
}

JobsClientListOptions contains the optional parameters for the JobsClient.NewListPager method.

type JobsClientListResponse 

type JobsClientListResponse struct {
	// List of AzureBackup Job resources
	AzureBackupJobResourceList
}

JobsClientListResponse contains the response from method JobsClient.NewListPager.

type KubernetesClusterBackupDatasourceParameters 

type KubernetesClusterBackupDatasourceParameters struct {
	// REQUIRED; Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources
	// during backup.
	IncludeClusterScopeResources *bool

	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string

	// REQUIRED; Gets or sets the volume snapshot property. This property if enabled will take volume snapshots during backup.
	SnapshotVolumes *bool

	// Gets or sets the backup hook references. This property sets the hook reference to be executed during backup.
	BackupHookReferences []*NamespacedNameResource

	// Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during backup.
	ExcludedNamespaces []*string

	// Gets or sets the exclude resource types property. This property sets the resource types to be excluded during backup.
	ExcludedResourceTypes []*string

	// Gets or sets the include namespaces property. This property sets the namespaces to be included during backup.
	IncludedNamespaces []*string

	// Gets or sets the include resource types property. This property sets the resource types to be included during backup.
	IncludedResourceTypes []*string

	// Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during
	// backup.
	LabelSelectors []*string
}

KubernetesClusterBackupDatasourceParameters - Parameters for Kubernetes Cluster Backup Datasource

func (*KubernetesClusterBackupDatasourceParameters) GetBackupDatasourceParameters 

func (k *KubernetesClusterBackupDatasourceParameters) GetBackupDatasourceParameters() *BackupDatasourceParameters

GetBackupDatasourceParameters implements the BackupDatasourceParametersClassification interface for type KubernetesClusterBackupDatasourceParameters.

func (KubernetesClusterBackupDatasourceParameters) MarshalJSON 

func (k KubernetesClusterBackupDatasourceParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KubernetesClusterBackupDatasourceParameters.

func (*KubernetesClusterBackupDatasourceParameters) UnmarshalJSON 

func (k *KubernetesClusterBackupDatasourceParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KubernetesClusterBackupDatasourceParameters.

type KubernetesClusterRestoreCriteria 

type KubernetesClusterRestoreCriteria struct {
	// REQUIRED; Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources
	// during restore.
	IncludeClusterScopeResources *bool

	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string

	// Gets or sets the Conflict Policy property. This property sets policy during conflict of resources during restore.
	ConflictPolicy *ExistingResourcePolicy

	// Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during restore.
	ExcludedNamespaces []*string

	// Gets or sets the exclude resource types property. This property sets the resource types to be excluded during restore.
	ExcludedResourceTypes []*string

	// Gets or sets the include namespaces property. This property sets the namespaces to be included during restore.
	IncludedNamespaces []*string

	// Gets or sets the include resource types property. This property sets the resource types to be included during restore.
	IncludedResourceTypes []*string

	// Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during
	// restore.
	LabelSelectors []*string

	// Gets or sets the Namespace Mappings property. This property sets if namespace needs to be change during restore.
	NamespaceMappings map[string]*string

	// Gets or sets the PV (Persistent Volume) Restore Mode property. This property sets whether volumes needs to be restored.
	PersistentVolumeRestoreMode *PersistentVolumeRestoreMode

	// Gets or sets the resource modifier reference. This property sets the reference for resource modifier during restore.
	ResourceModifierReference *NamespacedNameResource

	// Gets or sets the restore hook references. This property sets the hook reference to be executed during restore.
	RestoreHookReferences []*NamespacedNameResource
}

KubernetesClusterRestoreCriteria - kubernetes Cluster Backup target info for restore operation

func (*KubernetesClusterRestoreCriteria) GetItemLevelRestoreCriteria 

func (k *KubernetesClusterRestoreCriteria) GetItemLevelRestoreCriteria() *ItemLevelRestoreCriteria

GetItemLevelRestoreCriteria implements the ItemLevelRestoreCriteriaClassification interface for type KubernetesClusterRestoreCriteria.

func (KubernetesClusterRestoreCriteria) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type KubernetesClusterRestoreCriteria.

func (*KubernetesClusterRestoreCriteria) UnmarshalJSON 

func (k *KubernetesClusterRestoreCriteria) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KubernetesClusterRestoreCriteria.

type KubernetesClusterVaultTierRestoreCriteria 

type KubernetesClusterVaultTierRestoreCriteria struct {
	// REQUIRED; Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources
	// during restore from vault.
	IncludeClusterScopeResources *bool

	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string

	// Gets or sets the Conflict Policy property. This property sets policy during conflict of resources during restore from vault.
	ConflictPolicy *ExistingResourcePolicy

	// Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during restore from vault.
	ExcludedNamespaces []*string

	// Gets or sets the exclude resource types property. This property sets the resource types to be excluded during restore from
	// vault.
	ExcludedResourceTypes []*string

	// Gets or sets the include namespaces property. This property sets the namespaces to be included during restore from vault.
	IncludedNamespaces []*string

	// Gets or sets the include resource types property. This property sets the resource types to be included during restore from
	// vault.
	IncludedResourceTypes []*string

	// Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during
	// restore from vault.
	LabelSelectors []*string

	// Gets or sets the Namespace Mappings property. This property sets if namespace needs to be change during restore from vault.
	NamespaceMappings map[string]*string

	// Gets or sets the PV (Persistent Volume) Restore Mode property. This property sets whether volumes needs to be restored
	// from vault.
	PersistentVolumeRestoreMode *PersistentVolumeRestoreMode

	// Gets or sets the resource modifier reference. This property sets the reference for resource modifier during restore.
	ResourceModifierReference *NamespacedNameResource

	// Gets or sets the restore hook references. This property sets the hook reference to be executed during restore from vault.
	RestoreHookReferences []*NamespacedNameResource

	// Gets or sets the staging RG Id for creating staging disks and snapshots during restore from vault.
	StagingResourceGroupID *string

	// Gets or sets the staging Storage Account Id for creating backup extension object store data during restore from vault.
	StagingStorageAccountID *string
}

KubernetesClusterVaultTierRestoreCriteria - kubernetes Cluster Backup target info for restore operation from vault

func (*KubernetesClusterVaultTierRestoreCriteria) GetItemLevelRestoreCriteria 

func (k *KubernetesClusterVaultTierRestoreCriteria) GetItemLevelRestoreCriteria() *ItemLevelRestoreCriteria

GetItemLevelRestoreCriteria implements the ItemLevelRestoreCriteriaClassification interface for type KubernetesClusterVaultTierRestoreCriteria.

func (KubernetesClusterVaultTierRestoreCriteria) MarshalJSON 

func (k KubernetesClusterVaultTierRestoreCriteria) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KubernetesClusterVaultTierRestoreCriteria.

func (*KubernetesClusterVaultTierRestoreCriteria) UnmarshalJSON 

func (k *KubernetesClusterVaultTierRestoreCriteria) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KubernetesClusterVaultTierRestoreCriteria.

type KubernetesPVRestoreCriteria 

type KubernetesPVRestoreCriteria struct {
	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string

	// Selected persistent volume claim name
	Name *string

	// Selected storage class name for restore operation
	StorageClassName *string
}

KubernetesPVRestoreCriteria - Item Level kubernetes persistent volume target info for restore operation

func (*KubernetesPVRestoreCriteria) GetItemLevelRestoreCriteria 

func (k *KubernetesPVRestoreCriteria) GetItemLevelRestoreCriteria() *ItemLevelRestoreCriteria

GetItemLevelRestoreCriteria implements the ItemLevelRestoreCriteriaClassification interface for type KubernetesPVRestoreCriteria.

func (KubernetesPVRestoreCriteria) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type KubernetesPVRestoreCriteria.

func (*KubernetesPVRestoreCriteria) UnmarshalJSON 

func (k *KubernetesPVRestoreCriteria) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KubernetesPVRestoreCriteria.

type KubernetesStorageClassRestoreCriteria 

type KubernetesStorageClassRestoreCriteria struct {
	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string

	// Provisioner of the storage class
	Provisioner *string

	// Selected storage class name
	SelectedStorageClassName *string
}

KubernetesStorageClassRestoreCriteria - Item Level kubernetes storage class target info for restore operation

func (*KubernetesStorageClassRestoreCriteria) GetItemLevelRestoreCriteria 

func (k *KubernetesStorageClassRestoreCriteria) GetItemLevelRestoreCriteria() *ItemLevelRestoreCriteria

GetItemLevelRestoreCriteria implements the ItemLevelRestoreCriteriaClassification interface for type KubernetesStorageClassRestoreCriteria.

func (KubernetesStorageClassRestoreCriteria) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type KubernetesStorageClassRestoreCriteria.

func (*KubernetesStorageClassRestoreCriteria) UnmarshalJSON 

func (k *KubernetesStorageClassRestoreCriteria) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KubernetesStorageClassRestoreCriteria.

type MonitoringSettings 

type MonitoringSettings struct {
	// Settings for Azure Monitor based alerts
	AzureMonitorAlertSettings *AzureMonitorAlertSettings
}

MonitoringSettings - Monitoring Settings

func (MonitoringSettings) MarshalJSON 

func (m MonitoringSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MonitoringSettings.

func (*MonitoringSettings) UnmarshalJSON 

func (m *MonitoringSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MonitoringSettings.

type Month 

type Month string
const (
	MonthApril     Month = "April"
	MonthAugust    Month = "August"
	MonthDecember  Month = "December"
	MonthFebruary  Month = "February"
	MonthJanuary   Month = "January"
	MonthJuly      Month = "July"
	MonthJune      Month = "June"
	MonthMarch     Month = "March"
	MonthMay       Month = "May"
	MonthNovember  Month = "November"
	MonthOctober   Month = "October"
	MonthSeptember Month = "September"
)

func PossibleMonthValues 

func PossibleMonthValues() []Month

PossibleMonthValues returns the possible values for the Month const type.

type NamespacedNameResource 

type NamespacedNameResource struct {
	// Name of the resource
	Name *string

	// Namespace in which the resource exists
	Namespace *string
}

NamespacedNameResource - Class to refer resources which contains namespace and name

func (NamespacedNameResource) MarshalJSON 

func (n NamespacedNameResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NamespacedNameResource.

func (*NamespacedNameResource) UnmarshalJSON 

func (n *NamespacedNameResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NamespacedNameResource.

type OperationExtendedInfo 

type OperationExtendedInfo struct {
	// REQUIRED; This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
	ObjectType *string
}

OperationExtendedInfo - Operation Extended Info

func (*OperationExtendedInfo) GetOperationExtendedInfo 

func (o *OperationExtendedInfo) GetOperationExtendedInfo() *OperationExtendedInfo

GetOperationExtendedInfo implements the OperationExtendedInfoClassification interface for type OperationExtendedInfo.

func (OperationExtendedInfo) MarshalJSON 

func (o OperationExtendedInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationExtendedInfo.

func (*OperationExtendedInfo) UnmarshalJSON 

func (o *OperationExtendedInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationExtendedInfo.

type OperationExtendedInfoClassification 

type OperationExtendedInfoClassification interface {
	// GetOperationExtendedInfo returns the OperationExtendedInfo content of the underlying type.
	GetOperationExtendedInfo() *OperationExtendedInfo
}

OperationExtendedInfoClassification provides polymorphic access to related types. Call the interface's GetOperationExtendedInfo() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *OperationExtendedInfo, *OperationJobExtendedInfo

type OperationJobExtendedInfo 

type OperationJobExtendedInfo struct {
	// REQUIRED; This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
	ObjectType *string

	// Name or Arm Id of the job created for this operation.
	JobID *string
}

OperationJobExtendedInfo - Operation Job Extended Info

func (*OperationJobExtendedInfo) GetOperationExtendedInfo 

func (o *OperationJobExtendedInfo) GetOperationExtendedInfo() *OperationExtendedInfo

GetOperationExtendedInfo implements the OperationExtendedInfoClassification interface for type OperationJobExtendedInfo.

func (OperationJobExtendedInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type OperationJobExtendedInfo.

func (*OperationJobExtendedInfo) UnmarshalJSON 

func (o *OperationJobExtendedInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationJobExtendedInfo.

type OperationResource 

type OperationResource struct {
	// End time of the operation
	EndTime *time.Time

	// Required if status == failed or status == canceled. This is the OData v4 error format, used by the RPC and will go into
	// the v2.2 Azure REST API guidelines. The full set of optional properties (e.g.
	// inner errors / details) can be found in the "Error Response" section.
	Error *Error

	// It should match what is used to GET the operation result
	ID *string

	// It must match the last segment of the "id" field, and will typically be a GUID / system generated value
	Name *string

	// End time of the operation
	Properties OperationExtendedInfoClassification

	// Start time of the operation
	StartTime *time.Time
	Status    *string
}

OperationResource - Operation Resource

func (OperationResource) MarshalJSON 

func (o OperationResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationResource.

func (*OperationResource) UnmarshalJSON 

func (o *OperationResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationResource.

type OperationResultClient 

type OperationResultClient struct {
	// contains filtered or unexported fields
}

OperationResultClient contains the methods for the OperationResult group. Don't use this type directly, use NewOperationResultClient() instead.

func NewOperationResultClient 

func NewOperationResultClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationResultClient, error)

NewOperationResultClient creates a new instance of OperationResultClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*OperationResultClient) Get 

func (client *OperationResultClient) Get(ctx context.Context, operationID string, location string, options *OperationResultClientGetOptions) (OperationResultClientGetResponse, error)

Get - Gets the operation result for a resource If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • options - OperationResultClientGetOptions contains the optional parameters for the OperationResultClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/GetOperationResult.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewOperationResultClient().Get(ctx, "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", "WestUS", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.OperationJobExtendedInfo = armdataprotection.OperationJobExtendedInfo{
// 	ObjectType: to.Ptr("OperationJobExtendedInfo"),
// 	JobID: to.Ptr("c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
// }

Output:

type OperationResultClientGetOptions 

type OperationResultClientGetOptions struct {
}

OperationResultClientGetOptions contains the optional parameters for the OperationResultClient.Get method.

type OperationResultClientGetResponse 

type OperationResultClientGetResponse struct {
	// Operation Job Extended Info
	OperationJobExtendedInfo

	// AzureAsyncOperation contains the information returned from the Azure-AsyncOperation header response.
	AzureAsyncOperation *string

	// Location contains the information returned from the Location header response.
	Location *string

	// RetryAfter contains the information returned from the Retry-After header response.
	RetryAfter *int32
}

OperationResultClientGetResponse contains the response from method OperationResultClient.Get.

type OperationStatusBackupVaultContextClient 

type OperationStatusBackupVaultContextClient struct {
	// contains filtered or unexported fields
}

OperationStatusBackupVaultContextClient contains the methods for the OperationStatusBackupVaultContext group. Don't use this type directly, use NewOperationStatusBackupVaultContextClient() instead.

func NewOperationStatusBackupVaultContextClient 

func NewOperationStatusBackupVaultContextClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationStatusBackupVaultContextClient, error)

NewOperationStatusBackupVaultContextClient creates a new instance of OperationStatusBackupVaultContextClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*OperationStatusBackupVaultContextClient) Get 

func (client *OperationStatusBackupVaultContextClient) Get(ctx context.Context, resourceGroupName string, vaultName string, operationID string, options *OperationStatusBackupVaultContextClientGetOptions) (OperationStatusBackupVaultContextClientGetResponse, error)

Get - Gets the operation status for an operation over a BackupVault's context. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • options - OperationStatusBackupVaultContextClientGetOptions contains the optional parameters for the OperationStatusBackupVaultContextClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/GetOperationStatusVaultContext.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewOperationStatusBackupVaultContextClient().Get(ctx, "SampleResourceGroup", "swaggerExample", "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.OperationResource = armdataprotection.OperationResource{
// 	Name: to.Ptr("MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA=="),
// 	EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-11-20T09:49:46.000Z"); return t}()),
// 	ID: to.Ptr("/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA=="),
// 	StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-11-20T09:49:44.047Z"); return t}()),
// 	Status: to.Ptr("Succeeded"),
// }

Output:

type OperationStatusBackupVaultContextClientGetOptions 

type OperationStatusBackupVaultContextClientGetOptions struct {
}

OperationStatusBackupVaultContextClientGetOptions contains the optional parameters for the OperationStatusBackupVaultContextClient.Get method.

type OperationStatusBackupVaultContextClientGetResponse 

type OperationStatusBackupVaultContextClientGetResponse struct {
	// Operation Resource
	OperationResource
}

OperationStatusBackupVaultContextClientGetResponse contains the response from method OperationStatusBackupVaultContextClient.Get.

type OperationStatusClient 

type OperationStatusClient struct {
	// contains filtered or unexported fields
}

OperationStatusClient contains the methods for the OperationStatus group. Don't use this type directly, use NewOperationStatusClient() instead.

func NewOperationStatusClient 

func NewOperationStatusClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationStatusClient, error)

NewOperationStatusClient creates a new instance of OperationStatusClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*OperationStatusClient) Get 

func (client *OperationStatusClient) Get(ctx context.Context, location string, operationID string, options *OperationStatusClientGetOptions) (OperationStatusClientGetResponse, error)

Get - Gets the operation status for a resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • options - OperationStatusClientGetOptions contains the optional parameters for the OperationStatusClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/GetOperationStatus.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewOperationStatusClient().Get(ctx, "WestUS", "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.OperationResource = armdataprotection.OperationResource{
// 	Name: to.Ptr("MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA=="),
// 	EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-11-20T09:49:46.000Z"); return t}()),
// 	ID: to.Ptr("/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/providers/Microsoft.DataProtection/locations/WestUS/operationStatus/MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA=="),
// 	StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-11-20T09:49:44.047Z"); return t}()),
// 	Status: to.Ptr("Succeeded"),
// }

Output:

type OperationStatusClientGetOptions 

type OperationStatusClientGetOptions struct {
}

OperationStatusClientGetOptions contains the optional parameters for the OperationStatusClient.Get method.

type OperationStatusClientGetResponse 

type OperationStatusClientGetResponse struct {
	// Operation Resource
	OperationResource
}

OperationStatusClientGetResponse contains the response from method OperationStatusClient.Get.

type OperationStatusResourceGroupContextClient 

type OperationStatusResourceGroupContextClient struct {
	// contains filtered or unexported fields
}

OperationStatusResourceGroupContextClient contains the methods for the OperationStatusResourceGroupContext group. Don't use this type directly, use NewOperationStatusResourceGroupContextClient() instead.

func NewOperationStatusResourceGroupContextClient 

func NewOperationStatusResourceGroupContextClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationStatusResourceGroupContextClient, error)

NewOperationStatusResourceGroupContextClient creates a new instance of OperationStatusResourceGroupContextClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*OperationStatusResourceGroupContextClient) Get 

func (client *OperationStatusResourceGroupContextClient) Get(ctx context.Context, resourceGroupName string, operationID string, options *OperationStatusResourceGroupContextClientGetOptions) (OperationStatusResourceGroupContextClientGetResponse, error)

Get - Gets the operation status for an operation over a ResourceGroup's context. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - OperationStatusResourceGroupContextClientGetOptions contains the optional parameters for the OperationStatusResourceGroupContextClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/GetOperationStatusRGContext.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewOperationStatusResourceGroupContextClient().Get(ctx, "SampleResourceGroup", "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.OperationResource = armdataprotection.OperationResource{
// 	Name: to.Ptr("MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA=="),
// 	EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-11-20T09:49:46.000Z"); return t}()),
// 	ID: to.Ptr("/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/operationStatus/MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA=="),
// 	StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-11-20T09:49:44.047Z"); return t}()),
// 	Status: to.Ptr("Succeeded"),
// }

Output:

type OperationStatusResourceGroupContextClientGetOptions 

type OperationStatusResourceGroupContextClientGetOptions struct {
}

OperationStatusResourceGroupContextClientGetOptions contains the optional parameters for the OperationStatusResourceGroupContextClient.Get method.

type OperationStatusResourceGroupContextClientGetResponse 

type OperationStatusResourceGroupContextClientGetResponse struct {
	// Operation Resource
	OperationResource
}

OperationStatusResourceGroupContextClientGetResponse contains the response from method OperationStatusResourceGroupContextClient.Get.

type OperationsClient 

type OperationsClient struct {
	// contains filtered or unexported fields
}

OperationsClient contains the methods for the DataProtectionOperations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

NewOperationsClient creates a new instance of OperationsClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*OperationsClient) NewListPager 

func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]

NewListPager - Returns the list of available operations.

Generated from API version 2024-04-01

  • options - OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/Operations/List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewOperationsClient().NewListPager(nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ClientDiscoveryResponse = armdataprotection.ClientDiscoveryResponse{
	// 	Value: []*armdataprotection.ClientDiscoveryValueForSingleAPI{
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/locations/getBackupStatus/action"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Check Backup Status for Recovery Services Vaults"),
	// 				Operation: to.Ptr("Check Backup Status for Vault"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Status"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances/write"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Creates a Backup Instance"),
	// 				Operation: to.Ptr("Create a Backup Instance"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Instance"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances/delete"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Deletes the Backup Instance"),
	// 				Operation: to.Ptr("Delete Backup Instance"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Instance"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Returns details of the Backup Instance"),
	// 				Operation: to.Ptr("Get Backup Instance Details"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Instance"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Returns all Backup Instances"),
	// 				Operation: to.Ptr("Get Backup Instances"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Instance"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances/backup/action"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Performs Backup on the Backup Instance"),
	// 				Operation: to.Ptr("Backup Backup Instance"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Instance"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances/sync/action"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Sync operation retries last failed operation on backup instance to bring it to a valid state."),
	// 				Operation: to.Ptr("Sync Backup Instance"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Instance"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances/operationResults/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Returns Backup Operation Result for Backup Vault."),
	// 				Operation: to.Ptr("Get Backup Operation Result"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Instance"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances/stopProtection/action"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Stop Protection operation stops both backup and retention schedules of backup instance. Existing data will be retained forever."),
	// 				Operation: to.Ptr("Stop Protection of Backup Instance"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Instance"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances/suspendBackups/action"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Suspend Backups operation stops only backups of backup instance. Retention activities will continue and hence data will be ratained as per policy."),
	// 				Operation: to.Ptr("Suspend Backups of Backup Instance"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Instance"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances/resumeProtection/action"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Resume protection of a ProtectionStopped BI."),
	// 				Operation: to.Ptr("Resume Protection of Backup Instance"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Instance"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances/resumeBackups/action"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Resume Backups for a BackupsSuspended BI."),
	// 				Operation: to.Ptr("Resume Backups of Backup Instance"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Instance"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances/validateRestore/action"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Validates for Restore of the Backup Instance"),
	// 				Operation: to.Ptr("Validate for Restore of Backup Instance"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Instance"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances/restore/action"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Triggers restore on the Backup Instance"),
	// 				Operation: to.Ptr("Restore Backup Instance"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Instance"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupPolicies/write"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Creates Backup Policy"),
	// 				Operation: to.Ptr("Create Backup Policy"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Policies"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupPolicies/delete"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Deletes the Backup Policy"),
	// 				Operation: to.Ptr("Delete Backup Policy"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Policies"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupPolicies/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Returns details of the Backup Policy"),
	// 				Operation: to.Ptr("Get Backup Policy details"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Policies"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupPolicies/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Returns all Backup Policies"),
	// 				Operation: to.Ptr("Get Backup Policies"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Policies"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Get the list of ResourceGuard proxies for a resource"),
	// 				Operation: to.Ptr("Get the list of ResourceGuard proxies for a resource"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Resource Guard Proxy"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Get ResourceGuard proxy operation gets an object representing the Azure resource of type 'ResourceGuard proxy'"),
	// 				Operation: to.Ptr("Get ResourceGuard proxy"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Resource Guard Proxy"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/write"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Create ResourceGuard proxy operation creates an Azure resource of type 'ResourceGuard Proxy'"),
	// 				Operation: to.Ptr("Create ResourceGuard proxy"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Resource Guard Proxy"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/delete"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("The Delete ResourceGuard proxy operation deletes the specified Azure resource of type 'ResourceGuard proxy'"),
	// 				Operation: to.Ptr("Delete ResourceGuard proxy"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Resource Guard Proxy"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/unlockDelete/action"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Unlock delete ResourceGuard proxy operation unlocks the next delete critical operation"),
	// 				Operation: to.Ptr("Unlock delete ResourceGuard proxy operation unlocks the next delete critical operation"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Resource Guard Proxy"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Returns details of the Recovery Point"),
	// 				Operation: to.Ptr("Get Recovery Point Details"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Recovery Points"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Returns all Recovery Points"),
	// 				Operation: to.Ptr("Get Recovery Points"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Recovery Points"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances/findRestorableTimeRanges/action"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Finds Restorable Time Ranges"),
	// 				Operation: to.Ptr("Find Restorable Time Ranges"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Restorable Time Ranges"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/write"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Create BackupVault operation creates an Azure resource of type 'Backup Vault'"),
	// 				Operation: to.Ptr("Create Backup Vault"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Vaults"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Create BackupVault operation creates an Azure resource of type 'Backup Vault'"),
	// 				Operation: to.Ptr("Create Backup Vault"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Vaults"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/delete"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Create BackupVault operation creates an Azure resource of type 'Backup Vault'"),
	// 				Operation: to.Ptr("Create Backup Vault"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Vaults"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/operationResults/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Gets Operation Result of a Patch Operation for a Backup Vault"),
	// 				Operation: to.Ptr("Get Operation Result of a Patch Operation for a Backup Vault"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Vaults"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/locations/checkNameAvailability/action"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Checks if the requested BackupVault Name is Available"),
	// 				Operation: to.Ptr("Check if the requested BackupVault Name is Available"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Vaults"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Gets list of Backup Vaults in a Resource Group"),
	// 				Operation: to.Ptr("Get Backup Vaults in a Resource Group"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Vaults"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Gets list of Backup Vaults in a Subscription"),
	// 				Operation: to.Ptr("Get Backup Vaults in a Subscription"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Vaults"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/write"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Create ResourceGuard operation creates an Azure resource of type 'ResourceGuard'"),
	// 				Operation: to.Ptr("Create ResourceGuard"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Resource Guards"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("The Get ResourceGuard operation gets an object representing the Azure resource of type 'ResourceGuard'"),
	// 				Operation: to.Ptr("Get ResourceGuard"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Resource Guards"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/delete"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("The Delete ResourceGuard operation deletes the specified Azure resource of type 'ResourceGuard'"),
	// 				Operation: to.Ptr("Delete ResourceGuard"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Resource Guards"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Gets list of ResourceGuards in a Resource Group"),
	// 				Operation: to.Ptr("Get ResourceGuards in a Resource Group"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Resource Guards"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/subscriptions/providers/resourceGuards/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Gets list of ResourceGuards in a Subscription"),
	// 				Operation: to.Ptr("Get ResourceGuards in a Subscription"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Resource Guards"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/write"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Update ResouceGuard operation updates an Azure resource of type 'ResourceGuard'"),
	// 				Operation: to.Ptr("Update ResourceGuard"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Resource Guards"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/{operationName}/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Gets ResourceGuard operation request info"),
	// 				Operation: to.Ptr("Get ResourceGuard operation request info"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Resource Guards"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/{operationName}/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Gets ResourceGuard default operation request info"),
	// 				Operation: to.Ptr("Get ResourceGuard default operation request info"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Resource Guards"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/subscriptions/providers/locations/checkFeatureSupport/action"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Validates if a feature is supported"),
	// 				Operation: to.Ptr("Validate if a feature is supported"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Resource Provider Operation"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/locations/operationStatus/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Returns Backup Operation Status for Backup Vault."),
	// 				Operation: to.Ptr("Get Backup Operation Status"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Operation Status"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/operationStatus/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Returns Backup Operation Status for Backup Vault."),
	// 				Operation: to.Ptr("Get Backup Operation Status"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Operation Status"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/subscriptions/resourceGroups/providers/operationStatus/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Returns Backup Operation Status for Backup Vault."),
	// 				Operation: to.Ptr("Get Backup Operation Status"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Operation Status"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/locations/operationResults/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Returns Backup Operation Result for Backup Vault."),
	// 				Operation: to.Ptr("Get Backup Operation Result"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Operation Results"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/validateForBackup/action"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Validates for backup of Backup Instance"),
	// 				Operation: to.Ptr("Validate for backup of Backup Instance"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Validate Backup"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/backupVaults/backupJobs/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Get Jobs list"),
	// 				Operation: to.Ptr("Backup Jobs"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Jobs"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.RecoveryServices/Vaults/backupJobs/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Get Job details"),
	// 				Operation: to.Ptr("Backup Job Object"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Backup Jobs"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/register/action"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Registers subscription for given Resource Provider"),
	// 				Operation: to.Ptr("Register Resource Provider"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Resource Provider Operation"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/unregister/action"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Unregisters subscription for given Resource Provider"),
	// 				Operation: to.Ptr("Unregister Resource Provider"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Resource Provider Operation"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DataProtection/operations/read"),
	// 			Display: &armdataprotection.ClientDiscoveryDisplay{
	// 				Description: to.Ptr("Operation returns the list of Operations for a Resource Provider"),
	// 				Operation: to.Ptr("List of Operations"),
	// 				Provider: to.Ptr("Microsoft.DataProtection"),
	// 				Resource: to.Ptr("Resource Provider Operation"),
	// 			},
	// 			Origin: to.Ptr("user"),
	// 	}},
	// }
}

Output:

type OperationsClientListOptions 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.

type OperationsClientListResponse 

type OperationsClientListResponse struct {
	// Operations List response which contains list of available APIs.
	ClientDiscoveryResponse
}

OperationsClientListResponse contains the response from method OperationsClient.NewListPager.

type PatchBackupVaultInput 

type PatchBackupVaultInput struct {
	// Feature Settings
	FeatureSettings *FeatureSettings

	// Monitoring Settings
	MonitoringSettings *MonitoringSettings

	// ResourceGuardOperationRequests on which LAC check will be performed
	ResourceGuardOperationRequests []*string

	// Security Settings
	SecuritySettings *SecuritySettings
}

PatchBackupVaultInput - Backup Vault Contract for Patch Backup Vault API.

func (PatchBackupVaultInput) MarshalJSON 

func (p PatchBackupVaultInput) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PatchBackupVaultInput.

func (*PatchBackupVaultInput) UnmarshalJSON 

func (p *PatchBackupVaultInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PatchBackupVaultInput.

type PatchResourceGuardInput 

type PatchResourceGuardInput struct {
	// Resource Guard tags.
	Tags map[string]*string
}

PatchResourceGuardInput - Patch Request content for Microsoft.DataProtection Resource Guard resources

func (PatchResourceGuardInput) MarshalJSON 

func (p PatchResourceGuardInput) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PatchResourceGuardInput.

func (*PatchResourceGuardInput) UnmarshalJSON 

func (p *PatchResourceGuardInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PatchResourceGuardInput.

type PatchResourceRequestInput 

type PatchResourceRequestInput struct {
	// Input Managed Identity Details
	Identity *DppIdentityDetails

	// Resource properties.
	Properties *PatchBackupVaultInput

	// Resource tags.
	Tags map[string]*string
}

PatchResourceRequestInput - Patch Request content for Microsoft.DataProtection resources

func (PatchResourceRequestInput) MarshalJSON 

func (p PatchResourceRequestInput) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PatchResourceRequestInput.

func (*PatchResourceRequestInput) UnmarshalJSON 

func (p *PatchResourceRequestInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PatchResourceRequestInput.

type PersistentVolumeRestoreMode 

type PersistentVolumeRestoreMode string

PersistentVolumeRestoreMode - Gets or sets the PV (Persistent Volume) Restore Mode property. This property sets whether volumes needs to be restored. 

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

func PossiblePersistentVolumeRestoreModeValues 

func PossiblePersistentVolumeRestoreModeValues() []PersistentVolumeRestoreMode

PossiblePersistentVolumeRestoreModeValues returns the possible values for the PersistentVolumeRestoreMode const type.

type PolicyInfo 

type PolicyInfo struct {
	// REQUIRED
	PolicyID *string

	// Policy parameters for the backup instance
	PolicyParameters *PolicyParameters

	// READ-ONLY
	PolicyVersion *string
}

PolicyInfo - Policy Info in backupInstance

func (PolicyInfo) MarshalJSON 

func (p PolicyInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PolicyInfo.

func (*PolicyInfo) UnmarshalJSON 

func (p *PolicyInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PolicyInfo.

type PolicyParameters 

type PolicyParameters struct {
	// Gets or sets the Backup Data Source Parameters
	BackupDatasourceParametersList []BackupDatasourceParametersClassification

	// Gets or sets the DataStore Parameters
	DataStoreParametersList []DataStoreParametersClassification
}

PolicyParameters - Parameters in Policy

func (PolicyParameters) MarshalJSON 

func (p PolicyParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PolicyParameters.

func (*PolicyParameters) UnmarshalJSON 

func (p *PolicyParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PolicyParameters.

type ProtectionStatusDetails 

type ProtectionStatusDetails struct {
	// Specifies the protection status error of the resource
	ErrorDetails *UserFacingError

	// Specifies the protection status of the resource
	Status *Status
}

ProtectionStatusDetails - Protection status details

func (ProtectionStatusDetails) MarshalJSON 

func (p ProtectionStatusDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProtectionStatusDetails.

func (*ProtectionStatusDetails) UnmarshalJSON 

func (p *ProtectionStatusDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProtectionStatusDetails.

type ProvisioningState 

type ProvisioningState string

ProvisioningState - Provisioning state of the BackupVault resource 

const (
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateProvisioning ProvisioningState = "Provisioning"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
	ProvisioningStateUnknown      ProvisioningState = "Unknown"
	ProvisioningStateUpdating     ProvisioningState = "Updating"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

type RangeBasedItemLevelRestoreCriteria 

type RangeBasedItemLevelRestoreCriteria struct {
	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string

	// maximum value for range prefix match
	MaxMatchingValue *string

	// minimum value for range prefix match
	MinMatchingValue *string
}

RangeBasedItemLevelRestoreCriteria - Item Level target info for restore operation

func (*RangeBasedItemLevelRestoreCriteria) GetItemLevelRestoreCriteria 

func (r *RangeBasedItemLevelRestoreCriteria) GetItemLevelRestoreCriteria() *ItemLevelRestoreCriteria

GetItemLevelRestoreCriteria implements the ItemLevelRestoreCriteriaClassification interface for type RangeBasedItemLevelRestoreCriteria.

func (RangeBasedItemLevelRestoreCriteria) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RangeBasedItemLevelRestoreCriteria.

func (*RangeBasedItemLevelRestoreCriteria) UnmarshalJSON 

func (r *RangeBasedItemLevelRestoreCriteria) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RangeBasedItemLevelRestoreCriteria.

type RecoveryOption 

type RecoveryOption string

RecoveryOption - Recovery Option 

const (
	RecoveryOptionFailIfExists RecoveryOption = "FailIfExists"
)

func PossibleRecoveryOptionValues 

func PossibleRecoveryOptionValues() []RecoveryOption

PossibleRecoveryOptionValues returns the possible values for the RecoveryOption const type.

type RecoveryPointCompletionState 

type RecoveryPointCompletionState string

RecoveryPointCompletionState - Specifies recovery point completeness. Partial (i.e., only some of the intended items were backed up), or Completed (i.e., ALL intended items were backed up). 

const (
	RecoveryPointCompletionStateCompleted RecoveryPointCompletionState = "Completed"
	RecoveryPointCompletionStatePartial   RecoveryPointCompletionState = "Partial"
)

func PossibleRecoveryPointCompletionStateValues 

func PossibleRecoveryPointCompletionStateValues() []RecoveryPointCompletionState

PossibleRecoveryPointCompletionStateValues returns the possible values for the RecoveryPointCompletionState const type.

type RecoveryPointDataStoreDetails 

type RecoveryPointDataStoreDetails struct {
	CreationTime *time.Time
	ExpiryTime   *time.Time
	ID           *string
	MetaData     *string
	State        *string
	Type         *string
	Visible      *bool

	// READ-ONLY
	RehydrationExpiryTime *time.Time

	// READ-ONLY
	RehydrationStatus *RehydrationStatus
}

RecoveryPointDataStoreDetails - RecoveryPoint datastore details

func (RecoveryPointDataStoreDetails) MarshalJSON 

func (r RecoveryPointDataStoreDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RecoveryPointDataStoreDetails.

func (*RecoveryPointDataStoreDetails) UnmarshalJSON 

func (r *RecoveryPointDataStoreDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RecoveryPointDataStoreDetails.

type RecoveryPointsClient 

type RecoveryPointsClient struct {
	// contains filtered or unexported fields
}

RecoveryPointsClient contains the methods for the RecoveryPoints group. Don't use this type directly, use NewRecoveryPointsClient() instead.

func NewRecoveryPointsClient 

func NewRecoveryPointsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*RecoveryPointsClient, error)

NewRecoveryPointsClient creates a new instance of RecoveryPointsClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*RecoveryPointsClient) Get 

func (client *RecoveryPointsClient) Get(ctx context.Context, resourceGroupName string, vaultName string, backupInstanceName string, recoveryPointID string, options *RecoveryPointsClientGetOptions) (RecoveryPointsClientGetResponse, error)

Get - Gets a Recovery Point using recoveryPointId for a Datasource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • backupInstanceName - The name of the backup instance.
  • options - RecoveryPointsClientGetOptions contains the optional parameters for the RecoveryPointsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/GetRecoveryPoint.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewRecoveryPointsClient().Get(ctx, "000pikumar", "PratikPrivatePreviewVault1", "testInstance1", "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.AzureBackupRecoveryPointResource = armdataprotection.AzureBackupRecoveryPointResource{
// 	Name: to.Ptr("7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25"),
// 	Type: to.Ptr("microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints"),
// 	ID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25"),
// 	Properties: &armdataprotection.AzureBackupDiscreteRecoveryPoint{
// 		ObjectType: to.Ptr("AzureBackupDiscreteRecoveryPoint"),
// 		FriendlyName: to.Ptr("panbha4"),
// 		RecoveryPointDataStoresDetails: []*armdataprotection.RecoveryPointDataStoreDetails{
// 			{
// 				Type: to.Ptr("Snapshot"),
// 				CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00.000Z"); return t}()),
// 				ID: to.Ptr("0ff03512-b333-4509-a6c7-12164c8b1dce"),
// 				MetaData: to.Ptr("123456"),
// 			},
// 			{
// 				Type: to.Ptr("BackupStorage"),
// 				CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00.000Z"); return t}()),
// 				ID: to.Ptr("5d8cfd30-722e-4bab-85f6-4a9d01ffc6f1"),
// 				MetaData: to.Ptr("123456"),
// 		}},
// 		RecoveryPointState: to.Ptr(armdataprotection.RecoveryPointCompletionStateCompleted),
// 		RecoveryPointTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00.000Z"); return t}()),
// 		RecoveryPointType: to.Ptr("Full"),
// 	},
// }

Output:

func (*RecoveryPointsClient) NewListPager 

func (client *RecoveryPointsClient) NewListPager(resourceGroupName string, vaultName string, backupInstanceName string, options *RecoveryPointsClientListOptions) *runtime.Pager[RecoveryPointsClientListResponse]

NewListPager - Returns a list of Recovery Points for a DataSource in a vault.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • backupInstanceName - The name of the backup instance.
  • options - RecoveryPointsClientListOptions contains the optional parameters for the RecoveryPointsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/ListRecoveryPoints.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewRecoveryPointsClient().NewListPager("000pikumar", "PratikPrivatePreviewVault1", "testInstance1", &armdataprotection.RecoveryPointsClientListOptions{Filter: nil,
	SkipToken: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.AzureBackupRecoveryPointResourceList = armdataprotection.AzureBackupRecoveryPointResourceList{
	// 	Value: []*armdataprotection.AzureBackupRecoveryPointResource{
	// 		{
	// 			Name: to.Ptr("7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5e35"),
	// 			Type: to.Ptr("microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints"),
	// 			ID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25"),
	// 			Properties: &armdataprotection.AzureBackupDiscreteRecoveryPoint{
	// 				ObjectType: to.Ptr("AzureBackupDiscreteRecoveryPoint"),
	// 				ExpiryTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-03-01T13:00:00.000Z"); return t}()),
	// 				FriendlyName: to.Ptr("panbha4"),
	// 				RecoveryPointDataStoresDetails: []*armdataprotection.RecoveryPointDataStoreDetails{
	// 					{
	// 						Type: to.Ptr("Snapshot"),
	// 						CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00.000Z"); return t}()),
	// 						ID: to.Ptr("0ff03512-b333-4509-a6c7-12164c8b1dce"),
	// 						MetaData: to.Ptr("123456"),
	// 					},
	// 					{
	// 						Type: to.Ptr("BackupStorage"),
	// 						CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00.000Z"); return t}()),
	// 						ID: to.Ptr("5d8cfd30-722e-4bab-85f6-4a9d01ffc6f1"),
	// 						MetaData: to.Ptr("123456"),
	// 				}},
	// 				RecoveryPointState: to.Ptr(armdataprotection.RecoveryPointCompletionStateCompleted),
	// 				RecoveryPointTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00.000Z"); return t}()),
	// 				RecoveryPointType: to.Ptr("Full"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25"),
	// 			Type: to.Ptr("microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints"),
	// 			ID: to.Ptr("/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25"),
	// 			Properties: &armdataprotection.AzureBackupDiscreteRecoveryPoint{
	// 				ObjectType: to.Ptr("AzureBackupDiscreteRecoveryPoint"),
	// 				FriendlyName: to.Ptr("panbha4"),
	// 				RecoveryPointDataStoresDetails: []*armdataprotection.RecoveryPointDataStoreDetails{
	// 					{
	// 						Type: to.Ptr("Snapshot"),
	// 						CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00.000Z"); return t}()),
	// 						ID: to.Ptr("808cfd30-722e-4bab-85f6-4a9d01ffc6f2"),
	// 						MetaData: to.Ptr("123456"),
	// 					},
	// 					{
	// 						Type: to.Ptr("BackupStorage"),
	// 						CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00.000Z"); return t}()),
	// 						ID: to.Ptr("798cfd30-722e-4bab-85f6-4a9d01ffc6f3"),
	// 						MetaData: to.Ptr("123456"),
	// 				}},
	// 				RecoveryPointState: to.Ptr(armdataprotection.RecoveryPointCompletionStateCompleted),
	// 				RecoveryPointTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-01T13:00:00.000Z"); return t}()),
	// 				RecoveryPointType: to.Ptr("Full"),
	// 			},
	// 	}},
	// }
}

Output:

type RecoveryPointsClientGetOptions 

type RecoveryPointsClientGetOptions struct {
}

RecoveryPointsClientGetOptions contains the optional parameters for the RecoveryPointsClient.Get method.

type RecoveryPointsClientGetResponse 

type RecoveryPointsClientGetResponse struct {
	// Azure backup recoveryPoint resource
	AzureBackupRecoveryPointResource
}

RecoveryPointsClientGetResponse contains the response from method RecoveryPointsClient.Get.

type RecoveryPointsClientListOptions 

type RecoveryPointsClientListOptions struct {
	// OData filter options.
	Filter *string

	// skipToken Filter.
	SkipToken *string
}

RecoveryPointsClientListOptions contains the optional parameters for the RecoveryPointsClient.NewListPager method.

type RecoveryPointsClientListResponse 

type RecoveryPointsClientListResponse struct {
	// Azure backup recoveryPoint resource list
	AzureBackupRecoveryPointResourceList
}

RecoveryPointsClientListResponse contains the response from method RecoveryPointsClient.NewListPager.

type RecoveryPointsFilters 

type RecoveryPointsFilters struct {
	EndDate                 *string
	ExtendedInfo            *bool
	IsVisible               *bool
	RestorePointDataStoreID *string
	RestorePointState       *string
	StartDate               *string
}

func (RecoveryPointsFilters) MarshalJSON 

func (r RecoveryPointsFilters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RecoveryPointsFilters.

func (*RecoveryPointsFilters) UnmarshalJSON 

func (r *RecoveryPointsFilters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RecoveryPointsFilters.

type RehydrationPriority 

type RehydrationPriority string

RehydrationPriority - Priority to be used for rehydration. Values High or Standard 

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

func PossibleRehydrationPriorityValues 

func PossibleRehydrationPriorityValues() []RehydrationPriority

PossibleRehydrationPriorityValues returns the possible values for the RehydrationPriority const type.

type RehydrationStatus 

type RehydrationStatus string
const (
	RehydrationStatusCOMPLETED        RehydrationStatus = "COMPLETED"
	RehydrationStatusCREATEINPROGRESS RehydrationStatus = "CREATE_IN_PROGRESS"
	RehydrationStatusDELETED          RehydrationStatus = "DELETED"
	RehydrationStatusDELETEINPROGRESS RehydrationStatus = "DELETE_IN_PROGRESS"
	RehydrationStatusFAILED           RehydrationStatus = "FAILED"
)

func PossibleRehydrationStatusValues 

func PossibleRehydrationStatusValues() []RehydrationStatus

PossibleRehydrationStatusValues returns the possible values for the RehydrationStatus const type.

type ResourceGuard 

type ResourceGuard struct {
	// List of critical operations which are not protected by this resourceGuard
	VaultCriticalOperationExclusionList []*string

	// READ-ONLY; This flag indicates whether auto approval is allowed or not.
	AllowAutoApprovals *bool

	// READ-ONLY; Description about the pre-req steps to perform all the critical operations.
	Description *string

	// READ-ONLY; Provisioning state of the BackupVault resource
	ProvisioningState *ProvisioningState

	// READ-ONLY; {readonly} List of operation details those are protected by the ResourceGuard resource
	ResourceGuardOperations []*ResourceGuardOperation
}

func (ResourceGuard) MarshalJSON 

func (r ResourceGuard) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceGuard.

func (*ResourceGuard) UnmarshalJSON 

func (r *ResourceGuard) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceGuard.

type ResourceGuardOperation 

type ResourceGuardOperation struct {
	// READ-ONLY; Type of resource request.
	RequestResourceType *string

	// READ-ONLY; Name of the critical operation.
	VaultCriticalOperation *string
}

ResourceGuardOperation - This class contains all the details about a critical operation.

func (ResourceGuardOperation) MarshalJSON 

func (r ResourceGuardOperation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceGuardOperation.

func (*ResourceGuardOperation) UnmarshalJSON 

func (r *ResourceGuardOperation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceGuardOperation.

type ResourceGuardOperationDetail 

type ResourceGuardOperationDetail struct {
	DefaultResourceRequest *string
	VaultCriticalOperation *string
}

ResourceGuardOperationDetail - VaultCritical Operation protected by a resource guard

func (ResourceGuardOperationDetail) MarshalJSON 

func (r ResourceGuardOperationDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceGuardOperationDetail.

func (*ResourceGuardOperationDetail) UnmarshalJSON 

func (r *ResourceGuardOperationDetail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceGuardOperationDetail.

type ResourceGuardProxyBase 

type ResourceGuardProxyBase struct {
	Description                   *string
	LastUpdatedTime               *string
	ResourceGuardOperationDetails []*ResourceGuardOperationDetail
	ResourceGuardResourceID       *string
}

ResourceGuardProxyBase object, used in ResourceGuardProxyBaseResource

func (ResourceGuardProxyBase) MarshalJSON 

func (r ResourceGuardProxyBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceGuardProxyBase.

func (*ResourceGuardProxyBase) UnmarshalJSON 

func (r *ResourceGuardProxyBase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceGuardProxyBase.

type ResourceGuardProxyBaseResource 

type ResourceGuardProxyBaseResource struct {
	// ResourceGuardProxyBaseResource properties
	Properties *ResourceGuardProxyBase

	// READ-ONLY; Resource Id represents the complete path to the resource.
	ID *string

	// READ-ONLY; Resource name associated with the resource.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…
	Type *string
}

ResourceGuardProxyBaseResource object, used for response and request bodies for ResourceGuardProxy APIs

func (ResourceGuardProxyBaseResource) MarshalJSON 

func (r ResourceGuardProxyBaseResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceGuardProxyBaseResource.

func (*ResourceGuardProxyBaseResource) UnmarshalJSON 

func (r *ResourceGuardProxyBaseResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceGuardProxyBaseResource.

type ResourceGuardProxyBaseResourceList 

type ResourceGuardProxyBaseResourceList struct {
	// The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
	NextLink *string

	// List of resources.
	Value []*ResourceGuardProxyBaseResource
}

ResourceGuardProxyBaseResourceList - List of ResourceGuardProxyBase resources

func (ResourceGuardProxyBaseResourceList) MarshalJSON 

func (r ResourceGuardProxyBaseResourceList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceGuardProxyBaseResourceList.

func (*ResourceGuardProxyBaseResourceList) UnmarshalJSON 

func (r *ResourceGuardProxyBaseResourceList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceGuardProxyBaseResourceList.

type ResourceGuardResource 

type ResourceGuardResource struct {
	// Optional ETag.
	ETag *string

	// Resource location.
	Location *string

	// ResourceGuardResource properties
	Properties *ResourceGuard

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Resource Id represents the complete path to the resource.
	ID *string

	// READ-ONLY; Resource name associated with the resource.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…
	Type *string
}

func (ResourceGuardResource) MarshalJSON 

func (r ResourceGuardResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceGuardResource.

func (*ResourceGuardResource) UnmarshalJSON 

func (r *ResourceGuardResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceGuardResource.

type ResourceGuardResourceList 

type ResourceGuardResourceList struct {
	// The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
	NextLink *string

	// List of resources.
	Value []*ResourceGuardResource
}

ResourceGuardResourceList - List of ResourceGuard resources

func (ResourceGuardResourceList) MarshalJSON 

func (r ResourceGuardResourceList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceGuardResourceList.

func (*ResourceGuardResourceList) UnmarshalJSON 

func (r *ResourceGuardResourceList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceGuardResourceList.

type ResourceGuardsClient 

type ResourceGuardsClient struct {
	// contains filtered or unexported fields
}

ResourceGuardsClient contains the methods for the ResourceGuards group. Don't use this type directly, use NewResourceGuardsClient() instead.

func NewResourceGuardsClient 

func NewResourceGuardsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ResourceGuardsClient, error)

NewResourceGuardsClient creates a new instance of ResourceGuardsClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ResourceGuardsClient) Delete 

func (client *ResourceGuardsClient) Delete(ctx context.Context, resourceGroupName string, resourceGuardsName string, options *ResourceGuardsClientDeleteOptions) (ResourceGuardsClientDeleteResponse, error)

Delete - Deletes a ResourceGuard resource from the resource group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • resourceGuardsName - The name of ResourceGuard
  • options - ResourceGuardsClientDeleteOptions contains the optional parameters for the ResourceGuardsClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardCRUD/DeleteResourceGuard.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = clientFactory.NewResourceGuardsClient().Delete(ctx, "SampleResourceGroup", "swaggerExample", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}

Output:

func (*ResourceGuardsClient) Get 

func (client *ResourceGuardsClient) Get(ctx context.Context, resourceGroupName string, resourceGuardsName string, options *ResourceGuardsClientGetOptions) (ResourceGuardsClientGetResponse, error)

Get - Returns a ResourceGuard belonging to a resource group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • resourceGuardsName - The name of ResourceGuard
  • options - ResourceGuardsClientGetOptions contains the optional parameters for the ResourceGuardsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardCRUD/GetResourceGuard.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewResourceGuardsClient().Get(ctx, "SampleResourceGroup", "swaggerExample", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ResourceGuardResource = armdataprotection.ResourceGuardResource{
// 	Name: to.Ptr("ResourceGuardTestNew"),
// 	Type: to.Ptr("Microsoft.DataProtection/resourceGuards"),
// 	ID: to.Ptr("/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew"),
// 	Location: to.Ptr("eastus"),
// 	Tags: map[string]*string{
// 		"TestKey": to.Ptr("TestValue"),
// 	},
// 	Properties: &armdataprotection.ResourceGuard{
// 		Description: to.Ptr("Please take JIT access before performing any of the critical operation"),
// 		AllowAutoApprovals: to.Ptr(true),
// 		ProvisioningState: to.Ptr(armdataprotection.ProvisioningStateSucceeded),
// 		ResourceGuardOperations: []*armdataprotection.ResourceGuardOperation{
// 			{
// 				RequestResourceType: to.Ptr("Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"),
// 				VaultCriticalOperation: to.Ptr("Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete"),
// 			},
// 			{
// 				RequestResourceType: to.Ptr("Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"),
// 				VaultCriticalOperation: to.Ptr("Microsoft.RecoveryServices/vaults/backupconfig/write"),
// 		}},
// 		VaultCriticalOperationExclusionList: []*string{
// 		},
// 	},
// }

Output:

func (*ResourceGuardsClient) GetDefaultBackupSecurityPINRequestsObject 

func (client *ResourceGuardsClient) GetDefaultBackupSecurityPINRequestsObject(ctx context.Context, resourceGroupName string, resourceGuardsName string, requestName string, options *ResourceGuardsClientGetDefaultBackupSecurityPINRequestsObjectOptions) (ResourceGuardsClientGetDefaultBackupSecurityPINRequestsObjectResponse, error)

GetDefaultBackupSecurityPINRequestsObject - Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - ResourceGuardsClientGetDefaultBackupSecurityPINRequestsObjectOptions contains the optional parameters for the ResourceGuardsClient.GetDefaultBackupSecurityPINRequestsObject method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewResourceGuardsClient().GetDefaultBackupSecurityPINRequestsObject(ctx, "SampleResourceGroup", "swaggerExample", "default", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DppBaseResource = armdataprotection.DppBaseResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.DataProtection/resourceGuards/getBackupSecurityPINRequests"),
// 	ID: to.Ptr("subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/getBackupSecurityPINRequests/default"),
// }

Output:

func (*ResourceGuardsClient) GetDefaultDeleteProtectedItemRequestsObject 

func (client *ResourceGuardsClient) GetDefaultDeleteProtectedItemRequestsObject(ctx context.Context, resourceGroupName string, resourceGuardsName string, requestName string, options *ResourceGuardsClientGetDefaultDeleteProtectedItemRequestsObjectOptions) (ResourceGuardsClientGetDefaultDeleteProtectedItemRequestsObjectResponse, error)

GetDefaultDeleteProtectedItemRequestsObject - Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - ResourceGuardsClientGetDefaultDeleteProtectedItemRequestsObjectOptions contains the optional parameters for the ResourceGuardsClient.GetDefaultDeleteProtectedItemRequestsObject method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewResourceGuardsClient().GetDefaultDeleteProtectedItemRequestsObject(ctx, "SampleResourceGroup", "swaggerExample", "default", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DppBaseResource = armdataprotection.DppBaseResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.DataProtection/resourceGuards/deleteProtectedItemRequests"),
// 	ID: to.Ptr("subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/deleteProtectedItemRequests/default"),
// }

Output:

func (*ResourceGuardsClient) GetDefaultDeleteResourceGuardProxyRequestsObject 

func (client *ResourceGuardsClient) GetDefaultDeleteResourceGuardProxyRequestsObject(ctx context.Context, resourceGroupName string, resourceGuardsName string, requestName string, options *ResourceGuardsClientGetDefaultDeleteResourceGuardProxyRequestsObjectOptions) (ResourceGuardsClientGetDefaultDeleteResourceGuardProxyRequestsObjectResponse, error)

GetDefaultDeleteResourceGuardProxyRequestsObject - Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - ResourceGuardsClientGetDefaultDeleteResourceGuardProxyRequestsObjectOptions contains the optional parameters for the ResourceGuardsClient.GetDefaultDeleteResourceGuardProxyRequestsObject method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewResourceGuardsClient().GetDefaultDeleteResourceGuardProxyRequestsObject(ctx, "SampleResourceGroup", "swaggerExample", "default", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DppBaseResource = armdataprotection.DppBaseResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"),
// 	ID: to.Ptr("subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/deleteResourceGuardProxyRequests/default"),
// }

Output:

func (*ResourceGuardsClient) GetDefaultDisableSoftDeleteRequestsObject 

func (client *ResourceGuardsClient) GetDefaultDisableSoftDeleteRequestsObject(ctx context.Context, resourceGroupName string, resourceGuardsName string, requestName string, options *ResourceGuardsClientGetDefaultDisableSoftDeleteRequestsObjectOptions) (ResourceGuardsClientGetDefaultDisableSoftDeleteRequestsObjectResponse, error)

GetDefaultDisableSoftDeleteRequestsObject - Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - ResourceGuardsClientGetDefaultDisableSoftDeleteRequestsObjectOptions contains the optional parameters for the ResourceGuardsClient.GetDefaultDisableSoftDeleteRequestsObject method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewResourceGuardsClient().GetDefaultDisableSoftDeleteRequestsObject(ctx, "SampleResourceGroup", "swaggerExample", "default", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DppBaseResource = armdataprotection.DppBaseResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"),
// 	ID: to.Ptr("subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/disableSoftDeleteRequests/default"),
// }

Output:

func (*ResourceGuardsClient) GetDefaultUpdateProtectedItemRequestsObject 

func (client *ResourceGuardsClient) GetDefaultUpdateProtectedItemRequestsObject(ctx context.Context, resourceGroupName string, resourceGuardsName string, requestName string, options *ResourceGuardsClientGetDefaultUpdateProtectedItemRequestsObjectOptions) (ResourceGuardsClientGetDefaultUpdateProtectedItemRequestsObjectResponse, error)

GetDefaultUpdateProtectedItemRequestsObject - Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - ResourceGuardsClientGetDefaultUpdateProtectedItemRequestsObjectOptions contains the optional parameters for the ResourceGuardsClient.GetDefaultUpdateProtectedItemRequestsObject method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewResourceGuardsClient().GetDefaultUpdateProtectedItemRequestsObject(ctx, "SampleResourceGroup", "swaggerExample", "default", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DppBaseResource = armdataprotection.DppBaseResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.DataProtection/resourceGuards/updateProtectedItemRequests"),
// 	ID: to.Ptr("subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/updateProtectedItemRequests/default"),
// }

Output:

func (*ResourceGuardsClient) GetDefaultUpdateProtectionPolicyRequestsObject 

func (client *ResourceGuardsClient) GetDefaultUpdateProtectionPolicyRequestsObject(ctx context.Context, resourceGroupName string, resourceGuardsName string, requestName string, options *ResourceGuardsClientGetDefaultUpdateProtectionPolicyRequestsObjectOptions) (ResourceGuardsClientGetDefaultUpdateProtectionPolicyRequestsObjectResponse, error)

GetDefaultUpdateProtectionPolicyRequestsObject - Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - ResourceGuardsClientGetDefaultUpdateProtectionPolicyRequestsObjectOptions contains the optional parameters for the ResourceGuardsClient.GetDefaultUpdateProtectionPolicyRequestsObject method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewResourceGuardsClient().GetDefaultUpdateProtectionPolicyRequestsObject(ctx, "SampleResourceGroup", "swaggerExample", "default", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DppBaseResource = armdataprotection.DppBaseResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.DataProtection/resourceGuards/updateProtectionPolicyRequests"),
// 	ID: to.Ptr("subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/updateProtectionPolicyRequests/default"),
// }

Output:

func (*ResourceGuardsClient) NewGetBackupSecurityPINRequestsObjectsPager 

func (client *ResourceGuardsClient) NewGetBackupSecurityPINRequestsObjectsPager(resourceGroupName string, resourceGuardsName string, options *ResourceGuardsClientGetBackupSecurityPINRequestsObjectsOptions) *runtime.Pager[ResourceGuardsClientGetBackupSecurityPINRequestsObjectsResponse]

NewGetBackupSecurityPINRequestsObjectsPager - Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - ResourceGuardsClientGetBackupSecurityPINRequestsObjectsOptions contains the optional parameters for the ResourceGuardsClient.NewGetBackupSecurityPINRequestsObjectsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewResourceGuardsClient().NewGetBackupSecurityPINRequestsObjectsPager("SampleResourceGroup", "swaggerExample", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.DppBaseResourceList = armdataprotection.DppBaseResourceList{
	// 	Value: []*armdataprotection.DppBaseResource{
	// 		{
	// 			Name: to.Ptr("default"),
	// 			Type: to.Ptr("Microsoft.DataProtection/resourceGuards/getBackupSecurityPINRequests"),
	// 			ID: to.Ptr("subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/getBackupSecurityPINRequests/default"),
	// 	}},
	// }
}

Output:

func (*ResourceGuardsClient) NewGetDeleteProtectedItemRequestsObjectsPager 

func (client *ResourceGuardsClient) NewGetDeleteProtectedItemRequestsObjectsPager(resourceGroupName string, resourceGuardsName string, options *ResourceGuardsClientGetDeleteProtectedItemRequestsObjectsOptions) *runtime.Pager[ResourceGuardsClientGetDeleteProtectedItemRequestsObjectsResponse]

NewGetDeleteProtectedItemRequestsObjectsPager - Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - ResourceGuardsClientGetDeleteProtectedItemRequestsObjectsOptions contains the optional parameters for the ResourceGuardsClient.NewGetDeleteProtectedItemRequestsObjectsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewResourceGuardsClient().NewGetDeleteProtectedItemRequestsObjectsPager("SampleResourceGroup", "swaggerExample", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.DppBaseResourceList = armdataprotection.DppBaseResourceList{
	// 	Value: []*armdataprotection.DppBaseResource{
	// 		{
	// 			Name: to.Ptr("default"),
	// 			Type: to.Ptr("Microsoft.DataProtection/resourceGuards/deleteProtectedItemRequests"),
	// 			ID: to.Ptr("subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/deleteProtectedItemRequests/default"),
	// 	}},
	// }
}

Output:

func (*ResourceGuardsClient) NewGetDeleteResourceGuardProxyRequestsObjectsPager 

func (client *ResourceGuardsClient) NewGetDeleteResourceGuardProxyRequestsObjectsPager(resourceGroupName string, resourceGuardsName string, options *ResourceGuardsClientGetDeleteResourceGuardProxyRequestsObjectsOptions) *runtime.Pager[ResourceGuardsClientGetDeleteResourceGuardProxyRequestsObjectsResponse]

NewGetDeleteResourceGuardProxyRequestsObjectsPager - Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - ResourceGuardsClientGetDeleteResourceGuardProxyRequestsObjectsOptions contains the optional parameters for the ResourceGuardsClient.NewGetDeleteResourceGuardProxyRequestsObjectsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewResourceGuardsClient().NewGetDeleteResourceGuardProxyRequestsObjectsPager("SampleResourceGroup", "swaggerExample", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.DppBaseResourceList = armdataprotection.DppBaseResourceList{
	// 	Value: []*armdataprotection.DppBaseResource{
	// 		{
	// 			Name: to.Ptr("default"),
	// 			Type: to.Ptr("Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"),
	// 			ID: to.Ptr("subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/deleteResourceGuardProxyRequests/default"),
	// 	}},
	// }
}

Output:

func (*ResourceGuardsClient) NewGetDisableSoftDeleteRequestsObjectsPager 

func (client *ResourceGuardsClient) NewGetDisableSoftDeleteRequestsObjectsPager(resourceGroupName string, resourceGuardsName string, options *ResourceGuardsClientGetDisableSoftDeleteRequestsObjectsOptions) *runtime.Pager[ResourceGuardsClientGetDisableSoftDeleteRequestsObjectsResponse]

NewGetDisableSoftDeleteRequestsObjectsPager - Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - ResourceGuardsClientGetDisableSoftDeleteRequestsObjectsOptions contains the optional parameters for the ResourceGuardsClient.NewGetDisableSoftDeleteRequestsObjectsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewResourceGuardsClient().NewGetDisableSoftDeleteRequestsObjectsPager("SampleResourceGroup", "swaggerExample", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.DppBaseResourceList = armdataprotection.DppBaseResourceList{
	// 	Value: []*armdataprotection.DppBaseResource{
	// 		{
	// 			Name: to.Ptr("default"),
	// 			Type: to.Ptr("Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"),
	// 			ID: to.Ptr("subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/disableSoftDeleteRequests/default"),
	// 	}},
	// }
}

Output:

func (*ResourceGuardsClient) NewGetResourcesInResourceGroupPager 

func (client *ResourceGuardsClient) NewGetResourcesInResourceGroupPager(resourceGroupName string, options *ResourceGuardsClientGetResourcesInResourceGroupOptions) *runtime.Pager[ResourceGuardsClientGetResourcesInResourceGroupResponse]

NewGetResourcesInResourceGroupPager - Returns ResourceGuards collection belonging to a ResourceGroup.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - ResourceGuardsClientGetResourcesInResourceGroupOptions contains the optional parameters for the ResourceGuardsClient.NewGetResourcesInResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewResourceGuardsClient().NewGetResourcesInResourceGroupPager("SampleResourceGroup", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ResourceGuardResourceList = armdataprotection.ResourceGuardResourceList{
	// 	Value: []*armdataprotection.ResourceGuardResource{
	// 		{
	// 			Name: to.Ptr("VaultGuardTestNew"),
	// 			Type: to.Ptr("Microsoft.DataProtection/resourceGuards"),
	// 			ID: to.Ptr("/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew"),
	// 			Location: to.Ptr("eastus"),
	// 			Tags: map[string]*string{
	// 				"TestKey": to.Ptr("TestValue"),
	// 			},
	// 			Properties: &armdataprotection.ResourceGuard{
	// 				Description: to.Ptr("Please take JIT access before performing any of the critical operation"),
	// 				AllowAutoApprovals: to.Ptr(true),
	// 				ProvisioningState: to.Ptr(armdataprotection.ProvisioningStateSucceeded),
	// 				ResourceGuardOperations: []*armdataprotection.ResourceGuardOperation{
	// 					{
	// 						RequestResourceType: to.Ptr("Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"),
	// 						VaultCriticalOperation: to.Ptr("Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete"),
	// 					},
	// 					{
	// 						RequestResourceType: to.Ptr("Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"),
	// 						VaultCriticalOperation: to.Ptr("Microsoft.RecoveryServices/vaults/backupconfig/write"),
	// 				}},
	// 				VaultCriticalOperationExclusionList: []*string{
	// 				},
	// 			},
	// 	}},
	// }
}

Output:

func (*ResourceGuardsClient) NewGetResourcesInSubscriptionPager 

func (client *ResourceGuardsClient) NewGetResourcesInSubscriptionPager(options *ResourceGuardsClientGetResourcesInSubscriptionOptions) *runtime.Pager[ResourceGuardsClientGetResourcesInSubscriptionResponse]

NewGetResourcesInSubscriptionPager - Returns ResourceGuards collection belonging to a subscription.

Generated from API version 2024-04-01

  • options - ResourceGuardsClientGetResourcesInSubscriptionOptions contains the optional parameters for the ResourceGuardsClient.NewGetResourcesInSubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewResourceGuardsClient().NewGetResourcesInSubscriptionPager(nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ResourceGuardResourceList = armdataprotection.ResourceGuardResourceList{
	// 	Value: []*armdataprotection.ResourceGuardResource{
	// 		{
	// 			Name: to.Ptr("VaultGuardTestNew"),
	// 			Type: to.Ptr("Microsoft.DataProtection/resourceGuards"),
	// 			ID: to.Ptr("/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew"),
	// 			Location: to.Ptr("eastus"),
	// 			Tags: map[string]*string{
	// 				"TestKey": to.Ptr("TestValue"),
	// 			},
	// 			Properties: &armdataprotection.ResourceGuard{
	// 				Description: to.Ptr("Please take JIT access before performing any of the critical operation"),
	// 				AllowAutoApprovals: to.Ptr(true),
	// 				ProvisioningState: to.Ptr(armdataprotection.ProvisioningStateSucceeded),
	// 				ResourceGuardOperations: []*armdataprotection.ResourceGuardOperation{
	// 					{
	// 						RequestResourceType: to.Ptr("Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"),
	// 						VaultCriticalOperation: to.Ptr("Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete"),
	// 					},
	// 					{
	// 						RequestResourceType: to.Ptr("Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"),
	// 						VaultCriticalOperation: to.Ptr("Microsoft.RecoveryServices/vaults/backupconfig/write"),
	// 				}},
	// 				VaultCriticalOperationExclusionList: []*string{
	// 				},
	// 			},
	// 	}},
	// }
}

Output:

func (*ResourceGuardsClient) NewGetUpdateProtectedItemRequestsObjectsPager 

func (client *ResourceGuardsClient) NewGetUpdateProtectedItemRequestsObjectsPager(resourceGroupName string, resourceGuardsName string, options *ResourceGuardsClientGetUpdateProtectedItemRequestsObjectsOptions) *runtime.Pager[ResourceGuardsClientGetUpdateProtectedItemRequestsObjectsResponse]

NewGetUpdateProtectedItemRequestsObjectsPager - Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - ResourceGuardsClientGetUpdateProtectedItemRequestsObjectsOptions contains the optional parameters for the ResourceGuardsClient.NewGetUpdateProtectedItemRequestsObjectsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewResourceGuardsClient().NewGetUpdateProtectedItemRequestsObjectsPager("SampleResourceGroup", "swaggerExample", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.DppBaseResourceList = armdataprotection.DppBaseResourceList{
	// 	Value: []*armdataprotection.DppBaseResource{
	// 		{
	// 			Name: to.Ptr("default"),
	// 			Type: to.Ptr("Microsoft.DataProtection/resourceGuards/updateProtectedItemRequests"),
	// 			ID: to.Ptr("subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/updateProtectedItemRequests/default"),
	// 	}},
	// }
}

Output:

func (*ResourceGuardsClient) NewGetUpdateProtectionPolicyRequestsObjectsPager 

func (client *ResourceGuardsClient) NewGetUpdateProtectionPolicyRequestsObjectsPager(resourceGroupName string, resourceGuardsName string, options *ResourceGuardsClientGetUpdateProtectionPolicyRequestsObjectsOptions) *runtime.Pager[ResourceGuardsClientGetUpdateProtectionPolicyRequestsObjectsResponse]

NewGetUpdateProtectionPolicyRequestsObjectsPager - Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - ResourceGuardsClientGetUpdateProtectionPolicyRequestsObjectsOptions contains the optional parameters for the ResourceGuardsClient.NewGetUpdateProtectionPolicyRequestsObjectsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewResourceGuardsClient().NewGetUpdateProtectionPolicyRequestsObjectsPager("SampleResourceGroup", "swaggerExample", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.DppBaseResourceList = armdataprotection.DppBaseResourceList{
	// 	Value: []*armdataprotection.DppBaseResource{
	// 		{
	// 			Name: to.Ptr("default"),
	// 			Type: to.Ptr("Microsoft.DataProtection/resourceGuards/updateProtectionPolicyRequests"),
	// 			ID: to.Ptr("subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/updateProtectionPolicyRequests/default"),
	// 	}},
	// }
}

Output:

func (*ResourceGuardsClient) Patch 

func (client *ResourceGuardsClient) Patch(ctx context.Context, resourceGroupName string, resourceGuardsName string, parameters PatchResourceGuardInput, options *ResourceGuardsClientPatchOptions) (ResourceGuardsClientPatchResponse, error)

Patch - Updates a ResourceGuard resource belonging to a resource group. For example, updating tags for a resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • resourceGuardsName - The name of ResourceGuard
  • parameters - Request body for operation
  • options - ResourceGuardsClientPatchOptions contains the optional parameters for the ResourceGuardsClient.Patch method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardCRUD/PatchResourceGuard.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewResourceGuardsClient().Patch(ctx, "SampleResourceGroup", "swaggerExample", armdataprotection.PatchResourceGuardInput{
	Tags: map[string]*string{
		"newKey": to.Ptr("newVal"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ResourceGuardResource = armdataprotection.ResourceGuardResource{
// 	Name: to.Ptr("VaultGuardTestNew"),
// 	Type: to.Ptr("Microsoft.DataProtection/resourceGuards"),
// 	ID: to.Ptr("/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew"),
// 	Location: to.Ptr("eastus"),
// 	Tags: map[string]*string{
// 		"TestKey": to.Ptr("TestValue"),
// 	},
// 	Properties: &armdataprotection.ResourceGuard{
// 		Description: to.Ptr("Please take JIT access before performing any of the critical operation"),
// 		AllowAutoApprovals: to.Ptr(true),
// 		ProvisioningState: to.Ptr(armdataprotection.ProvisioningStateSucceeded),
// 		ResourceGuardOperations: []*armdataprotection.ResourceGuardOperation{
// 			{
// 				RequestResourceType: to.Ptr("Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"),
// 				VaultCriticalOperation: to.Ptr("Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete"),
// 			},
// 			{
// 				RequestResourceType: to.Ptr("Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"),
// 				VaultCriticalOperation: to.Ptr("Microsoft.RecoveryServices/vaults/backupconfig/write"),
// 		}},
// 	},
// }

Output:

func (*ResourceGuardsClient) Put 

func (client *ResourceGuardsClient) Put(ctx context.Context, resourceGroupName string, resourceGuardsName string, parameters ResourceGuardResource, options *ResourceGuardsClientPutOptions) (ResourceGuardsClientPutResponse, error)

Put - Creates or updates a ResourceGuard resource belonging to a resource group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • resourceGuardsName - The name of ResourceGuard
  • parameters - Request body for operation
  • options - ResourceGuardsClientPutOptions contains the optional parameters for the ResourceGuardsClient.Put method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardCRUD/PutResourceGuard.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewResourceGuardsClient().Put(ctx, "SampleResourceGroup", "swaggerExample", armdataprotection.ResourceGuardResource{
	Location: to.Ptr("WestUS"),
	Tags: map[string]*string{
		"key1": to.Ptr("val1"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ResourceGuardResource = armdataprotection.ResourceGuardResource{
// 	Name: to.Ptr("VaultGuardTestNew"),
// 	Type: to.Ptr("Microsoft.DataProtection/resourceGuards"),
// 	ID: to.Ptr("/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew"),
// 	Location: to.Ptr("eastus"),
// 	Tags: map[string]*string{
// 		"TestKey": to.Ptr("TestValue"),
// 	},
// 	Properties: &armdataprotection.ResourceGuard{
// 		Description: to.Ptr("Please take JIT access before performing any of the critical operation"),
// 		AllowAutoApprovals: to.Ptr(true),
// 		ProvisioningState: to.Ptr(armdataprotection.ProvisioningStateSucceeded),
// 		ResourceGuardOperations: []*armdataprotection.ResourceGuardOperation{
// 			{
// 				RequestResourceType: to.Ptr("Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"),
// 				VaultCriticalOperation: to.Ptr("Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete"),
// 			},
// 			{
// 				RequestResourceType: to.Ptr("Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"),
// 				VaultCriticalOperation: to.Ptr("Microsoft.RecoveryServices/vaults/backupconfig/write"),
// 		}},
// 		VaultCriticalOperationExclusionList: []*string{
// 		},
// 	},
// }

Output:

type ResourceGuardsClientDeleteOptions 

type ResourceGuardsClientDeleteOptions struct {
}

ResourceGuardsClientDeleteOptions contains the optional parameters for the ResourceGuardsClient.Delete method.

type ResourceGuardsClientDeleteResponse 

type ResourceGuardsClientDeleteResponse struct {
}

ResourceGuardsClientDeleteResponse contains the response from method ResourceGuardsClient.Delete.

type ResourceGuardsClientGetBackupSecurityPINRequestsObjectsOptions 

type ResourceGuardsClientGetBackupSecurityPINRequestsObjectsOptions struct {
}

ResourceGuardsClientGetBackupSecurityPINRequestsObjectsOptions contains the optional parameters for the ResourceGuardsClient.NewGetBackupSecurityPINRequestsObjectsPager method.

type ResourceGuardsClientGetBackupSecurityPINRequestsObjectsResponse 

type ResourceGuardsClientGetBackupSecurityPINRequestsObjectsResponse struct {
	// Base for all lists of V2 resources.
	DppBaseResourceList
}

ResourceGuardsClientGetBackupSecurityPINRequestsObjectsResponse contains the response from method ResourceGuardsClient.NewGetBackupSecurityPINRequestsObjectsPager.

type ResourceGuardsClientGetDefaultBackupSecurityPINRequestsObjectOptions 

type ResourceGuardsClientGetDefaultBackupSecurityPINRequestsObjectOptions struct {
}

ResourceGuardsClientGetDefaultBackupSecurityPINRequestsObjectOptions contains the optional parameters for the ResourceGuardsClient.GetDefaultBackupSecurityPINRequestsObject method.

type ResourceGuardsClientGetDefaultBackupSecurityPINRequestsObjectResponse 

type ResourceGuardsClientGetDefaultBackupSecurityPINRequestsObjectResponse struct {
	// Base resource under Microsoft.DataProtection provider namespace
	DppBaseResource
}

ResourceGuardsClientGetDefaultBackupSecurityPINRequestsObjectResponse contains the response from method ResourceGuardsClient.GetDefaultBackupSecurityPINRequestsObject.

type ResourceGuardsClientGetDefaultDeleteProtectedItemRequestsObjectOptions 

type ResourceGuardsClientGetDefaultDeleteProtectedItemRequestsObjectOptions struct {
}

ResourceGuardsClientGetDefaultDeleteProtectedItemRequestsObjectOptions contains the optional parameters for the ResourceGuardsClient.GetDefaultDeleteProtectedItemRequestsObject method.

type ResourceGuardsClientGetDefaultDeleteProtectedItemRequestsObjectResponse 

type ResourceGuardsClientGetDefaultDeleteProtectedItemRequestsObjectResponse struct {
	// Base resource under Microsoft.DataProtection provider namespace
	DppBaseResource
}

ResourceGuardsClientGetDefaultDeleteProtectedItemRequestsObjectResponse contains the response from method ResourceGuardsClient.GetDefaultDeleteProtectedItemRequestsObject.

type ResourceGuardsClientGetDefaultDeleteResourceGuardProxyRequestsObjectOptions 

type ResourceGuardsClientGetDefaultDeleteResourceGuardProxyRequestsObjectOptions struct {
}

ResourceGuardsClientGetDefaultDeleteResourceGuardProxyRequestsObjectOptions contains the optional parameters for the ResourceGuardsClient.GetDefaultDeleteResourceGuardProxyRequestsObject method.

type ResourceGuardsClientGetDefaultDeleteResourceGuardProxyRequestsObjectResponse 

type ResourceGuardsClientGetDefaultDeleteResourceGuardProxyRequestsObjectResponse struct {
	// Base resource under Microsoft.DataProtection provider namespace
	DppBaseResource
}

ResourceGuardsClientGetDefaultDeleteResourceGuardProxyRequestsObjectResponse contains the response from method ResourceGuardsClient.GetDefaultDeleteResourceGuardProxyRequestsObject.

type ResourceGuardsClientGetDefaultDisableSoftDeleteRequestsObjectOptions 

type ResourceGuardsClientGetDefaultDisableSoftDeleteRequestsObjectOptions struct {
}

ResourceGuardsClientGetDefaultDisableSoftDeleteRequestsObjectOptions contains the optional parameters for the ResourceGuardsClient.GetDefaultDisableSoftDeleteRequestsObject method.

type ResourceGuardsClientGetDefaultDisableSoftDeleteRequestsObjectResponse 

type ResourceGuardsClientGetDefaultDisableSoftDeleteRequestsObjectResponse struct {
	// Base resource under Microsoft.DataProtection provider namespace
	DppBaseResource
}

ResourceGuardsClientGetDefaultDisableSoftDeleteRequestsObjectResponse contains the response from method ResourceGuardsClient.GetDefaultDisableSoftDeleteRequestsObject.

type ResourceGuardsClientGetDefaultUpdateProtectedItemRequestsObjectOptions 

type ResourceGuardsClientGetDefaultUpdateProtectedItemRequestsObjectOptions struct {
}

ResourceGuardsClientGetDefaultUpdateProtectedItemRequestsObjectOptions contains the optional parameters for the ResourceGuardsClient.GetDefaultUpdateProtectedItemRequestsObject method.

type ResourceGuardsClientGetDefaultUpdateProtectedItemRequestsObjectResponse 

type ResourceGuardsClientGetDefaultUpdateProtectedItemRequestsObjectResponse struct {
	// Base resource under Microsoft.DataProtection provider namespace
	DppBaseResource
}

ResourceGuardsClientGetDefaultUpdateProtectedItemRequestsObjectResponse contains the response from method ResourceGuardsClient.GetDefaultUpdateProtectedItemRequestsObject.

type ResourceGuardsClientGetDefaultUpdateProtectionPolicyRequestsObjectOptions 

type ResourceGuardsClientGetDefaultUpdateProtectionPolicyRequestsObjectOptions struct {
}

ResourceGuardsClientGetDefaultUpdateProtectionPolicyRequestsObjectOptions contains the optional parameters for the ResourceGuardsClient.GetDefaultUpdateProtectionPolicyRequestsObject method.

type ResourceGuardsClientGetDefaultUpdateProtectionPolicyRequestsObjectResponse 

type ResourceGuardsClientGetDefaultUpdateProtectionPolicyRequestsObjectResponse struct {
	// Base resource under Microsoft.DataProtection provider namespace
	DppBaseResource
}

ResourceGuardsClientGetDefaultUpdateProtectionPolicyRequestsObjectResponse contains the response from method ResourceGuardsClient.GetDefaultUpdateProtectionPolicyRequestsObject.

type ResourceGuardsClientGetDeleteProtectedItemRequestsObjectsOptions 

type ResourceGuardsClientGetDeleteProtectedItemRequestsObjectsOptions struct {
}

ResourceGuardsClientGetDeleteProtectedItemRequestsObjectsOptions contains the optional parameters for the ResourceGuardsClient.NewGetDeleteProtectedItemRequestsObjectsPager method.

type ResourceGuardsClientGetDeleteProtectedItemRequestsObjectsResponse 

type ResourceGuardsClientGetDeleteProtectedItemRequestsObjectsResponse struct {
	// Base for all lists of V2 resources.
	DppBaseResourceList
}

ResourceGuardsClientGetDeleteProtectedItemRequestsObjectsResponse contains the response from method ResourceGuardsClient.NewGetDeleteProtectedItemRequestsObjectsPager.

type ResourceGuardsClientGetDeleteResourceGuardProxyRequestsObjectsOptions 

type ResourceGuardsClientGetDeleteResourceGuardProxyRequestsObjectsOptions struct {
}

ResourceGuardsClientGetDeleteResourceGuardProxyRequestsObjectsOptions contains the optional parameters for the ResourceGuardsClient.NewGetDeleteResourceGuardProxyRequestsObjectsPager method.

type ResourceGuardsClientGetDeleteResourceGuardProxyRequestsObjectsResponse 

type ResourceGuardsClientGetDeleteResourceGuardProxyRequestsObjectsResponse struct {
	// Base for all lists of V2 resources.
	DppBaseResourceList
}

ResourceGuardsClientGetDeleteResourceGuardProxyRequestsObjectsResponse contains the response from method ResourceGuardsClient.NewGetDeleteResourceGuardProxyRequestsObjectsPager.

type ResourceGuardsClientGetDisableSoftDeleteRequestsObjectsOptions 

type ResourceGuardsClientGetDisableSoftDeleteRequestsObjectsOptions struct {
}

ResourceGuardsClientGetDisableSoftDeleteRequestsObjectsOptions contains the optional parameters for the ResourceGuardsClient.NewGetDisableSoftDeleteRequestsObjectsPager method.

type ResourceGuardsClientGetDisableSoftDeleteRequestsObjectsResponse 

type ResourceGuardsClientGetDisableSoftDeleteRequestsObjectsResponse struct {
	// Base for all lists of V2 resources.
	DppBaseResourceList
}

ResourceGuardsClientGetDisableSoftDeleteRequestsObjectsResponse contains the response from method ResourceGuardsClient.NewGetDisableSoftDeleteRequestsObjectsPager.

type ResourceGuardsClientGetOptions 

type ResourceGuardsClientGetOptions struct {
}

ResourceGuardsClientGetOptions contains the optional parameters for the ResourceGuardsClient.Get method.

type ResourceGuardsClientGetResourcesInResourceGroupOptions 

type ResourceGuardsClientGetResourcesInResourceGroupOptions struct {
}

ResourceGuardsClientGetResourcesInResourceGroupOptions contains the optional parameters for the ResourceGuardsClient.NewGetResourcesInResourceGroupPager method.

type ResourceGuardsClientGetResourcesInResourceGroupResponse 

type ResourceGuardsClientGetResourcesInResourceGroupResponse struct {
	// List of ResourceGuard resources
	ResourceGuardResourceList
}

ResourceGuardsClientGetResourcesInResourceGroupResponse contains the response from method ResourceGuardsClient.NewGetResourcesInResourceGroupPager.

type ResourceGuardsClientGetResourcesInSubscriptionOptions 

type ResourceGuardsClientGetResourcesInSubscriptionOptions struct {
}

ResourceGuardsClientGetResourcesInSubscriptionOptions contains the optional parameters for the ResourceGuardsClient.NewGetResourcesInSubscriptionPager method.

type ResourceGuardsClientGetResourcesInSubscriptionResponse 

type ResourceGuardsClientGetResourcesInSubscriptionResponse struct {
	// List of ResourceGuard resources
	ResourceGuardResourceList
}

ResourceGuardsClientGetResourcesInSubscriptionResponse contains the response from method ResourceGuardsClient.NewGetResourcesInSubscriptionPager.

type ResourceGuardsClientGetResponse 

type ResourceGuardsClientGetResponse struct {
	ResourceGuardResource
}

ResourceGuardsClientGetResponse contains the response from method ResourceGuardsClient.Get.

type ResourceGuardsClientGetUpdateProtectedItemRequestsObjectsOptions 

type ResourceGuardsClientGetUpdateProtectedItemRequestsObjectsOptions struct {
}

ResourceGuardsClientGetUpdateProtectedItemRequestsObjectsOptions contains the optional parameters for the ResourceGuardsClient.NewGetUpdateProtectedItemRequestsObjectsPager method.

type ResourceGuardsClientGetUpdateProtectedItemRequestsObjectsResponse 

type ResourceGuardsClientGetUpdateProtectedItemRequestsObjectsResponse struct {
	// Base for all lists of V2 resources.
	DppBaseResourceList
}

ResourceGuardsClientGetUpdateProtectedItemRequestsObjectsResponse contains the response from method ResourceGuardsClient.NewGetUpdateProtectedItemRequestsObjectsPager.

type ResourceGuardsClientGetUpdateProtectionPolicyRequestsObjectsOptions 

type ResourceGuardsClientGetUpdateProtectionPolicyRequestsObjectsOptions struct {
}

ResourceGuardsClientGetUpdateProtectionPolicyRequestsObjectsOptions contains the optional parameters for the ResourceGuardsClient.NewGetUpdateProtectionPolicyRequestsObjectsPager method.

type ResourceGuardsClientGetUpdateProtectionPolicyRequestsObjectsResponse 

type ResourceGuardsClientGetUpdateProtectionPolicyRequestsObjectsResponse struct {
	// Base for all lists of V2 resources.
	DppBaseResourceList
}

ResourceGuardsClientGetUpdateProtectionPolicyRequestsObjectsResponse contains the response from method ResourceGuardsClient.NewGetUpdateProtectionPolicyRequestsObjectsPager.

type ResourceGuardsClientPatchOptions 

type ResourceGuardsClientPatchOptions struct {
}

ResourceGuardsClientPatchOptions contains the optional parameters for the ResourceGuardsClient.Patch method.

type ResourceGuardsClientPatchResponse 

type ResourceGuardsClientPatchResponse struct {
	ResourceGuardResource
}

ResourceGuardsClientPatchResponse contains the response from method ResourceGuardsClient.Patch.

type ResourceGuardsClientPutOptions 

type ResourceGuardsClientPutOptions struct {
}

ResourceGuardsClientPutOptions contains the optional parameters for the ResourceGuardsClient.Put method.

type ResourceGuardsClientPutResponse 

type ResourceGuardsClientPutResponse struct {
	ResourceGuardResource
}

ResourceGuardsClientPutResponse contains the response from method ResourceGuardsClient.Put.

type ResourceMoveDetails 

type ResourceMoveDetails struct {
	// Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format.
	CompletionTimeUTC *string

	// CorrelationId of latest ResourceMove operation attempted
	OperationID *string

	// ARM resource path of source resource
	SourceResourcePath *string

	// Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format.
	StartTimeUTC *string

	// ARM resource path of target resource used in latest ResourceMove operation
	TargetResourcePath *string
}

ResourceMoveDetails will be returned in response to GetResource call from ARM

func (ResourceMoveDetails) MarshalJSON 

func (r ResourceMoveDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceMoveDetails.

func (*ResourceMoveDetails) UnmarshalJSON 

func (r *ResourceMoveDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceMoveDetails.

type ResourceMoveState 

type ResourceMoveState string

ResourceMoveState - Resource move state for backup vault 

const (
	ResourceMoveStateCommitFailed    ResourceMoveState = "CommitFailed"
	ResourceMoveStateCommitTimedout  ResourceMoveState = "CommitTimedout"
	ResourceMoveStateCriticalFailure ResourceMoveState = "CriticalFailure"
	ResourceMoveStateFailed          ResourceMoveState = "Failed"
	ResourceMoveStateInProgress      ResourceMoveState = "InProgress"
	ResourceMoveStateMoveSucceeded   ResourceMoveState = "MoveSucceeded"
	ResourceMoveStatePartialSuccess  ResourceMoveState = "PartialSuccess"
	ResourceMoveStatePrepareFailed   ResourceMoveState = "PrepareFailed"
	ResourceMoveStatePrepareTimedout ResourceMoveState = "PrepareTimedout"
	ResourceMoveStateUnknown         ResourceMoveState = "Unknown"
)

func PossibleResourceMoveStateValues 

func PossibleResourceMoveStateValues() []ResourceMoveState

PossibleResourceMoveStateValues returns the possible values for the ResourceMoveState const type.

type ResourcePropertiesObjectType 

type ResourcePropertiesObjectType string

ResourcePropertiesObjectType - Type of the specific object - used for deserializing 

const (
	ResourcePropertiesObjectTypeDefaultResourceProperties ResourcePropertiesObjectType = "DefaultResourceProperties"
)

func PossibleResourcePropertiesObjectTypeValues 

func PossibleResourcePropertiesObjectTypeValues() []ResourcePropertiesObjectType

PossibleResourcePropertiesObjectTypeValues returns the possible values for the ResourcePropertiesObjectType const type.

type RestorableTimeRange 

type RestorableTimeRange struct {
	// REQUIRED; End time for the available restore range
	EndTime *string

	// REQUIRED; Start time for the available restore range
	StartTime  *string
	ObjectType *string
}

func (RestorableTimeRange) MarshalJSON 

func (r RestorableTimeRange) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RestorableTimeRange.

func (*RestorableTimeRange) UnmarshalJSON 

func (r *RestorableTimeRange) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RestorableTimeRange.

type RestorableTimeRangesClient 

type RestorableTimeRangesClient struct {
	// contains filtered or unexported fields
}

RestorableTimeRangesClient contains the methods for the RestorableTimeRanges group. Don't use this type directly, use NewRestorableTimeRangesClient() instead.

func NewRestorableTimeRangesClient 

func NewRestorableTimeRangesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*RestorableTimeRangesClient, error)

NewRestorableTimeRangesClient creates a new instance of RestorableTimeRangesClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*RestorableTimeRangesClient) Find 

func (client *RestorableTimeRangesClient) Find(ctx context.Context, resourceGroupName string, vaultName string, backupInstanceName string, parameters AzureBackupFindRestorableTimeRangesRequest, options *RestorableTimeRangesClientFindOptions) (RestorableTimeRangesClientFindResponse, error)

Find - If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • vaultName - The name of the backup vault.
  • backupInstanceName - The name of the backup instance.
  • parameters - Request body for operation
  • options - RestorableTimeRangesClientFindOptions contains the optional parameters for the RestorableTimeRangesClient.Find method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewRestorableTimeRangesClient().Find(ctx, "Blob-Backup", "ZBlobBackupVaultBVTD3", "zblobbackuptestsa58", armdataprotection.AzureBackupFindRestorableTimeRangesRequest{
	EndTime:             to.Ptr("2021-02-24T00:35:17.6829685Z"),
	SourceDataStoreType: to.Ptr(armdataprotection.RestoreSourceDataStoreTypeOperationalStore),
	StartTime:           to.Ptr("2020-10-17T23:28:17.6829685Z"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.AzureBackupFindRestorableTimeRangesResponseResource = armdataprotection.AzureBackupFindRestorableTimeRangesResponseResource{
// 	Type: to.Ptr("Microsoft.DataProtection/backupVaults/backupInstances/findRestorableTimeRanges"),
// 	ID: to.Ptr("zblobbackuptestsa58"),
// 	Properties: &armdataprotection.AzureBackupFindRestorableTimeRangesResponse{
// 		ObjectType: to.Ptr("AzureBackupFindRestorableTimeRangesResponse"),
// 		RestorableTimeRanges: []*armdataprotection.RestorableTimeRange{
// 			{
// 				EndTime: to.Ptr("2021-02-24T00:35:17.0000000Z"),
// 				ObjectType: to.Ptr("RestorableTimeRange"),
// 				StartTime: to.Ptr("2021-02-23T18:33:51.6349708Z"),
// 		}},
// 	},
// }

Output:

type RestorableTimeRangesClientFindOptions 

type RestorableTimeRangesClientFindOptions struct {
}

RestorableTimeRangesClientFindOptions contains the optional parameters for the RestorableTimeRangesClient.Find method.

type RestorableTimeRangesClientFindResponse 

type RestorableTimeRangesClientFindResponse struct {
	// List Restore Ranges Response
	AzureBackupFindRestorableTimeRangesResponseResource
}

RestorableTimeRangesClientFindResponse contains the response from method RestorableTimeRangesClient.Find.

type RestoreFilesTargetInfo 

type RestoreFilesTargetInfo struct {
	// REQUIRED; Type of Datasource object, used to initialize the right inherited type
	ObjectType *string

	// REQUIRED; Recovery Option
	RecoveryOption *RecoveryOption

	// REQUIRED; Destination of RestoreAsFiles operation, when destination is not a datasource
	TargetDetails *TargetDetails

	// Target Restore region
	RestoreLocation *string
}

RestoreFilesTargetInfo - Class encapsulating restore as files target parameters

func (*RestoreFilesTargetInfo) GetRestoreTargetInfoBase 

func (r *RestoreFilesTargetInfo) GetRestoreTargetInfoBase() *RestoreTargetInfoBase

GetRestoreTargetInfoBase implements the RestoreTargetInfoBaseClassification interface for type RestoreFilesTargetInfo.

func (RestoreFilesTargetInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RestoreFilesTargetInfo.

func (*RestoreFilesTargetInfo) UnmarshalJSON 

func (r *RestoreFilesTargetInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RestoreFilesTargetInfo.

type RestoreJobRecoveryPointDetails 

type RestoreJobRecoveryPointDetails struct {
	RecoveryPointID   *string
	RecoveryPointTime *time.Time
}

func (RestoreJobRecoveryPointDetails) MarshalJSON 

func (r RestoreJobRecoveryPointDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RestoreJobRecoveryPointDetails.

func (*RestoreJobRecoveryPointDetails) UnmarshalJSON 

func (r *RestoreJobRecoveryPointDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RestoreJobRecoveryPointDetails.

type RestoreSourceDataStoreType 

type RestoreSourceDataStoreType string

RestoreSourceDataStoreType - Gets or sets the type of the source data store. 

const (
	RestoreSourceDataStoreTypeArchiveStore     RestoreSourceDataStoreType = "ArchiveStore"
	RestoreSourceDataStoreTypeOperationalStore RestoreSourceDataStoreType = "OperationalStore"
	RestoreSourceDataStoreTypeVaultStore       RestoreSourceDataStoreType = "VaultStore"
)

func PossibleRestoreSourceDataStoreTypeValues 

func PossibleRestoreSourceDataStoreTypeValues() []RestoreSourceDataStoreType

PossibleRestoreSourceDataStoreTypeValues returns the possible values for the RestoreSourceDataStoreType const type.

type RestoreTargetInfo 

type RestoreTargetInfo struct {
	// REQUIRED; Information of target DS
	DatasourceInfo *Datasource

	// REQUIRED; Type of Datasource object, used to initialize the right inherited type
	ObjectType *string

	// REQUIRED; Recovery Option
	RecoveryOption *RecoveryOption

	// Credentials to use to authenticate with data source provider.
	DatasourceAuthCredentials AuthCredentialsClassification

	// Information of target DS Set
	DatasourceSetInfo *DatasourceSet

	// Target Restore region
	RestoreLocation *string
}

RestoreTargetInfo - Class encapsulating restore target parameters

func (*RestoreTargetInfo) GetRestoreTargetInfoBase 

func (r *RestoreTargetInfo) GetRestoreTargetInfoBase() *RestoreTargetInfoBase

GetRestoreTargetInfoBase implements the RestoreTargetInfoBaseClassification interface for type RestoreTargetInfo.

func (RestoreTargetInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RestoreTargetInfo.

func (*RestoreTargetInfo) UnmarshalJSON 

func (r *RestoreTargetInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RestoreTargetInfo.

type RestoreTargetInfoBase 

type RestoreTargetInfoBase struct {
	// REQUIRED; Type of Datasource object, used to initialize the right inherited type
	ObjectType *string

	// REQUIRED; Recovery Option
	RecoveryOption *RecoveryOption

	// Target Restore region
	RestoreLocation *string
}

RestoreTargetInfoBase - Base class common to RestoreTargetInfo and RestoreFilesTargetInfo

func (*RestoreTargetInfoBase) GetRestoreTargetInfoBase 

func (r *RestoreTargetInfoBase) GetRestoreTargetInfoBase() *RestoreTargetInfoBase

GetRestoreTargetInfoBase implements the RestoreTargetInfoBaseClassification interface for type RestoreTargetInfoBase.

func (RestoreTargetInfoBase) MarshalJSON 

func (r RestoreTargetInfoBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RestoreTargetInfoBase.

func (*RestoreTargetInfoBase) UnmarshalJSON 

func (r *RestoreTargetInfoBase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RestoreTargetInfoBase.

type RestoreTargetInfoBaseClassification 

type RestoreTargetInfoBaseClassification interface {
	// GetRestoreTargetInfoBase returns the RestoreTargetInfoBase content of the underlying type.
	GetRestoreTargetInfoBase() *RestoreTargetInfoBase
}

RestoreTargetInfoBaseClassification provides polymorphic access to related types. Call the interface's GetRestoreTargetInfoBase() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *ItemLevelRestoreTargetInfo, *RestoreFilesTargetInfo, *RestoreTargetInfo, *RestoreTargetInfoBase

type RestoreTargetLocationType 

type RestoreTargetLocationType string

RestoreTargetLocationType - Denotes the target location where the data will be restored, string value for the enum {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType} 

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

func PossibleRestoreTargetLocationTypeValues 

func PossibleRestoreTargetLocationTypeValues() []RestoreTargetLocationType

PossibleRestoreTargetLocationTypeValues returns the possible values for the RestoreTargetLocationType const type.

type RetentionTag 

type RetentionTag struct {
	// REQUIRED; Retention Tag Name to relate it to retention rule.
	TagName *string

	// READ-ONLY; Retention Tag version.
	ETag *string

	// READ-ONLY; Retention Tag version.
	ID *string
}

RetentionTag - Retention tag

func (RetentionTag) MarshalJSON 

func (r RetentionTag) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RetentionTag.

func (*RetentionTag) UnmarshalJSON 

func (r *RetentionTag) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RetentionTag.

type ScheduleBasedBackupCriteria 

type ScheduleBasedBackupCriteria struct {
	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string

	// it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" and should be part of AbsoluteMarker
	// enum
	AbsoluteCriteria []*AbsoluteMarker

	// This is day of the month from 1 to 28 other wise last of month
	DaysOfMonth []*Day

	// It should be Sunday/Monday/T…./Saturday
	DaysOfTheWeek []*DayOfWeek

	// It should be January/February/……/December
	MonthsOfYear []*Month

	// List of schedule times for backup
	ScheduleTimes []*time.Time

	// It should be First/Second/Third/Fourth/Last
	WeeksOfTheMonth []*WeekNumber
}

ScheduleBasedBackupCriteria - Schedule based backup criteria

func (*ScheduleBasedBackupCriteria) GetBackupCriteria 

func (s *ScheduleBasedBackupCriteria) GetBackupCriteria() *BackupCriteria

GetBackupCriteria implements the BackupCriteriaClassification interface for type ScheduleBasedBackupCriteria.

func (ScheduleBasedBackupCriteria) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ScheduleBasedBackupCriteria.

func (*ScheduleBasedBackupCriteria) UnmarshalJSON 

func (s *ScheduleBasedBackupCriteria) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScheduleBasedBackupCriteria.

type ScheduleBasedTriggerContext 

type ScheduleBasedTriggerContext struct {
	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string

	// REQUIRED; Schedule for this backup
	Schedule *BackupSchedule

	// REQUIRED; List of tags that can be applicable for given schedule.
	TaggingCriteria []*TaggingCriteria
}

ScheduleBasedTriggerContext - Schedule based trigger context

func (*ScheduleBasedTriggerContext) GetTriggerContext 

func (s *ScheduleBasedTriggerContext) GetTriggerContext() *TriggerContext

GetTriggerContext implements the TriggerContextClassification interface for type ScheduleBasedTriggerContext.

func (ScheduleBasedTriggerContext) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ScheduleBasedTriggerContext.

func (*ScheduleBasedTriggerContext) UnmarshalJSON 

func (s *ScheduleBasedTriggerContext) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScheduleBasedTriggerContext.

type SecretStoreBasedAuthCredentials 

type SecretStoreBasedAuthCredentials struct {
	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string

	// Secret store resource
	SecretStoreResource *SecretStoreResource
}

SecretStoreBasedAuthCredentials - Secret store based authentication credentials.

func (*SecretStoreBasedAuthCredentials) GetAuthCredentials 

func (s *SecretStoreBasedAuthCredentials) GetAuthCredentials() *AuthCredentials

GetAuthCredentials implements the AuthCredentialsClassification interface for type SecretStoreBasedAuthCredentials.

func (SecretStoreBasedAuthCredentials) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SecretStoreBasedAuthCredentials.

func (*SecretStoreBasedAuthCredentials) UnmarshalJSON 

func (s *SecretStoreBasedAuthCredentials) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecretStoreBasedAuthCredentials.

type SecretStoreResource 

type SecretStoreResource struct {
	// REQUIRED; Gets or sets the type of secret store
	SecretStoreType *SecretStoreType

	// Uri to get to the resource
	URI *string

	// Gets or sets value stored in secret store resource
	Value *string
}

SecretStoreResource - Class representing a secret store resource.

func (SecretStoreResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SecretStoreResource.

func (*SecretStoreResource) UnmarshalJSON 

func (s *SecretStoreResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecretStoreResource.

type SecretStoreType 

type SecretStoreType string

SecretStoreType - Gets or sets the type of secret store 

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

func PossibleSecretStoreTypeValues 

func PossibleSecretStoreTypeValues() []SecretStoreType

PossibleSecretStoreTypeValues returns the possible values for the SecretStoreType const type.

type SecureScoreLevel 

type SecureScoreLevel string

SecureScoreLevel - Secure Score of Backup Vault 

const (
	SecureScoreLevelAdequate     SecureScoreLevel = "Adequate"
	SecureScoreLevelMaximum      SecureScoreLevel = "Maximum"
	SecureScoreLevelMinimum      SecureScoreLevel = "Minimum"
	SecureScoreLevelNone         SecureScoreLevel = "None"
	SecureScoreLevelNotSupported SecureScoreLevel = "NotSupported"
)

func PossibleSecureScoreLevelValues 

func PossibleSecureScoreLevelValues() []SecureScoreLevel

PossibleSecureScoreLevelValues returns the possible values for the SecureScoreLevel const type.

type SecuritySettings 

type SecuritySettings struct {
	// Customer Managed Key details of the resource.
	EncryptionSettings *EncryptionSettings

	// Immutability Settings at vault level
	ImmutabilitySettings *ImmutabilitySettings

	// Soft delete related settings
	SoftDeleteSettings *SoftDeleteSettings
}

SecuritySettings - Class containing security settings of vault

func (SecuritySettings) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SecuritySettings.

func (*SecuritySettings) UnmarshalJSON 

func (s *SecuritySettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecuritySettings.

type SoftDeleteSettings 

type SoftDeleteSettings struct {
	// Soft delete retention duration
	RetentionDurationInDays *float64

	// State of soft delete
	State *SoftDeleteState
}

SoftDeleteSettings - Soft delete related settings

func (SoftDeleteSettings) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SoftDeleteSettings.

func (*SoftDeleteSettings) UnmarshalJSON 

func (s *SoftDeleteSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SoftDeleteSettings.

type SoftDeleteState 

type SoftDeleteState string

SoftDeleteState - State of soft delete 

const (
	// SoftDeleteStateAlwaysOn - Soft Delete is permanently enabled for the BackupVault and the setting cannot be changed
	SoftDeleteStateAlwaysOn SoftDeleteState = "AlwaysOn"
	// SoftDeleteStateOff - Soft Delete is turned off for the BackupVault
	SoftDeleteStateOff SoftDeleteState = "Off"
	// SoftDeleteStateOn - Soft Delete is enabled for the BackupVault but can be turned off
	SoftDeleteStateOn SoftDeleteState = "On"
)

func PossibleSoftDeleteStateValues 

func PossibleSoftDeleteStateValues() []SoftDeleteState

PossibleSoftDeleteStateValues returns the possible values for the SoftDeleteState const type.

type SourceDataStoreType 

type SourceDataStoreType string

SourceDataStoreType - Gets or sets the type of the source data store. 

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

func PossibleSourceDataStoreTypeValues 

func PossibleSourceDataStoreTypeValues() []SourceDataStoreType

PossibleSourceDataStoreTypeValues returns the possible values for the SourceDataStoreType const type.

type SourceLifeCycle 

type SourceLifeCycle struct {
	// REQUIRED; Delete Option
	DeleteAfter DeleteOptionClassification

	// REQUIRED; DataStoreInfo base
	SourceDataStore             *DataStoreInfoBase
	TargetDataStoreCopySettings []*TargetCopySetting
}

SourceLifeCycle - Source LifeCycle

func (SourceLifeCycle) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SourceLifeCycle.

func (*SourceLifeCycle) UnmarshalJSON 

func (s *SourceLifeCycle) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SourceLifeCycle.

type Status 

type Status string

Status - Specifies the protection status of the resource 

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

func PossibleStatusValues 

func PossibleStatusValues() []Status

PossibleStatusValues returns the possible values for the Status const type.

type StopProtectionRequest added in v3.1.0 

type StopProtectionRequest struct {
	// ResourceGuardOperationRequests on which LAC check will be performed
	ResourceGuardOperationRequests []*string
}

StopProtectionRequest - Request body of Stop protection when MUA is Enabled

func (StopProtectionRequest) MarshalJSON added in v3.1.0 

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

MarshalJSON implements the json.Marshaller interface for type StopProtectionRequest.

func (*StopProtectionRequest) UnmarshalJSON added in v3.1.0 

func (s *StopProtectionRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StopProtectionRequest.

type StorageSetting 

type StorageSetting struct {
	// Gets or sets the type of the datastore.
	DatastoreType *StorageSettingStoreTypes

	// Gets or sets the type.
	Type *StorageSettingTypes
}

StorageSetting - Storage setting

func (StorageSetting) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type StorageSetting.

func (*StorageSetting) UnmarshalJSON 

func (s *StorageSetting) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageSetting.

type StorageSettingStoreTypes 

type StorageSettingStoreTypes string

StorageSettingStoreTypes - Gets or sets the type of the datastore. 

const (
	StorageSettingStoreTypesArchiveStore     StorageSettingStoreTypes = "ArchiveStore"
	StorageSettingStoreTypesOperationalStore StorageSettingStoreTypes = "OperationalStore"
	StorageSettingStoreTypesVaultStore       StorageSettingStoreTypes = "VaultStore"
)

func PossibleStorageSettingStoreTypesValues 

func PossibleStorageSettingStoreTypesValues() []StorageSettingStoreTypes

PossibleStorageSettingStoreTypesValues returns the possible values for the StorageSettingStoreTypes const type.

type StorageSettingTypes 

type StorageSettingTypes string

StorageSettingTypes - Gets or sets the type. 

const (
	StorageSettingTypesGeoRedundant     StorageSettingTypes = "GeoRedundant"
	StorageSettingTypesLocallyRedundant StorageSettingTypes = "LocallyRedundant"
	StorageSettingTypesZoneRedundant    StorageSettingTypes = "ZoneRedundant"
)

func PossibleStorageSettingTypesValues 

func PossibleStorageSettingTypesValues() []StorageSettingTypes

PossibleStorageSettingTypesValues returns the possible values for the StorageSettingTypes const type.

type SupportedFeature 

type SupportedFeature struct {
	// support feature type.
	ExposureControlledFeatures []*string

	// support feature type.
	FeatureName *string

	// feature support status
	SupportStatus *FeatureSupportStatus
}

SupportedFeature - Elements class for feature request

func (SupportedFeature) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SupportedFeature.

func (*SupportedFeature) UnmarshalJSON 

func (s *SupportedFeature) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SupportedFeature.

type SuspendBackupRequest added in v3.1.0 

type SuspendBackupRequest struct {
	// ResourceGuardOperationRequests on which LAC check will be performed
	ResourceGuardOperationRequests []*string
}

SuspendBackupRequest - Request body of Suspend backup when MUA is Enabled

func (SuspendBackupRequest) MarshalJSON added in v3.1.0 

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

MarshalJSON implements the json.Marshaller interface for type SuspendBackupRequest.

func (*SuspendBackupRequest) UnmarshalJSON added in v3.1.0 

func (s *SuspendBackupRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SuspendBackupRequest.

type SyncBackupInstanceRequest 

type SyncBackupInstanceRequest struct {
	// Field indicating sync type e.g. to sync only in case of failure or in all cases
	SyncType *SyncType
}

SyncBackupInstanceRequest - Sync BackupInstance Request

func (SyncBackupInstanceRequest) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SyncBackupInstanceRequest.

func (*SyncBackupInstanceRequest) UnmarshalJSON 

func (s *SyncBackupInstanceRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SyncBackupInstanceRequest.

type SyncType 

type SyncType string

SyncType - Field indicating sync type e.g. to sync only in case of failure or in all cases 

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

func PossibleSyncTypeValues 

func PossibleSyncTypeValues() []SyncType

PossibleSyncTypeValues returns the possible values for the SyncType const type.

type SystemData 

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time

	// The identity that created the resource.
	CreatedBy *string

	// The type of identity that created the resource.
	CreatedByType *CreatedByType

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time

	// The identity that last modified the resource.
	LastModifiedBy *string

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON 

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type TaggingCriteria 

type TaggingCriteria struct {
	// REQUIRED; Specifies if tag is default.
	IsDefault *bool

	// REQUIRED; Retention tag information
	TagInfo *RetentionTag

	// REQUIRED; Retention Tag priority.
	TaggingPriority *int64

	// Criteria which decides whether the tag can be applied to a triggered backup.
	Criteria []BackupCriteriaClassification
}

TaggingCriteria - Tagging criteria

func (TaggingCriteria) MarshalJSON 

func (t TaggingCriteria) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TaggingCriteria.

func (*TaggingCriteria) UnmarshalJSON 

func (t *TaggingCriteria) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TaggingCriteria.

type TargetCopySetting 

type TargetCopySetting struct {
	// REQUIRED; It can be CustomCopyOption or ImmediateCopyOption.
	CopyAfter CopyOptionClassification

	// REQUIRED; Info of target datastore
	DataStore *DataStoreInfoBase
}

TargetCopySetting - Target copy settings

func (TargetCopySetting) MarshalJSON 

func (t TargetCopySetting) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TargetCopySetting.

func (*TargetCopySetting) UnmarshalJSON 

func (t *TargetCopySetting) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TargetCopySetting.

type TargetDetails 

type TargetDetails struct {
	// REQUIRED; Restore operation may create multiple files inside location pointed by Url Below will be the common prefix for
	// all of them
	FilePrefix *string

	// REQUIRED; Denotes the target location where the data will be restored, string value for the enum {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType}
	RestoreTargetLocationType *RestoreTargetLocationType

	// REQUIRED; Url denoting the restore destination. It can point to container / file share etc
	URL *string

	// Full ARM Id denoting the restore destination. It is the ARM Id pointing to container / file share This is optional if the
	// target subscription can be identified with the URL field. If not then this is
	// needed if CrossSubscriptionRestore field of BackupVault is in any of the disabled states
	TargetResourceArmID *string
}

TargetDetails - Class encapsulating target details, used where the destination is not a datasource

func (TargetDetails) MarshalJSON 

func (t TargetDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TargetDetails.

func (*TargetDetails) UnmarshalJSON 

func (t *TargetDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TargetDetails.

type TriggerBackupRequest 

type TriggerBackupRequest struct {
	// REQUIRED; Name for the Rule of the Policy which needs to be applied for this backup
	BackupRuleOptions *AdHocBackupRuleOptions
}

TriggerBackupRequest - Trigger backup request

func (TriggerBackupRequest) MarshalJSON 

func (t TriggerBackupRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TriggerBackupRequest.

func (*TriggerBackupRequest) UnmarshalJSON 

func (t *TriggerBackupRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TriggerBackupRequest.

type TriggerContext 

type TriggerContext struct {
	// REQUIRED; Type of the specific object - used for deserializing
	ObjectType *string
}

TriggerContext - Trigger context

func (*TriggerContext) GetTriggerContext 

func (t *TriggerContext) GetTriggerContext() *TriggerContext

GetTriggerContext implements the TriggerContextClassification interface for type TriggerContext.

func (TriggerContext) MarshalJSON 

func (t TriggerContext) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TriggerContext.

func (*TriggerContext) UnmarshalJSON 

func (t *TriggerContext) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TriggerContext.

type TriggerContextClassification 

type TriggerContextClassification interface {
	// GetTriggerContext returns the TriggerContext content of the underlying type.
	GetTriggerContext() *TriggerContext
}

TriggerContextClassification provides polymorphic access to related types. Call the interface's GetTriggerContext() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AdhocBasedTriggerContext, *ScheduleBasedTriggerContext, *TriggerContext

type UnlockDeleteRequest 

type UnlockDeleteRequest struct {
	// ResourceGuardOperationRequests on which LAC check will be performed
	ResourceGuardOperationRequests []*string
	ResourceToBeDeleted            *string
}

UnlockDeleteRequest - Request body of unlock delete API.

func (UnlockDeleteRequest) MarshalJSON 

func (u UnlockDeleteRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UnlockDeleteRequest.

func (*UnlockDeleteRequest) UnmarshalJSON 

func (u *UnlockDeleteRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UnlockDeleteRequest.

type UnlockDeleteResponse 

type UnlockDeleteResponse struct {
	// This is the time when unlock delete privileges will get expired.
	UnlockDeleteExpiryTime *string
}

UnlockDeleteResponse - Response of Unlock Delete API.

func (UnlockDeleteResponse) MarshalJSON 

func (u UnlockDeleteResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UnlockDeleteResponse.

func (*UnlockDeleteResponse) UnmarshalJSON 

func (u *UnlockDeleteResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UnlockDeleteResponse.

type UserAssignedIdentity 

type UserAssignedIdentity struct {
	// READ-ONLY; The client ID of the assigned identity.
	ClientID *string

	// READ-ONLY; The principal ID of the assigned identity.
	PrincipalID *string
}

UserAssignedIdentity - User assigned identity properties

func (UserAssignedIdentity) MarshalJSON 

func (u UserAssignedIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserAssignedIdentity.

func (*UserAssignedIdentity) UnmarshalJSON 

func (u *UserAssignedIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserAssignedIdentity.

type UserFacingError 

type UserFacingError struct {
	// Unique code for this error
	Code *string

	// Additional related Errors
	Details []*UserFacingError

	// Inner Error
	InnerError *InnerError

	// Whether the operation will be retryable or not
	IsRetryable *bool

	// Whether the operation is due to a user error or service error
	IsUserError *bool
	Message     *string

	// Any key value pairs that can be injected inside error object
	Properties map[string]*string

	// RecommendedAction � localized.
	RecommendedAction []*string

	// Target of the error.
	Target *string
}

UserFacingError - Error object used by layers that have access to localized content, and propagate that to user

func (UserFacingError) MarshalJSON 

func (u UserFacingError) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserFacingError.

func (*UserFacingError) UnmarshalJSON 

func (u *UserFacingError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserFacingError.

type UserFacingWarningDetail 

type UserFacingWarningDetail struct {
	// REQUIRED; Error details for the warning.
	Warning *UserFacingError

	// Name of resource for which warning is raised.
	ResourceName *string
}

UserFacingWarningDetail - Warning object used by layers that have access to localized content, and propagate that to user

func (UserFacingWarningDetail) MarshalJSON 

func (u UserFacingWarningDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserFacingWarningDetail.

func (*UserFacingWarningDetail) UnmarshalJSON 

func (u *UserFacingWarningDetail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserFacingWarningDetail.

type ValidateCrossRegionRestoreRequestObject 

type ValidateCrossRegionRestoreRequestObject struct {
	// REQUIRED; Cross region restore details.
	CrossRegionRestoreDetails *CrossRegionRestoreDetails

	// REQUIRED; Gets or sets the restore request object.
	RestoreRequestObject AzureBackupRestoreRequestClassification
}

ValidateCrossRegionRestoreRequestObject - Cross Region Restore Request Object

func (ValidateCrossRegionRestoreRequestObject) MarshalJSON 

func (v ValidateCrossRegionRestoreRequestObject) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ValidateCrossRegionRestoreRequestObject.

func (*ValidateCrossRegionRestoreRequestObject) UnmarshalJSON 

func (v *ValidateCrossRegionRestoreRequestObject) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ValidateCrossRegionRestoreRequestObject.

type ValidateForBackupRequest 

type ValidateForBackupRequest struct {
	// REQUIRED; Backup Instance
	BackupInstance *BackupInstance
}

ValidateForBackupRequest - Validate for backup request

func (ValidateForBackupRequest) MarshalJSON 

func (v ValidateForBackupRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ValidateForBackupRequest.

func (*ValidateForBackupRequest) UnmarshalJSON 

func (v *ValidateForBackupRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ValidateForBackupRequest.

type ValidateRestoreRequestObject 

type ValidateRestoreRequestObject struct {
	// REQUIRED; Gets or sets the restore request object.
	RestoreRequestObject AzureBackupRestoreRequestClassification
}

ValidateRestoreRequestObject - Validate restore request object

func (ValidateRestoreRequestObject) MarshalJSON 

func (v ValidateRestoreRequestObject) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ValidateRestoreRequestObject.

func (*ValidateRestoreRequestObject) UnmarshalJSON 

func (v *ValidateRestoreRequestObject) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ValidateRestoreRequestObject.

type ValidationType 

type ValidationType string

ValidationType - Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. 

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

func PossibleValidationTypeValues 

func PossibleValidationTypeValues() []ValidationType

PossibleValidationTypeValues returns the possible values for the ValidationType const type.

type WeekNumber 

type WeekNumber string
const (
	WeekNumberFirst  WeekNumber = "First"
	WeekNumberFourth WeekNumber = "Fourth"
	WeekNumberLast   WeekNumber = "Last"
	WeekNumberSecond WeekNumber = "Second"
	WeekNumberThird  WeekNumber = "Third"
)

func PossibleWeekNumberValues 

func PossibleWeekNumberValues() []WeekNumber

PossibleWeekNumberValues returns the possible values for the WeekNumber const type.

Source Files

View all Source files

Directories

Path Synopsis

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.