resourceguardproxy

README

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

The resourceguardproxy 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/resourceguardproxy"

Client Initialization

client := resourceguardproxy.NewResourceGuardProxyClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ResourceGuardProxyClient.Delete

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

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

Example Usage: ResourceGuardProxyClient.Get

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

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: ResourceGuardProxyClient.Put

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

payload := resourceguardproxy.ResourceGuardProxyBaseResource{
	// ...
}


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

Example Usage: ResourceGuardProxyClient.UnlockDelete

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

payload := resourceguardproxy.UnlockDeleteRequest{
	// ...
}


read, err := client.UnlockDelete(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 ValidateBackupResourceGuardProxyID(input interface{}, key string) (warnings []string, errors []error)
• type BackupResourceGuardProxyId
  • func NewBackupResourceGuardProxyID(subscriptionId string, resourceGroupName string, vaultName string, ...) BackupResourceGuardProxyId
  • func ParseBackupResourceGuardProxyID(input string) (*BackupResourceGuardProxyId, error)
  • func ParseBackupResourceGuardProxyIDInsensitively(input string) (*BackupResourceGuardProxyId, error)
  • func (id *BackupResourceGuardProxyId) FromParseResult(input resourceids.ParseResult) error
  • func (id BackupResourceGuardProxyId) ID() string
  • func (id BackupResourceGuardProxyId) Segments() []resourceids.Segment
  • func (id BackupResourceGuardProxyId) String() string
• type DeleteOperationResponse
• type GetOperationResponse
• type PutOperationResponse
• type ResourceGuardOperationDetail
• type ResourceGuardProxyBase
• type ResourceGuardProxyBaseResource
• type ResourceGuardProxyClient
  • func NewResourceGuardProxyClientWithBaseURI(endpoint string) ResourceGuardProxyClient
  • func (c ResourceGuardProxyClient) Delete(ctx context.Context, id BackupResourceGuardProxyId) (result DeleteOperationResponse, err error)
  • func (c ResourceGuardProxyClient) Get(ctx context.Context, id BackupResourceGuardProxyId) (result GetOperationResponse, err error)
  • func (c ResourceGuardProxyClient) Put(ctx context.Context, id BackupResourceGuardProxyId, ...) (result PutOperationResponse, err error)
  • func (c ResourceGuardProxyClient) UnlockDelete(ctx context.Context, id BackupResourceGuardProxyId, input UnlockDeleteRequest) (result UnlockDeleteOperationResponse, err error)
• type UnlockDeleteOperationResponse
• type UnlockDeleteRequest
• type UnlockDeleteResponse

Functions

func ValidateBackupResourceGuardProxyID

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

ValidateBackupResourceGuardProxyID checks that 'input' can be parsed as a Backup Resource Guard Proxy ID

Types

type BackupResourceGuardProxyId

type BackupResourceGuardProxyId struct {
	SubscriptionId               string
	ResourceGroupName            string
	VaultName                    string
	BackupResourceGuardProxyName string
}

BackupResourceGuardProxyId is a struct representing the Resource ID for a Backup Resource Guard Proxy

func NewBackupResourceGuardProxyID

func NewBackupResourceGuardProxyID(subscriptionId string, resourceGroupName string, vaultName string, backupResourceGuardProxyName string) BackupResourceGuardProxyId

NewBackupResourceGuardProxyID returns a new BackupResourceGuardProxyId struct

func ParseBackupResourceGuardProxyID

func ParseBackupResourceGuardProxyID(input string) (*BackupResourceGuardProxyId, error)

ParseBackupResourceGuardProxyID parses 'input' into a BackupResourceGuardProxyId

func ParseBackupResourceGuardProxyIDInsensitively

func ParseBackupResourceGuardProxyIDInsensitively(input string) (*BackupResourceGuardProxyId, error)

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

func (*BackupResourceGuardProxyId) FromParseResult

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

func (BackupResourceGuardProxyId) ID

func (id BackupResourceGuardProxyId) ID() string

ID returns the formatted Backup Resource Guard Proxy ID

func (BackupResourceGuardProxyId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Backup Resource Guard Proxy ID

func (BackupResourceGuardProxyId) String

func (id BackupResourceGuardProxyId) String() string

String returns a human-readable description of this Backup Resource Guard Proxy ID

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

type GetOperationResponse

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

type PutOperationResponse

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

type ResourceGuardOperationDetail

type ResourceGuardOperationDetail struct {
	DefaultResourceRequest *string `json:"defaultResourceRequest,omitempty"`
	VaultCriticalOperation *string `json:"vaultCriticalOperation,omitempty"`
}

type ResourceGuardProxyBase

type ResourceGuardProxyBase struct {
	Description                   *string                         `json:"description,omitempty"`
	LastUpdatedTime               *string                         `json:"lastUpdatedTime,omitempty"`
	ResourceGuardOperationDetails *[]ResourceGuardOperationDetail `json:"resourceGuardOperationDetails,omitempty"`
	ResourceGuardResourceId       string                          `json:"resourceGuardResourceId"`
}

type ResourceGuardProxyBaseResource

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

type ResourceGuardProxyClient

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

func NewResourceGuardProxyClientWithBaseURI

func NewResourceGuardProxyClientWithBaseURI(endpoint string) ResourceGuardProxyClient

func (ResourceGuardProxyClient) Delete

func (c ResourceGuardProxyClient) Delete(ctx context.Context, id BackupResourceGuardProxyId) (result DeleteOperationResponse, err error)

Delete ...

func (ResourceGuardProxyClient) Get

func (c ResourceGuardProxyClient) Get(ctx context.Context, id BackupResourceGuardProxyId) (result GetOperationResponse, err error)

Get ...

func (ResourceGuardProxyClient) Put

func (c ResourceGuardProxyClient) Put(ctx context.Context, id BackupResourceGuardProxyId, input ResourceGuardProxyBaseResource) (result PutOperationResponse, err error)

Put ...

func (ResourceGuardProxyClient) UnlockDelete

func (c ResourceGuardProxyClient) UnlockDelete(ctx context.Context, id BackupResourceGuardProxyId, input UnlockDeleteRequest) (result UnlockDeleteOperationResponse, err error)

UnlockDelete ...

type UnlockDeleteOperationResponse

type UnlockDeleteOperationResponse struct {
	HttpResponse *http.Response
	Model        *UnlockDeleteResponse
}

type UnlockDeleteRequest

type UnlockDeleteRequest struct {
	ResourceGuardOperationRequests *[]string `json:"resourceGuardOperationRequests,omitempty"`
	ResourceToBeDeleted            *string   `json:"resourceToBeDeleted,omitempty"`
}

type UnlockDeleteResponse

type UnlockDeleteResponse struct {
	UnlockDeleteExpiryTime *string `json:"unlockDeleteExpiryTime,omitempty"`
}