checknameavailabilitynamespaces

README

github.com/hashicorp/go-azure-sdk/resource-manager/eventhub/2024-01-01/checknameavailabilitynamespaces Documentation

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

Client Initialization

client := checknameavailabilitynamespaces.NewCheckNameAvailabilityNamespacesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CheckNameAvailabilityNamespacesClient.NamespacesCheckNameAvailability

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

payload := checknameavailabilitynamespaces.CheckNameAvailabilityParameter{
	// ...
}


read, err := client.NamespacesCheckNameAvailability(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 PossibleValuesForUnavailableReason() []string
• type CheckNameAvailabilityNamespacesClient
  • func NewCheckNameAvailabilityNamespacesClientWithBaseURI(sdkApi sdkEnv.Api) (*CheckNameAvailabilityNamespacesClient, error)
  • func (c CheckNameAvailabilityNamespacesClient) NamespacesCheckNameAvailability(ctx context.Context, id commonids.SubscriptionId, ...) (result NamespacesCheckNameAvailabilityOperationResponse, err error)
• type CheckNameAvailabilityParameter
• type CheckNameAvailabilityResult
• type NamespacesCheckNameAvailabilityOperationResponse
• type UnavailableReason
  • func (s *UnavailableReason) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForUnavailableReason

func PossibleValuesForUnavailableReason() []string

Types

type CheckNameAvailabilityNamespacesClient

type CheckNameAvailabilityNamespacesClient struct {
	Client *resourcemanager.Client
}

func NewCheckNameAvailabilityNamespacesClientWithBaseURI

func NewCheckNameAvailabilityNamespacesClientWithBaseURI(sdkApi sdkEnv.Api) (*CheckNameAvailabilityNamespacesClient, error)

func (CheckNameAvailabilityNamespacesClient) NamespacesCheckNameAvailability

func (c CheckNameAvailabilityNamespacesClient) NamespacesCheckNameAvailability(ctx context.Context, id commonids.SubscriptionId, input CheckNameAvailabilityParameter) (result NamespacesCheckNameAvailabilityOperationResponse, err error)

NamespacesCheckNameAvailability ...

type CheckNameAvailabilityParameter

type CheckNameAvailabilityParameter struct {
	Name string `json:"name"`
}

type CheckNameAvailabilityResult

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

type NamespacesCheckNameAvailabilityOperationResponse

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

type UnavailableReason

type UnavailableReason string

const (
	UnavailableReasonInvalidName                           UnavailableReason = "InvalidName"
	UnavailableReasonNameInLockdown                        UnavailableReason = "NameInLockdown"
	UnavailableReasonNameInUse                             UnavailableReason = "NameInUse"
	UnavailableReasonNone                                  UnavailableReason = "None"
	UnavailableReasonSubscriptionIsDisabled                UnavailableReason = "SubscriptionIsDisabled"
	UnavailableReasonTooManyNamespaceInCurrentSubscription UnavailableReason = "TooManyNamespaceInCurrentSubscription"
)

func (*UnavailableReason) UnmarshalJSON

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