resourceguardproxies

README

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

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

Client Initialization

client := resourceguardproxies.NewResourceGuardProxiesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ResourceGuardProxiesClient.Get

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

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

Documentation

Index

• func ValidateVaultID(input interface{}, key string) (warnings []string, errors []error)
• type GetCompleteResult
• type GetOperationResponse
  • func (r GetOperationResponse) HasMore() bool
  • func (r GetOperationResponse) LoadMore(ctx context.Context) (resp GetOperationResponse, err error)
• type ResourceGuardOperationDetail
• type ResourceGuardProxiesClient
  • func NewResourceGuardProxiesClientWithBaseURI(endpoint string) ResourceGuardProxiesClient
  • func (c ResourceGuardProxiesClient) Get(ctx context.Context, id VaultId) (resp GetOperationResponse, err error)
  • func (c ResourceGuardProxiesClient) GetComplete(ctx context.Context, id VaultId) (GetCompleteResult, error)
  • func (c ResourceGuardProxiesClient) GetCompleteMatchingPredicate(ctx context.Context, id VaultId, ...) (resp GetCompleteResult, err error)
• type ResourceGuardProxyBase
• type ResourceGuardProxyBaseResource
• type ResourceGuardProxyBaseResourceOperationPredicate
  • func (p ResourceGuardProxyBaseResourceOperationPredicate) Matches(input ResourceGuardProxyBaseResource) bool
• 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 ValidateVaultID

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

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

Types

type GetCompleteResult

type GetCompleteResult struct {
	Items []ResourceGuardProxyBaseResource
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]ResourceGuardProxyBaseResource
	// contains filtered or unexported fields
}

func (GetOperationResponse) HasMore

func (r GetOperationResponse) HasMore() bool

func (GetOperationResponse) LoadMore

func (r GetOperationResponse) LoadMore(ctx context.Context) (resp GetOperationResponse, err error)

type ResourceGuardOperationDetail

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

type ResourceGuardProxiesClient

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

func NewResourceGuardProxiesClientWithBaseURI

func NewResourceGuardProxiesClientWithBaseURI(endpoint string) ResourceGuardProxiesClient

func (ResourceGuardProxiesClient) Get

func (c ResourceGuardProxiesClient) Get(ctx context.Context, id VaultId) (resp GetOperationResponse, err error)

Get ...

func (ResourceGuardProxiesClient) GetComplete

func (c ResourceGuardProxiesClient) GetComplete(ctx context.Context, id VaultId) (GetCompleteResult, error)

GetComplete retrieves all of the results into a single object

func (ResourceGuardProxiesClient) GetCompleteMatchingPredicate

func (c ResourceGuardProxiesClient) GetCompleteMatchingPredicate(ctx context.Context, id VaultId, predicate ResourceGuardProxyBaseResourceOperationPredicate) (resp GetCompleteResult, err error)

GetCompleteMatchingPredicate retrieves all of the results and then applied the predicate

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 ResourceGuardProxyBaseResourceOperationPredicate

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

func (ResourceGuardProxyBaseResourceOperationPredicate) Matches

func (p ResourceGuardProxyBaseResourceOperationPredicate) Matches(input ResourceGuardProxyBaseResource) bool

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