backupresourceencryptionconfigs

README

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

The backupresourceencryptionconfigs SDK allows for interaction with the Azure Resource Manager Service recoveryservicesbackup (API Version 2024-01-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-01-01/backupresourceencryptionconfigs"

Client Initialization

client := backupresourceencryptionconfigs.NewBackupResourceEncryptionConfigsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BackupResourceEncryptionConfigsClient.Get

ctx := context.TODO()
id := backupresourceencryptionconfigs.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: BackupResourceEncryptionConfigsClient.Update

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

payload := backupresourceencryptionconfigs.BackupResourceEncryptionConfigResource{
	// ...
}


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

Documentation

Index

• func PossibleValuesForEncryptionAtRestType() []string
• func PossibleValuesForInfrastructureEncryptionState() []string
• func PossibleValuesForLastUpdateStatus() []string
• func ValidateVaultID(input interface{}, key string) (warnings []string, errors []error)
• type BackupResourceEncryptionConfig
• type BackupResourceEncryptionConfigExtended
• type BackupResourceEncryptionConfigExtendedResource
• type BackupResourceEncryptionConfigResource
• type BackupResourceEncryptionConfigsClient
  • func NewBackupResourceEncryptionConfigsClientWithBaseURI(endpoint string) BackupResourceEncryptionConfigsClient
  • func (c BackupResourceEncryptionConfigsClient) Get(ctx context.Context, id VaultId) (result GetOperationResponse, err error)
  • func (c BackupResourceEncryptionConfigsClient) Update(ctx context.Context, id VaultId, input BackupResourceEncryptionConfigResource) (result UpdateOperationResponse, err error)
• type EncryptionAtRestType
• type GetOperationResponse
• type InfrastructureEncryptionState
• type LastUpdateStatus
• 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 PossibleValuesForEncryptionAtRestType

func PossibleValuesForEncryptionAtRestType() []string

func PossibleValuesForInfrastructureEncryptionState

func PossibleValuesForInfrastructureEncryptionState() []string

func PossibleValuesForLastUpdateStatus

func PossibleValuesForLastUpdateStatus() []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 BackupResourceEncryptionConfig

type BackupResourceEncryptionConfig struct {
	EncryptionAtRestType          *EncryptionAtRestType          `json:"encryptionAtRestType,omitempty"`
	InfrastructureEncryptionState *InfrastructureEncryptionState `json:"infrastructureEncryptionState,omitempty"`
	KeyUri                        *string                        `json:"keyUri,omitempty"`
	LastUpdateStatus              *LastUpdateStatus              `json:"lastUpdateStatus,omitempty"`
	SubscriptionId                *string                        `json:"subscriptionId,omitempty"`
}

type BackupResourceEncryptionConfigExtended

type BackupResourceEncryptionConfigExtended struct {
	EncryptionAtRestType          *EncryptionAtRestType          `json:"encryptionAtRestType,omitempty"`
	InfrastructureEncryptionState *InfrastructureEncryptionState `json:"infrastructureEncryptionState,omitempty"`
	KeyUri                        *string                        `json:"keyUri,omitempty"`
	LastUpdateStatus              *LastUpdateStatus              `json:"lastUpdateStatus,omitempty"`
	SubscriptionId                *string                        `json:"subscriptionId,omitempty"`
	UseSystemAssignedIdentity     *bool                          `json:"useSystemAssignedIdentity,omitempty"`
	UserAssignedIdentity          *string                        `json:"userAssignedIdentity,omitempty"`
}

type BackupResourceEncryptionConfigExtendedResource

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

type BackupResourceEncryptionConfigResource

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

type BackupResourceEncryptionConfigsClient

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

func NewBackupResourceEncryptionConfigsClientWithBaseURI

func NewBackupResourceEncryptionConfigsClientWithBaseURI(endpoint string) BackupResourceEncryptionConfigsClient

func (BackupResourceEncryptionConfigsClient) Get

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

Get ...

func (BackupResourceEncryptionConfigsClient) Update

func (c BackupResourceEncryptionConfigsClient) Update(ctx context.Context, id VaultId, input BackupResourceEncryptionConfigResource) (result UpdateOperationResponse, err error)

Update ...

type EncryptionAtRestType

type EncryptionAtRestType string

const (
	EncryptionAtRestTypeCustomerManaged  EncryptionAtRestType = "CustomerManaged"
	EncryptionAtRestTypeInvalid          EncryptionAtRestType = "Invalid"
	EncryptionAtRestTypeMicrosoftManaged EncryptionAtRestType = "MicrosoftManaged"
)

type GetOperationResponse

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

type InfrastructureEncryptionState

type InfrastructureEncryptionState string

const (
	InfrastructureEncryptionStateDisabled InfrastructureEncryptionState = "Disabled"
	InfrastructureEncryptionStateEnabled  InfrastructureEncryptionState = "Enabled"
	InfrastructureEncryptionStateInvalid  InfrastructureEncryptionState = "Invalid"
)

type LastUpdateStatus

type LastUpdateStatus string

const (
	LastUpdateStatusFailed              LastUpdateStatus = "Failed"
	LastUpdateStatusFirstInitialization LastUpdateStatus = "FirstInitialization"
	LastUpdateStatusInitialized         LastUpdateStatus = "Initialized"
	LastUpdateStatusInvalid             LastUpdateStatus = "Invalid"
	LastUpdateStatusNotEnabled          LastUpdateStatus = "NotEnabled"
	LastUpdateStatusPartiallyFailed     LastUpdateStatus = "PartiallyFailed"
	LastUpdateStatusPartiallySucceeded  LastUpdateStatus = "PartiallySucceeded"
	LastUpdateStatusSucceeded           LastUpdateStatus = "Succeeded"
)

type UpdateOperationResponse

type UpdateOperationResponse struct {
	HttpResponse *http.Response
}

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