managedserverdnsaliases

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2023-02-01-preview/managedserverdnsaliases Documentation

The managedserverdnsaliases SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2023-02-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/sql/2023-02-01-preview/managedserverdnsaliases"

Client Initialization

client := managedserverdnsaliases.NewManagedServerDnsAliasesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ManagedServerDnsAliasesClient.Acquire

ctx := context.TODO()
id := managedserverdnsaliases.NewManagedInstanceDnsAliasID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue", "dnsAliasValue")

payload := managedserverdnsaliases.ManagedServerDnsAliasAcquisition{
	// ...
}


if err := client.AcquireThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: ManagedServerDnsAliasesClient.CreateOrUpdate

ctx := context.TODO()
id := managedserverdnsaliases.NewManagedInstanceDnsAliasID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue", "dnsAliasValue")

payload := managedserverdnsaliases.ManagedServerDnsAliasCreation{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: ManagedServerDnsAliasesClient.Delete

ctx := context.TODO()
id := managedserverdnsaliases.NewManagedInstanceDnsAliasID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue", "dnsAliasValue")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: ManagedServerDnsAliasesClient.Get

ctx := context.TODO()
id := managedserverdnsaliases.NewManagedInstanceDnsAliasID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue", "dnsAliasValue")

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

Example Usage: ManagedServerDnsAliasesClient.ListByManagedInstance

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

// alternatively `client.ListByManagedInstance(ctx, id)` can be used to do batched pagination
items, err := client.ListByManagedInstanceComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

• func ValidateManagedInstanceDnsAliasID(input interface{}, key string) (warnings []string, errors []error)
• type AcquireOperationResponse
• type CreateOrUpdateOperationResponse
• type DeleteOperationResponse
• type GetOperationResponse
• type ListByManagedInstanceCompleteResult
• type ListByManagedInstanceOperationResponse
• type ManagedInstanceDnsAliasId
  • func NewManagedInstanceDnsAliasID(subscriptionId string, resourceGroupName string, managedInstanceName string, ...) ManagedInstanceDnsAliasId
  • func ParseManagedInstanceDnsAliasID(input string) (*ManagedInstanceDnsAliasId, error)
  • func ParseManagedInstanceDnsAliasIDInsensitively(input string) (*ManagedInstanceDnsAliasId, error)
  • func (id *ManagedInstanceDnsAliasId) FromParseResult(input resourceids.ParseResult) error
  • func (id ManagedInstanceDnsAliasId) ID() string
  • func (id ManagedInstanceDnsAliasId) Segments() []resourceids.Segment
  • func (id ManagedInstanceDnsAliasId) String() string
• type ManagedServerDnsAlias
• type ManagedServerDnsAliasAcquisition
• type ManagedServerDnsAliasCreation
• type ManagedServerDnsAliasOperationPredicate
  • func (p ManagedServerDnsAliasOperationPredicate) Matches(input ManagedServerDnsAlias) bool
• type ManagedServerDnsAliasProperties
• type ManagedServerDnsAliasesClient
  • func NewManagedServerDnsAliasesClientWithBaseURI(sdkApi sdkEnv.Api) (*ManagedServerDnsAliasesClient, error)
  • func (c ManagedServerDnsAliasesClient) Acquire(ctx context.Context, id ManagedInstanceDnsAliasId, ...) (result AcquireOperationResponse, err error)
  • func (c ManagedServerDnsAliasesClient) AcquireThenPoll(ctx context.Context, id ManagedInstanceDnsAliasId, ...) error
  • func (c ManagedServerDnsAliasesClient) CreateOrUpdate(ctx context.Context, id ManagedInstanceDnsAliasId, ...) (result CreateOrUpdateOperationResponse, err error)
  • func (c ManagedServerDnsAliasesClient) CreateOrUpdateThenPoll(ctx context.Context, id ManagedInstanceDnsAliasId, ...) error
  • func (c ManagedServerDnsAliasesClient) Delete(ctx context.Context, id ManagedInstanceDnsAliasId) (result DeleteOperationResponse, err error)
  • func (c ManagedServerDnsAliasesClient) DeleteThenPoll(ctx context.Context, id ManagedInstanceDnsAliasId) error
  • func (c ManagedServerDnsAliasesClient) Get(ctx context.Context, id ManagedInstanceDnsAliasId) (result GetOperationResponse, err error)
  • func (c ManagedServerDnsAliasesClient) ListByManagedInstance(ctx context.Context, id commonids.SqlManagedInstanceId) (result ListByManagedInstanceOperationResponse, err error)
  • func (c ManagedServerDnsAliasesClient) ListByManagedInstanceComplete(ctx context.Context, id commonids.SqlManagedInstanceId) (ListByManagedInstanceCompleteResult, error)
  • func (c ManagedServerDnsAliasesClient) ListByManagedInstanceCompleteMatchingPredicate(ctx context.Context, id commonids.SqlManagedInstanceId, ...) (result ListByManagedInstanceCompleteResult, err error)

Functions

func ValidateManagedInstanceDnsAliasID

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

ValidateManagedInstanceDnsAliasID checks that 'input' can be parsed as a Managed Instance Dns Alias ID

Types

type AcquireOperationResponse

type AcquireOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ManagedServerDnsAlias
}

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ManagedServerDnsAlias
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ManagedServerDnsAlias
}

