incrementalrestorepoints

package
v0.20230911.1163300 Latest Latest
Warning

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

 Go to latest Published: Sep 11, 2023 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/compute/2023-04-02/incrementalrestorepoints Documentation

The incrementalrestorepoints SDK allows for interaction with the Azure Resource Manager Service compute (API Version 2023-04-02).

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/compute/2023-04-02/incrementalrestorepoints"

Client Initialization

client := incrementalrestorepoints.NewIncrementalRestorePointsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: IncrementalRestorePointsClient.DiskRestorePointGet

ctx := context.TODO()
id := incrementalrestorepoints.NewDiskRestorePointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "restorePointCollectionValue", "restorePointValue", "diskRestorePointValue")

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

Example Usage: IncrementalRestorePointsClient.DiskRestorePointGrantAccess

ctx := context.TODO()
id := incrementalrestorepoints.NewDiskRestorePointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "restorePointCollectionValue", "restorePointValue", "diskRestorePointValue")

payload := incrementalrestorepoints.GrantAccessData{
	// ...
}


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

Example Usage: IncrementalRestorePointsClient.DiskRestorePointListByRestorePoint

ctx := context.TODO()
id := incrementalrestorepoints.NewRestorePointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "restorePointCollectionValue", "restorePointValue")

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

Example Usage: IncrementalRestorePointsClient.DiskRestorePointRevokeAccess

ctx := context.TODO()
id := incrementalrestorepoints.NewDiskRestorePointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "restorePointCollectionValue", "restorePointValue", "diskRestorePointValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAccessLevel 

func PossibleValuesForAccessLevel() []string

func PossibleValuesForArchitecture 

func PossibleValuesForArchitecture() []string

func PossibleValuesForDiskSecurityTypes 

func PossibleValuesForDiskSecurityTypes() []string

func PossibleValuesForEncryptionType 

func PossibleValuesForEncryptionType() []string

func PossibleValuesForFileFormat 

func PossibleValuesForFileFormat() []string

func PossibleValuesForHyperVGeneration 

func PossibleValuesForHyperVGeneration() []string

func PossibleValuesForNetworkAccessPolicy 

func PossibleValuesForNetworkAccessPolicy() []string

func PossibleValuesForOperatingSystemTypes 

func PossibleValuesForOperatingSystemTypes() []string

func PossibleValuesForPublicNetworkAccess 

func PossibleValuesForPublicNetworkAccess() []string

func ValidateDiskRestorePointID 

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

ValidateDiskRestorePointID checks that 'input' can be parsed as a Disk Restore Point ID

func ValidateRestorePointID 

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

ValidateRestorePointID checks that 'input' can be parsed as a Restore Point ID

Types

type AccessLevel 

type AccessLevel string
const (
	AccessLevelNone  AccessLevel = "None"
	AccessLevelRead  AccessLevel = "Read"
	AccessLevelWrite AccessLevel = "Write"
)

func (*AccessLevel) UnmarshalJSON 

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

type AccessUri 

type AccessUri struct {
	AccessSAS             *string `json:"accessSAS,omitempty"`
	SecurityDataAccessSAS *string `json:"securityDataAccessSAS,omitempty"`
}

type Architecture 

type Architecture string
const (
	ArchitectureArmSixFour Architecture = "Arm64"
	ArchitectureXSixFour   Architecture = "x64"
)

func (*Architecture) UnmarshalJSON 

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

type DiskRestorePoint 

type DiskRestorePoint struct {
	Id         *string                     `json:"id,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties *DiskRestorePointProperties `json:"properties,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type DiskRestorePointGetOperationResponse 

type DiskRestorePointGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DiskRestorePoint
}

type DiskRestorePointGrantAccessOperationResponse 

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

type DiskRestorePointId 

type DiskRestorePointId struct {
	SubscriptionId             string
	ResourceGroupName          string
	RestorePointCollectionName string
	RestorePointName           string
	DiskRestorePointName       string
}

