put

package
v0.20240313.1132601 Latest Latest
Warning

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

 Go to latest Published: Mar 13, 2024 License: MPL-2.0 Imports: 14 Imported by: 1

README

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

The put 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/put"

Client Initialization

client := put.NewPUTClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PUTClient.FilesCreateOrUpdate

ctx := context.TODO()
id := put.NewFileID("12345678-1234-9876-4563-123456789012", "resourceGroupValue", "serviceValue", "projectValue", "fileValue")

payload := put.ProjectFile{
	// ...
}


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

Example Usage: PUTClient.ProjectsCreateOrUpdate

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

payload := put.Project{
	// ...
}


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

Example Usage: PUTClient.ServiceTasksCreateOrUpdate

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

payload := put.ProjectTask{
	// ...
}


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

Example Usage: PUTClient.ServicesCreateOrUpdate

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

payload := put.DataMigrationService{
	// ...
}


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

Example Usage: PUTClient.TasksCreateOrUpdate

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

payload := put.ProjectTask{
	// ...
}


read, err := client.TasksCreateOrUpdate(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 PossibleValuesForProjectProvisioningState 

func PossibleValuesForProjectProvisioningState() []string

func PossibleValuesForProjectSourcePlatform 

func PossibleValuesForProjectSourcePlatform() []string

func PossibleValuesForProjectTargetPlatform 

func PossibleValuesForProjectTargetPlatform() []string

func PossibleValuesForServiceProvisioningState 

func PossibleValuesForServiceProvisioningState() []string

func PossibleValuesForTaskState 

func PossibleValuesForTaskState() []string

func ValidateFileID 

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

ValidateFileID checks that 'input' can be parsed as a File ID

func ValidateProjectID 

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

ValidateProjectID checks that 'input' can be parsed as a Project ID

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 

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

type ConnectionInfo 

type ConnectionInfo struct {
	Password *string `json:"password,omitempty"`
	Type     string  `json:"type"`
	UserName *string `json:"userName,omitempty"`
}

type DataMigrationService 

type DataMigrationService struct {
	Etag       *string                         `json:"etag,omitempty"`
	Id         *string                         `json:"id,omitempty"`
	Kind       *string                         `json:"kind,omitempty"`
	Location   string                          `json:"location"`
	Name       *string                         `json:"name,omitempty"`
	Properties *DataMigrationServiceProperties `json:"properties,omitempty"`
	Sku        *ServiceSku                     `json:"sku,omitempty"`
	SystemData *systemdata.SystemData          `json:"systemData,omitempty"`
	Tags       *map[string]string              `json:"tags,omitempty"`
	Type       *string                         `json:"type,omitempty"`
}

type DataMigrationServiceProperties 

type DataMigrationServiceProperties struct {
	ProvisioningState *ServiceProvisioningState `json:"provisioningState,omitempty"`
	PublicKey         *string                   `json:"publicKey,omitempty"`
	VirtualNicId      *string                   `json:"virtualNicId,omitempty"`
	VirtualSubnetId   string                    `json:"virtualSubnetId"`
}

type DatabaseInfo 

type DatabaseInfo struct {
	SourceDatabaseName string `json:"sourceDatabaseName"`
}

type FileId 

type FileId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	ProjectName       string
	FileName          string
}

FileId is a struct representing the Resource ID for a File

func NewFileID 

func NewFileID(subscriptionId string, resourceGroupName string, serviceName string, projectName string, fileName string) FileId

NewFileID returns a new FileId struct

func ParseFileID 

func ParseFileID(input string) (*FileId, error)

ParseFileID parses 'input' into a FileId

func ParseFileIDInsensitively 

func ParseFileIDInsensitively(input string) (*FileId, error)

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

func (*FileId) FromParseResult 

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

func (FileId) ID 

func (id FileId) ID() string

ID returns the formatted File ID

func (FileId) Segments 

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

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

func (FileId) String 

func (id FileId) String() string

String returns a human-readable description of this File ID

type FilesCreateOrUpdateOperationResponse 

type FilesCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ProjectFile
}

type ODataError 

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

type PUTClient 

type PUTClient struct {
	Client *resourcemanager.Client
}

func NewPUTClientWithBaseURI 

func NewPUTClientWithBaseURI(sdkApi sdkEnv.Api) (*PUTClient, error)

func (PUTClient) FilesCreateOrUpdate 

func (c PUTClient) FilesCreateOrUpdate(ctx context.Context, id FileId, input ProjectFile) (result FilesCreateOrUpdateOperationResponse, err error)

FilesCreateOrUpdate ...

func (PUTClient) ProjectsCreateOrUpdate 

func (c PUTClient) ProjectsCreateOrUpdate(ctx context.Context, id ProjectId, input Project) (result ProjectsCreateOrUpdateOperationResponse, err error)

ProjectsCreateOrUpdate ...

func (PUTClient) ServiceTasksCreateOrUpdate 

func (c PUTClient) ServiceTasksCreateOrUpdate(ctx context.Context, id ServiceTaskId, input ProjectTask) (result ServiceTasksCreateOrUpdateOperationResponse, err error)

ServiceTasksCreateOrUpdate ...

func (PUTClient) ServicesCreateOrUpdate 

func (c PUTClient) ServicesCreateOrUpdate(ctx context.Context, id ServiceId, input DataMigrationService) (result ServicesCreateOrUpdateOperationResponse, err error)

ServicesCreateOrUpdate ...

func (PUTClient) ServicesCreateOrUpdateThenPoll 

func (c PUTClient) ServicesCreateOrUpdateThenPoll(ctx context.Context, id ServiceId, input DataMigrationService) error

ServicesCreateOrUpdateThenPoll performs ServicesCreateOrUpdate then polls until it's completed

func (PUTClient) TasksCreateOrUpdate 

func (c PUTClient) TasksCreateOrUpdate(ctx context.Context, id TaskId, input ProjectTask) (result TasksCreateOrUpdateOperationResponse, err error)

TasksCreateOrUpdate ...

type Project 

type Project struct {
	Id         *string                `json:"id,omitempty"`
	Location   string                 `json:"location"`
	Name       *string                `json:"name,omitempty"`
	Properties *ProjectProperties     `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Tags       *map[string]string     `json:"tags,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type ProjectFile 

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

type ProjectFileProperties 

type ProjectFileProperties struct {
	Extension    *string `json:"extension,omitempty"`
	FilePath     *string `json:"filePath,omitempty"`
	LastModified *string `json:"lastModified,omitempty"`
	MediaType    *string `json:"mediaType,omitempty"`
	Size         *int64  `json:"size,omitempty"`
}

func (*ProjectFileProperties) GetLastModifiedAsTime 

func (o *ProjectFileProperties) GetLastModifiedAsTime() (*time.Time, error)

func (*ProjectFileProperties) SetLastModifiedAsTime 

func (o *ProjectFileProperties) SetLastModifiedAsTime(input time.Time)

type ProjectId 

type ProjectId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	ProjectName       string
}

ProjectId is a struct representing the Resource ID for a Project

func NewProjectID 

func NewProjectID(subscriptionId string, resourceGroupName string, serviceName string, projectName string) ProjectId

NewProjectID returns a new ProjectId struct

func ParseProjectID 

func ParseProjectID(input string) (*ProjectId, error)

ParseProjectID parses 'input' into a ProjectId

func ParseProjectIDInsensitively 

func ParseProjectIDInsensitively(input string) (*ProjectId, error)

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

func (*ProjectId) FromParseResult 

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

func (ProjectId) ID 

func (id ProjectId) ID() string

ID returns the formatted Project ID

func (ProjectId) Segments 

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

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

func (ProjectId) String 

func (id ProjectId) String() string

String returns a human-readable description of this Project ID

type ProjectProperties 

type ProjectProperties struct {
	CreationTime         *string                   `json:"creationTime,omitempty"`
	DatabasesInfo        *[]DatabaseInfo           `json:"databasesInfo,omitempty"`
	ProvisioningState    *ProjectProvisioningState `json:"provisioningState,omitempty"`
	SourceConnectionInfo *ConnectionInfo           `json:"sourceConnectionInfo,omitempty"`
	SourcePlatform       ProjectSourcePlatform     `json:"sourcePlatform"`
	TargetConnectionInfo *ConnectionInfo           `json:"targetConnectionInfo,omitempty"`
	TargetPlatform       ProjectTargetPlatform     `json:"targetPlatform"`
}

