migrationconfigs

README

github.com/hashicorp/go-azure-sdk/resource-manager/servicebus/2022-01-01-preview/migrationconfigs Documentation

The migrationconfigs SDK allows for interaction with the Azure Resource Manager Service servicebus (API Version 2022-01-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/servicebus/2022-01-01-preview/migrationconfigs"

Client Initialization

client := migrationconfigs.NewMigrationConfigsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: MigrationConfigsClient.CompleteMigration

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

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

Example Usage: MigrationConfigsClient.CreateAndStartMigration

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

payload := migrationconfigs.MigrationConfigProperties{
	// ...
}


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

Example Usage: MigrationConfigsClient.Delete

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

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

Example Usage: MigrationConfigsClient.Get

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

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: MigrationConfigsClient.List

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

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

Example Usage: MigrationConfigsClient.Revert

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

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

Documentation

Index

• func ValidateNamespaceID(input interface{}, key string) (warnings []string, errors []error)
• type CompleteMigrationOperationResponse
• type CreateAndStartMigrationOperationResponse
• type DeleteOperationResponse
• type GetOperationResponse
• type ListCompleteResult
• type ListOperationResponse
• type MigrationConfigProperties
• type MigrationConfigPropertiesOperationPredicate
  • func (p MigrationConfigPropertiesOperationPredicate) Matches(input MigrationConfigProperties) bool
• type MigrationConfigPropertiesProperties
• type MigrationConfigsClient
  • func NewMigrationConfigsClientWithBaseURI(sdkApi sdkEnv.Api) (*MigrationConfigsClient, error)
  • func (c MigrationConfigsClient) CompleteMigration(ctx context.Context, id NamespaceId) (result CompleteMigrationOperationResponse, err error)
  • func (c MigrationConfigsClient) CreateAndStartMigration(ctx context.Context, id NamespaceId, input MigrationConfigProperties) (result CreateAndStartMigrationOperationResponse, err error)
  • func (c MigrationConfigsClient) CreateAndStartMigrationThenPoll(ctx context.Context, id NamespaceId, input MigrationConfigProperties) error
  • func (c MigrationConfigsClient) Delete(ctx context.Context, id NamespaceId) (result DeleteOperationResponse, err error)
  • func (c MigrationConfigsClient) Get(ctx context.Context, id NamespaceId) (result GetOperationResponse, err error)
  • func (c MigrationConfigsClient) List(ctx context.Context, id NamespaceId) (result ListOperationResponse, err error)
  • func (c MigrationConfigsClient) ListComplete(ctx context.Context, id NamespaceId) (ListCompleteResult, error)
  • func (c MigrationConfigsClient) ListCompleteMatchingPredicate(ctx context.Context, id NamespaceId, ...) (result ListCompleteResult, err error)
  • func (c MigrationConfigsClient) Revert(ctx context.Context, id NamespaceId) (result RevertOperationResponse, err error)
• type NamespaceId
  • func NewNamespaceID(subscriptionId string, resourceGroupName string, namespaceName string) NamespaceId
  • func ParseNamespaceID(input string) (*NamespaceId, error)
  • func ParseNamespaceIDInsensitively(input string) (*NamespaceId, error)
  • func (id *NamespaceId) FromParseResult(input resourceids.ParseResult) error
  • func (id NamespaceId) ID() string
  • func (id NamespaceId) Segments() []resourceids.Segment
  • func (id NamespaceId) String() string
• type RevertOperationResponse

Functions

func ValidateNamespaceID

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

ValidateNamespaceID checks that 'input' can be parsed as a Namespace ID

Types

type CompleteMigrationOperationResponse

type CompleteMigrationOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type CreateAndStartMigrationOperationResponse

type CreateAndStartMigrationOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *MigrationConfigProperties
}

type DeleteOperationResponse

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

type GetOperationResponse

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

type ListCompleteResult

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []MigrationConfigProperties
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]MigrationConfigProperties
}

type MigrationConfigProperties

