checkendpointnameavailability

README

github.com/hashicorp/go-azure-sdk/resource-manager/cdn/2024-02-01/checkendpointnameavailability Documentation

The checkendpointnameavailability SDK allows for interaction with Azure Resource Manager cdn (API Version 2024-02-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/cdn/2024-02-01/checkendpointnameavailability"

Client Initialization

client := checkendpointnameavailability.NewCheckEndpointNameAvailabilityClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CheckEndpointNameAvailabilityClient.CheckEndpointNameAvailability

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

payload := checkendpointnameavailability.CheckEndpointNameAvailabilityInput{
	// ...
}


read, err := client.CheckEndpointNameAvailability(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 PossibleValuesForAutoGeneratedDomainNameLabelScope() []string
• func PossibleValuesForResourceType() []string
• type AutoGeneratedDomainNameLabelScope
  • func (s *AutoGeneratedDomainNameLabelScope) UnmarshalJSON(bytes []byte) error
• type CheckEndpointNameAvailabilityClient
  • func NewCheckEndpointNameAvailabilityClientWithBaseURI(sdkApi sdkEnv.Api) (*CheckEndpointNameAvailabilityClient, error)
  • func (c CheckEndpointNameAvailabilityClient) CheckEndpointNameAvailability(ctx context.Context, id commonids.ResourceGroupId, ...) (result CheckEndpointNameAvailabilityOperationResponse, err error)
• type CheckEndpointNameAvailabilityInput
• type CheckEndpointNameAvailabilityOperationResponse
• type CheckEndpointNameAvailabilityOutput
• type ResourceType
  • func (s *ResourceType) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForAutoGeneratedDomainNameLabelScope

func PossibleValuesForAutoGeneratedDomainNameLabelScope() []string

func PossibleValuesForResourceType

func PossibleValuesForResourceType() []string

Types

type AutoGeneratedDomainNameLabelScope

type AutoGeneratedDomainNameLabelScope string

const (
	AutoGeneratedDomainNameLabelScopeNoReuse            AutoGeneratedDomainNameLabelScope = "NoReuse"
	AutoGeneratedDomainNameLabelScopeResourceGroupReuse AutoGeneratedDomainNameLabelScope = "ResourceGroupReuse"
	AutoGeneratedDomainNameLabelScopeSubscriptionReuse  AutoGeneratedDomainNameLabelScope = "SubscriptionReuse"
	AutoGeneratedDomainNameLabelScopeTenantReuse        AutoGeneratedDomainNameLabelScope = "TenantReuse"
)

func (*AutoGeneratedDomainNameLabelScope) UnmarshalJSON

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

type CheckEndpointNameAvailabilityClient

type CheckEndpointNameAvailabilityClient struct {
	Client *resourcemanager.Client
}

func NewCheckEndpointNameAvailabilityClientWithBaseURI

func NewCheckEndpointNameAvailabilityClientWithBaseURI(sdkApi sdkEnv.Api) (*CheckEndpointNameAvailabilityClient, error)

func (CheckEndpointNameAvailabilityClient) CheckEndpointNameAvailability

func (c CheckEndpointNameAvailabilityClient) CheckEndpointNameAvailability(ctx context.Context, id commonids.ResourceGroupId, input CheckEndpointNameAvailabilityInput) (result CheckEndpointNameAvailabilityOperationResponse, err error)

CheckEndpointNameAvailability ...

type CheckEndpointNameAvailabilityInput

type CheckEndpointNameAvailabilityInput struct {
	AutoGeneratedDomainNameLabelScope *AutoGeneratedDomainNameLabelScope `json:"autoGeneratedDomainNameLabelScope,omitempty"`
	Name                              string                             `json:"name"`
	Type                              ResourceType                       `json:"type"`
}

type CheckEndpointNameAvailabilityOperationResponse

type CheckEndpointNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CheckEndpointNameAvailabilityOutput
}

type CheckEndpointNameAvailabilityOutput

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

type ResourceType

type ResourceType string

const (
	ResourceTypeMicrosoftPointCdnProfilesAfdEndpoints ResourceType = "Microsoft.Cdn/Profiles/AfdEndpoints"
	ResourceTypeMicrosoftPointCdnProfilesEndpoints    ResourceType = "Microsoft.Cdn/Profiles/Endpoints"
)

func (*ResourceType) UnmarshalJSON

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