Documentation ¶
Overview ¶
Package storageimportexport implements the Azure ARM Storageimportexport service API version 2016-11-01.
The Storage Import/Export Resource Provider API.
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type BaseClient
- type BitLockerKeysClient
- func (client BitLockerKeysClient) List(ctx context.Context, jobName string, resourceGroupName string) (result GetBitLockerKeysResponse, err error)
- func (client BitLockerKeysClient) ListPreparer(ctx context.Context, jobName string, resourceGroupName string) (*http.Request, error)
- func (client BitLockerKeysClient) ListResponder(resp *http.Response) (result GetBitLockerKeysResponse, err error)
- func (client BitLockerKeysClient) ListSender(req *http.Request) (*http.Response, error)
- type DriveBitLockerKey
- type DriveState
- type DriveStatus
- type ErrorResponse
- type ErrorResponseError
- type ErrorResponseErrorDetailsItem
- type Export
- type ExportBlobList
- type GetBitLockerKeysResponse
- type JobDetails
- type JobResponse
- type JobsClient
- func (client JobsClient) Create(ctx context.Context, jobName string, resourceGroupName string, ...) (result JobResponse, err error)
- func (client JobsClient) CreatePreparer(ctx context.Context, jobName string, resourceGroupName string, ...) (*http.Request, error)
- func (client JobsClient) CreateResponder(resp *http.Response) (result JobResponse, err error)
- func (client JobsClient) CreateSender(req *http.Request) (*http.Response, error)
- func (client JobsClient) Delete(ctx context.Context, jobName string, resourceGroupName string) (result autorest.Response, err error)
- func (client JobsClient) DeletePreparer(ctx context.Context, jobName string, resourceGroupName string) (*http.Request, error)
- func (client JobsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client JobsClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client JobsClient) Get(ctx context.Context, jobName string, resourceGroupName string) (result JobResponse, err error)
- func (client JobsClient) GetPreparer(ctx context.Context, jobName string, resourceGroupName string) (*http.Request, error)
- func (client JobsClient) GetResponder(resp *http.Response) (result JobResponse, err error)
- func (client JobsClient) GetSender(req *http.Request) (*http.Response, error)
- func (client JobsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, top *int32, filter string) (result ListJobsResponsePage, err error)
- func (client JobsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, top *int32, filter string) (result ListJobsResponseIterator, err error)
- func (client JobsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, top *int32, filter string) (*http.Request, error)
- func (client JobsClient) ListByResourceGroupResponder(resp *http.Response) (result ListJobsResponse, err error)
- func (client JobsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client JobsClient) ListBySubscription(ctx context.Context, top *int32, filter string) (result ListJobsResponsePage, err error)
- func (client JobsClient) ListBySubscriptionComplete(ctx context.Context, top *int32, filter string) (result ListJobsResponseIterator, err error)
- func (client JobsClient) ListBySubscriptionPreparer(ctx context.Context, top *int32, filter string) (*http.Request, error)
- func (client JobsClient) ListBySubscriptionResponder(resp *http.Response) (result ListJobsResponse, err error)
- func (client JobsClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
- func (client JobsClient) Update(ctx context.Context, jobName string, resourceGroupName string, ...) (result JobResponse, err error)
- func (client JobsClient) UpdatePreparer(ctx context.Context, jobName string, resourceGroupName string, ...) (*http.Request, error)
- func (client JobsClient) UpdateResponder(resp *http.Response) (result JobResponse, err error)
- func (client JobsClient) UpdateSender(req *http.Request) (*http.Response, error)
- type ListJobsResponse
- type ListJobsResponseIterator
- func (iter *ListJobsResponseIterator) Next() error
- func (iter *ListJobsResponseIterator) NextWithContext(ctx context.Context) (err error)
- func (iter ListJobsResponseIterator) NotDone() bool
- func (iter ListJobsResponseIterator) Response() ListJobsResponse
- func (iter ListJobsResponseIterator) Value() JobResponse
- type ListJobsResponsePage
- type ListOperationsResponse
- type Location
- type LocationProperties
- type LocationsClient
- func (client LocationsClient) Get(ctx context.Context, locationName string) (result Location, err error)
- func (client LocationsClient) GetPreparer(ctx context.Context, locationName string) (*http.Request, error)
- func (client LocationsClient) GetResponder(resp *http.Response) (result Location, err error)
- func (client LocationsClient) GetSender(req *http.Request) (*http.Response, error)
- func (client LocationsClient) List(ctx context.Context) (result LocationsResponse, err error)
- func (client LocationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client LocationsClient) ListResponder(resp *http.Response) (result LocationsResponse, err error)
- func (client LocationsClient) ListSender(req *http.Request) (*http.Response, error)
- type LocationsResponse
- type Operation
- type OperationDisplay
- type OperationsClient
- func (client OperationsClient) List(ctx context.Context) (result ListOperationsResponse, err error)
- func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client OperationsClient) ListResponder(resp *http.Response) (result ListOperationsResponse, err error)
- func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
- type PackageInfomation
- type PutJobParameters
- type ReturnAddress
- type ReturnShipping
- type ShippingInformation
- type UpdateJobParameters
- type UpdateJobParametersProperties
Constants ¶
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 BaseClient ¶
type BaseClient struct { autorest.Client BaseURI string SubscriptionID string AcceptLanguage string }
BaseClient is the base client for Storageimportexport.
func New ¶
func New(subscriptionID string, acceptLanguage string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI ¶
func NewWithBaseURI(baseURI string, subscriptionID string, acceptLanguage string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
type BitLockerKeysClient ¶
type BitLockerKeysClient struct {
BaseClient
}
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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (BitLockerKeysClient) List ¶
func (client BitLockerKeysClient) List(ctx context.Context, jobName string, resourceGroupName string) (result GetBitLockerKeysResponse, err error)
List returns the BitLocker Keys for all drives in the specified job. Parameters: jobName - the name of the import/export job. resourceGroupName - the resource group name uniquely identifies the resource group within the user subscription.
func (BitLockerKeysClient) ListPreparer ¶
func (client BitLockerKeysClient) ListPreparer(ctx context.Context, 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 ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type DriveBitLockerKey ¶
type DriveBitLockerKey struct { // BitLockerKey - BitLocker recovery key or password BitLockerKey *string `json:"bitLockerKey,omitempty"` // DriveID - Drive ID DriveID *string `json:"driveId,omitempty"` }
DriveBitLockerKey bitLocker recovery key or password to the specified drive
type DriveState ¶
type DriveState string
DriveState enumerates the values for drive state.
const ( // Completed ... Completed DriveState = "Completed" // CompletedMoreInfo ... CompletedMoreInfo DriveState = "CompletedMoreInfo" // NeverReceived ... NeverReceived DriveState = "NeverReceived" // Received ... Received DriveState = "Received" // ShippedBack ... ShippedBack DriveState = "ShippedBack" // Specified ... Specified DriveState = "Specified" // Transferring ... Transferring DriveState = "Transferring" )
func PossibleDriveStateValues ¶
func PossibleDriveStateValues() []DriveState
PossibleDriveStateValues returns an array of possible values for the DriveState const type.
type DriveStatus ¶
type DriveStatus struct { // DriveID - The drive's hardware serial number, without spaces. DriveID *string `json:"driveId,omitempty"` // BitLockerKey - The BitLocker key used to encrypt the drive. BitLockerKey *string `json:"bitLockerKey,omitempty"` // ManifestFile - The relative path of the manifest file on the drive. ManifestFile *string `json:"manifestFile,omitempty"` // ManifestHash - The Base16-encoded MD5 hash of the manifest file on the drive. ManifestHash *string `json:"manifestHash,omitempty"` // DriveHeaderHash - The drive header hash value. DriveHeaderHash *string `json:"driveHeaderHash,omitempty"` // State - The drive's current state. Possible values include: 'Specified', 'Received', 'NeverReceived', 'Transferring', 'Completed', 'CompletedMoreInfo', 'ShippedBack' State DriveState `json:"state,omitempty"` // CopyStatus - Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state. CopyStatus *string `json:"copyStatus,omitempty"` // PercentComplete - Percentage completed for the drive. PercentComplete *int32 `json:"percentComplete,omitempty"` // VerboseLogURI - A URI that points to the blob containing the verbose log for the data transfer operation. VerboseLogURI *string `json:"verboseLogUri,omitempty"` // ErrorLogURI - A URI that points to the blob containing the error log for the data transfer operation. ErrorLogURI *string `json:"errorLogUri,omitempty"` // ManifestURI - A URI that points to the blob containing the drive manifest file. ManifestURI *string `json:"manifestUri,omitempty"` // BytesSucceeded - Bytes successfully transferred for the drive. BytesSucceeded *int64 `json:"bytesSucceeded,omitempty"` }
DriveStatus provides information about the drive's status
type ErrorResponse ¶
type ErrorResponse struct { // ErrorResponseError - Describes the error information. *ErrorResponseError `json:"error,omitempty"` }
ErrorResponse response when errors occurred
func (ErrorResponse) MarshalJSON ¶
func (er ErrorResponse) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ErrorResponse.
func (*ErrorResponse) UnmarshalJSON ¶
func (er *ErrorResponse) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ErrorResponse struct.
type ErrorResponseError ¶
type ErrorResponseError struct { // Code - Provides information about the error code. Code *string `json:"code,omitempty"` // Message - Provides information about the error message. Message *string `json:"message,omitempty"` // Target - Provides information about the error target. Target *string `json:"target,omitempty"` // Details - Describes the error details if present. Details *[]ErrorResponseErrorDetailsItem `json:"details,omitempty"` // Innererror - Inner error object if present. Innererror interface{} `json:"innererror,omitempty"` }
ErrorResponseError describes the error information.
type ErrorResponseErrorDetailsItem ¶
type ErrorResponseErrorDetailsItem struct { // Code - Provides information about the error code. Code *string `json:"code,omitempty"` // Target - Provides information about the error target. Target *string `json:"target,omitempty"` // Message - Provides information about the error message. Message *string `json:"message,omitempty"` }
ErrorResponseErrorDetailsItem ...
type Export ¶
type Export struct { // ExportBlobList - A list of the blobs to be exported. *ExportBlobList `json:"blobList,omitempty"` // BlobListblobPath - The relative URI to the block blob that contains the list of blob paths or blob path prefixes as defined above, beginning with the container name. If the blob is in root container, the URI must begin with $root. BlobListblobPath *string `json:"blobListblobPath,omitempty"` }
Export 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.
func (Export) MarshalJSON ¶
MarshalJSON is the custom marshaler for Export.
func (*Export) UnmarshalJSON ¶
UnmarshalJSON is the custom unmarshaler for Export struct.
type ExportBlobList ¶
type ExportBlobList struct { // BlobPath - A collection of blob-path strings. BlobPath *[]string `json:"blobPath,omitempty"` // BlobPathPrefix - A collection of blob-prefix strings. BlobPathPrefix *[]string `json:"blobPathPrefix,omitempty"` }
ExportBlobList a list of the blobs to be exported.
type GetBitLockerKeysResponse ¶
type GetBitLockerKeysResponse struct { autorest.Response `json:"-"` // Value - drive status Value *[]DriveBitLockerKey `json:"value,omitempty"` }
GetBitLockerKeysResponse getBitLockerKeys response
type JobDetails ¶
type JobDetails struct { // StorageAccountID - The resource identifier of the storage account where data will be imported to or exported from. StorageAccountID *string `json:"storageAccountId,omitempty"` // JobType - The type of job JobType *string `json:"jobType,omitempty"` // ReturnAddress - Specifies the return address information for the job. ReturnAddress *ReturnAddress `json:"returnAddress,omitempty"` // ReturnShipping - Specifies the return carrier and customer's account with the carrier. ReturnShipping *ReturnShipping `json:"returnShipping,omitempty"` // ShippingInformation - Contains information about the Microsoft datacenter to which the drives should be shipped. ShippingInformation *ShippingInformation `json:"shippingInformation,omitempty"` // DeliveryPackage - Contains information about the package being shipped by the customer to the Microsoft data center. DeliveryPackage *PackageInfomation `json:"deliveryPackage,omitempty"` // ReturnPackage - Contains information about the package being shipped from the Microsoft data center to the customer to return the drives. The format is the same as the deliveryPackage property above. This property is not included if the drives have not yet been returned. ReturnPackage *PackageInfomation `json:"returnPackage,omitempty"` // DiagnosticsPath - The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored. DiagnosticsPath *string `json:"diagnosticsPath,omitempty"` // LogLevel - Default value is Error. Indicates whether error logging or verbose logging will be enabled. LogLevel *string `json:"logLevel,omitempty"` // BackupDriveManifest - Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs. BackupDriveManifest *bool `json:"backupDriveManifest,omitempty"` // State - Current state of the job. State *string `json:"state,omitempty"` // CancelRequested - Indicates whether a request has been submitted to cancel the job. CancelRequested *bool `json:"cancelRequested,omitempty"` // PercentComplete - Overall percentage completed for the job. PercentComplete *int32 `json:"percentComplete,omitempty"` // IncompleteBlobListURI - A blob path that points to a block blob containing a list of blob names that were not exported due to insufficient drive space. If all blobs were exported successfully, then this element is not included in the response. IncompleteBlobListURI *string `json:"incompleteBlobListUri,omitempty"` // DriveList - List of up to ten drives that comprise the job. The drive list is a required element for an import job; it is not specified for export jobs. DriveList *[]DriveStatus `json:"driveList,omitempty"` // Export - A property containing information about the blobs to be exported for an export job. This property is included for export jobs only. Export *Export `json:"export,omitempty"` // ProvisioningState - Specifies the provisioning state of the job. ProvisioningState *string `json:"provisioningState,omitempty"` }
JobDetails specifies the job properties
type JobResponse ¶
type JobResponse struct { autorest.Response `json:"-"` // ID - READ-ONLY; Specifies the resource identifier of the job. ID *string `json:"id,omitempty"` // Name - READ-ONLY; Specifies the name of the job. Name *string `json:"name,omitempty"` // Type - READ-ONLY; Specifies the type of the job resource. Type *string `json:"type,omitempty"` // Location - Specifies the Azure location where the job is created. Location *string `json:"location,omitempty"` // Tags - Specifies the tags that are assigned to the job. Tags interface{} `json:"tags,omitempty"` // Properties - Specifies the job properties Properties *JobDetails `json:"properties,omitempty"` }
JobResponse contains the job information.
func (JobResponse) MarshalJSON ¶
func (jr JobResponse) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for JobResponse.
type JobsClient ¶
type JobsClient struct {
BaseClient
}
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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (JobsClient) Create ¶
func (client JobsClient) Create(ctx context.Context, 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. Parameters: jobName - the name of the import/export job. resourceGroupName - the resource group name uniquely identifies the resource group within the user subscription. body - the parameters used for creating the job clientTenantID - the tenant ID of the client making the request.
func (JobsClient) CreatePreparer ¶
func (client JobsClient) CreatePreparer(ctx context.Context, 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 ¶
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(ctx context.Context, 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. Parameters: jobName - the name of the import/export job. resourceGroupName - the resource group name uniquely identifies the resource group within the user subscription.
func (JobsClient) DeletePreparer ¶
func (client JobsClient) DeletePreparer(ctx context.Context, jobName string, resourceGroupName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (JobsClient) DeleteResponder ¶
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (JobsClient) DeleteSender ¶
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(ctx context.Context, jobName string, resourceGroupName string) (result JobResponse, err error)
Get gets information about an existing job. Parameters: jobName - the name of the import/export job. resourceGroupName - the resource group name uniquely identifies the resource group within the user subscription.
func (JobsClient) GetPreparer ¶
func (client JobsClient) GetPreparer(ctx context.Context, 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 ¶
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(ctx context.Context, resourceGroupName string, top *int32, filter string) (result ListJobsResponsePage, err error)
ListByResourceGroup returns all active and completed jobs in a resource group. Parameters: resourceGroupName - the resource group name uniquely identifies the resource group within the user subscription. top - an integer value that specifies how many jobs at most should be returned. The value cannot exceed 100. filter - can be used to restrict the results to certain conditions.
func (JobsClient) ListByResourceGroupComplete ¶
func (client JobsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, top *int32, filter string) (result ListJobsResponseIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (JobsClient) ListByResourceGroupPreparer ¶
func (client JobsClient) ListByResourceGroupPreparer(ctx context.Context, 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 ¶
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(ctx context.Context, top *int32, filter string) (result ListJobsResponsePage, err error)
ListBySubscription returns all active and completed jobs in a subscription. Parameters: top - an integer value that specifies how many jobs at most should be returned. The value cannot exceed 100. filter - can be used to restrict the results to certain conditions.
func (JobsClient) ListBySubscriptionComplete ¶
func (client JobsClient) ListBySubscriptionComplete(ctx context.Context, top *int32, filter string) (result ListJobsResponseIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (JobsClient) ListBySubscriptionPreparer ¶
func (client JobsClient) ListBySubscriptionPreparer(ctx context.Context, 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 ¶
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(ctx context.Context, 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. Parameters: jobName - the name of the import/export job. resourceGroupName - the resource group name uniquely identifies the resource group within the user subscription. body - the parameters to update in the job
func (JobsClient) UpdatePreparer ¶
func (client JobsClient) UpdatePreparer(ctx context.Context, 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 ¶
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 - link to next batch of jobs NextLink *string `json:"nextLink,omitempty"` // Value - Job list Value *[]JobResponse `json:"value,omitempty"` }
ListJobsResponse list jobs response
func (ListJobsResponse) IsEmpty ¶
func (ljr ListJobsResponse) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ListJobsResponseIterator ¶
type ListJobsResponseIterator struct {
// contains filtered or unexported fields
}
ListJobsResponseIterator provides access to a complete listing of JobResponse values.
func NewListJobsResponseIterator ¶
func NewListJobsResponseIterator(page ListJobsResponsePage) ListJobsResponseIterator
Creates a new instance of the ListJobsResponseIterator type.
func (*ListJobsResponseIterator) Next ¶
func (iter *ListJobsResponseIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*ListJobsResponseIterator) NextWithContext ¶
func (iter *ListJobsResponseIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (ListJobsResponseIterator) NotDone ¶
func (iter ListJobsResponseIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (ListJobsResponseIterator) Response ¶
func (iter ListJobsResponseIterator) Response() ListJobsResponse
Response returns the raw server response from the last page request.
func (ListJobsResponseIterator) Value ¶
func (iter ListJobsResponseIterator) Value() JobResponse
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ListJobsResponsePage ¶
type ListJobsResponsePage struct {
// contains filtered or unexported fields
}
ListJobsResponsePage contains a page of JobResponse values.
func NewListJobsResponsePage ¶
func NewListJobsResponsePage(cur ListJobsResponse, getNextPage func(context.Context, ListJobsResponse) (ListJobsResponse, error)) ListJobsResponsePage
Creates a new instance of the ListJobsResponsePage type.
func (*ListJobsResponsePage) Next ¶
func (page *ListJobsResponsePage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*ListJobsResponsePage) NextWithContext ¶
func (page *ListJobsResponsePage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (ListJobsResponsePage) NotDone ¶
func (page ListJobsResponsePage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (ListJobsResponsePage) Response ¶
func (page ListJobsResponsePage) Response() ListJobsResponse
Response returns the raw server response from the last page request.
func (ListJobsResponsePage) Values ¶
func (page ListJobsResponsePage) Values() []JobResponse
Values returns the slice of values for the current page or nil if there are no values.
type ListOperationsResponse ¶
type ListOperationsResponse struct { autorest.Response `json:"-"` // Value - operations Value *[]Operation `json:"value,omitempty"` }
ListOperationsResponse list operations response
type Location ¶
type Location struct { autorest.Response `json:"-"` // ID - Specifies the resource identifier of the location. ID *string `json:"id,omitempty"` // Name - Specifies the name of the location. Use List Locations to get all supported locations. Name *string `json:"name,omitempty"` // Type - Specifies the type of the location. Type *string `json:"type,omitempty"` // LocationProperties - location properties *LocationProperties `json:"properties,omitempty"` }
Location provides information about an Azure data center location.
func (Location) MarshalJSON ¶
MarshalJSON is the custom marshaler for Location.
func (*Location) UnmarshalJSON ¶
UnmarshalJSON is the custom unmarshaler for Location struct.
type LocationProperties ¶
type LocationProperties struct { // RecipientName - The recipient name to use when shipping the drives to the Azure data center. RecipientName *string `json:"recipientName,omitempty"` // StreetAddress1 - The first line of the street address to use when shipping the drives to the Azure data center. StreetAddress1 *string `json:"streetAddress1,omitempty"` // StreetAddress2 - The second line of the street address to use when shipping the drives to the Azure data center. StreetAddress2 *string `json:"streetAddress2,omitempty"` // City - The city name to use when shipping the drives to the Azure data center. City *string `json:"city,omitempty"` // StateOrProvince - The state or province to use when shipping the drives to the Azure data center. StateOrProvince *string `json:"stateOrProvince,omitempty"` // PostalCode - The postal code to use when shipping the drives to the Azure data center. PostalCode *string `json:"postalCode,omitempty"` // CountryOrRegion - The country or region to use when shipping the drives to the Azure data center. CountryOrRegion *string `json:"countryOrRegion,omitempty"` // Phone - The phone number for the Azure data center. Phone *string `json:"phone,omitempty"` // SupportedCarriers - A list of carriers that are supported at this location. SupportedCarriers *[]string `json:"supportedCarriers,omitempty"` // AlternateLocations - A list of location IDs that should be used to ship shipping drives to for jobs created against the current location. If the current location is active, it will be part of the list. If it is temporarily closed due to maintenance, this list may contain other locations. AlternateLocations *[]string `json:"alternateLocations,omitempty"` }
LocationProperties location properties
type LocationsClient ¶
type LocationsClient struct {
BaseClient
}
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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (LocationsClient) Get ¶
func (client LocationsClient) Get(ctx context.Context, 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. Parameters: locationName - the name of the location. For example, West US or westus.
func (LocationsClient) GetPreparer ¶
func (client LocationsClient) GetPreparer(ctx context.Context, 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 ¶
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(ctx context.Context) (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 ¶
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 ¶
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 - locations Value *[]Location `json:"value,omitempty"` }
LocationsResponse locations response
type Operation ¶
type Operation struct { // Name - Name of the operation. Name *string `json:"name,omitempty"` // OperationDisplay - operation display properties *OperationDisplay `json:"display,omitempty"` }
Operation describes a supported operation by the Storage Import/Export job API.
func (Operation) MarshalJSON ¶
MarshalJSON is the custom marshaler for Operation.
func (*Operation) UnmarshalJSON ¶
UnmarshalJSON is the custom unmarshaler for Operation struct.
type OperationDisplay ¶
type OperationDisplay struct { // Provider - The resource provider name to which the operation belongs. Provider *string `json:"provider,omitempty"` // Resource - The name of the resource to which the operation belongs. Resource *string `json:"resource,omitempty"` // Operation - The display name of the operation. Operation *string `json:"operation,omitempty"` // Description - Short description of the operation. Description *string `json:"description,omitempty"` }
OperationDisplay operation display properties
type OperationsClient ¶
type OperationsClient struct {
BaseClient
}
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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (OperationsClient) List ¶
func (client OperationsClient) List(ctx context.Context) (result ListOperationsResponse, err error)
List returns the list of operations supported by the import/export resource provider.
func (OperationsClient) ListPreparer ¶
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 ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type PackageInfomation ¶
type PackageInfomation struct { // CarrierName - The name of the carrier that is used to ship the import or export drives. CarrierName *string `json:"carrierName,omitempty"` // TrackingNumber - The tracking number of the package. TrackingNumber *string `json:"trackingNumber,omitempty"` // DriveCount - The number of drives included in the package. DriveCount *int32 `json:"driveCount,omitempty"` // ShipDate - The date when the package is shipped. ShipDate *string `json:"shipDate,omitempty"` }
PackageInfomation contains information about the package being shipped by the customer to the Microsoft data center.
type PutJobParameters ¶
type PutJobParameters struct { // Location - Specifies the supported Azure location where the job should be created Location *string `json:"location,omitempty"` // Tags - Specifies the tags that will be assigned to the job. Tags interface{} `json:"tags,omitempty"` // Properties - Specifies the job properties Properties *JobDetails `json:"properties,omitempty"` }
PutJobParameters put Job parameters
type ReturnAddress ¶
type ReturnAddress struct { // RecipientName - The name of the recipient who will receive the hard drives when they are returned. RecipientName *string `json:"recipientName,omitempty"` // StreetAddress1 - The first line of the street address to use when returning the drives. StreetAddress1 *string `json:"streetAddress1,omitempty"` // StreetAddress2 - The second line of the street address to use when returning the drives. StreetAddress2 *string `json:"streetAddress2,omitempty"` // City - The city name to use when returning the drives. City *string `json:"city,omitempty"` // StateOrProvince - The state or province to use when returning the drives. StateOrProvince *string `json:"stateOrProvince,omitempty"` // PostalCode - The postal code to use when returning the drives. PostalCode *string `json:"postalCode,omitempty"` // CountryOrRegion - The country or region to use when returning the drives. CountryOrRegion *string `json:"countryOrRegion,omitempty"` // Phone - Phone number of the recipient of the returned drives. Phone *string `json:"phone,omitempty"` // Email - Email address of the recipient of the returned drives. Email *string `json:"email,omitempty"` }
ReturnAddress specifies the return address information for the job.
type ReturnShipping ¶
type ReturnShipping struct { // CarrierName - The carrier's name. CarrierName *string `json:"carrierName,omitempty"` // CarrierAccountNumber - The customer's account number with the carrier. CarrierAccountNumber *string `json:"carrierAccountNumber,omitempty"` }
ReturnShipping specifies the return carrier and customer's account with the carrier.
type ShippingInformation ¶
type ShippingInformation struct { // RecipientName - The name of the recipient who will receive the hard drives when they are returned. RecipientName *string `json:"recipientName,omitempty"` // StreetAddress1 - The first line of the street address to use when returning the drives. StreetAddress1 *string `json:"streetAddress1,omitempty"` // StreetAddress2 - The second line of the street address to use when returning the drives. StreetAddress2 *string `json:"streetAddress2,omitempty"` // City - The city name to use when returning the drives. City *string `json:"city,omitempty"` // StateOrProvince - The state or province to use when returning the drives. StateOrProvince *string `json:"stateOrProvince,omitempty"` // PostalCode - The postal code to use when returning the drives. PostalCode *string `json:"postalCode,omitempty"` // CountryOrRegion - The country or region to use when returning the drives. CountryOrRegion *string `json:"countryOrRegion,omitempty"` // Phone - Phone number of the recipient of the returned drives. Phone *string `json:"phone,omitempty"` }
ShippingInformation contains information about the Microsoft datacenter to which the drives should be shipped.
type UpdateJobParameters ¶
type UpdateJobParameters struct { // Tags - Specifies the tags that will be assigned to the job Tags interface{} `json:"tags,omitempty"` // UpdateJobParametersProperties - Specifies the properties of a UpdateJob. *UpdateJobParametersProperties `json:"properties,omitempty"` }
UpdateJobParameters update Job parameters
func (UpdateJobParameters) MarshalJSON ¶
func (ujp UpdateJobParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UpdateJobParameters.
func (*UpdateJobParameters) UnmarshalJSON ¶
func (ujp *UpdateJobParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for UpdateJobParameters struct.
type UpdateJobParametersProperties ¶
type UpdateJobParametersProperties struct { // CancelRequested - If specified, the value must be true. The service will attempt to cancel the job. CancelRequested *bool `json:"cancelRequested,omitempty"` // State - If specified, the value must be Shipping, which tells the Import/Export service that the package for the job has been shipped. The ReturnAddress and DeliveryPackage properties must have been set either in this request or in a previous request, otherwise the request will fail. State *string `json:"state,omitempty"` // ReturnAddress - Specifies the return address information for the job. ReturnAddress *ReturnAddress `json:"returnAddress,omitempty"` // ReturnShipping - Specifies the return carrier and customer's account with the carrier. ReturnShipping *ReturnShipping `json:"returnShipping,omitempty"` // DeliveryPackage - Contains information about the package being shipped by the customer to the Microsoft data center. DeliveryPackage *PackageInfomation `json:"deliveryPackage,omitempty"` // LogLevel - Indicates whether error logging or verbose logging is enabled. LogLevel *string `json:"logLevel,omitempty"` // BackupDriveManifest - Indicates whether the manifest files on the drives should be copied to block blobs. BackupDriveManifest *bool `json:"backupDriveManifest,omitempty"` // DriveList - List of drives that comprise the job. DriveList *[]DriveStatus `json:"driveList,omitempty"` }
UpdateJobParametersProperties specifies the properties of a UpdateJob.