type ListByManagedInstanceCompleteResult

type ListByManagedInstanceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ManagedServerDnsAlias
}

type ListByManagedInstanceOperationResponse

type ListByManagedInstanceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ManagedServerDnsAlias
}

type ManagedInstanceDnsAliasId

type ManagedInstanceDnsAliasId struct {
	SubscriptionId      string
	ResourceGroupName   string
	ManagedInstanceName string
	DnsAliasName        string
}

ManagedInstanceDnsAliasId is a struct representing the Resource ID for a Managed Instance Dns Alias

func NewManagedInstanceDnsAliasID

func NewManagedInstanceDnsAliasID(subscriptionId string, resourceGroupName string, managedInstanceName string, dnsAliasName string) ManagedInstanceDnsAliasId

NewManagedInstanceDnsAliasID returns a new ManagedInstanceDnsAliasId struct

func ParseManagedInstanceDnsAliasID

func ParseManagedInstanceDnsAliasID(input string) (*ManagedInstanceDnsAliasId, error)

ParseManagedInstanceDnsAliasID parses 'input' into a ManagedInstanceDnsAliasId

func ParseManagedInstanceDnsAliasIDInsensitively

func ParseManagedInstanceDnsAliasIDInsensitively(input string) (*ManagedInstanceDnsAliasId, error)

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

func (*ManagedInstanceDnsAliasId) FromParseResult

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

func (ManagedInstanceDnsAliasId) ID

func (id ManagedInstanceDnsAliasId) ID() string

ID returns the formatted Managed Instance Dns Alias ID

