checknameavailability

README

github.com/hashicorp/go-azure-sdk/resource-manager/postgresql/2021-06-01/checknameavailability Documentation

The checknameavailability SDK allows for interaction with Azure Resource Manager postgresql (API Version 2021-06-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/postgresql/2021-06-01/checknameavailability"

Client Initialization

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

Example Usage: CheckNameAvailabilityClient.Execute

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

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
}

Documentation

Index

• func PossibleValuesForReason() []string
• type CheckNameAvailabilityClient
  • func NewCheckNameAvailabilityClientWithBaseURI(sdkApi sdkEnv.Api) (*CheckNameAvailabilityClient, error)
  • func (c CheckNameAvailabilityClient) Execute(ctx context.Context, id commonids.SubscriptionId, ...) (result ExecuteOperationResponse, err error)
• type ExecuteOperationResponse
• type NameAvailability
• type NameAvailabilityRequest
• type Reason
  • func (s *Reason) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForReason

func PossibleValuesForReason() []string

Types

type CheckNameAvailabilityClient

type CheckNameAvailabilityClient struct {
	Client *resourcemanager.Client
}

func NewCheckNameAvailabilityClientWithBaseURI

func NewCheckNameAvailabilityClientWithBaseURI(sdkApi sdkEnv.Api) (*CheckNameAvailabilityClient, error)

func (CheckNameAvailabilityClient) Execute

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

Execute ...

type ExecuteOperationResponse

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

type NameAvailability

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

type NameAvailabilityRequest

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

type Reason

type Reason string

const (
	ReasonAlreadyExists Reason = "AlreadyExists"
	ReasonInvalid       Reason = "Invalid"
)

func (*Reason) UnmarshalJSON

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