type MigrationConfigProperties struct {
	Id         *string                              `json:"id,omitempty"`
	Location   *string                              `json:"location,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *MigrationConfigPropertiesProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData               `json:"systemData,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type MigrationConfigPropertiesOperationPredicate

type MigrationConfigPropertiesOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (MigrationConfigPropertiesOperationPredicate) Matches

func (p MigrationConfigPropertiesOperationPredicate) Matches(input MigrationConfigProperties) bool

type MigrationConfigPropertiesProperties

type MigrationConfigPropertiesProperties struct {
	MigrationState                    *string `json:"migrationState,omitempty"`
	PendingReplicationOperationsCount *int64  `json:"pendingReplicationOperationsCount,omitempty"`
	PostMigrationName                 string  `json:"postMigrationName"`
	ProvisioningState                 *string `json:"provisioningState,omitempty"`
	TargetNamespace                   string  `json:"targetNamespace"`
}

type MigrationConfigsClient

type MigrationConfigsClient struct {
	Client *resourcemanager.Client
}

func NewMigrationConfigsClientWithBaseURI

func NewMigrationConfigsClientWithBaseURI(sdkApi sdkEnv.Api) (*MigrationConfigsClient, error)

func (MigrationConfigsClient) CompleteMigration

func (c MigrationConfigsClient) CompleteMigration(ctx context.Context, id NamespaceId) (result CompleteMigrationOperationResponse, err error)

CompleteMigration ...

func (MigrationConfigsClient) CreateAndStartMigration

func (c MigrationConfigsClient) CreateAndStartMigration(ctx context.Context, id NamespaceId, input MigrationConfigProperties) (result CreateAndStartMigrationOperationResponse, err error)

CreateAndStartMigration ...

func (MigrationConfigsClient) CreateAndStartMigrationThenPoll

func (c MigrationConfigsClient) CreateAndStartMigrationThenPoll(ctx context.Context, id NamespaceId, input MigrationConfigProperties) error

CreateAndStartMigrationThenPoll performs CreateAndStartMigration then polls until it's completed

func (MigrationConfigsClient) Delete

func (c MigrationConfigsClient) Delete(ctx context.Context, id NamespaceId) (result DeleteOperationResponse, err error)

Delete ...

func (MigrationConfigsClient) Get

func (c MigrationConfigsClient) Get(ctx context.Context, id NamespaceId) (result GetOperationResponse, err error)

Get ...

func (MigrationConfigsClient) List

func (c MigrationConfigsClient) List(ctx context.Context, id NamespaceId) (result ListOperationResponse, err error)

List ...

func (MigrationConfigsClient) ListComplete

func (c MigrationConfigsClient) ListComplete(ctx context.Context, id NamespaceId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (MigrationConfigsClient) ListCompleteMatchingPredicate

func (c MigrationConfigsClient) ListCompleteMatchingPredicate(ctx context.Context, id NamespaceId, predicate MigrationConfigPropertiesOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (MigrationConfigsClient) Revert

func (c MigrationConfigsClient) Revert(ctx context.Context, id NamespaceId) (result RevertOperationResponse, err error)

Revert ...

type NamespaceId

type NamespaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	NamespaceName     string
}

NamespaceId is a struct representing the Resource ID for a Namespace

func NewNamespaceID

func NewNamespaceID(subscriptionId string, resourceGroupName string, namespaceName string) NamespaceId

NewNamespaceID returns a new NamespaceId struct

func ParseNamespaceID

func ParseNamespaceID(input string) (*NamespaceId, error)

ParseNamespaceID parses 'input' into a NamespaceId

func ParseNamespaceIDInsensitively

func ParseNamespaceIDInsensitively(input string) (*NamespaceId, error)

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

func (*NamespaceId) FromParseResult

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

func (NamespaceId) ID

func (id NamespaceId) ID() string

ID returns the formatted Namespace ID

func (NamespaceId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Namespace ID

func (NamespaceId) String

func (id NamespaceId) String() string

String returns a human-readable description of this Namespace ID

type RevertOperationResponse

type RevertOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}