func (ManagedInstanceDnsAliasId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Managed Instance Dns Alias ID

func (ManagedInstanceDnsAliasId) String

func (id ManagedInstanceDnsAliasId) String() string

String returns a human-readable description of this Managed Instance Dns Alias ID

type ManagedServerDnsAlias

type ManagedServerDnsAlias struct {
	Id         *string                          `json:"id,omitempty"`
	Name       *string                          `json:"name,omitempty"`
	Properties *ManagedServerDnsAliasProperties `json:"properties,omitempty"`
	Type       *string                          `json:"type,omitempty"`
}

type ManagedServerDnsAliasAcquisition

type ManagedServerDnsAliasAcquisition struct {
	OldManagedServerDnsAliasResourceId string `json:"oldManagedServerDnsAliasResourceId"`
}

type ManagedServerDnsAliasCreation

type ManagedServerDnsAliasCreation struct {
	CreateDnsRecord *bool `json:"createDnsRecord,omitempty"`
}

type ManagedServerDnsAliasOperationPredicate

type ManagedServerDnsAliasOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (ManagedServerDnsAliasOperationPredicate) Matches

func (p ManagedServerDnsAliasOperationPredicate) Matches(input ManagedServerDnsAlias) bool

type ManagedServerDnsAliasProperties

type ManagedServerDnsAliasProperties struct {
	AzureDnsRecord       *string `json:"azureDnsRecord,omitempty"`
	PublicAzureDnsRecord *string `json:"publicAzureDnsRecord,omitempty"`
}

type ManagedServerDnsAliasesClient

type ManagedServerDnsAliasesClient struct {
	Client *resourcemanager.Client
}

func NewManagedServerDnsAliasesClientWithBaseURI

func NewManagedServerDnsAliasesClientWithBaseURI(sdkApi sdkEnv.Api) (*ManagedServerDnsAliasesClient, error)

func (ManagedServerDnsAliasesClient) Acquire

func (c ManagedServerDnsAliasesClient) Acquire(ctx context.Context, id ManagedInstanceDnsAliasId, input ManagedServerDnsAliasAcquisition) (result AcquireOperationResponse, err error)

Acquire ...

func (ManagedServerDnsAliasesClient) AcquireThenPoll

func (c ManagedServerDnsAliasesClient) AcquireThenPoll(ctx context.Context, id ManagedInstanceDnsAliasId, input ManagedServerDnsAliasAcquisition) error

AcquireThenPoll performs Acquire then polls until it's completed

func (ManagedServerDnsAliasesClient) CreateOrUpdate

func (c ManagedServerDnsAliasesClient) CreateOrUpdate(ctx context.Context, id ManagedInstanceDnsAliasId, input ManagedServerDnsAliasCreation) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ManagedServerDnsAliasesClient) CreateOrUpdateThenPoll

func (c ManagedServerDnsAliasesClient) CreateOrUpdateThenPoll(ctx context.Context, id ManagedInstanceDnsAliasId, input ManagedServerDnsAliasCreation) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ManagedServerDnsAliasesClient) Delete

func (c ManagedServerDnsAliasesClient) Delete(ctx context.Context, id ManagedInstanceDnsAliasId) (result DeleteOperationResponse, err error)

Delete ...

func (ManagedServerDnsAliasesClient) DeleteThenPoll

func (c ManagedServerDnsAliasesClient) DeleteThenPoll(ctx context.Context, id ManagedInstanceDnsAliasId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ManagedServerDnsAliasesClient) Get

func (c ManagedServerDnsAliasesClient) Get(ctx context.Context, id ManagedInstanceDnsAliasId) (result GetOperationResponse, err error)

Get ...

func (ManagedServerDnsAliasesClient) ListByManagedInstance

func (c ManagedServerDnsAliasesClient) ListByManagedInstance(ctx context.Context, id commonids.SqlManagedInstanceId) (result ListByManagedInstanceOperationResponse, err error)

ListByManagedInstance ...

func (ManagedServerDnsAliasesClient) ListByManagedInstanceComplete

func (c ManagedServerDnsAliasesClient) ListByManagedInstanceComplete(ctx context.Context, id commonids.SqlManagedInstanceId) (ListByManagedInstanceCompleteResult, error)

ListByManagedInstanceComplete retrieves all the results into a single object

func (ManagedServerDnsAliasesClient) ListByManagedInstanceCompleteMatchingPredicate

func (c ManagedServerDnsAliasesClient) ListByManagedInstanceCompleteMatchingPredicate(ctx context.Context, id commonids.SqlManagedInstanceId, predicate ManagedServerDnsAliasOperationPredicate) (result ListByManagedInstanceCompleteResult, err error)

ListByManagedInstanceCompleteMatchingPredicate retrieves all the results and then applies the predicate