customoperation

package
v0.20231109.1085442 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 9, 2023 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/datamigration/2021-06-30/customoperation Documentation

The customoperation SDK allows for interaction with the Azure Resource Manager Service datamigration (API Version 2021-06-30).

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/datamigration/2021-06-30/customoperation"

Client Initialization

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

Example Usage: CustomOperationClient.ServiceTasksCancel

ctx := context.TODO()
id := customoperation.NewServiceTaskID("12345678-1234-9876-4563-123456789012", "resourceGroupValue", "serviceValue", "serviceTaskValue")

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

Example Usage: CustomOperationClient.ServicesCheckChildrenNameAvailability

ctx := context.TODO()
id := customoperation.NewServiceID("12345678-1234-9876-4563-123456789012", "resourceGroupValue", "serviceValue")

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


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

Example Usage: CustomOperationClient.ServicesCheckStatus

ctx := context.TODO()
id := customoperation.NewServiceID("12345678-1234-9876-4563-123456789012", "resourceGroupValue", "serviceValue")

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

Example Usage: CustomOperationClient.ServicesStart

ctx := context.TODO()
id := customoperation.NewServiceID("12345678-1234-9876-4563-123456789012", "resourceGroupValue", "serviceValue")

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

Example Usage: CustomOperationClient.ServicesStop

ctx := context.TODO()
id := customoperation.NewServiceID("12345678-1234-9876-4563-123456789012", "resourceGroupValue", "serviceValue")

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

Example Usage: CustomOperationClient.TasksCancel

ctx := context.TODO()
id := customoperation.NewTaskID("12345678-1234-9876-4563-123456789012", "resourceGroupValue", "serviceValue", "projectValue", "taskValue")

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

Example Usage: CustomOperationClient.TasksCommand

ctx := context.TODO()
id := customoperation.NewTaskID("12345678-1234-9876-4563-123456789012", "resourceGroupValue", "serviceValue", "projectValue", "taskValue")

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


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForCommandState

func PossibleValuesForCommandState() []string

func PossibleValuesForNameCheckFailureReason

func PossibleValuesForNameCheckFailureReason() []string

func PossibleValuesForTaskState

func PossibleValuesForTaskState() []string

func ValidateServiceID

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

ValidateServiceID checks that 'input' can be parsed as a Service ID

func ValidateServiceTaskID

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

ValidateServiceTaskID checks that 'input' can be parsed as a Service Task ID

func ValidateTaskID

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

ValidateTaskID checks that 'input' can be parsed as a Task ID

Types

type CommandProperties

type CommandProperties struct {
	CommandType string        `json:"commandType"`
	Errors      *[]ODataError `json:"errors,omitempty"`
	State       *CommandState `json:"state,omitempty"`
}

type CommandState

type CommandState string
const (
	CommandStateAccepted  CommandState = "Accepted"
	CommandStateFailed    CommandState = "Failed"
	CommandStateRunning   CommandState = "Running"
	CommandStateSucceeded CommandState = "Succeeded"
	CommandStateUnknown   CommandState = "Unknown"
)

func (*CommandState) UnmarshalJSON added in v0.20230712.1163130

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

type CustomOperationClient

type CustomOperationClient struct {
	Client *resourcemanager.Client
}

func NewCustomOperationClientWithBaseURI

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

func (CustomOperationClient) ServiceTasksCancel

ServiceTasksCancel ...

func (CustomOperationClient) ServicesCheckChildrenNameAvailability

func (c CustomOperationClient) ServicesCheckChildrenNameAvailability(ctx context.Context, id ServiceId, input NameAvailabilityRequest) (result ServicesCheckChildrenNameAvailabilityOperationResponse, err error)

ServicesCheckChildrenNameAvailability ...

func (CustomOperationClient) ServicesCheckStatus

func (c CustomOperationClient) ServicesCheckStatus(ctx context.Context, id ServiceId) (result ServicesCheckStatusOperationResponse, err error)

ServicesCheckStatus ...

func (CustomOperationClient) ServicesStart

func (c CustomOperationClient) ServicesStart(ctx context.Context, id ServiceId) (result ServicesStartOperationResponse, err error)

ServicesStart ...

func (CustomOperationClient) ServicesStartThenPoll

func (c CustomOperationClient) ServicesStartThenPoll(ctx context.Context, id ServiceId) error

ServicesStartThenPoll performs ServicesStart then polls until it's completed

func (CustomOperationClient) ServicesStop

func (c CustomOperationClient) ServicesStop(ctx context.Context, id ServiceId) (result ServicesStopOperationResponse, err error)

ServicesStop ...

func (CustomOperationClient) ServicesStopThenPoll

func (c CustomOperationClient) ServicesStopThenPoll(ctx context.Context, id ServiceId) error

ServicesStopThenPoll performs ServicesStop then polls until it's completed

func (CustomOperationClient) TasksCancel

func (c CustomOperationClient) TasksCancel(ctx context.Context, id TaskId) (result TasksCancelOperationResponse, err error)

TasksCancel ...

func (CustomOperationClient) TasksCommand

TasksCommand ...

type DataMigrationServiceStatusResponse

