recoveryservices

README

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

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

Client Initialization

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

Example Usage: RecoveryServicesClient.CheckNameAvailability

ctx := context.TODO()
id := recoveryservices.NewLocationID("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 ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• type CheckNameAvailabilityOperationResponse
• type CheckNameAvailabilityParameters
• type CheckNameAvailabilityResult
• type LocationId
  • func NewLocationID(subscriptionId string, resourceGroupName 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 RecoveryServicesClient
  • func NewRecoveryServicesClientWithBaseURI(sdkApi sdkEnv.Api) (*RecoveryServicesClient, error)
  • func (c RecoveryServicesClient) CheckNameAvailability(ctx context.Context, id LocationId, input CheckNameAvailabilityParameters) (result CheckNameAvailabilityOperationResponse, err error)

Functions

func ValidateLocationID

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

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

Types

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 LocationId

type LocationId struct {
	SubscriptionId    string
	ResourceGroupName string
	LocationName      string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID

func NewLocationID(subscriptionId string, resourceGroupName 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 RecoveryServicesClient

type RecoveryServicesClient struct {
	Client *resourcemanager.Client
}

func NewRecoveryServicesClientWithBaseURI

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

func (RecoveryServicesClient) CheckNameAvailability

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

CheckNameAvailability ...