backupresourcevaultconfigs

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservicesbackup/2024-04-01/backupresourcevaultconfigs Documentation

The backupresourcevaultconfigs SDK allows for interaction with the Azure Resource Manager Service recoveryservicesbackup (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-sdk/resource-manager/recoveryservicesbackup/2024-04-01/backupresourcevaultconfigs"

Client Initialization

client := backupresourcevaultconfigs.NewBackupResourceVaultConfigsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BackupResourceVaultConfigsClient.Get

ctx := context.TODO()
id := backupresourcevaultconfigs.NewVaultID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue")

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

Example Usage: BackupResourceVaultConfigsClient.Put

ctx := context.TODO()
id := backupresourcevaultconfigs.NewVaultID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue")

payload := backupresourcevaultconfigs.BackupResourceVaultConfigResource{
	// ...
}


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

Example Usage: BackupResourceVaultConfigsClient.Update

ctx := context.TODO()
id := backupresourcevaultconfigs.NewVaultID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue")

payload := backupresourcevaultconfigs.BackupResourceVaultConfigResource{
	// ...
}


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

Documentation

Index

• func PossibleValuesForEnhancedSecurityState() []string
• func PossibleValuesForSoftDeleteFeatureState() []string
• func PossibleValuesForStorageType() []string
• func PossibleValuesForStorageTypeState() []string
• func ValidateVaultID(input interface{}, key string) (warnings []string, errors []error)
• type BackupResourceVaultConfig
• type BackupResourceVaultConfigResource
• type BackupResourceVaultConfigsClient
  • func NewBackupResourceVaultConfigsClientWithBaseURI(endpoint string) BackupResourceVaultConfigsClient
  • func (c BackupResourceVaultConfigsClient) Get(ctx context.Context, id VaultId) (result GetOperationResponse, err error)
  • func (c BackupResourceVaultConfigsClient) Put(ctx context.Context, id VaultId, input BackupResourceVaultConfigResource, ...) (result PutOperationResponse, err error)
  • func (c BackupResourceVaultConfigsClient) Update(ctx context.Context, id VaultId, input BackupResourceVaultConfigResource, ...) (result UpdateOperationResponse, err error)
• type EnhancedSecurityState
• type GetOperationResponse
• type PutOperationOptions
  • func DefaultPutOperationOptions() PutOperationOptions
• type PutOperationResponse
• type SoftDeleteFeatureState
• type StorageType
• type StorageTypeState
• type UpdateOperationOptions
  • func DefaultUpdateOperationOptions() UpdateOperationOptions
• type UpdateOperationResponse
• type VaultId
  • func NewVaultID(subscriptionId string, resourceGroupName string, vaultName string) VaultId
  • func ParseVaultID(input string) (*VaultId, error)
  • func ParseVaultIDInsensitively(input string) (*VaultId, error)
  • func (id *VaultId) FromParseResult(input resourceids.ParseResult) error
  • func (id VaultId) ID() string
  • func (id VaultId) Segments() []resourceids.Segment
  • func (id VaultId) String() string

Functions

func PossibleValuesForEnhancedSecurityState

func PossibleValuesForEnhancedSecurityState() []string

func PossibleValuesForSoftDeleteFeatureState

func PossibleValuesForSoftDeleteFeatureState() []string

func PossibleValuesForStorageType

func PossibleValuesForStorageType() []string

func PossibleValuesForStorageTypeState

func PossibleValuesForStorageTypeState() []string

func ValidateVaultID

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

ValidateVaultID checks that 'input' can be parsed as a Vault ID

Types

type BackupResourceVaultConfig

type BackupResourceVaultConfig struct {
	EnhancedSecurityState            *EnhancedSecurityState  `json:"enhancedSecurityState,omitempty"`
	IsSoftDeleteFeatureStateEditable *bool                   `json:"isSoftDeleteFeatureStateEditable,omitempty"`
	ResourceGuardOperationRequests   *[]string               `json:"resourceGuardOperationRequests,omitempty"`
	SoftDeleteFeatureState           *SoftDeleteFeatureState `json:"softDeleteFeatureState,omitempty"`
	SoftDeleteRetentionPeriodInDays  *int64                  `json:"softDeleteRetentionPeriodInDays,omitempty"`
	StorageModelType                 *StorageType            `json:"storageModelType,omitempty"`
	StorageType                      *StorageType            `json:"storageType,omitempty"`
	StorageTypeState                 *StorageTypeState       `json:"storageTypeState,omitempty"`
}

type BackupResourceVaultConfigResource

type BackupResourceVaultConfigResource struct {
	ETag       *string                    `json:"eTag,omitempty"`
	Id         *string                    `json:"id,omitempty"`
	Location   *string                    `json:"location,omitempty"`
	Name       *string                    `json:"name,omitempty"`
	Properties *BackupResourceVaultConfig `json:"properties,omitempty"`
	Tags       *map[string]string         `json:"tags,omitempty"`
	Type       *string                    `json:"type,omitempty"`
}

type BackupResourceVaultConfigsClient

type BackupResourceVaultConfigsClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewBackupResourceVaultConfigsClientWithBaseURI

func NewBackupResourceVaultConfigsClientWithBaseURI(endpoint string) BackupResourceVaultConfigsClient

func (BackupResourceVaultConfigsClient) Get

func (c BackupResourceVaultConfigsClient) Get(ctx context.Context, id VaultId) (result GetOperationResponse, err error)

Get ...

func (BackupResourceVaultConfigsClient) Put

func (c BackupResourceVaultConfigsClient) Put(ctx context.Context, id VaultId, input BackupResourceVaultConfigResource, options PutOperationOptions) (result PutOperationResponse, err error)

Put ...

func (BackupResourceVaultConfigsClient) Update

func (c BackupResourceVaultConfigsClient) Update(ctx context.Context, id VaultId, input BackupResourceVaultConfigResource, options UpdateOperationOptions) (result UpdateOperationResponse, err error)

Update ...

type EnhancedSecurityState

type EnhancedSecurityState string

const (
	EnhancedSecurityStateDisabled EnhancedSecurityState = "Disabled"
	EnhancedSecurityStateEnabled  EnhancedSecurityState = "Enabled"
	EnhancedSecurityStateInvalid  EnhancedSecurityState = "Invalid"
)

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *BackupResourceVaultConfigResource
}