type DataMigrationServiceStatusResponse struct {
	AgentVersion       *string   `json:"agentVersion,omitempty"`
	Status             *string   `json:"status,omitempty"`
	SupportedTaskTypes *[]string `json:"supportedTaskTypes,omitempty"`
	VMSize             *string   `json:"vmSize,omitempty"`
}

type NameAvailabilityRequest

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

type NameAvailabilityResponse

type NameAvailabilityResponse struct {
	Message       *string                 `json:"message,omitempty"`
	NameAvailable *bool                   `json:"nameAvailable,omitempty"`
	Reason        *NameCheckFailureReason `json:"reason,omitempty"`
}

type NameCheckFailureReason

type NameCheckFailureReason string
const (
	NameCheckFailureReasonAlreadyExists NameCheckFailureReason = "AlreadyExists"
	NameCheckFailureReasonInvalid       NameCheckFailureReason = "Invalid"
)

func (*NameCheckFailureReason) UnmarshalJSON added in v0.20230712.1163130

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

type ODataError

type ODataError struct {
	Code    *string       `json:"code,omitempty"`
	Details *[]ODataError `json:"details,omitempty"`
	Message *string       `json:"message,omitempty"`
}

type ProjectTask

type ProjectTask struct {
	Etag       *string                `json:"etag,omitempty"`
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *ProjectTaskProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type ProjectTaskProperties

type ProjectTaskProperties struct {
	ClientData *map[string]string   `json:"clientData,omitempty"`
	Commands   *[]CommandProperties `json:"commands,omitempty"`
	Errors     *[]ODataError        `json:"errors,omitempty"`
	State      *TaskState           `json:"state,omitempty"`
	TaskType   string               `json:"taskType"`
}

type ServiceId

type ServiceId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
}

ServiceId is a struct representing the Resource ID for a Service

func NewServiceID

func NewServiceID(subscriptionId string, resourceGroupName string, serviceName string) ServiceId

NewServiceID returns a new ServiceId struct

func ParseServiceID

func ParseServiceID(input string) (*ServiceId, error)

ParseServiceID parses 'input' into a ServiceId

func ParseServiceIDInsensitively

func ParseServiceIDInsensitively(input string) (*ServiceId, error)

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

func (ServiceId) ID

func (id ServiceId) ID() string

ID returns the formatted Service ID

func (ServiceId) Segments

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

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

func (ServiceId) String

func (id ServiceId) String() string

String returns a human-readable description of this Service ID

type ServiceTaskId

type ServiceTaskId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	ServiceTaskName   string
}

ServiceTaskId is a struct representing the Resource ID for a Service Task

func NewServiceTaskID

func NewServiceTaskID(subscriptionId string, resourceGroupName string, serviceName string, serviceTaskName string) ServiceTaskId

NewServiceTaskID returns a new ServiceTaskId struct

func ParseServiceTaskID

func ParseServiceTaskID(input string) (*ServiceTaskId, error)

ParseServiceTaskID parses 'input' into a ServiceTaskId

func ParseServiceTaskIDInsensitively

func ParseServiceTaskIDInsensitively(input string) (*ServiceTaskId, error)

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

func (ServiceTaskId) ID

func (id ServiceTaskId) ID() string

ID returns the formatted Service Task ID

func (ServiceTaskId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Service Task ID

func (ServiceTaskId) String

func (id ServiceTaskId) String() string

String returns a human-readable description of this Service Task ID

type ServiceTasksCancelOperationResponse

type ServiceTasksCancelOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ProjectTask
}

type ServicesCheckChildrenNameAvailabilityOperationResponse

type ServicesCheckChildrenNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NameAvailabilityResponse
}

type ServicesCheckStatusOperationResponse

type ServicesCheckStatusOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DataMigrationServiceStatusResponse
}

type ServicesStartOperationResponse

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

type ServicesStopOperationResponse

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

type TaskId

type TaskId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	ProjectName       string
	TaskName          string
}

TaskId is a struct representing the Resource ID for a Task

func NewTaskID

func NewTaskID(subscriptionId string, resourceGroupName string, serviceName string, projectName string, taskName string) TaskId

NewTaskID returns a new TaskId struct

func ParseTaskID

func ParseTaskID(input string) (*TaskId, error)

ParseTaskID parses 'input' into a TaskId

func ParseTaskIDInsensitively

func ParseTaskIDInsensitively(input string) (*TaskId, error)

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

func (TaskId) ID

func (id TaskId) ID() string

ID returns the formatted Task ID

func (TaskId) Segments

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

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

func (TaskId) String

func (id TaskId) String() string

String returns a human-readable description of this Task ID

type TaskState

type TaskState string
const (
	TaskStateCanceled              TaskState = "Canceled"
	TaskStateFailed                TaskState = "Failed"
	TaskStateFailedInputValidation TaskState = "FailedInputValidation"
	TaskStateFaulted               TaskState = "Faulted"
	TaskStateQueued                TaskState = "Queued"
	TaskStateRunning               TaskState = "Running"
	TaskStateSucceeded             TaskState = "Succeeded"
	TaskStateUnknown               TaskState = "Unknown"
)

func (*TaskState) UnmarshalJSON added in v0.20230712.1163130

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

type TasksCancelOperationResponse

type TasksCancelOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ProjectTask
}

type TasksCommandOperationResponse

type TasksCommandOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CommandProperties
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL