checknameavailability

README

github.com/hashicorp/go-azure-sdk/resource-manager/managementgroups/2023-04-01/checknameavailability Documentation

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

Client Initialization

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

Example Usage: CheckNameAvailabilityClient.CheckNameAvailability

ctx := context.TODO()

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


read, err := client.CheckNameAvailability(ctx, 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
• func PossibleValuesForType() []string
• type CheckNameAvailabilityClient
  • func NewCheckNameAvailabilityClientWithBaseURI(sdkApi sdkEnv.Api) (*CheckNameAvailabilityClient, error)
  • func (c CheckNameAvailabilityClient) CheckNameAvailability(ctx context.Context, input CheckNameAvailabilityRequest) (result CheckNameAvailabilityOperationResponse, err error)
• type CheckNameAvailabilityOperationResponse
• type CheckNameAvailabilityRequest
• type CheckNameAvailabilityResult
• type Reason
  • func (s *Reason) UnmarshalJSON(bytes []byte) error
• type Type
  • func (s *Type) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForReason

func PossibleValuesForReason() []string

func PossibleValuesForType

func PossibleValuesForType() []string

Types

type CheckNameAvailabilityClient

type CheckNameAvailabilityClient struct {
	Client *resourcemanager.Client
}

func NewCheckNameAvailabilityClientWithBaseURI

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

func (CheckNameAvailabilityClient) CheckNameAvailability

func (c CheckNameAvailabilityClient) CheckNameAvailability(ctx context.Context, input CheckNameAvailabilityRequest) (result CheckNameAvailabilityOperationResponse, err error)

CheckNameAvailability ...

type CheckNameAvailabilityOperationResponse

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

type CheckNameAvailabilityRequest

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

type CheckNameAvailabilityResult

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

type Reason

type Reason string

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

func (*Reason) UnmarshalJSON

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

type Type

type Type string

const (
	TypeMicrosoftPointManagementManagementGroups Type = "Microsoft.Management/managementGroups"
)

func (*Type) UnmarshalJSON

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