checknameavailability

README

github.com/hashicorp/go-azure-sdk/resource-manager/digitaltwins/2023-01-31/checknameavailability Documentation

The checknameavailability SDK allows for interaction with the Azure Resource Manager Service digitaltwins (API Version 2023-01-31).

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/digitaltwins/2023-01-31/checknameavailability"

Client Initialization

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

Example Usage: CheckNameAvailabilityClient.DigitalTwinsCheckNameAvailability

ctx := context.TODO()
id := checknameavailability.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

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


read, err := client.DigitalTwinsCheckNameAvailability(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
• func PossibleValuesForType() []string
• func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• type CheckNameAvailabilityClient
  • func NewCheckNameAvailabilityClientWithBaseURI(sdkApi sdkEnv.Api) (*CheckNameAvailabilityClient, error)
  • func (c CheckNameAvailabilityClient) DigitalTwinsCheckNameAvailability(ctx context.Context, id LocationId, input CheckNameRequest) (result DigitalTwinsCheckNameAvailabilityOperationResponse, err error)
• type CheckNameRequest
• type CheckNameResult
• type DigitalTwinsCheckNameAvailabilityOperationResponse
• type LocationId
  • func NewLocationID(subscriptionId string, locationName string) LocationId
  • func ParseLocationID(input string) (*LocationId, error)
  • func ParseLocationIDInsensitively(input string) (*LocationId, error)
  • func (id LocationId) ID() string
  • func (id LocationId) Segments() []resourceids.Segment
  • func (id LocationId) String() string
• 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

func ValidateLocationID

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type CheckNameAvailabilityClient

type CheckNameAvailabilityClient struct {
	Client *resourcemanager.Client
}

func NewCheckNameAvailabilityClientWithBaseURI

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

func (CheckNameAvailabilityClient) DigitalTwinsCheckNameAvailability

func (c CheckNameAvailabilityClient) DigitalTwinsCheckNameAvailability(ctx context.Context, id LocationId, input CheckNameRequest) (result DigitalTwinsCheckNameAvailabilityOperationResponse, err error)

DigitalTwinsCheckNameAvailability ...

type CheckNameRequest

type CheckNameRequest struct {
	Name string `json:"name"`
	Type Type   `json:"type"`
}

type CheckNameResult

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

type DigitalTwinsCheckNameAvailabilityOperationResponse

type DigitalTwinsCheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CheckNameResult
}

type LocationId

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (LocationId) ID

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments

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

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

func (LocationId) String

func (id LocationId) String() string

String returns a human-readable description of this Location ID

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 (
	TypeMicrosoftPointDigitalTwinsDigitalTwinsInstances Type = "Microsoft.DigitalTwins/digitalTwinsInstances"
)

func (*Type) UnmarshalJSON

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