dppresourceguardproxies

package
v0.20240712.1145105 Latest Latest
Warning

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

 Go to latest Published: Jul 12, 2024 License: MPL-2.0 Imports: 11 Imported by: 0

README

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

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

Client Initialization

client := dppresourceguardproxies.NewDppResourceGuardProxiesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DppResourceGuardProxiesClient.DppResourceGuardProxyCreateOrUpdate

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

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


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

Example Usage: DppResourceGuardProxiesClient.DppResourceGuardProxyDelete

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

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

Example Usage: DppResourceGuardProxiesClient.DppResourceGuardProxyGet

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

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

Example Usage: DppResourceGuardProxiesClient.DppResourceGuardProxyList

ctx := context.TODO()
id := dppresourceguardproxies.NewBackupVaultID("12345678-1234-9876-4563-123456789012", "example-resource-group", "backupVaultValue")

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

Example Usage: DppResourceGuardProxiesClient.DppResourceGuardProxyUnlockDelete

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

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


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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

func ValidateBackupVaultID 

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

ValidateBackupVaultID checks that 'input' can be parsed as a Backup Vault ID

Types

type BackupResourceGuardProxyId 

type BackupResourceGuardProxyId struct {
	SubscriptionId               string
	ResourceGroupName            string
	BackupVaultName              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, backupVaultName 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 BackupVaultId 

type BackupVaultId struct {
	SubscriptionId    string
	ResourceGroupName string
	BackupVaultName   string
}

BackupVaultId is a struct representing the Resource ID for a Backup Vault

func NewBackupVaultID 

func NewBackupVaultID(subscriptionId string, resourceGroupName string, backupVaultName string) BackupVaultId

NewBackupVaultID returns a new BackupVaultId struct

func ParseBackupVaultID 

func ParseBackupVaultID(input string) (*BackupVaultId, error)

ParseBackupVaultID parses 'input' into a BackupVaultId

func ParseBackupVaultIDInsensitively 

func ParseBackupVaultIDInsensitively(input string) (*BackupVaultId, error)

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

func (*BackupVaultId) FromParseResult 

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

func (BackupVaultId) ID 

func (id BackupVaultId) ID() string

ID returns the formatted Backup Vault ID

func (BackupVaultId) Segments 

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

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

func (BackupVaultId) String 

func (id BackupVaultId) String() string

String returns a human-readable description of this Backup Vault ID

type DppResourceGuardProxiesClient 

type DppResourceGuardProxiesClient struct {
	Client *resourcemanager.Client
}

func NewDppResourceGuardProxiesClientWithBaseURI 

func NewDppResourceGuardProxiesClientWithBaseURI(sdkApi sdkEnv.Api) (*DppResourceGuardProxiesClient, error)

func (DppResourceGuardProxiesClient) DppResourceGuardProxyCreateOrUpdate 

func (c DppResourceGuardProxiesClient) DppResourceGuardProxyCreateOrUpdate(ctx context.Context, id BackupResourceGuardProxyId, input ResourceGuardProxyBaseResource) (result DppResourceGuardProxyCreateOrUpdateOperationResponse, err error)

DppResourceGuardProxyCreateOrUpdate ...

func (DppResourceGuardProxiesClient) DppResourceGuardProxyDelete 

func (c DppResourceGuardProxiesClient) DppResourceGuardProxyDelete(ctx context.Context, id BackupResourceGuardProxyId) (result DppResourceGuardProxyDeleteOperationResponse, err error)

DppResourceGuardProxyDelete ...

func (DppResourceGuardProxiesClient) DppResourceGuardProxyGet 

func (c DppResourceGuardProxiesClient) DppResourceGuardProxyGet(ctx context.Context, id BackupResourceGuardProxyId) (result DppResourceGuardProxyGetOperationResponse, err error)

DppResourceGuardProxyGet ...

func (DppResourceGuardProxiesClient) DppResourceGuardProxyList 

func (c DppResourceGuardProxiesClient) DppResourceGuardProxyList(ctx context.Context, id BackupVaultId) (result DppResourceGuardProxyListOperationResponse, err error)

DppResourceGuardProxyList ...

func (DppResourceGuardProxiesClient) DppResourceGuardProxyListComplete 

func (c DppResourceGuardProxiesClient) DppResourceGuardProxyListComplete(ctx context.Context, id BackupVaultId) (DppResourceGuardProxyListCompleteResult, error)

DppResourceGuardProxyListComplete retrieves all the results into a single object

func (DppResourceGuardProxiesClient) DppResourceGuardProxyListCompleteMatchingPredicate 

func (c DppResourceGuardProxiesClient) DppResourceGuardProxyListCompleteMatchingPredicate(ctx context.Context, id BackupVaultId, predicate ResourceGuardProxyBaseResourceOperationPredicate) (result DppResourceGuardProxyListCompleteResult, err error)

DppResourceGuardProxyListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DppResourceGuardProxiesClient) DppResourceGuardProxyUnlockDelete 

