storageimportexport

package
v11.3.0-beta+incompatible Latest Latest
Warning

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

Go to latest
Published: Dec 12, 2017 License: Apache-2.0 Imports: 5 Imported by: 240

Documentation

Overview

Package storageimportexport implements the Azure ARM Storageimportexport service API version 2016-11-01.

The Storage Import/Export Resource Provider API.

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Storageimportexport
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type BitLockerKeysClient

type BitLockerKeysClient struct {
	ManagementClient
}

BitLockerKeysClient is the the Storage Import/Export Resource Provider API.

func NewBitLockerKeysClient

func NewBitLockerKeysClient(subscriptionID string, acceptLanguage string) BitLockerKeysClient

NewBitLockerKeysClient creates an instance of the BitLockerKeysClient client.

func NewBitLockerKeysClientWithBaseURI

func NewBitLockerKeysClientWithBaseURI(baseURI string, subscriptionID string, acceptLanguage string) BitLockerKeysClient

NewBitLockerKeysClientWithBaseURI creates an instance of the BitLockerKeysClient client.

func (BitLockerKeysClient) List

func (client BitLockerKeysClient) List(jobName string, resourceGroupName string) (result GetBitLockerKeysResponse, err error)

List returns the BitLocker Keys for all drives in the specified job.

jobName is the name of the import/export job. resourceGroupName is the resource group name uniquely identifies the resource group within the user subscription.

func (BitLockerKeysClient) ListPreparer

func (client BitLockerKeysClient) ListPreparer(jobName string, resourceGroupName string) (*http.Request, error)

ListPreparer prepares the List request.

func (BitLockerKeysClient) ListResponder