func (*ProjectProperties) GetCreationTimeAsTime 

func (o *ProjectProperties) GetCreationTimeAsTime() (*time.Time, error)

func (*ProjectProperties) SetCreationTimeAsTime 

func (o *ProjectProperties) SetCreationTimeAsTime(input time.Time)

type ProjectProvisioningState 

type ProjectProvisioningState string
const (
	ProjectProvisioningStateDeleting  ProjectProvisioningState = "Deleting"
	ProjectProvisioningStateSucceeded ProjectProvisioningState = "Succeeded"
)

func (*ProjectProvisioningState) UnmarshalJSON 

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

type ProjectSourcePlatform 

type ProjectSourcePlatform string
const (
	ProjectSourcePlatformMongoDb    ProjectSourcePlatform = "MongoDb"
	ProjectSourcePlatformMySQL      ProjectSourcePlatform = "MySQL"
	ProjectSourcePlatformPostgreSql ProjectSourcePlatform = "PostgreSql"
	ProjectSourcePlatformSQL        ProjectSourcePlatform = "SQL"
	ProjectSourcePlatformUnknown    ProjectSourcePlatform = "Unknown"
)

func (*ProjectSourcePlatform) UnmarshalJSON 

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

type ProjectTargetPlatform 

type ProjectTargetPlatform string
const (
	ProjectTargetPlatformAzureDbForMySql      ProjectTargetPlatform = "AzureDbForMySql"
	ProjectTargetPlatformAzureDbForPostgreSql ProjectTargetPlatform = "AzureDbForPostgreSql"
	ProjectTargetPlatformMongoDb              ProjectTargetPlatform = "MongoDb"
	ProjectTargetPlatformSQLDB                ProjectTargetPlatform = "SQLDB"
	ProjectTargetPlatformSQLMI                ProjectTargetPlatform = "SQLMI"
	ProjectTargetPlatformUnknown              ProjectTargetPlatform = "Unknown"
)

func (*ProjectTargetPlatform) UnmarshalJSON 

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

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 ProjectsCreateOrUpdateOperationResponse 

type ProjectsCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Project
}

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) FromParseResult 

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

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 ServiceProvisioningState 

type ServiceProvisioningState string
const (
	ServiceProvisioningStateAccepted      ServiceProvisioningState = "Accepted"
	ServiceProvisioningStateDeleting      ServiceProvisioningState = "Deleting"
	ServiceProvisioningStateDeploying     ServiceProvisioningState = "Deploying"
	ServiceProvisioningStateFailed        ServiceProvisioningState = "Failed"
	ServiceProvisioningStateFailedToStart ServiceProvisioningState = "FailedToStart"
	ServiceProvisioningStateFailedToStop  ServiceProvisioningState = "FailedToStop"
	ServiceProvisioningStateStarting      ServiceProvisioningState = "Starting"
	ServiceProvisioningStateStopped       ServiceProvisioningState = "Stopped"
	ServiceProvisioningStateStopping      ServiceProvisioningState = "Stopping"
	ServiceProvisioningStateSucceeded     ServiceProvisioningState = "Succeeded"
)

func (*ServiceProvisioningState) UnmarshalJSON 

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

type ServiceSku 

type ServiceSku struct {
	Capacity *int64  `json:"capacity,omitempty"`
	Family   *string `json:"family,omitempty"`
	Name     *string `json:"name,omitempty"`
	Size     *string `json:"size,omitempty"`
	Tier     *string `json:"tier,omitempty"`
}

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) FromParseResult 

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

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 ServiceTasksCreateOrUpdateOperationResponse 

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

type ServicesCreateOrUpdateOperationResponse 

type ServicesCreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DataMigrationService
}

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) FromParseResult 

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

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 

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

type TasksCreateOrUpdateOperationResponse 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.