README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/storagemover/2023-10-01/storagemovers
Documentation
The storagemovers
SDK allows for interaction with the Azure Resource Manager Service storagemover
(API Version 2023-10-01
).
This readme covers example usages, but further information on using this SDK can be found in the project root.
Import Path
import "github.com/hashicorp/go-azure-sdk/resource-manager/storagemover/2023-10-01/storagemovers"
Client Initialization
client := storagemovers.NewStorageMoversClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: StorageMoversClient.CreateOrUpdate
ctx := context.TODO()
id := storagemovers.NewStorageMoverID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageMoverValue")
payload := storagemovers.StorageMover{
// ...
}
read, err := client.CreateOrUpdate(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: StorageMoversClient.Delete
ctx := context.TODO()
id := storagemovers.NewStorageMoverID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageMoverValue")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: StorageMoversClient.Get
ctx := context.TODO()
id := storagemovers.NewStorageMoverID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageMoverValue")
read, err := client.Get(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: StorageMoversClient.List
ctx := context.TODO()
id := storagemovers.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")
// alternatively `client.List(ctx, id)` can be used to do batched pagination
items, err := client.ListComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: StorageMoversClient.ListBySubscription
ctx := context.TODO()
id := storagemovers.NewSubscriptionID("12345678-1234-9876-4563-123456789012")
// alternatively `client.ListBySubscription(ctx, id)` can be used to do batched pagination
items, err := client.ListBySubscriptionComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: StorageMoversClient.Update
ctx := context.TODO()
id := storagemovers.NewStorageMoverID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageMoverValue")
payload := storagemovers.StorageMoverUpdateParameters{
// ...
}
read, err := client.Update(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Documentation ¶
Index ¶
- func PossibleValuesForProvisioningState() []string
- func ValidateStorageMoverID(input interface{}, key string) (warnings []string, errors []error)
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type GetOperationResponse
- type ListBySubscriptionCompleteResult
- type ListBySubscriptionOperationResponse
- type ListCompleteResult
- type ListOperationResponse
- type ProvisioningState
- type StorageMover
- type StorageMoverId
- type StorageMoverOperationPredicate
- type StorageMoverProperties
- type StorageMoverUpdateParameters
- type StorageMoverUpdateProperties
- type StorageMoversClient
- func (c StorageMoversClient) CreateOrUpdate(ctx context.Context, id StorageMoverId, input StorageMover) (result CreateOrUpdateOperationResponse, err error)
- func (c StorageMoversClient) Delete(ctx context.Context, id StorageMoverId) (result DeleteOperationResponse, err error)
- func (c StorageMoversClient) DeleteThenPoll(ctx context.Context, id StorageMoverId) error
- func (c StorageMoversClient) Get(ctx context.Context, id StorageMoverId) (result GetOperationResponse, err error)
- func (c StorageMoversClient) List(ctx context.Context, id commonids.ResourceGroupId) (result ListOperationResponse, err error)
- func (c StorageMoversClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)
- func (c StorageMoversClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)
- func (c StorageMoversClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListBySubscriptionCompleteResult, err error)
- func (c StorageMoversClient) ListComplete(ctx context.Context, id commonids.ResourceGroupId) (ListCompleteResult, error)
- func (c StorageMoversClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, ...) (result ListCompleteResult, err error)
- func (c StorageMoversClient) Update(ctx context.Context, id StorageMoverId, input StorageMoverUpdateParameters) (result UpdateOperationResponse, err error)
- type UpdateOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForProvisioningState ¶
func PossibleValuesForProvisioningState() []string
func ValidateStorageMoverID ¶
ValidateStorageMoverID checks that 'input' can be parsed as a Storage Mover ID
Types ¶
type CreateOrUpdateOperationResponse ¶
type CreateOrUpdateOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *StorageMover }
type DeleteOperationResponse ¶
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *StorageMover }
type ListBySubscriptionCompleteResult ¶
type ListBySubscriptionCompleteResult struct { LatestHttpResponse *http.Response Items []StorageMover }
type ListBySubscriptionOperationResponse ¶
type ListBySubscriptionOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]StorageMover }
type ListCompleteResult ¶
type ListCompleteResult struct { LatestHttpResponse *http.Response Items []StorageMover }
type ListOperationResponse ¶
type ListOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]StorageMover }
type ProvisioningState ¶
type ProvisioningState string
const (
ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)
func (*ProvisioningState) UnmarshalJSON ¶
func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
type StorageMover ¶
type StorageMover struct { Id *string `json:"id,omitempty"` Location string `json:"location"` Name *string `json:"name,omitempty"` Properties *StorageMoverProperties `json:"properties,omitempty"` SystemData *systemdata.SystemData `json:"systemData,omitempty"` Tags *map[string]string `json:"tags,omitempty"` Type *string `json:"type,omitempty"` }
type StorageMoverId ¶
type StorageMoverId struct { SubscriptionId string ResourceGroupName string StorageMoverName string }
StorageMoverId is a struct representing the Resource ID for a Storage Mover
func NewStorageMoverID ¶
func NewStorageMoverID(subscriptionId string, resourceGroupName string, storageMoverName string) StorageMoverId
NewStorageMoverID returns a new StorageMoverId struct
func ParseStorageMoverID ¶
func ParseStorageMoverID(input string) (*StorageMoverId, error)
ParseStorageMoverID parses 'input' into a StorageMoverId
func ParseStorageMoverIDInsensitively ¶
func ParseStorageMoverIDInsensitively(input string) (*StorageMoverId, error)
ParseStorageMoverIDInsensitively parses 'input' case-insensitively into a StorageMoverId note: this method should only be used for API response data and not user input
func (*StorageMoverId) FromParseResult ¶ added in v0.20231127.1171502
func (id *StorageMoverId) FromParseResult(input resourceids.ParseResult) error
func (StorageMoverId) ID ¶
func (id StorageMoverId) ID() string
ID returns the formatted Storage Mover ID
func (StorageMoverId) Segments ¶
func (id StorageMoverId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Storage Mover ID
func (StorageMoverId) String ¶
func (id StorageMoverId) String() string
String returns a human-readable description of this Storage Mover ID
type StorageMoverOperationPredicate ¶
type StorageMoverOperationPredicate struct { Id *string Location *string Name *string Type *string }
func (StorageMoverOperationPredicate) Matches ¶
func (p StorageMoverOperationPredicate) Matches(input StorageMover) bool
type StorageMoverProperties ¶
type StorageMoverProperties struct { Description *string `json:"description,omitempty"` ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"` }
type StorageMoverUpdateParameters ¶
type StorageMoverUpdateParameters struct { Properties *StorageMoverUpdateProperties `json:"properties,omitempty"` Tags *map[string]string `json:"tags,omitempty"` }
type StorageMoverUpdateProperties ¶
type StorageMoverUpdateProperties struct {
Description *string `json:"description,omitempty"`
}
type StorageMoversClient ¶
type StorageMoversClient struct {
Client *resourcemanager.Client
}
func NewStorageMoversClientWithBaseURI ¶
func NewStorageMoversClientWithBaseURI(sdkApi sdkEnv.Api) (*StorageMoversClient, error)
func (StorageMoversClient) CreateOrUpdate ¶
func (c StorageMoversClient) CreateOrUpdate(ctx context.Context, id StorageMoverId, input StorageMover) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (StorageMoversClient) Delete ¶
func (c StorageMoversClient) Delete(ctx context.Context, id StorageMoverId) (result DeleteOperationResponse, err error)
Delete ...
func (StorageMoversClient) DeleteThenPoll ¶
func (c StorageMoversClient) DeleteThenPoll(ctx context.Context, id StorageMoverId) error
DeleteThenPoll performs Delete then polls until it's completed
func (StorageMoversClient) Get ¶
func (c StorageMoversClient) Get(ctx context.Context, id StorageMoverId) (result GetOperationResponse, err error)
Get ...
func (StorageMoversClient) List ¶
func (c StorageMoversClient) List(ctx context.Context, id commonids.ResourceGroupId) (result ListOperationResponse, err error)
List ...
func (StorageMoversClient) ListBySubscription ¶
func (c StorageMoversClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)
ListBySubscription ...
func (StorageMoversClient) ListBySubscriptionComplete ¶
func (c StorageMoversClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)
ListBySubscriptionComplete retrieves all the results into a single object
func (StorageMoversClient) ListBySubscriptionCompleteMatchingPredicate ¶
func (c StorageMoversClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate StorageMoverOperationPredicate) (result ListBySubscriptionCompleteResult, err error)
ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (StorageMoversClient) ListComplete ¶
func (c StorageMoversClient) ListComplete(ctx context.Context, id commonids.ResourceGroupId) (ListCompleteResult, error)
ListComplete retrieves all the results into a single object
func (StorageMoversClient) ListCompleteMatchingPredicate ¶
func (c StorageMoversClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate StorageMoverOperationPredicate) (result ListCompleteResult, err error)
ListCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (StorageMoversClient) Update ¶
func (c StorageMoversClient) Update(ctx context.Context, id StorageMoverId, input StorageMoverUpdateParameters) (result UpdateOperationResponse, err error)
Update ...
type UpdateOperationResponse ¶
type UpdateOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *StorageMover }
Source Files ¶
- client.go
- constants.go
- id_storagemover.go
- method_createorupdate.go
- method_delete.go
- method_get.go
- method_list.go
- method_listbysubscription.go
- method_update.go
- model_storagemover.go
- model_storagemoverproperties.go
- model_storagemoverupdateparameters.go
- model_storagemoverupdateproperties.go
- predicates.go
- version.go