recoveryservices

README

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

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

Client Initialization

client := recoveryservices.NewRecoveryServicesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RecoveryServicesClient.Capabilities

ctx := context.TODO()
id := recoveryservices.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

payload := recoveryservices.ResourceCapabilities{
	// ...
}


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

Example Usage: RecoveryServicesClient.CheckNameAvailability

ctx := context.TODO()
id := recoveryservices.NewProviderLocationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "locationValue")

payload := recoveryservices.CheckNameAvailabilityParameters{
	// ...
}


read, err := client.CheckNameAvailability(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 PossibleValuesForVaultSubResourceType() []string
• func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateProviderLocationID(input interface{}, key string) (warnings []string, errors []error)
• type CapabilitiesOperationResponse
• type CapabilitiesProperties
• type CapabilitiesResponse
• type CapabilitiesResponseProperties
• type CheckNameAvailabilityOperationResponse
• type CheckNameAvailabilityParameters
• type CheckNameAvailabilityResult
• type DNSZone
• type DNSZoneResponse
• type LocationId
  • func NewLocationID(subscriptionId string, locationName string) LocationId
  • func ParseLocationID(input string) (*LocationId, error)
  • func ParseLocationIDInsensitively(input string) (*LocationId, error)
  • func (id *LocationId) FromParseResult(input resourceids.ParseResult) error
  • func (id LocationId) ID() string
  • func (id LocationId) Segments() []resourceids.Segment
  • func (id LocationId) String() string
• type ProviderLocationId
  • func NewProviderLocationID(subscriptionId string, resourceGroupName string, locationName string) ProviderLocationId
  • func ParseProviderLocationID(input string) (*ProviderLocationId, error)
  • func ParseProviderLocationIDInsensitively(input string) (*ProviderLocationId, error)
  • func (id *ProviderLocationId) FromParseResult(input resourceids.ParseResult) error
  • func (id ProviderLocationId) ID() string
  • func (id ProviderLocationId) Segments() []resourceids.Segment
  • func (id ProviderLocationId) String() string
• type RecoveryServicesClient
  • func NewRecoveryServicesClientWithBaseURI(sdkApi sdkEnv.Api) (*RecoveryServicesClient, error)
  • func (c RecoveryServicesClient) Capabilities(ctx context.Context, id LocationId, input ResourceCapabilities) (result CapabilitiesOperationResponse, err error)
  • func (c RecoveryServicesClient) CheckNameAvailability(ctx context.Context, id ProviderLocationId, ...) (result CheckNameAvailabilityOperationResponse, err error)
• type ResourceCapabilities
• type VaultSubResourceType
  • func (s *VaultSubResourceType) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForVaultSubResourceType

func PossibleValuesForVaultSubResourceType() []string

func ValidateLocationID

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

func ValidateProviderLocationID

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

ValidateProviderLocationID checks that 'input' can be parsed as a Provider Location ID

Types

type CapabilitiesOperationResponse

type CapabilitiesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CapabilitiesResponse
}

type CapabilitiesProperties

type CapabilitiesProperties struct {
	DnsZones *[]DNSZone `json:"dnsZones,omitempty"`
}

type CapabilitiesResponse

type CapabilitiesResponse struct {
	Properties *CapabilitiesResponseProperties `json:"properties,omitempty"`
	Type       string                          `json:"type"`
}

type CapabilitiesResponseProperties

type CapabilitiesResponseProperties struct {
	DnsZones *[]DNSZoneResponse `json:"dnsZones,omitempty"`
}

type CheckNameAvailabilityOperationResponse

type CheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CheckNameAvailabilityResult
}

type CheckNameAvailabilityParameters

type CheckNameAvailabilityParameters struct {
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

type CheckNameAvailabilityResult

type CheckNameAvailabilityResult struct {
	Message       *string `json:"message,omitempty"`
	NameAvailable *bool   `json:"nameAvailable,omitempty"`
	Reason        *string `json:"reason,omitempty"`
}

type DNSZone

type DNSZone struct {
	SubResource *VaultSubResourceType `json:"subResource,omitempty"`
}

type DNSZoneResponse

type DNSZoneResponse struct {
	RequiredZoneNames *[]string             `json:"requiredZoneNames,omitempty"`
	SubResource       *VaultSubResourceType `json:"subResource,omitempty"`
}

type LocationId

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (*LocationId) FromParseResult

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

func (LocationId) ID

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Location ID

func (LocationId) String

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type ProviderLocationId

type ProviderLocationId struct {
	SubscriptionId    string
	ResourceGroupName string
	LocationName      string
}

ProviderLocationId is a struct representing the Resource ID for a Provider Location

func NewProviderLocationID

func NewProviderLocationID(subscriptionId string, resourceGroupName string, locationName string) ProviderLocationId

NewProviderLocationID returns a new ProviderLocationId struct

func ParseProviderLocationID

func ParseProviderLocationID(input string) (*ProviderLocationId, error)

ParseProviderLocationID parses 'input' into a ProviderLocationId

func ParseProviderLocationIDInsensitively

func ParseProviderLocationIDInsensitively(input string) (*ProviderLocationId, error)

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

func (*ProviderLocationId) FromParseResult

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

func (ProviderLocationId) ID

func (id ProviderLocationId) ID() string

ID returns the formatted Provider Location ID

func (ProviderLocationId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Provider Location ID

func (ProviderLocationId) String

func (id ProviderLocationId) String() string

String returns a human-readable description of this Provider Location ID

type RecoveryServicesClient

type RecoveryServicesClient struct {
	Client *resourcemanager.Client
}

func NewRecoveryServicesClientWithBaseURI

func NewRecoveryServicesClientWithBaseURI(sdkApi sdkEnv.Api) (*RecoveryServicesClient, error)

func (RecoveryServicesClient) Capabilities

func (c RecoveryServicesClient) Capabilities(ctx context.Context, id LocationId, input ResourceCapabilities) (result CapabilitiesOperationResponse, err error)

Capabilities ...

func (RecoveryServicesClient) CheckNameAvailability

func (c RecoveryServicesClient) CheckNameAvailability(ctx context.Context, id ProviderLocationId, input CheckNameAvailabilityParameters) (result CheckNameAvailabilityOperationResponse, err error)

CheckNameAvailability ...

type ResourceCapabilities

type ResourceCapabilities struct {
	Properties *CapabilitiesProperties `json:"properties,omitempty"`
	Type       string                  `json:"type"`
}

type VaultSubResourceType

type VaultSubResourceType string

const (
	VaultSubResourceTypeAzureBackup          VaultSubResourceType = "AzureBackup"
	VaultSubResourceTypeAzureBackupSecondary VaultSubResourceType = "AzureBackup_secondary"
	VaultSubResourceTypeAzureSiteRecovery    VaultSubResourceType = "AzureSiteRecovery"
)

func (*VaultSubResourceType) UnmarshalJSON

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