func (c DppResourceGuardProxiesClient) DppResourceGuardProxyUnlockDelete(ctx context.Context, id BackupResourceGuardProxyId, input UnlockDeleteRequest, options DppResourceGuardProxyUnlockDeleteOperationOptions) (result DppResourceGuardProxyUnlockDeleteOperationResponse, err error)

DppResourceGuardProxyUnlockDelete ...

type DppResourceGuardProxyCreateOrUpdateOperationResponse 

type DppResourceGuardProxyCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ResourceGuardProxyBaseResource
}

type DppResourceGuardProxyDeleteOperationResponse 

type DppResourceGuardProxyDeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type DppResourceGuardProxyGetOperationResponse 

type DppResourceGuardProxyGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ResourceGuardProxyBaseResource
}

type DppResourceGuardProxyListCompleteResult 

type DppResourceGuardProxyListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ResourceGuardProxyBaseResource
}

type DppResourceGuardProxyListCustomPager added in v0.20240628.1153531 

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

type DppResourceGuardProxyListOperationResponse 

type DppResourceGuardProxyListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ResourceGuardProxyBaseResource
}

type DppResourceGuardProxyUnlockDeleteOperationOptions 

type DppResourceGuardProxyUnlockDeleteOperationOptions struct {
	XMsAuthorizationAuxiliary *string
}

func DefaultDppResourceGuardProxyUnlockDeleteOperationOptions 

func DefaultDppResourceGuardProxyUnlockDeleteOperationOptions() DppResourceGuardProxyUnlockDeleteOperationOptions

func (DppResourceGuardProxyUnlockDeleteOperationOptions) ToHeaders 

func (o DppResourceGuardProxyUnlockDeleteOperationOptions) ToHeaders() *client.Headers

func (DppResourceGuardProxyUnlockDeleteOperationOptions) ToOData 

func (o DppResourceGuardProxyUnlockDeleteOperationOptions) ToOData() *odata.Query

func (DppResourceGuardProxyUnlockDeleteOperationOptions) ToQuery 

func (o DppResourceGuardProxyUnlockDeleteOperationOptions) ToQuery() *client.QueryParams

type DppResourceGuardProxyUnlockDeleteOperationResponse 

type DppResourceGuardProxyUnlockDeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *UnlockDeleteResponse
}

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,omitempty"`
}

type ResourceGuardProxyBaseResource 

type ResourceGuardProxyBaseResource struct {
	Id         *string                 `json:"id,omitempty"`
	Name       *string                 `json:"name,omitempty"`
	Properties *ResourceGuardProxyBase `json:"properties,omitempty"`
	SystemData *systemdata.SystemData  `json:"systemData,omitempty"`
	Type       *string                 `json:"type,omitempty"`
}

type ResourceGuardProxyBaseResourceOperationPredicate 

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

func (ResourceGuardProxyBaseResourceOperationPredicate) Matches 

func (p ResourceGuardProxyBaseResourceOperationPredicate) Matches(input ResourceGuardProxyBaseResource) bool

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"`
}

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.