backupinstancesextensionrouting

package
v0.20241016.1080325 Latest Latest
Warning

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

 Go to latest Published: Oct 16, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/dataprotection/2024-04-01/backupinstancesextensionrouting Documentation

The backupinstancesextensionrouting SDK allows for interaction with Azure Resource Manager dataprotection (API Version 2024-04-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/dataprotection/2024-04-01/backupinstancesextensionrouting"

Client Initialization

client := backupinstancesextensionrouting.NewBackupInstancesExtensionRoutingClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BackupInstancesExtensionRoutingClient.List

ctx := context.TODO()
id := commonids.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

// alternatively `client.List(ctx, id)` can be used to do batched pagination
items, err := client.ListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForCurrentProtectionState 

func PossibleValuesForCurrentProtectionState() []string

func PossibleValuesForDataStoreTypes 

func PossibleValuesForDataStoreTypes() []string

func PossibleValuesForResourcePropertiesObjectType 

func PossibleValuesForResourcePropertiesObjectType() []string

func PossibleValuesForSecretStoreType 

func PossibleValuesForSecretStoreType() []string

func PossibleValuesForStatus 

func PossibleValuesForStatus() []string

func PossibleValuesForValidationType 

func PossibleValuesForValidationType() []string

Types

type AuthCredentials 

type AuthCredentials interface {
	AuthCredentials() BaseAuthCredentialsImpl
}

func UnmarshalAuthCredentialsImplementation added in v0.20240920.1135249 

func UnmarshalAuthCredentialsImplementation(input []byte) (AuthCredentials, error)

type AzureOperationalStoreParameters 

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

	DataStoreType DataStoreTypes `json:"dataStoreType"`
	ObjectType    string         `json:"objectType"`
}

func (AzureOperationalStoreParameters) DataStoreParameters added in v0.20240920.1135249 

func (s AzureOperationalStoreParameters) DataStoreParameters() BaseDataStoreParametersImpl

func (AzureOperationalStoreParameters) MarshalJSON 

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

type BackupDatasourceParameters 

type BackupDatasourceParameters interface {
	BackupDatasourceParameters() BaseBackupDatasourceParametersImpl
}

func UnmarshalBackupDatasourceParametersImplementation added in v0.20240920.1135249 

func UnmarshalBackupDatasourceParametersImplementation(input []byte) (BackupDatasourceParameters, error)

type BackupInstance 

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

func (*BackupInstance) UnmarshalJSON 

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

type BackupInstanceResource 

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

type BackupInstanceResourceOperationPredicate 

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

func (BackupInstanceResourceOperationPredicate) Matches 

func (p BackupInstanceResourceOperationPredicate) Matches(input BackupInstanceResource) bool

type BackupInstancesExtensionRoutingClient 

type BackupInstancesExtensionRoutingClient struct {
	Client *resourcemanager.Client
}

func NewBackupInstancesExtensionRoutingClientWithBaseURI 

func NewBackupInstancesExtensionRoutingClientWithBaseURI(sdkApi sdkEnv.Api) (*BackupInstancesExtensionRoutingClient, error)

func (BackupInstancesExtensionRoutingClient) List 

func (c BackupInstancesExtensionRoutingClient) List(ctx context.Context, id commonids.ScopeId) (result ListOperationResponse, err error)

List ...

func (BackupInstancesExtensionRoutingClient) ListComplete 