func (client BitLockerKeysClient) ListResponder(resp *http.Response) (result GetBitLockerKeysResponse, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (BitLockerKeysClient) ListSender

func (client BitLockerKeysClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type DriveBitLockerKey

type DriveBitLockerKey struct {
	BitLockerKey *string `json:"bitLockerKey,omitempty"`
	DriveID      *string `json:"driveId,omitempty"`
}

DriveBitLockerKey is bitLocker recovery key or password to the specified drive

type DriveState

type DriveState string

DriveState enumerates the values for drive state.

const (
	// Completed specifies the completed state for drive state.
	Completed DriveState = "Completed"
	// CompletedMoreInfo specifies the completed more info state for drive state.
	CompletedMoreInfo DriveState = "CompletedMoreInfo"
	// NeverReceived specifies the never received state for drive state.
	NeverReceived DriveState = "NeverReceived"
	// Received specifies the received state for drive state.
	Received DriveState = "Received"
	// ShippedBack specifies the shipped back state for drive state.
	ShippedBack DriveState = "ShippedBack"
	// Specified specifies the specified state for drive state.
	Specified DriveState = "Specified"
	// Transferring specifies the transferring state for drive state.
	Transferring DriveState = "Transferring"
)

type DriveStatus

type DriveStatus struct {
	DriveID         *string    `json:"driveId,omitempty"`
	BitLockerKey    *string    `json:"bitLockerKey,omitempty"`
	ManifestFile    *string    `json:"manifestFile,omitempty"`
	ManifestHash    *string    `json:"manifestHash,omitempty"`
	DriveHeaderHash *string    `json:"driveHeaderHash,omitempty"`
	State           DriveState `json:"state,omitempty"`
	CopyStatus      *string    `json:"copyStatus,omitempty"`
	PercentComplete *int32     `json:"percentComplete,omitempty"`
	VerboseLogURI   *string    `json:"verboseLogUri,omitempty"`
	ErrorLogURI     *string    `json:"errorLogUri,omitempty"`
	ManifestURI     *string    `json:"manifestUri,omitempty"`
	BytesSucceeded  *int64     `json:"bytesSucceeded,omitempty"`
}

DriveStatus is provides information about the drive's status

type ErrorResponse

type ErrorResponse struct {
	*ErrorResponseError `json:"error,omitempty"`
}

ErrorResponse is response when errors occurred

type ErrorResponseError

type ErrorResponseError struct {
	Code       *string                          `json:"code,omitempty"`
	Message    *string                          `json:"message,omitempty"`
	Target     *string                          `json:"target,omitempty"`
	Details    *[]ErrorResponseErrorDetailsItem `json:"details,omitempty"`
	Innererror *map[string]interface{}          `json:"innererror,omitempty"`
}

ErrorResponseError is describes the error information.

type ErrorResponseErrorDetailsItem

type ErrorResponseErrorDetailsItem struct {
	Code    *string `json:"code,omitempty"`
	Target  *string `json:"target,omitempty"`
	Message *string `json:"message,omitempty"`
}

ErrorResponseErrorDetailsItem is

type Export

type Export struct {
	*ExportBlobList  `json:"blobList,omitempty"`
	BlobListblobPath *string `json:"blobListblobPath,omitempty"`
}

Export is a property containing information about the blobs to be exported for an export job. This property is required for export jobs, but must not be specified for import jobs.

type ExportBlobList

type ExportBlobList struct {
	BlobPath       *[]string `json:"blobPath,omitempty"`
	BlobPathPrefix *[]string `json:"blobPathPrefix,omitempty"`
}

ExportBlobList is a list of the blobs to be exported.

type GetBitLockerKeysResponse

type GetBitLockerKeysResponse struct {
	autorest.Response `json:"-"`
	Value             *[]DriveBitLockerKey `json:"value,omitempty"`
}

GetBitLockerKeysResponse is getBitLockerKeys response

type JobDetails

type JobDetails struct {
	StorageAccountID      *string              `json:"storageAccountId,omitempty"`
	JobType               *string              `json:"jobType,omitempty"`
	ReturnAddress         *ReturnAddress       `json:"returnAddress,omitempty"`
	ReturnShipping        *ReturnShipping      `json:"returnShipping,omitempty"`
	ShippingInformation   *ShippingInformation `json:"shippingInformation,omitempty"`
	DeliveryPackage       *PackageInfomation   `json:"deliveryPackage,omitempty"`
	ReturnPackage         *PackageInfomation   `json:"returnPackage,omitempty"`
	DiagnosticsPath       *string              `json:"diagnosticsPath,omitempty"`
	LogLevel              *string              `json:"logLevel,omitempty"`
	BackupDriveManifest   *bool                `json:"backupDriveManifest,omitempty"`
	State                 *string              `json:"state,omitempty"`
	CancelRequested       *bool                `json:"cancelRequested,omitempty"`
	PercentComplete       *int32               `json:"percentComplete,omitempty"`
	IncompleteBlobListURI *string              `json:"incompleteBlobListUri,omitempty"`
	DriveList             *[]DriveStatus       `json:"driveList,omitempty"`
	Export                *Export              `json:"export,omitempty"`
	ProvisioningState     *string              `json:"provisioningState,omitempty"`
}

JobDetails is specifies the job properties

type JobResponse

type JobResponse struct {
	autorest.Response `json:"-"`
	ID                *string                 `json:"id,omitempty"`
	Name              *string                 `json:"name,omitempty"`
	Type              *string                 `json:"type,omitempty"`
	Location          *string                 `json:"location,omitempty"`
	Tags              *map[string]interface{} `json:"tags,omitempty"`
	Properties        *JobDetails             `json:"properties,omitempty"`
}

JobResponse is contains the job information.

type JobsClient

type JobsClient struct {
	ManagementClient
}

JobsClient is the the Storage Import/Export Resource Provider API.

func NewJobsClient

func NewJobsClient(subscriptionID string, acceptLanguage string) JobsClient

NewJobsClient creates an instance of the JobsClient client.

func NewJobsClientWithBaseURI

func NewJobsClientWithBaseURI(baseURI string, subscriptionID string, acceptLanguage string) JobsClient

NewJobsClientWithBaseURI creates an instance of the JobsClient client.

func (JobsClient) Create

func (client JobsClient) Create(jobName string, resourceGroupName string, body PutJobParameters, clientTenantID string) (result JobResponse, err error)

Create creates a new job or updates an existing job in the specified subscription.

jobName is the name of the import/export job. resourceGroupName is the resource group name uniquely identifies the resource group within the user subscription. body is the parameters used for creating the job clientTenantID is the tenant ID of the client making the request.

func (JobsClient) CreatePreparer

func (client JobsClient) CreatePreparer(jobName string, resourceGroupName string, body PutJobParameters, clientTenantID string) (*http.Request, error)

CreatePreparer prepares the Create request.

func (JobsClient) CreateResponder

func (client JobsClient) CreateResponder(resp *http.Response) (result JobResponse, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (JobsClient) CreateSender

func (client JobsClient) CreateSender(req *http.Request) (*http.Response, error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (JobsClient) Delete

func (client JobsClient) Delete(jobName string, resourceGroupName string) (result autorest.Response, err error)

Delete deletes an existing job. Only jobs in the Creating or Completed states can be deleted.

jobName is the name of the import/export job. resourceGroupName is the resource group name uniquely identifies the resource group within the user subscription.

func (JobsClient) DeletePreparer

func (client JobsClient) DeletePreparer(jobName string, resourceGroupName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (JobsClient) DeleteResponder

func (client JobsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (JobsClient) DeleteSender

func (client JobsClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (JobsClient) Get

func (client JobsClient) Get(jobName string, resourceGroupName string) (result JobResponse, err error)

Get gets information about an existing job.

jobName is the name of the import/export job. resourceGroupName is the resource group name uniquely identifies the resource group within the user subscription.

func (JobsClient) GetPreparer

func (client JobsClient) GetPreparer(jobName string, resourceGroupName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (JobsClient) GetResponder

func (client JobsClient) GetResponder(resp *http.Response) (result JobResponse, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (JobsClient) GetSender

func (client JobsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (JobsClient) ListByResourceGroup

func (client JobsClient) ListByResourceGroup(resourceGroupName string, top *int32, filter string) (result ListJobsResponse, err error)

ListByResourceGroup returns all active and completed jobs in a resource group.

resourceGroupName is the resource group name uniquely identifies the resource group within the user subscription. top is an integer value that specifies how many jobs at most should be returned. The value cannot exceed 100. filter is can be used to restrict the results to certain conditions.

func (JobsClient) ListByResourceGroupComplete

func (client JobsClient) ListByResourceGroupComplete(resourceGroupName string, top *int32, filter string, cancel <-chan struct{}) (<-chan JobResponse, <-chan error)

ListByResourceGroupComplete gets all elements from the list without paging.

func (JobsClient) ListByResourceGroupNextResults

func (client JobsClient) ListByResourceGroupNextResults(lastResults ListJobsResponse) (result ListJobsResponse, err error)

ListByResourceGroupNextResults retrieves the next set of results, if any.

func (JobsClient) ListByResourceGroupPreparer

func (client JobsClient) ListByResourceGroupPreparer(resourceGroupName string, top *int32, filter string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (JobsClient) ListByResourceGroupResponder

func (client JobsClient) ListByResourceGroupResponder(resp *http.Response) (result ListJobsResponse, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (JobsClient) ListByResourceGroupSender

func (client JobsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (JobsClient) ListBySubscription

func (client JobsClient) ListBySubscription(top *int32, filter string) (result ListJobsResponse, err error)

ListBySubscription returns all active and completed jobs in a subscription.

top is an integer value that specifies how many jobs at most should be returned. The value cannot exceed 100. filter is can be used to restrict the results to certain conditions.

func (JobsClient) ListBySubscriptionComplete

func (client JobsClient) ListBySubscriptionComplete(top *int32, filter string, cancel <-chan struct{}) (<-chan JobResponse, <-chan error)

ListBySubscriptionComplete gets all elements from the list without paging.

func (JobsClient) ListBySubscriptionNextResults

func (client JobsClient) ListBySubscriptionNextResults(lastResults ListJobsResponse) (result ListJobsResponse, err error)

ListBySubscriptionNextResults retrieves the next set of results, if any.

func (JobsClient) ListBySubscriptionPreparer

func (client JobsClient) ListBySubscriptionPreparer(top *int32, filter string) (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (JobsClient) ListBySubscriptionResponder

func (client JobsClient) ListBySubscriptionResponder(resp *http.Response) (result ListJobsResponse, err error)

ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.

func (JobsClient) ListBySubscriptionSender

func (client JobsClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)

ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.

func (JobsClient) Update

func (client JobsClient) Update(jobName string, resourceGroupName string, body UpdateJobParameters) (result JobResponse, err error)

Update updates specific properties of a job. You can call this operation to notify the Import/Export service that the hard drives comprising the import or export job have been shipped to the Microsoft data center. It can also be used to cancel an existing job.

jobName is the name of the import/export job. resourceGroupName is the resource group name uniquely identifies the resource group within the user subscription. body is the parameters to update in the job

func (JobsClient) UpdatePreparer

func (client JobsClient) UpdatePreparer(jobName string, resourceGroupName string, body UpdateJobParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (JobsClient) UpdateResponder

func (client JobsClient) UpdateResponder(resp *http.Response) (result JobResponse, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (JobsClient) UpdateSender

func (client JobsClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type ListJobsResponse

type ListJobsResponse struct {
	autorest.Response `json:"-"`
	NextLink          *string        `json:"nextLink,omitempty"`
	Value             *[]JobResponse `json:"value,omitempty"`
}

ListJobsResponse is list jobs response

func (ListJobsResponse) ListJobsResponsePreparer

func (client ListJobsResponse) ListJobsResponsePreparer() (*http.Request, error)

ListJobsResponsePreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type ListOperationsResponse

type ListOperationsResponse struct {
	autorest.Response `json:"-"`
	Value             *[]Operation `json:"value,omitempty"`
}

ListOperationsResponse is list operations response

type Location

type Location struct {
	autorest.Response   `json:"-"`
	ID                  *string `json:"id,omitempty"`
	Name                *string `json:"name,omitempty"`
	Type                *string `json:"type,omitempty"`
	*LocationProperties `json:"properties,omitempty"`
}

Location is provides information about an Azure data center location.

type LocationProperties

type LocationProperties struct {
	RecipientName      *string   `json:"recipientName,omitempty"`
	StreetAddress1     *string   `json:"streetAddress1,omitempty"`
	StreetAddress2     *string   `json:"streetAddress2,omitempty"`
	City               *string   `json:"city,omitempty"`
	StateOrProvince    *string   `json:"stateOrProvince,omitempty"`
	PostalCode         *string   `json:"postalCode,omitempty"`
	CountryOrRegion    *string   `json:"countryOrRegion,omitempty"`
	Phone              *string   `json:"phone,omitempty"`
	SupportedCarriers  *[]string `json:"supportedCarriers,omitempty"`
	AlternateLocations *[]string `json:"alternateLocations,omitempty"`
}

LocationProperties is location properties

type LocationsClient

type LocationsClient struct {
	ManagementClient
}

LocationsClient is the the Storage Import/Export Resource Provider API.

func NewLocationsClient

func NewLocationsClient(subscriptionID string, acceptLanguage string) LocationsClient

NewLocationsClient creates an instance of the LocationsClient client.

func NewLocationsClientWithBaseURI

func NewLocationsClientWithBaseURI(baseURI string, subscriptionID string, acceptLanguage string) LocationsClient

NewLocationsClientWithBaseURI creates an instance of the LocationsClient client.

func (LocationsClient) Get

func (client LocationsClient) Get(locationName string) (result Location, err error)

Get returns the details about a location to which you can ship the disks associated with an import or export job. A location is an Azure region.

locationName is the name of the location. For example, West US or westus.

func (LocationsClient) GetPreparer

func (client LocationsClient) GetPreparer(locationName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (LocationsClient) GetResponder

func (client LocationsClient) GetResponder(resp *http.Response) (result Location, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (LocationsClient) GetSender

func (client LocationsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (LocationsClient) List

func (client LocationsClient) List() (result LocationsResponse, err error)

List returns a list of locations to which you can ship the disks associated with an import or export job. A location is a Microsoft data center region.

func (LocationsClient) ListPreparer

func (client LocationsClient) ListPreparer() (*http.Request, error)

ListPreparer prepares the List request.

func (LocationsClient) ListResponder

func (client LocationsClient) ListResponder(resp *http.Response) (result LocationsResponse, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (LocationsClient) ListSender

func (client LocationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type LocationsResponse

type LocationsResponse struct {
	autorest.Response `json:"-"`
	Value             *[]Location `json:"value,omitempty"`
}

LocationsResponse is locations response

type ManagementClient

type ManagementClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
	AcceptLanguage string
}

ManagementClient is the base client for Storageimportexport.

func New

func New(subscriptionID string, acceptLanguage string) ManagementClient

New creates an instance of the ManagementClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string, acceptLanguage string) ManagementClient

NewWithBaseURI creates an instance of the ManagementClient client.

type Operation

type Operation struct {
	Name              *string `json:"name,omitempty"`
	*OperationDisplay `json:"display,omitempty"`
}

Operation is describes a supported operation by the Storage Import/Export job API.

type OperationDisplay

type OperationDisplay struct {
	Provider    *string `json:"provider,omitempty"`
	Resource    *string `json:"resource,omitempty"`
	Operation   *string `json:"operation,omitempty"`
	Description *string `json:"description,omitempty"`
}

OperationDisplay is operation display properties

type OperationsClient

type OperationsClient struct {
	ManagementClient
}

OperationsClient is the the Storage Import/Export Resource Provider API.

func NewOperationsClient

func NewOperationsClient(subscriptionID string, acceptLanguage string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string, acceptLanguage string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List

func (client OperationsClient) List() (result ListOperationsResponse, err error)

List returns the list of operations supported by the import/export resource provider.

func (OperationsClient) ListPreparer

func (client OperationsClient) ListPreparer() (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder

func (client OperationsClient) ListResponder(resp *http.Response) (result ListOperationsResponse, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OperationsClient) ListSender

func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type PackageInfomation

type PackageInfomation struct {
	CarrierName    *string `json:"carrierName,omitempty"`
	TrackingNumber *string `json:"trackingNumber,omitempty"`
	DriveCount     *int32  `json:"driveCount,omitempty"`
	ShipDate       *string `json:"shipDate,omitempty"`
}

PackageInfomation is contains information about the package being shipped by the customer to the Microsoft data center.

type PutJobParameters

type PutJobParameters struct {
	Location   *string                 `json:"location,omitempty"`
	Tags       *map[string]interface{} `json:"tags,omitempty"`
	Properties *JobDetails             `json:"properties,omitempty"`
}

PutJobParameters is put Job parameters

type ReturnAddress

type ReturnAddress struct {
	RecipientName   *string `json:"recipientName,omitempty"`
	StreetAddress1  *string `json:"streetAddress1,omitempty"`
	StreetAddress2  *string `json:"streetAddress2,omitempty"`
	City            *string `json:"city,omitempty"`
	StateOrProvince *string `json:"stateOrProvince,omitempty"`
	PostalCode      *string `json:"postalCode,omitempty"`
	CountryOrRegion *string `json:"countryOrRegion,omitempty"`
	Phone           *string `json:"phone,omitempty"`
	Email           *string `json:"email,omitempty"`
}

ReturnAddress is specifies the return address information for the job.

type ReturnShipping

type ReturnShipping struct {
	CarrierName          *string `json:"carrierName,omitempty"`
	CarrierAccountNumber *string `json:"carrierAccountNumber,omitempty"`
}

ReturnShipping is specifies the return carrier and customer's account with the carrier.

type ShippingInformation

type ShippingInformation struct {
	RecipientName   *string `json:"recipientName,omitempty"`
	StreetAddress1  *string `json:"streetAddress1,omitempty"`
	StreetAddress2  *string `json:"streetAddress2,omitempty"`
	City            *string `json:"city,omitempty"`
	StateOrProvince *string `json:"stateOrProvince,omitempty"`
	PostalCode      *string `json:"postalCode,omitempty"`
	CountryOrRegion *string `json:"countryOrRegion,omitempty"`
	Phone           *string `json:"phone,omitempty"`
}

ShippingInformation is contains information about the Microsoft datacenter to which the drives should be shipped.

type UpdateJobParameters

type UpdateJobParameters struct {
	Tags                           *map[string]interface{} `json:"tags,omitempty"`
	*UpdateJobParametersProperties `json:"properties,omitempty"`
}

UpdateJobParameters is update Job parameters

type UpdateJobParametersProperties

type UpdateJobParametersProperties struct {
	CancelRequested     *bool              `json:"cancelRequested,omitempty"`
	State               *string            `json:"state,omitempty"`
	ReturnAddress       *ReturnAddress     `json:"returnAddress,omitempty"`
	ReturnShipping      *ReturnShipping    `json:"returnShipping,omitempty"`
	DeliveryPackage     *PackageInfomation `json:"deliveryPackage,omitempty"`
	LogLevel            *string            `json:"logLevel,omitempty"`
	BackupDriveManifest *bool              `json:"backupDriveManifest,omitempty"`
	DriveList           *[]DriveStatus     `json:"driveList,omitempty"`
}

UpdateJobParametersProperties is specifies the properties of a UpdateJob.

Jump to

Keyboard shortcuts

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