checkdnsavailabilities

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-04-01/checkdnsavailabilities Documentation

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

Client Initialization

client := checkdnsavailabilities.NewCheckDnsAvailabilitiesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CheckDnsAvailabilitiesClient.CheckDnsNameAvailability

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

read, err := client.CheckDnsNameAvailability(ctx, id, checkdnsavailabilities.DefaultCheckDnsNameAvailabilityOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

• func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• type CheckDnsAvailabilitiesClient
  • func NewCheckDnsAvailabilitiesClientWithBaseURI(sdkApi sdkEnv.Api) (*CheckDnsAvailabilitiesClient, error)
  • func (c CheckDnsAvailabilitiesClient) CheckDnsNameAvailability(ctx context.Context, id LocationId, ...) (result CheckDnsNameAvailabilityOperationResponse, err error)
• type CheckDnsNameAvailabilityOperationOptions
  • func DefaultCheckDnsNameAvailabilityOperationOptions() CheckDnsNameAvailabilityOperationOptions
  • func (o CheckDnsNameAvailabilityOperationOptions) ToHeaders() *client.Headers
  • func (o CheckDnsNameAvailabilityOperationOptions) ToOData() *odata.Query
  • func (o CheckDnsNameAvailabilityOperationOptions) ToQuery() *client.QueryParams
• type CheckDnsNameAvailabilityOperationResponse
• type DnsNameAvailabilityResult
• type LocationId
  • func NewLocationID(subscriptionId string, locationName string) LocationId
  • func ParseLocationID(input string) (*LocationId, error)
  • func ParseLocationIDInsensitively(input string) (*LocationId, error)
  • func (id *LocationId) FromParseResult(input resourceids.ParseResult) error
  • func (id LocationId) ID() string
  • func (id LocationId) Segments() []resourceids.Segment
  • func (id LocationId) String() string

Functions

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 CheckDnsAvailabilitiesClient

type CheckDnsAvailabilitiesClient struct {
	Client *resourcemanager.Client
}

func NewCheckDnsAvailabilitiesClientWithBaseURI

func NewCheckDnsAvailabilitiesClientWithBaseURI(sdkApi sdkEnv.Api) (*CheckDnsAvailabilitiesClient, error)

func (CheckDnsAvailabilitiesClient) CheckDnsNameAvailability

func (c CheckDnsAvailabilitiesClient) CheckDnsNameAvailability(ctx context.Context, id LocationId, options CheckDnsNameAvailabilityOperationOptions) (result CheckDnsNameAvailabilityOperationResponse, err error)

CheckDnsNameAvailability ...

type CheckDnsNameAvailabilityOperationOptions

type CheckDnsNameAvailabilityOperationOptions struct {
	DomainNameLabel *string
}

func DefaultCheckDnsNameAvailabilityOperationOptions

func DefaultCheckDnsNameAvailabilityOperationOptions() CheckDnsNameAvailabilityOperationOptions

func (CheckDnsNameAvailabilityOperationOptions) ToHeaders

func (o CheckDnsNameAvailabilityOperationOptions) ToHeaders() *client.Headers

func (CheckDnsNameAvailabilityOperationOptions) ToOData

func (o CheckDnsNameAvailabilityOperationOptions) ToOData() *odata.Query

func (CheckDnsNameAvailabilityOperationOptions) ToQuery

func (o CheckDnsNameAvailabilityOperationOptions) ToQuery() *client.QueryParams

type CheckDnsNameAvailabilityOperationResponse

type CheckDnsNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DnsNameAvailabilityResult
}

type DnsNameAvailabilityResult

type DnsNameAvailabilityResult struct {
	Available *bool `json:"available,omitempty"`
}

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) FromParseResult

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

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