func (c BackupInstancesExtensionRoutingClient) ListComplete(ctx context.Context, id commonids.ScopeId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (BackupInstancesExtensionRoutingClient) ListCompleteMatchingPredicate 

func (c BackupInstancesExtensionRoutingClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, predicate BackupInstanceResourceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type BaseAuthCredentialsImpl added in v0.20240920.1135249 

type BaseAuthCredentialsImpl struct {
	ObjectType string `json:"objectType"`
}

func (BaseAuthCredentialsImpl) AuthCredentials added in v0.20240920.1135249 

func (s BaseAuthCredentialsImpl) AuthCredentials() BaseAuthCredentialsImpl

type BaseBackupDatasourceParametersImpl added in v0.20240920.1135249 

type BaseBackupDatasourceParametersImpl struct {
	ObjectType string `json:"objectType"`
}

func (BaseBackupDatasourceParametersImpl) BackupDatasourceParameters added in v0.20240920.1135249 

func (s BaseBackupDatasourceParametersImpl) BackupDatasourceParameters() BaseBackupDatasourceParametersImpl

type BaseBaseResourcePropertiesImpl added in v0.20240920.1135249 

type BaseBaseResourcePropertiesImpl struct {
	ObjectType ResourcePropertiesObjectType `json:"objectType"`
}

func (BaseBaseResourcePropertiesImpl) BaseResourceProperties added in v0.20240920.1135249 

func (s BaseBaseResourcePropertiesImpl) BaseResourceProperties() BaseBaseResourcePropertiesImpl

type BaseDataStoreParametersImpl added in v0.20240920.1135249 

type BaseDataStoreParametersImpl struct {
	DataStoreType DataStoreTypes `json:"dataStoreType"`
	ObjectType    string         `json:"objectType"`
}

func (BaseDataStoreParametersImpl) DataStoreParameters added in v0.20240920.1135249 

func (s BaseDataStoreParametersImpl) DataStoreParameters() BaseDataStoreParametersImpl

type BaseResourceProperties 

type BaseResourceProperties interface {
	BaseResourceProperties() BaseBaseResourcePropertiesImpl
}

func UnmarshalBaseResourcePropertiesImplementation added in v0.20240920.1135249 

func UnmarshalBaseResourcePropertiesImplementation(input []byte) (BaseResourceProperties, error)

type BlobBackupDatasourceParameters 

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

	ObjectType string `json:"objectType"`
}

func (BlobBackupDatasourceParameters) BackupDatasourceParameters added in v0.20240920.1135249 

func (s BlobBackupDatasourceParameters) BackupDatasourceParameters() BaseBackupDatasourceParametersImpl

func (BlobBackupDatasourceParameters) MarshalJSON 

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

type CurrentProtectionState 

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

func (*CurrentProtectionState) UnmarshalJSON 

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

type DataStoreParameters 

type DataStoreParameters interface {
	DataStoreParameters() BaseDataStoreParametersImpl
}

func UnmarshalDataStoreParametersImplementation added in v0.20240920.1135249 

func UnmarshalDataStoreParametersImplementation(input []byte) (DataStoreParameters, error)

type DataStoreTypes 

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

func (*DataStoreTypes) UnmarshalJSON 

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

type Datasource 

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

func (*Datasource) UnmarshalJSON 

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

type DatasourceSet 

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

func (*DatasourceSet) UnmarshalJSON 

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

type DefaultResourceProperties 

type DefaultResourceProperties struct {
	ObjectType ResourcePropertiesObjectType `json:"objectType"`
}

func (DefaultResourceProperties) BaseResourceProperties added in v0.20240920.1135249 

func (s DefaultResourceProperties) BaseResourceProperties() BaseBaseResourcePropertiesImpl

func (DefaultResourceProperties) MarshalJSON 

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

type IdentityDetails 

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

type InnerError 

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

type KubernetesClusterBackupDatasourceParameters 

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

	ObjectType string `json:"objectType"`
}

func (KubernetesClusterBackupDatasourceParameters) BackupDatasourceParameters added in v0.20240920.1135249 

func (s KubernetesClusterBackupDatasourceParameters) BackupDatasourceParameters() BaseBackupDatasourceParametersImpl

func (KubernetesClusterBackupDatasourceParameters) MarshalJSON 

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

type ListCompleteResult 

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

type ListCustomPager added in v0.20240628.1153531 

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

type ListOperationResponse 

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

type NamespacedNameResource 

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

type PolicyInfo 

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

type PolicyParameters 

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

func (*PolicyParameters) UnmarshalJSON 

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

type ProtectionStatusDetails 

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

type RawAuthCredentialsImpl 

type RawAuthCredentialsImpl struct {
	Type   string
	Values map[string]interface{}
	// contains filtered or unexported fields
}

RawAuthCredentialsImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

func (RawAuthCredentialsImpl) AuthCredentials added in v0.20240920.1135249 

func (s RawAuthCredentialsImpl) AuthCredentials() BaseAuthCredentialsImpl

type RawBackupDatasourceParametersImpl 

type RawBackupDatasourceParametersImpl struct {
	Type   string
	Values map[string]interface{}
	// contains filtered or unexported fields
}

RawBackupDatasourceParametersImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

func (RawBackupDatasourceParametersImpl) BackupDatasourceParameters added in v0.20240920.1135249 

func (s RawBackupDatasourceParametersImpl) BackupDatasourceParameters() BaseBackupDatasourceParametersImpl

type RawBaseResourcePropertiesImpl 

type RawBaseResourcePropertiesImpl struct {
	Type   string
	Values map[string]interface{}
	// contains filtered or unexported fields
}

RawBaseResourcePropertiesImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

func (RawBaseResourcePropertiesImpl) BaseResourceProperties added in v0.20240920.1135249 

func (s RawBaseResourcePropertiesImpl) BaseResourceProperties() BaseBaseResourcePropertiesImpl

type RawDataStoreParametersImpl 

type RawDataStoreParametersImpl struct {
	Type   string
	Values map[string]interface{}
	// contains filtered or unexported fields
}

RawDataStoreParametersImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

func (RawDataStoreParametersImpl) DataStoreParameters added in v0.20240920.1135249 

func (s RawDataStoreParametersImpl) DataStoreParameters() BaseDataStoreParametersImpl

type ResourcePropertiesObjectType 

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

func (*ResourcePropertiesObjectType) UnmarshalJSON 

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

type SecretStoreBasedAuthCredentials 

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

	ObjectType string `json:"objectType"`
}

func (SecretStoreBasedAuthCredentials) AuthCredentials added in v0.20240920.1135249 

func (s SecretStoreBasedAuthCredentials) AuthCredentials() BaseAuthCredentialsImpl

func (SecretStoreBasedAuthCredentials) MarshalJSON 

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

type SecretStoreResource 

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

type SecretStoreType 

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

func (*SecretStoreType) UnmarshalJSON 

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

type Status 

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

func (*Status) UnmarshalJSON 

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

type UserFacingError 

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

type ValidationType 

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

func (*ValidationType) UnmarshalJSON 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.