type PutOperationOptions

type PutOperationOptions struct {
	XMsAuthorizationAuxiliary *string
}

func DefaultPutOperationOptions

func DefaultPutOperationOptions() PutOperationOptions

type PutOperationResponse

type PutOperationResponse struct {
	HttpResponse *http.Response
	Model        *BackupResourceVaultConfigResource
}

type SoftDeleteFeatureState

type SoftDeleteFeatureState string

const (
	SoftDeleteFeatureStateAlwaysON SoftDeleteFeatureState = "AlwaysON"
	SoftDeleteFeatureStateDisabled SoftDeleteFeatureState = "Disabled"
	SoftDeleteFeatureStateEnabled  SoftDeleteFeatureState = "Enabled"
	SoftDeleteFeatureStateInvalid  SoftDeleteFeatureState = "Invalid"
)

type StorageType

type StorageType string

const (
	StorageTypeGeoRedundant               StorageType = "GeoRedundant"
	StorageTypeInvalid                    StorageType = "Invalid"
	StorageTypeLocallyRedundant           StorageType = "LocallyRedundant"
	StorageTypeReadAccessGeoZoneRedundant StorageType = "ReadAccessGeoZoneRedundant"
	StorageTypeZoneRedundant              StorageType = "ZoneRedundant"
)

type StorageTypeState

type StorageTypeState string

const (
	StorageTypeStateInvalid  StorageTypeState = "Invalid"
	StorageTypeStateLocked   StorageTypeState = "Locked"
	StorageTypeStateUnlocked StorageTypeState = "Unlocked"
)

type UpdateOperationOptions

type UpdateOperationOptions struct {
	XMsAuthorizationAuxiliary *string
}

func DefaultUpdateOperationOptions

func DefaultUpdateOperationOptions() UpdateOperationOptions

type UpdateOperationResponse

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *BackupResourceVaultConfigResource
}

type VaultId

type VaultId struct {
	SubscriptionId    string
	ResourceGroupName string
	VaultName         string
}

VaultId is a struct representing the Resource ID for a Vault

func NewVaultID

func NewVaultID(subscriptionId string, resourceGroupName string, vaultName string) VaultId

NewVaultID returns a new VaultId struct

func ParseVaultID

func ParseVaultID(input string) (*VaultId, error)

ParseVaultID parses 'input' into a VaultId

func ParseVaultIDInsensitively

func ParseVaultIDInsensitively(input string) (*VaultId, error)

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

func (*VaultId) FromParseResult

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

func (VaultId) ID

func (id VaultId) ID() string

ID returns the formatted Vault ID

func (VaultId) Segments

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

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

func (VaultId) String

func (id VaultId) String() string

String returns a human-readable description of this Vault ID