checknameavailability

README

github.com/hashicorp/go-azure-sdk/resource-manager/devcenter/2024-02-01/checknameavailability Documentation

The checknameavailability SDK allows for interaction with the Azure Resource Manager Service devcenter (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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/devcenter/2024-02-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.CheckNameAvailabilityRequest{
	// ...
}


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 PossibleValuesForCheckNameAvailabilityReason() []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 CheckNameAvailabilityReason
  • func (s *CheckNameAvailabilityReason) UnmarshalJSON(bytes []byte) error
• type CheckNameAvailabilityRequest
• type CheckNameAvailabilityResponse
• type ExecuteOperationResponse

Functions

func PossibleValuesForCheckNameAvailabilityReason

func PossibleValuesForCheckNameAvailabilityReason() []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 CheckNameAvailabilityRequest) (result ExecuteOperationResponse, err error)

Execute ...

type CheckNameAvailabilityReason

type CheckNameAvailabilityReason string

const (
	CheckNameAvailabilityReasonAlreadyExists CheckNameAvailabilityReason = "AlreadyExists"
	CheckNameAvailabilityReasonInvalid       CheckNameAvailabilityReason = "Invalid"
)

func (*CheckNameAvailabilityReason) UnmarshalJSON

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

type CheckNameAvailabilityRequest

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

type CheckNameAvailabilityResponse

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

type ExecuteOperationResponse

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