storagepool

package
v63.3.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Apr 18, 2022 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Package storagepool implements the Azure ARM Storagepool service API version 2020-03-15-preview.

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Storagepool
	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 ACL

type ACL struct {
	// InitiatorIqn - iSCSI initiator iqn (iSCSI Qualified Name); example: iqn.2005-03.org.iscsi:client
	InitiatorIqn *string `json:"initiatorIqn,omitempty"`
	// MappedLuns - Array of lun names mapped to the ACL
	MappedLuns *[]string `json:"mappedLuns,omitempty"`
	// IscsiTargetCredentials - CHAP credentials for iSCSI target.
	*IscsiTargetCredentials `json:"credentials,omitempty"`
}

ACL access Control List (ACL) for an iSCSI target lun

func (ACL) MarshalJSON

func (a ACL) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ACL.

func (*ACL) UnmarshalJSON

func (a *ACL) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ACL struct.

type Attributes

type Attributes struct {
	// Authentication - Indicates whether or not authentication is enabled on the ACL.
	Authentication *bool `json:"authentication,omitempty"`
	// ProdModeWriteProtect - Indicates whether or not write protect is enabled on the luns.
	ProdModeWriteProtect *bool `json:"prodModeWriteProtect,omitempty"`
}

Attributes attributes of an iSCSI target

type BaseClient

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Storagepool.

func New

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID 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 Disk

type Disk struct {
	// ID - Unique Azure resource id of the managed disk. Required.
	ID *string `json:"id,omitempty"`
}

Disk managed disk to attach to the DiskPool. Required.

type DiskPool

type DiskPool struct {
	autorest.Response `json:"-"`
	// DiskPoolProperties - RP defined properties for Disk Pool operations.
	*DiskPoolProperties `json:"properties,omitempty"`
	// Sku - Sku description.
	Sku *Sku `json:"sku,omitempty"`
	// SystemData - READ-ONLY; Resource metadata required by ARM RPC
	SystemData *SystemMetadata `json:"systemData,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty"`
}

DiskPool request payload for Create or Update Disk Pool requests.

func (DiskPool) MarshalJSON

func (dp DiskPool) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DiskPool.

func (*DiskPool) UnmarshalJSON

func (dp *DiskPool) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DiskPool struct.

type DiskPoolListResult

type DiskPoolListResult struct {
	autorest.Response `json:"-"`
	// Value - An array of Disk Pool objects.
	Value *[]DiskPool `json:"value,omitempty"`
	// NextLink - READ-ONLY; URI to fetch the next section of the paginated response.
	NextLink *string `json:"nextLink,omitempty"`
}

DiskPoolListResult list of Disk Pools

func (DiskPoolListResult) IsEmpty

