README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/postgresql/2023-06-01-preview/checknameavailability
Documentation
The checknameavailability
SDK allows for interaction with the Azure Resource Manager Service postgresql
(API Version 2023-06-01-preview
).
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/postgresql/2023-06-01-preview/checknameavailability"
Client Initialization
client := checknameavailability.NewCheckNameAvailabilityClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: CheckNameAvailabilityClient.Execute
ctx := context.TODO()
id := checknameavailability.NewSubscriptionID("12345678-1234-9876-4563-123456789012")
payload := checknameavailability.CheckNameAvailabilityRequest{
// ...
}
read, err := client.Execute(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: CheckNameAvailabilityClient.WithLocationExecute
ctx := context.TODO()
id := checknameavailability.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")
payload := checknameavailability.CheckNameAvailabilityRequest{
// ...
}
read, err := client.WithLocationExecute(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 CheckNameAvailabilityClient
- func (c CheckNameAvailabilityClient) Execute(ctx context.Context, id commonids.SubscriptionId, ...) (result ExecuteOperationResponse, err error)
- func (c CheckNameAvailabilityClient) WithLocationExecute(ctx context.Context, id LocationId, input CheckNameAvailabilityRequest) (result WithLocationExecuteOperationResponse, err error)
- type CheckNameAvailabilityReason
- type CheckNameAvailabilityRequest
- type ExecuteOperationResponse
- type LocationId
- type NameAvailability
- type WithLocationExecuteOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForCheckNameAvailabilityReason ¶
func PossibleValuesForCheckNameAvailabilityReason() []string
func ValidateLocationID ¶
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) Execute ¶
func (c CheckNameAvailabilityClient) Execute(ctx context.Context, id commonids.SubscriptionId, input CheckNameAvailabilityRequest) (result ExecuteOperationResponse, err error)
Execute ...
func (CheckNameAvailabilityClient) WithLocationExecute ¶
func (c CheckNameAvailabilityClient) WithLocationExecute(ctx context.Context, id LocationId, input CheckNameAvailabilityRequest) (result WithLocationExecuteOperationResponse, err error)
WithLocationExecute ...
type CheckNameAvailabilityReason ¶
type CheckNameAvailabilityReason string
const ( CheckNameAvailabilityReasonAlreadyExists CheckNameAvailabilityReason = "AlreadyExists" CheckNameAvailabilityReasonInvalid CheckNameAvailabilityReason = "Invalid" )
func (*CheckNameAvailabilityReason) UnmarshalJSON ¶
func (s *CheckNameAvailabilityReason) UnmarshalJSON(bytes []byte) error
type ExecuteOperationResponse ¶
type ExecuteOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *NameAvailability }
type LocationId ¶
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 ¶ added in v0.20231127.1171502
func (id *LocationId) FromParseResult(input resourceids.ParseResult) error
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 NameAvailability ¶
type NameAvailability struct { Message *string `json:"message,omitempty"` Name *string `json:"name,omitempty"` NameAvailable *bool `json:"nameAvailable,omitempty"` Reason *CheckNameAvailabilityReason `json:"reason,omitempty"` Type *string `json:"type,omitempty"` }
type WithLocationExecuteOperationResponse ¶
type WithLocationExecuteOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *NameAvailability }