checknameavailability

README

github.com/hashicorp/go-azure-sdk/resource-manager/mysql/2022-01-01/checknameavailability Documentation

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

Client Initialization

client := checknameavailability.NewCheckNameAvailabilityClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CheckNameAvailabilityClient.Execute

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

payload := checknameavailability.NameAvailabilityRequest{
	// ...
}


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

Example Usage: CheckNameAvailabilityClient.WithoutLocationExecute

ctx := context.TODO()
id := checknameavailability.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

payload := checknameavailability.NameAvailabilityRequest{
	// ...
}


read, err := client.WithoutLocationExecute(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 CheckNameAvailabilityClient
  • func NewCheckNameAvailabilityClientWithBaseURI(endpoint string) CheckNameAvailabilityClient
  • func (c CheckNameAvailabilityClient) Execute(ctx context.Context, id LocationId, input NameAvailabilityRequest) (result ExecuteOperationResponse, err error)
  • func (c CheckNameAvailabilityClient) WithoutLocationExecute(ctx context.Context, id commonids.SubscriptionId, ...) (result WithoutLocationExecuteOperationResponse, err error)
• type ExecuteOperationResponse
• type LocationId
  • func NewLocationID(subscriptionId string, locationName string) LocationId
  • func ParseLocationID(input string) (*LocationId, error)
  • func ParseLocationIDInsensitively(input string) (*LocationId, error)
  • func (id LocationId) ID() string
  • func (id LocationId) Segments() []resourceids.Segment
  • func (id LocationId) String() string
• type NameAvailability
• type NameAvailabilityRequest
• type WithoutLocationExecuteOperationResponse

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 CheckNameAvailabilityClient

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

func NewCheckNameAvailabilityClientWithBaseURI

func NewCheckNameAvailabilityClientWithBaseURI(endpoint string) CheckNameAvailabilityClient

func (CheckNameAvailabilityClient) Execute

func (c CheckNameAvailabilityClient) Execute(ctx context.Context, id LocationId, input NameAvailabilityRequest) (result ExecuteOperationResponse, err error)

Execute ...

func (CheckNameAvailabilityClient) WithoutLocationExecute

func (c CheckNameAvailabilityClient) WithoutLocationExecute(ctx context.Context, id commonids.SubscriptionId, input NameAvailabilityRequest) (result WithoutLocationExecuteOperationResponse, err error)

WithoutLocationExecute ...

type ExecuteOperationResponse

type ExecuteOperationResponse struct {
	HttpResponse *http.Response
	Model        *NameAvailability
}

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) 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 NameAvailability

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

type NameAvailabilityRequest

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

type WithoutLocationExecuteOperationResponse

type WithoutLocationExecuteOperationResponse struct {
	HttpResponse *http.Response
	Model        *NameAvailability
}