customoperation

README

github.com/hashicorp/go-azure-sdk/resource-manager/postgresql/2023-03-01-preview/customoperation Documentation

The customoperation SDK allows for interaction with the Azure Resource Manager Service postgresql (API Version 2023-03-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-03-01-preview/customoperation"

Client Initialization

client := customoperation.NewCustomOperationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CustomOperationClient.CheckMigrationNameAvailability

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

payload := customoperation.MigrationNameAvailabilityResource{
	// ...
}


read, err := client.CheckMigrationNameAvailability(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 PossibleValuesForMigrationNameAvailabilityReason() []string
• func ValidateFlexibleServerID(input interface{}, key string) (warnings []string, errors []error)
• type CheckMigrationNameAvailabilityOperationResponse
• type CustomOperationClient
  • func NewCustomOperationClientWithBaseURI(sdkApi sdkEnv.Api) (*CustomOperationClient, error)
  • func (c CustomOperationClient) CheckMigrationNameAvailability(ctx context.Context, id FlexibleServerId, ...) (result CheckMigrationNameAvailabilityOperationResponse, err error)
• type FlexibleServerId
  • func NewFlexibleServerID(subscriptionId string, resourceGroupName string, flexibleServerName string) FlexibleServerId
  • func ParseFlexibleServerID(input string) (*FlexibleServerId, error)
  • func ParseFlexibleServerIDInsensitively(input string) (*FlexibleServerId, error)
  • func (id *FlexibleServerId) FromParseResult(input resourceids.ParseResult) error
  • func (id FlexibleServerId) ID() string
  • func (id FlexibleServerId) Segments() []resourceids.Segment
  • func (id FlexibleServerId) String() string
• type MigrationNameAvailabilityReason
  • func (s *MigrationNameAvailabilityReason) UnmarshalJSON(bytes []byte) error
• type MigrationNameAvailabilityResource

Functions

func PossibleValuesForMigrationNameAvailabilityReason

func PossibleValuesForMigrationNameAvailabilityReason() []string

func ValidateFlexibleServerID

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

ValidateFlexibleServerID checks that 'input' can be parsed as a Flexible Server ID

Types

type CheckMigrationNameAvailabilityOperationResponse

type CheckMigrationNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *MigrationNameAvailabilityResource
}

type CustomOperationClient

type CustomOperationClient struct {
	Client *resourcemanager.Client
}

func NewCustomOperationClientWithBaseURI

func NewCustomOperationClientWithBaseURI(sdkApi sdkEnv.Api) (*CustomOperationClient, error)

func (CustomOperationClient) CheckMigrationNameAvailability

func (c CustomOperationClient) CheckMigrationNameAvailability(ctx context.Context, id FlexibleServerId, input MigrationNameAvailabilityResource) (result CheckMigrationNameAvailabilityOperationResponse, err error)

CheckMigrationNameAvailability ...

type FlexibleServerId

type FlexibleServerId struct {
	SubscriptionId     string
	ResourceGroupName  string
	FlexibleServerName string
}

FlexibleServerId is a struct representing the Resource ID for a Flexible Server

func NewFlexibleServerID

func NewFlexibleServerID(subscriptionId string, resourceGroupName string, flexibleServerName string) FlexibleServerId

NewFlexibleServerID returns a new FlexibleServerId struct

func ParseFlexibleServerID

func ParseFlexibleServerID(input string) (*FlexibleServerId, error)

ParseFlexibleServerID parses 'input' into a FlexibleServerId

func ParseFlexibleServerIDInsensitively

func ParseFlexibleServerIDInsensitively(input string) (*FlexibleServerId, error)

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

func (*FlexibleServerId) FromParseResult

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

func (FlexibleServerId) ID

func (id FlexibleServerId) ID() string

ID returns the formatted Flexible Server ID

func (FlexibleServerId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Flexible Server ID

func (FlexibleServerId) String

func (id FlexibleServerId) String() string

String returns a human-readable description of this Flexible Server ID

type MigrationNameAvailabilityReason

type MigrationNameAvailabilityReason string

const (
	MigrationNameAvailabilityReasonAlreadyExists MigrationNameAvailabilityReason = "AlreadyExists"
	MigrationNameAvailabilityReasonInvalid       MigrationNameAvailabilityReason = "Invalid"
)

func (*MigrationNameAvailabilityReason) UnmarshalJSON

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

type MigrationNameAvailabilityResource

type MigrationNameAvailabilityResource struct {
	Message       *string                          `json:"message,omitempty"`
	Name          string                           `json:"name"`
	NameAvailable *bool                            `json:"nameAvailable,omitempty"`
	Reason        *MigrationNameAvailabilityReason `json:"reason,omitempty"`
	Type          string                           `json:"type"`
}