func (dplr DiskPoolListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (DiskPoolListResult) MarshalJSON

func (dplr DiskPoolListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DiskPoolListResult.

type DiskPoolListResultIterator

type DiskPoolListResultIterator struct {
	// contains filtered or unexported fields
}

DiskPoolListResultIterator provides access to a complete listing of DiskPool values.

func NewDiskPoolListResultIterator

func NewDiskPoolListResultIterator(page DiskPoolListResultPage) DiskPoolListResultIterator

Creates a new instance of the DiskPoolListResultIterator type.

func (*DiskPoolListResultIterator) Next

func (iter *DiskPoolListResultIterator) 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 (*DiskPoolListResultIterator) NextWithContext

func (iter *DiskPoolListResultIterator) 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 (DiskPoolListResultIterator) NotDone

func (iter DiskPoolListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (DiskPoolListResultIterator) Response

Response returns the raw server response from the last page request.

func (DiskPoolListResultIterator) Value

func (iter DiskPoolListResultIterator) Value() DiskPool

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type DiskPoolListResultPage

type DiskPoolListResultPage struct {
	// contains filtered or unexported fields
}

DiskPoolListResultPage contains a page of DiskPool values.

func NewDiskPoolListResultPage

func NewDiskPoolListResultPage(cur DiskPoolListResult, getNextPage func(context.Context, DiskPoolListResult) (DiskPoolListResult, error)) DiskPoolListResultPage

Creates a new instance of the DiskPoolListResultPage type.

func (*DiskPoolListResultPage) Next

func (page *DiskPoolListResultPage) 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 (*DiskPoolListResultPage) NextWithContext

func (page *DiskPoolListResultPage) 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 (DiskPoolListResultPage) NotDone

func (page DiskPoolListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (DiskPoolListResultPage) Response

Response returns the raw server response from the last page request.

func (DiskPoolListResultPage) Values

func (page DiskPoolListResultPage) Values() []DiskPool

Values returns the slice of values for the current page or nil if there are no values.

type DiskPoolProperties

type DiskPoolProperties struct {
	// ProvisioningState - READ-ONLY; State of the operation on the resource. Possible values include: 'ProvisioningStatesInvalid', 'ProvisioningStatesSucceeded', 'ProvisioningStatesFailed', 'ProvisioningStatesCanceled', 'ProvisioningStatesPending', 'ProvisioningStatesCreating', 'ProvisioningStatesUpdating', 'ProvisioningStatesDeleting'
	ProvisioningState ProvisioningStates `json:"provisioningState,omitempty"`
	// AvailabilityZones - Logical zone for DiskPool resource.
	AvailabilityZones *[]string `json:"availabilityZones,omitempty"`
	// Status - READ-ONLY; Operational status of the Disk pool. Possible values include: 'Invalid', 'Unknown', 'Healthy', 'Unhealthy'
	Status OperationalStatus `json:"status,omitempty"`
	// Disks - List of Azure managed disks to attach to a DiskPool
	Disks *[]Disk `json:"disks,omitempty"`
	// SubnetID - Azure resource id of the subnet for the DiskPool
	SubnetID *string `json:"subnetId,omitempty"`
}

DiskPoolProperties properties section of the Disk Pool request payload.

func (DiskPoolProperties) MarshalJSON

func (dpp DiskPoolProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DiskPoolProperties.

type DiskPoolsClient

type DiskPoolsClient struct {
	BaseClient
}

DiskPoolsClient is the client for the DiskPools methods of the Storagepool service.

func NewDiskPoolsClient

func NewDiskPoolsClient(subscriptionID string) DiskPoolsClient

NewDiskPoolsClient creates an instance of the DiskPoolsClient client.

func NewDiskPoolsClientWithBaseURI

func NewDiskPoolsClientWithBaseURI(baseURI string, subscriptionID string) DiskPoolsClient

NewDiskPoolsClientWithBaseURI creates an instance of the DiskPoolsClient 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 (DiskPoolsClient) CreateOrUpdate

func (client DiskPoolsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, diskPoolName string, diskPoolPayload DiskPool) (result DiskPoolsCreateOrUpdateFuture, err error)

CreateOrUpdate create a new Disk Pool. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. diskPoolName - the name of the Disk Pool. diskPoolPayload - request payload for Disk Pool operations.

func (DiskPoolsClient) CreateOrUpdatePreparer

func (client DiskPoolsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, diskPoolName string, diskPoolPayload DiskPool) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (DiskPoolsClient) CreateOrUpdateResponder

func (client DiskPoolsClient) CreateOrUpdateResponder(resp *http.Response) (result DiskPool, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (DiskPoolsClient) CreateOrUpdateSender

func (client DiskPoolsClient) CreateOrUpdateSender(req *http.Request) (future DiskPoolsCreateOrUpdateFuture, err error)

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

func (DiskPoolsClient) Delete

func (client DiskPoolsClient) Delete(ctx context.Context, resourceGroupName string, diskPoolName string) (result DiskPoolsDeleteFuture, err error)

Delete delete a Disk Pool. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. diskPoolName - the name of the Disk Pool.

func (DiskPoolsClient) DeletePreparer

func (client DiskPoolsClient) DeletePreparer(ctx context.Context, resourceGroupName string, diskPoolName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (DiskPoolsClient) DeleteResponder

func (client DiskPoolsClient) 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 (DiskPoolsClient) DeleteSender

func (client DiskPoolsClient) DeleteSender(req *http.Request) (future DiskPoolsDeleteFuture, err error)

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

func (DiskPoolsClient) Get

func (client DiskPoolsClient) Get(ctx context.Context, resourceGroupName string, diskPoolName string) (result DiskPool, err error)

Get get a Disk Pool. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. diskPoolName - the name of the Disk Pool.

func (DiskPoolsClient) GetPreparer

func (client DiskPoolsClient) GetPreparer(ctx context.Context, resourceGroupName string, diskPoolName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (DiskPoolsClient) GetResponder

func (client DiskPoolsClient) GetResponder(resp *http.Response) (result DiskPool, err error)

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

func (DiskPoolsClient) GetSender

func (client DiskPoolsClient) 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 (DiskPoolsClient) ListByResourceGroup

func (client DiskPoolsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result DiskPoolListResultPage, err error)

ListByResourceGroup gets a list of DiskPools. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive.

func (DiskPoolsClient) ListByResourceGroupComplete

func (client DiskPoolsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result DiskPoolListResultIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (DiskPoolsClient) ListByResourceGroupPreparer

func (client DiskPoolsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (DiskPoolsClient) ListByResourceGroupResponder

func (client DiskPoolsClient) ListByResourceGroupResponder(resp *http.Response) (result DiskPoolListResult, err error)

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

func (DiskPoolsClient) ListByResourceGroupSender

func (client DiskPoolsClient) 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 (DiskPoolsClient) ListBySubscription

func (client DiskPoolsClient) ListBySubscription(ctx context.Context) (result DiskPoolListResultPage, err error)

ListBySubscription gets a list of Disk Pools in a subscription

func (DiskPoolsClient) ListBySubscriptionComplete

func (client DiskPoolsClient) ListBySubscriptionComplete(ctx context.Context) (result DiskPoolListResultIterator, err error)

ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.

func (DiskPoolsClient) ListBySubscriptionPreparer

func (client DiskPoolsClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (DiskPoolsClient) ListBySubscriptionResponder

func (client DiskPoolsClient) ListBySubscriptionResponder(resp *http.Response) (result DiskPoolListResult, err error)

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

func (DiskPoolsClient) ListBySubscriptionSender

func (client DiskPoolsClient) 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 (DiskPoolsClient) Update

func (client DiskPoolsClient) Update(ctx context.Context, resourceGroupName string, diskPoolName string, diskPoolPayload DiskPool) (result DiskPool, err error)

Update update a Storage Pool. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. diskPoolName - the name of the Disk Pool. diskPoolPayload - request payload for Disk Pool operations.

func (DiskPoolsClient) UpdatePreparer

func (client DiskPoolsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, diskPoolName string, diskPoolPayload DiskPool) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (DiskPoolsClient) UpdateResponder

func (client DiskPoolsClient) UpdateResponder(resp *http.Response) (result DiskPool, err error)

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

func (DiskPoolsClient) UpdateSender

func (client DiskPoolsClient) 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 DiskPoolsCreateOrUpdateFuture

type DiskPoolsCreateOrUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(DiskPoolsClient) (DiskPool, error)
}

DiskPoolsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*DiskPoolsCreateOrUpdateFuture) UnmarshalJSON

func (future *DiskPoolsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type DiskPoolsDeleteFuture

type DiskPoolsDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(DiskPoolsClient) (autorest.Response, error)
}

DiskPoolsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*DiskPoolsDeleteFuture) UnmarshalJSON

func (future *DiskPoolsDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type Error

type Error struct {
	// Error - RP error response
	Error *ErrorResponse `json:"error,omitempty"`
}

Error the resource management error response.

type ErrorAdditionalInfo

type ErrorAdditionalInfo struct {
	// Type - READ-ONLY; The additional info type.
	Type *string `json:"type,omitempty"`
	// Info - READ-ONLY; The additional info.
	Info interface{} `json:"info,omitempty"`
}

ErrorAdditionalInfo the resource management error additional info.

func (ErrorAdditionalInfo) MarshalJSON

func (eai ErrorAdditionalInfo) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ErrorAdditionalInfo.

type ErrorResponse

type ErrorResponse struct {
	// Code - READ-ONLY; The error code.
	Code *string `json:"code,omitempty"`
	// Message - READ-ONLY; The error message.
	Message *string `json:"message,omitempty"`
	// Target - READ-ONLY; The error target.
	Target *string `json:"target,omitempty"`
	// Details - READ-ONLY; The error details.
	Details *[]ErrorResponse `json:"details,omitempty"`
	// AdditionalInfo - READ-ONLY; The error additional info.
	AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"`
}

ErrorResponse the resource management error response.

func (ErrorResponse) MarshalJSON

func (er ErrorResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ErrorResponse.

type IscsiLun

type IscsiLun struct {
	// Name - Lun name.
	Name *string `json:"name,omitempty"`
	// ManagedDiskAzureResourceID - Unique Azure resource id of the managed disk. Required.
	ManagedDiskAzureResourceID *string `json:"managedDiskAzureResourceId,omitempty"`
}

IscsiLun lun to expose the ManagedDisk.

type IscsiTarget

type IscsiTarget struct {
	autorest.Response `json:"-"`
	// IscsiTargetProperties - RP defined properties for iSCSI Target operations.
	*IscsiTargetProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty"`
}

IscsiTarget payload for iSCSI Target Create or Update requests.

func (IscsiTarget) MarshalJSON

func (it IscsiTarget) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IscsiTarget.

func (*IscsiTarget) UnmarshalJSON

func (it *IscsiTarget) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for IscsiTarget struct.

type IscsiTargetCredentials

type IscsiTargetCredentials struct {
	// Username - Username for Challenge Handshake Authentication Protocol (CHAP) authentication
	Username *string `json:"username,omitempty"`
	// Password - Password for Challenge Handshake Authentication Protocol (CHAP) authentication
	Password *string `json:"password,omitempty"`
}

IscsiTargetCredentials CHAP credentials for an iSCSI target

type IscsiTargetList

type IscsiTargetList struct {
	autorest.Response `json:"-"`
	// Value - An array of iSCSI targets within a Disk Pool.
	Value *[]IscsiTarget `json:"value,omitempty"`
	// NextLink - READ-ONLY; URI to fetch the next section of the paginated response.
	NextLink *string `json:"nextLink,omitempty"`
}

IscsiTargetList list of iSCSI Targets.

func (IscsiTargetList) IsEmpty

func (itl IscsiTargetList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (IscsiTargetList) MarshalJSON

func (itl IscsiTargetList) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IscsiTargetList.

type IscsiTargetListIterator

type IscsiTargetListIterator struct {
	// contains filtered or unexported fields
}

IscsiTargetListIterator provides access to a complete listing of IscsiTarget values.

func NewIscsiTargetListIterator

func NewIscsiTargetListIterator(page IscsiTargetListPage) IscsiTargetListIterator

Creates a new instance of the IscsiTargetListIterator type.

func (*IscsiTargetListIterator) Next

func (iter *IscsiTargetListIterator) 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 (*IscsiTargetListIterator) NextWithContext

func (iter *IscsiTargetListIterator) 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 (IscsiTargetListIterator) NotDone

func (iter IscsiTargetListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (IscsiTargetListIterator) Response

func (iter IscsiTargetListIterator) Response() IscsiTargetList

Response returns the raw server response from the last page request.

func (IscsiTargetListIterator) Value

func (iter IscsiTargetListIterator) Value() IscsiTarget

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type IscsiTargetListPage

type IscsiTargetListPage struct {
	// contains filtered or unexported fields
}

IscsiTargetListPage contains a page of IscsiTarget values.

func NewIscsiTargetListPage

func NewIscsiTargetListPage(cur IscsiTargetList, getNextPage func(context.Context, IscsiTargetList) (IscsiTargetList, error)) IscsiTargetListPage

Creates a new instance of the IscsiTargetListPage type.

func (*IscsiTargetListPage) Next

func (page *IscsiTargetListPage) 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 (*IscsiTargetListPage) NextWithContext

func (page *IscsiTargetListPage) 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 (IscsiTargetListPage) NotDone

func (page IscsiTargetListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (IscsiTargetListPage) Response

func (page IscsiTargetListPage) Response() IscsiTargetList

Response returns the raw server response from the last page request.

func (IscsiTargetListPage) Values

func (page IscsiTargetListPage) Values() []IscsiTarget

Values returns the slice of values for the current page or nil if there are no values.

type IscsiTargetProperties

type IscsiTargetProperties struct {
	// ProvisioningState - READ-ONLY; State of the operation on the resource. Possible values include: 'ProvisioningStatesInvalid', 'ProvisioningStatesSucceeded', 'ProvisioningStatesFailed', 'ProvisioningStatesCanceled', 'ProvisioningStatesPending', 'ProvisioningStatesCreating', 'ProvisioningStatesUpdating', 'ProvisioningStatesDeleting'
	ProvisioningState ProvisioningStates `json:"provisioningState,omitempty"`
	// Status - READ-ONLY; Operational status of the Disk pool. Possible values include: 'Invalid', 'Unknown', 'Healthy', 'Unhealthy'
	Status OperationalStatus `json:"status,omitempty"`
	// Tpgs - list of iSCSI target portal groups
	Tpgs *[]TargetPortalGroup `json:"tpgs,omitempty"`
	// TargetIqn - iSCSI target iqn (iSCSI Qualified Name); example: iqn.2005-03.org.iscsi:server
	TargetIqn *string `json:"targetIqn,omitempty"`
}

IscsiTargetProperties properties of iSCSI Target request payload.

func (IscsiTargetProperties) MarshalJSON

func (itp IscsiTargetProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IscsiTargetProperties.

type IscsiTargetsClient

type IscsiTargetsClient struct {
	BaseClient
}

IscsiTargetsClient is the client for the IscsiTargets methods of the Storagepool service.

func NewIscsiTargetsClient

func NewIscsiTargetsClient(subscriptionID string) IscsiTargetsClient

NewIscsiTargetsClient creates an instance of the IscsiTargetsClient client.

func NewIscsiTargetsClientWithBaseURI

func NewIscsiTargetsClientWithBaseURI(baseURI string, subscriptionID string) IscsiTargetsClient

NewIscsiTargetsClientWithBaseURI creates an instance of the IscsiTargetsClient 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 (IscsiTargetsClient) CreateOrUpdate

func (client IscsiTargetsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, diskPoolName string, iscsiTargetName string, iscsiTargetPayload IscsiTarget) (result IscsiTargetsCreateOrUpdateFuture, err error)

CreateOrUpdate create or Update an iSCSI target. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. diskPoolName - the name of the Disk Pool. iscsiTargetName - the name of the iSCSI target. iscsiTargetPayload - request payload for iSCSI target operations.

func (IscsiTargetsClient) CreateOrUpdatePreparer

func (client IscsiTargetsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, diskPoolName string, iscsiTargetName string, iscsiTargetPayload IscsiTarget) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (IscsiTargetsClient) CreateOrUpdateResponder

func (client IscsiTargetsClient) CreateOrUpdateResponder(resp *http.Response) (result IscsiTarget, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (IscsiTargetsClient) CreateOrUpdateSender

func (client IscsiTargetsClient) CreateOrUpdateSender(req *http.Request) (future IscsiTargetsCreateOrUpdateFuture, err error)

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

func (IscsiTargetsClient) Delete

func (client IscsiTargetsClient) Delete(ctx context.Context, resourceGroupName string, diskPoolName string, iscsiTargetName string) (result IscsiTargetsDeleteFuture, err error)

Delete deletes an iSCSI Target Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. diskPoolName - the name of the Disk Pool. iscsiTargetName - the name of the iSCSI target.

func (IscsiTargetsClient) DeletePreparer

func (client IscsiTargetsClient) DeletePreparer(ctx context.Context, resourceGroupName string, diskPoolName string, iscsiTargetName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (IscsiTargetsClient) DeleteResponder

func (client IscsiTargetsClient) 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 (IscsiTargetsClient) DeleteSender

func (client IscsiTargetsClient) DeleteSender(req *http.Request) (future IscsiTargetsDeleteFuture, err error)

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

func (IscsiTargetsClient) Get

func (client IscsiTargetsClient) Get(ctx context.Context, resourceGroupName string, diskPoolName string, iscsiTargetName string) (result IscsiTarget, err error)

Get gets an iSCSI Target. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. diskPoolName - the name of the Disk Pool. iscsiTargetName - the name of the iSCSI target.

func (IscsiTargetsClient) GetPreparer

func (client IscsiTargetsClient) GetPreparer(ctx context.Context, resourceGroupName string, diskPoolName string, iscsiTargetName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (IscsiTargetsClient) GetResponder

func (client IscsiTargetsClient) GetResponder(resp *http.Response) (result IscsiTarget, err error)

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

func (IscsiTargetsClient) GetSender

func (client IscsiTargetsClient) 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 (IscsiTargetsClient) ListByDiskPool

func (client IscsiTargetsClient) ListByDiskPool(ctx context.Context, resourceGroupName string, diskPoolName string) (result IscsiTargetListPage, err error)

ListByDiskPool get iSCSI Targets within a Disk Pool Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. diskPoolName - the name of the Disk Pool.

func (IscsiTargetsClient) ListByDiskPoolComplete

func (client IscsiTargetsClient) ListByDiskPoolComplete(ctx context.Context, resourceGroupName string, diskPoolName string) (result IscsiTargetListIterator, err error)

ListByDiskPoolComplete enumerates all values, automatically crossing page boundaries as required.

func (IscsiTargetsClient) ListByDiskPoolPreparer

func (client IscsiTargetsClient) ListByDiskPoolPreparer(ctx context.Context, resourceGroupName string, diskPoolName string) (*http.Request, error)

ListByDiskPoolPreparer prepares the ListByDiskPool request.

func (IscsiTargetsClient) ListByDiskPoolResponder

func (client IscsiTargetsClient) ListByDiskPoolResponder(resp *http.Response) (result IscsiTargetList, err error)

ListByDiskPoolResponder handles the response to the ListByDiskPool request. The method always closes the http.Response Body.

func (IscsiTargetsClient) ListByDiskPoolSender

func (client IscsiTargetsClient) ListByDiskPoolSender(req *http.Request) (*http.Response, error)

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

type IscsiTargetsCreateOrUpdateFuture

type IscsiTargetsCreateOrUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(IscsiTargetsClient) (IscsiTarget, error)
}

IscsiTargetsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*IscsiTargetsCreateOrUpdateFuture) UnmarshalJSON

func (future *IscsiTargetsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type IscsiTargetsDeleteFuture

type IscsiTargetsDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(IscsiTargetsClient) (autorest.Response, error)
}

IscsiTargetsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*IscsiTargetsDeleteFuture) UnmarshalJSON

func (future *IscsiTargetsDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type OperationDisplay

type OperationDisplay struct {
	// Provider - Localized friendly form of the resource provider name.
	Provider *string `json:"provider,omitempty"`
	// Resource - Localized friendly form of the resource type related to this action/operation.
	Resource *string `json:"resource,omitempty"`
	// Operation - Localized friendly name for the operation, as it should be shown to the user.
	Operation *string `json:"operation,omitempty"`
	// Description - Localized friendly description for the operation, as it should be shown to the user.
	Description *string `json:"description,omitempty"`
}

OperationDisplay metadata about an operation.

type OperationListResult

type OperationListResult struct {
	autorest.Response `json:"-"`
	// Value - An array of operations supported by the StoragePool RP.
	Value *[]RPOperation `json:"value,omitempty"`
	// NextLink - URI to fetch the next section of the paginated response.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationListResult list of operations supported by the RP.

type OperationalStatus

type OperationalStatus string

OperationalStatus enumerates the values for operational status.

const (
	// Healthy ...
	Healthy OperationalStatus = "Healthy"
	// Invalid ...
	Invalid OperationalStatus = "Invalid"
	// Unhealthy ...
	Unhealthy OperationalStatus = "Unhealthy"
	// Unknown ...
	Unknown OperationalStatus = "Unknown"
)

func PossibleOperationalStatusValues

func PossibleOperationalStatusValues() []OperationalStatus

PossibleOperationalStatusValues returns an array of possible values for the OperationalStatus const type.

type OperationsClient

type OperationsClient struct {
	BaseClient
}

OperationsClient is the client for the Operations methods of the Storagepool service.

func NewOperationsClient

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID 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 OperationListResult, err error)

List gets a list of StoragePool operations.

func (OperationsClient) ListPreparer

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

ListPreparer prepares the List request.

func (OperationsClient) ListResponder

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, 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 ProvisioningStates

type ProvisioningStates string

ProvisioningStates enumerates the values for provisioning states.

const (
	// ProvisioningStatesCanceled ...
	ProvisioningStatesCanceled ProvisioningStates = "Canceled"
	// ProvisioningStatesCreating ...
	ProvisioningStatesCreating ProvisioningStates = "Creating"
	// ProvisioningStatesDeleting ...
	ProvisioningStatesDeleting ProvisioningStates = "Deleting"
	// ProvisioningStatesFailed ...
	ProvisioningStatesFailed ProvisioningStates = "Failed"
	// ProvisioningStatesInvalid ...
	ProvisioningStatesInvalid ProvisioningStates = "Invalid"
	// ProvisioningStatesPending ...
	ProvisioningStatesPending ProvisioningStates = "Pending"
	// ProvisioningStatesSucceeded ...
	ProvisioningStatesSucceeded ProvisioningStates = "Succeeded"
	// ProvisioningStatesUpdating ...
	ProvisioningStatesUpdating ProvisioningStates = "Updating"
)

func PossibleProvisioningStatesValues

func PossibleProvisioningStatesValues() []ProvisioningStates

PossibleProvisioningStatesValues returns an array of possible values for the ProvisioningStates const type.

type ProxyResource

type ProxyResource struct {
	// ID - READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty"`
}

ProxyResource the resource model definition for a ARM proxy resource. It will have everything other than required location and tags

func (ProxyResource) MarshalJSON

func (pr ProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProxyResource.

type RPOperation

type RPOperation struct {
	// Name - The name of the operation being performed on this particular object
	Name *string `json:"name,omitempty"`
	// IsDataAction - Indicates whether the operation applies to data-plane.
	IsDataAction *bool `json:"isDataAction,omitempty"`
	// ActionType - Indicates the action type.
	ActionType *string `json:"actionType,omitempty"`
	// Display - Additional metadata about RP operation.
	Display *OperationDisplay `json:"display,omitempty"`
	// Origin - The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX.
	Origin *string `json:"origin,omitempty"`
}

RPOperation description of a StoragePool RP Operation

type Resource

type Resource struct {
	// ID - READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty"`
}

Resource ARM resource model definition.

func (Resource) MarshalJSON

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type Sku

type Sku struct {
	// Name - The name of the SKU. Ex - P3. It is typically a letter+number code
	Name *string `json:"name,omitempty"`
	// Tier - This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. Possible values include: 'Free', 'Basic', 'Standard', 'Premium'
	Tier SkuTier `json:"tier,omitempty"`
	// Size - The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
	Size *string `json:"size,omitempty"`
	// Family - If the service has different generations of hardware, for the same SKU, then that can be captured here.
	Family *string `json:"family,omitempty"`
	// Capacity - If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
	Capacity *int32 `json:"capacity,omitempty"`
}

Sku the resource model definition representing SKU

type SkuTier

type SkuTier string

SkuTier enumerates the values for sku tier.

const (
	// Basic ...
	Basic SkuTier = "Basic"
	// Free ...
	Free SkuTier = "Free"
	// Premium ...
	Premium SkuTier = "Premium"
	// Standard ...
	Standard SkuTier = "Standard"
)

func PossibleSkuTierValues

func PossibleSkuTierValues() []SkuTier

PossibleSkuTierValues returns an array of possible values for the SkuTier const type.

type SystemMetadata

type SystemMetadata struct {
	// CreatedBy - A string identifier for the identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`
	// CreatedByType - The type of identity that created the resource: user, application, managedIdentity
	CreatedByType *string `json:"createdByType,omitempty"`
	// CreatedAt - The timestamp of resource creation (UTC)
	CreatedAt *string `json:"createdAt,omitempty"`
	// LastModifiedBy - A string identifier for the identity that last modified the resource
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`
	// LastModifiedByType - The type of identity that last modified the resource: user, application, managedIdentity
	LastModifiedByType *string `json:"lastModifiedByType,omitempty"`
	// LastModifiedAt - The timestamp of resource last modification (UTC)
	LastModifiedAt *string `json:"lastModifiedAt,omitempty"`
}

SystemMetadata resource metadata required by ARM RPC

type TargetPortalGroup

type TargetPortalGroup struct {
	// Luns - Lun list to be exposed through the iSCSI target. Required
	Luns *[]IscsiLun `json:"luns,omitempty"`
	// Acls - Access Control List (ACL) for an iSCSI target lun
	Acls *[]ACL `json:"acls,omitempty"`
	// Attributes - Attributes of an iSCSI target
	Attributes *Attributes `json:"attributes,omitempty"`
	// Endpoints - READ-ONLY; list of public ip addresses to connect to the iSCSI target
	Endpoints *[]string `json:"endpoints,omitempty"`
	// Tag - READ-ONLY; The tag associated with the iSCSI target portal group
	Tag *int32 `json:"tag,omitempty"`
	// Port - READ-ONLY; The port at which the iSCSI target is available
	Port *int32 `json:"port,omitempty"`
}

TargetPortalGroup iSCSI target portal group

func (TargetPortalGroup) MarshalJSON

func (tpg TargetPortalGroup) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TargetPortalGroup.

type TrackedResource

type TrackedResource struct {
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty"`
}

TrackedResource the resource model definition for a ARM tracked top level resource

func (TrackedResource) MarshalJSON

func (tr TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrackedResource.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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