checknameavailabilitydisasterrecoveryconfigs

README

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

The checknameavailabilitydisasterrecoveryconfigs 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-sdk/resource-manager/eventhub/2024-01-01/checknameavailabilitydisasterrecoveryconfigs"

Client Initialization

client := checknameavailabilitydisasterrecoveryconfigs.NewCheckNameAvailabilityDisasterRecoveryConfigsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CheckNameAvailabilityDisasterRecoveryConfigsClient.DisasterRecoveryConfigsCheckNameAvailability

ctx := context.TODO()
id := checknameavailabilitydisasterrecoveryconfigs.NewNamespaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue")

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


read, err := client.DisasterRecoveryConfigsCheckNameAvailability(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
• func ValidateNamespaceID(input interface{}, key string) (warnings []string, errors []error)
• type CheckNameAvailabilityDisasterRecoveryConfigsClient
  • func NewCheckNameAvailabilityDisasterRecoveryConfigsClientWithBaseURI(sdkApi sdkEnv.Api) (*CheckNameAvailabilityDisasterRecoveryConfigsClient, error)
  • func (c CheckNameAvailabilityDisasterRecoveryConfigsClient) DisasterRecoveryConfigsCheckNameAvailability(ctx context.Context, id NamespaceId, input CheckNameAvailabilityParameter) (result DisasterRecoveryConfigsCheckNameAvailabilityOperationResponse, ...)
• type CheckNameAvailabilityParameter
• type CheckNameAvailabilityResult
• type DisasterRecoveryConfigsCheckNameAvailabilityOperationResponse
• type NamespaceId
  • func NewNamespaceID(subscriptionId string, resourceGroupName string, namespaceName string) NamespaceId
  • func ParseNamespaceID(input string) (*NamespaceId, error)
  • func ParseNamespaceIDInsensitively(input string) (*NamespaceId, error)
  • func (id *NamespaceId) FromParseResult(input resourceids.ParseResult) error
  • func (id NamespaceId) ID() string
  • func (id NamespaceId) Segments() []resourceids.Segment
  • func (id NamespaceId) String() string
• type UnavailableReason
  • func (s *UnavailableReason) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForUnavailableReason

func PossibleValuesForUnavailableReason() []string

func ValidateNamespaceID

func ValidateNamespaceID(input interface{}, key string) (warnings []string, errors []error)

ValidateNamespaceID checks that 'input' can be parsed as a Namespace ID

Types

type CheckNameAvailabilityDisasterRecoveryConfigsClient

type CheckNameAvailabilityDisasterRecoveryConfigsClient struct {
	Client *resourcemanager.Client
}

func NewCheckNameAvailabilityDisasterRecoveryConfigsClientWithBaseURI

func NewCheckNameAvailabilityDisasterRecoveryConfigsClientWithBaseURI(sdkApi sdkEnv.Api) (*CheckNameAvailabilityDisasterRecoveryConfigsClient, error)

func (CheckNameAvailabilityDisasterRecoveryConfigsClient) DisasterRecoveryConfigsCheckNameAvailability

func (c CheckNameAvailabilityDisasterRecoveryConfigsClient) DisasterRecoveryConfigsCheckNameAvailability(ctx context.Context, id NamespaceId, input CheckNameAvailabilityParameter) (result DisasterRecoveryConfigsCheckNameAvailabilityOperationResponse, err error)

DisasterRecoveryConfigsCheckNameAvailability ...

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 DisasterRecoveryConfigsCheckNameAvailabilityOperationResponse

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

type NamespaceId

type NamespaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	NamespaceName     string
}

NamespaceId is a struct representing the Resource ID for a Namespace

func NewNamespaceID

func NewNamespaceID(subscriptionId string, resourceGroupName string, namespaceName string) NamespaceId

NewNamespaceID returns a new NamespaceId struct

func ParseNamespaceID

func ParseNamespaceID(input string) (*NamespaceId, error)

ParseNamespaceID parses 'input' into a NamespaceId

func ParseNamespaceIDInsensitively

func ParseNamespaceIDInsensitively(input string) (*NamespaceId, error)

ParseNamespaceIDInsensitively parses 'input' case-insensitively into a NamespaceId note: this method should only be used for API response data and not user input

func (*NamespaceId) FromParseResult

func (id *NamespaceId) FromParseResult(input resourceids.ParseResult) error

func (NamespaceId) ID

func (id NamespaceId) ID() string

ID returns the formatted Namespace ID

func (NamespaceId) Segments

func (id NamespaceId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Namespace ID

func (NamespaceId) String

func (id NamespaceId) String() string

String returns a human-readable description of this Namespace ID

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