DiskRestorePointId is a struct representing the Resource ID for a Disk Restore Point

func NewDiskRestorePointID 

func NewDiskRestorePointID(subscriptionId string, resourceGroupName string, restorePointCollectionName string, restorePointName string, diskRestorePointName string) DiskRestorePointId

NewDiskRestorePointID returns a new DiskRestorePointId struct

func ParseDiskRestorePointID 

func ParseDiskRestorePointID(input string) (*DiskRestorePointId, error)

ParseDiskRestorePointID parses 'input' into a DiskRestorePointId

func ParseDiskRestorePointIDInsensitively 

func ParseDiskRestorePointIDInsensitively(input string) (*DiskRestorePointId, error)

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

func (DiskRestorePointId) ID 

func (id DiskRestorePointId) ID() string

ID returns the formatted Disk Restore Point ID

func (DiskRestorePointId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Disk Restore Point ID

func (DiskRestorePointId) String 

func (id DiskRestorePointId) String() string

String returns a human-readable description of this Disk Restore Point ID

type DiskRestorePointListByRestorePointCompleteResult 

type DiskRestorePointListByRestorePointCompleteResult struct {
	Items []DiskRestorePoint
}

type DiskRestorePointListByRestorePointOperationResponse 

type DiskRestorePointListByRestorePointOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DiskRestorePoint
}

type DiskRestorePointOperationPredicate 

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

func (DiskRestorePointOperationPredicate) Matches 

func (p DiskRestorePointOperationPredicate) Matches(input DiskRestorePoint) bool

type DiskRestorePointProperties 

type DiskRestorePointProperties struct {
	CompletionPercent      *float64               `json:"completionPercent,omitempty"`
	DiskAccessId           *string                `json:"diskAccessId,omitempty"`
	Encryption             *Encryption            `json:"encryption,omitempty"`
	FamilyId               *string                `json:"familyId,omitempty"`
	HyperVGeneration       *HyperVGeneration      `json:"hyperVGeneration,omitempty"`
	NetworkAccessPolicy    *NetworkAccessPolicy   `json:"networkAccessPolicy,omitempty"`
	OsType                 *OperatingSystemTypes  `json:"osType,omitempty"`
	PublicNetworkAccess    *PublicNetworkAccess   `json:"publicNetworkAccess,omitempty"`
	PurchasePlan           *PurchasePlan          `json:"purchasePlan,omitempty"`
	ReplicationState       *string                `json:"replicationState,omitempty"`
	SecurityProfile        *DiskSecurityProfile   `json:"securityProfile,omitempty"`
	SourceResourceId       *string                `json:"sourceResourceId,omitempty"`
	SourceResourceLocation *string                `json:"sourceResourceLocation,omitempty"`
	SourceUniqueId         *string                `json:"sourceUniqueId,omitempty"`
	SupportedCapabilities  *SupportedCapabilities `json:"supportedCapabilities,omitempty"`
	SupportsHibernation    *bool                  `json:"supportsHibernation,omitempty"`
	TimeCreated            *string                `json:"timeCreated,omitempty"`
}

func (*DiskRestorePointProperties) GetTimeCreatedAsTime 

func (o *DiskRestorePointProperties) GetTimeCreatedAsTime() (*time.Time, error)

func (*DiskRestorePointProperties) SetTimeCreatedAsTime 

func (o *DiskRestorePointProperties) SetTimeCreatedAsTime(input time.Time)

type DiskRestorePointRevokeAccessOperationResponse 

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

type DiskSecurityProfile 

type DiskSecurityProfile struct {
	SecureVMDiskEncryptionSetId *string            `json:"secureVMDiskEncryptionSetId,omitempty"`
	SecurityType                *DiskSecurityTypes `json:"securityType,omitempty"`
}

type DiskSecurityTypes 

