voiceservices

README

github.com/hashicorp/go-azure-sdk/resource-manager/voiceservices/2023-04-03/voiceservices Documentation

The voiceservices SDK allows for interaction with the Azure Resource Manager Service voiceservices (API Version 2023-04-03).

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/voiceservices/2023-04-03/voiceservices"

Client Initialization

client := voiceservices.NewVoiceservicesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VoiceservicesClient.NameAvailabilityCheckLocal

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

payload := voiceservices.CheckNameAvailabilityRequest{
	// ...
}


read, err := client.NameAvailabilityCheckLocal(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 PossibleValuesForCheckNameAvailabilityReason() []string
• func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• type CheckNameAvailabilityReason
  • func (s *CheckNameAvailabilityReason) UnmarshalJSON(bytes []byte) error
• type CheckNameAvailabilityRequest
• type CheckNameAvailabilityResponse
• 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
• type NameAvailabilityCheckLocalOperationResponse
• type VoiceservicesClient
  • func NewVoiceservicesClientWithBaseURI(sdkApi sdkEnv.Api) (*VoiceservicesClient, error)
  • func (c VoiceservicesClient) NameAvailabilityCheckLocal(ctx context.Context, id LocationId, input CheckNameAvailabilityRequest) (result NameAvailabilityCheckLocalOperationResponse, err error)

Functions

func PossibleValuesForCheckNameAvailabilityReason

func PossibleValuesForCheckNameAvailabilityReason() []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 CheckNameAvailabilityReason

type CheckNameAvailabilityReason string

const (
	CheckNameAvailabilityReasonAlreadyExists CheckNameAvailabilityReason = "AlreadyExists"
	CheckNameAvailabilityReasonInvalid       CheckNameAvailabilityReason = "Invalid"
)

func (*CheckNameAvailabilityReason) UnmarshalJSON

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

type CheckNameAvailabilityRequest

type CheckNameAvailabilityRequest struct {
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

type CheckNameAvailabilityResponse

type CheckNameAvailabilityResponse struct {
	Message       *string                      `json:"message,omitempty"`
	NameAvailable *bool                        `json:"nameAvailable,omitempty"`
	Reason        *CheckNameAvailabilityReason `json:"reason,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

type NameAvailabilityCheckLocalOperationResponse

type NameAvailabilityCheckLocalOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CheckNameAvailabilityResponse
}

type VoiceservicesClient

type VoiceservicesClient struct {
	Client *resourcemanager.Client
}

func NewVoiceservicesClientWithBaseURI

func NewVoiceservicesClientWithBaseURI(sdkApi sdkEnv.Api) (*VoiceservicesClient, error)

func (VoiceservicesClient) NameAvailabilityCheckLocal

func (c VoiceservicesClient) NameAvailabilityCheckLocal(ctx context.Context, id LocationId, input CheckNameAvailabilityRequest) (result NameAvailabilityCheckLocalOperationResponse, err error)

NameAvailabilityCheckLocal ...