type DiskSecurityTypes string
const (
	DiskSecurityTypesConfidentialVMDiskEncryptedWithCustomerKey             DiskSecurityTypes = "ConfidentialVM_DiskEncryptedWithCustomerKey"
	DiskSecurityTypesConfidentialVMDiskEncryptedWithPlatformKey             DiskSecurityTypes = "ConfidentialVM_DiskEncryptedWithPlatformKey"
	DiskSecurityTypesConfidentialVMVMGuestStateOnlyEncryptedWithPlatformKey DiskSecurityTypes = "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey"
	DiskSecurityTypesTrustedLaunch                                          DiskSecurityTypes = "TrustedLaunch"
)

func (*DiskSecurityTypes) UnmarshalJSON 

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

type Encryption 

type Encryption struct {
	DiskEncryptionSetId *string         `json:"diskEncryptionSetId,omitempty"`
	Type                *EncryptionType `json:"type,omitempty"`
}

type EncryptionType 

type EncryptionType string
const (
	EncryptionTypeEncryptionAtRestWithCustomerKey             EncryptionType = "EncryptionAtRestWithCustomerKey"
	EncryptionTypeEncryptionAtRestWithPlatformAndCustomerKeys EncryptionType = "EncryptionAtRestWithPlatformAndCustomerKeys"
	EncryptionTypeEncryptionAtRestWithPlatformKey             EncryptionType = "EncryptionAtRestWithPlatformKey"
)

func (*EncryptionType) UnmarshalJSON 

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

type FileFormat 

type FileFormat string
const (
	FileFormatVHD  FileFormat = "VHD"
	FileFormatVHDX FileFormat = "VHDX"
)

func (*FileFormat) UnmarshalJSON 

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

type GrantAccessData 

type GrantAccessData struct {
	Access                   AccessLevel `json:"access"`
	DurationInSeconds        int64       `json:"durationInSeconds"`
	FileFormat               *FileFormat `json:"fileFormat,omitempty"`
	GetSecureVMGuestStateSAS *bool       `json:"getSecureVMGuestStateSAS,omitempty"`
}

type HyperVGeneration 

type HyperVGeneration string
const (
	HyperVGenerationVOne HyperVGeneration = "V1"
	HyperVGenerationVTwo HyperVGeneration = "V2"
)

func (*HyperVGeneration) UnmarshalJSON 

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

type IncrementalRestorePointsClient 

type IncrementalRestorePointsClient struct {
	Client *resourcemanager.Client
}

func NewIncrementalRestorePointsClientWithBaseURI 

func NewIncrementalRestorePointsClientWithBaseURI(sdkApi sdkEnv.Api) (*IncrementalRestorePointsClient, error)

func (IncrementalRestorePointsClient) DiskRestorePointGet 

func (c IncrementalRestorePointsClient) DiskRestorePointGet(ctx context.Context, id DiskRestorePointId) (result DiskRestorePointGetOperationResponse, err error)

DiskRestorePointGet ...

func (IncrementalRestorePointsClient) DiskRestorePointGrantAccess 

func (c IncrementalRestorePointsClient) DiskRestorePointGrantAccess(ctx context.Context, id DiskRestorePointId, input GrantAccessData) (result DiskRestorePointGrantAccessOperationResponse, err error)

DiskRestorePointGrantAccess ...

func (IncrementalRestorePointsClient) DiskRestorePointGrantAccessThenPoll 

func (c IncrementalRestorePointsClient) DiskRestorePointGrantAccessThenPoll(ctx context.Context, id DiskRestorePointId, input GrantAccessData) error

DiskRestorePointGrantAccessThenPoll performs DiskRestorePointGrantAccess then polls until it's completed

func (IncrementalRestorePointsClient) DiskRestorePointListByRestorePoint 

func (c IncrementalRestorePointsClient) DiskRestorePointListByRestorePoint(ctx context.Context, id RestorePointId) (result DiskRestorePointListByRestorePointOperationResponse, err error)

DiskRestorePointListByRestorePoint ...

func (IncrementalRestorePointsClient) DiskRestorePointListByRestorePointComplete 

func (c IncrementalRestorePointsClient) DiskRestorePointListByRestorePointComplete(ctx context.Context, id RestorePointId) (DiskRestorePointListByRestorePointCompleteResult, error)

DiskRestorePointListByRestorePointComplete retrieves all the results into a single object

func (IncrementalRestorePointsClient) DiskRestorePointListByRestorePointCompleteMatchingPredicate 

func (c IncrementalRestorePointsClient) DiskRestorePointListByRestorePointCompleteMatchingPredicate(ctx context.Context, id RestorePointId, predicate DiskRestorePointOperationPredicate) (result DiskRestorePointListByRestorePointCompleteResult, err error)

DiskRestorePointListByRestorePointCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (IncrementalRestorePointsClient) DiskRestorePointRevokeAccess 

func (c IncrementalRestorePointsClient) DiskRestorePointRevokeAccess(ctx context.Context, id DiskRestorePointId) (result DiskRestorePointRevokeAccessOperationResponse, err error)

DiskRestorePointRevokeAccess ...

func (IncrementalRestorePointsClient) DiskRestorePointRevokeAccessThenPoll 

func (c IncrementalRestorePointsClient) DiskRestorePointRevokeAccessThenPoll(ctx context.Context, id DiskRestorePointId) error

DiskRestorePointRevokeAccessThenPoll performs DiskRestorePointRevokeAccess then polls until it's completed

type NetworkAccessPolicy 

type NetworkAccessPolicy string
const (
	NetworkAccessPolicyAllowAll     NetworkAccessPolicy = "AllowAll"
	NetworkAccessPolicyAllowPrivate NetworkAccessPolicy = "AllowPrivate"
	NetworkAccessPolicyDenyAll      NetworkAccessPolicy = "DenyAll"
)

func (*NetworkAccessPolicy) UnmarshalJSON 

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

type OperatingSystemTypes 

type OperatingSystemTypes string
const (
	OperatingSystemTypesLinux   OperatingSystemTypes = "Linux"
	OperatingSystemTypesWindows OperatingSystemTypes = "Windows"
)

func (*OperatingSystemTypes) UnmarshalJSON 

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

type PublicNetworkAccess 

type PublicNetworkAccess string
const (
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	PublicNetworkAccessEnabled  PublicNetworkAccess = "Enabled"
)

func (*PublicNetworkAccess) UnmarshalJSON 

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

type PurchasePlan 

type PurchasePlan struct {
	Name          string  `json:"name"`
	Product       string  `json:"product"`
	PromotionCode *string `json:"promotionCode,omitempty"`
	Publisher     string  `json:"publisher"`
}

type RestorePointId 

type RestorePointId struct {
	SubscriptionId             string
	ResourceGroupName          string
	RestorePointCollectionName string
	RestorePointName           string
}

RestorePointId is a struct representing the Resource ID for a Restore Point

func NewRestorePointID 

func NewRestorePointID(subscriptionId string, resourceGroupName string, restorePointCollectionName string, restorePointName string) RestorePointId

NewRestorePointID returns a new RestorePointId struct

func ParseRestorePointID 

func ParseRestorePointID(input string) (*RestorePointId, error)

ParseRestorePointID parses 'input' into a RestorePointId

func ParseRestorePointIDInsensitively 

func ParseRestorePointIDInsensitively(input string) (*RestorePointId, error)

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

func (RestorePointId) ID 

func (id RestorePointId) ID() string

ID returns the formatted Restore Point ID

func (RestorePointId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Restore Point ID

func (RestorePointId) String 

func (id RestorePointId) String() string

String returns a human-readable description of this Restore Point ID

type SupportedCapabilities 

type SupportedCapabilities struct {
	AcceleratedNetwork  *bool         `json:"acceleratedNetwork,omitempty"`
	Architecture        *Architecture `json:"architecture,omitempty"`
	DiskControllerTypes *string       `json:"diskControllerTypes,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

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