storagetaskassignments

package
v0.20240903.1111904 Latest Latest
Warning

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

Go to latest
Published: Sep 3, 2024 License: MPL-2.0 Imports: 15 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/storage/2023-05-01/storagetaskassignments Documentation

The storagetaskassignments SDK allows for interaction with the Azure Resource Manager Service storage (API Version 2023-05-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/storage/2023-05-01/storagetaskassignments"

Client Initialization

client := storagetaskassignments.NewStorageTaskAssignmentsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: StorageTaskAssignmentsClient.Create

ctx := context.TODO()
id := storagetaskassignments.NewStorageTaskAssignmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageAccountValue", "storageTaskAssignmentValue")

payload := storagetaskassignments.StorageTaskAssignment{
	// ...
}


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

Example Usage: StorageTaskAssignmentsClient.Delete

ctx := context.TODO()
id := storagetaskassignments.NewStorageTaskAssignmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageAccountValue", "storageTaskAssignmentValue")

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

Example Usage: StorageTaskAssignmentsClient.Get

ctx := context.TODO()
id := storagetaskassignments.NewStorageTaskAssignmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageAccountValue", "storageTaskAssignmentValue")

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: StorageTaskAssignmentsClient.InstancesReportList

ctx := context.TODO()
id := commonids.NewStorageAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageAccountValue")

// alternatively `client.InstancesReportList(ctx, id, storagetaskassignments.DefaultInstancesReportListOperationOptions())` can be used to do batched pagination
items, err := client.InstancesReportListComplete(ctx, id, storagetaskassignments.DefaultInstancesReportListOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: StorageTaskAssignmentsClient.List

ctx := context.TODO()
id := commonids.NewStorageAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageAccountValue")

// alternatively `client.List(ctx, id, storagetaskassignments.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, storagetaskassignments.DefaultListOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: StorageTaskAssignmentsClient.StorageTaskAssignmentInstancesReportList

ctx := context.TODO()
id := storagetaskassignments.NewStorageTaskAssignmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageAccountValue", "storageTaskAssignmentValue")

// alternatively `client.StorageTaskAssignmentInstancesReportList(ctx, id, storagetaskassignments.DefaultStorageTaskAssignmentInstancesReportListOperationOptions())` can be used to do batched pagination
items, err := client.StorageTaskAssignmentInstancesReportListComplete(ctx, id, storagetaskassignments.DefaultStorageTaskAssignmentInstancesReportListOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: StorageTaskAssignmentsClient.Update

ctx := context.TODO()
id := storagetaskassignments.NewStorageTaskAssignmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageAccountValue", "storageTaskAssignmentValue")

payload := storagetaskassignments.StorageTaskAssignmentUpdateParameters{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForIntervalUnit

func PossibleValuesForIntervalUnit() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func PossibleValuesForRunResult

func PossibleValuesForRunResult() []string

func PossibleValuesForRunStatusEnum

func PossibleValuesForRunStatusEnum() []string

func PossibleValuesForTriggerType

func PossibleValuesForTriggerType() []string

func ValidateStorageTaskAssignmentID

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

ValidateStorageTaskAssignmentID checks that 'input' can be parsed as a Storage Task Assignment ID

Types

type CreateOperationResponse

type CreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *StorageTaskAssignment
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type ExecutionTarget

type ExecutionTarget struct {
	ExcludePrefix *[]string `json:"excludePrefix,omitempty"`
	Prefix        *[]string `json:"prefix,omitempty"`
}

type ExecutionTrigger

type ExecutionTrigger struct {
	Parameters TriggerParameters `json:"parameters"`
	Type       TriggerType       `json:"type"`
}

type ExecutionTriggerUpdate

type ExecutionTriggerUpdate struct {
	Parameters *TriggerParametersUpdate `json:"parameters,omitempty"`
	Type       *TriggerType             `json:"type,omitempty"`
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *StorageTaskAssignment
}

type InstancesReportListCompleteResult

type InstancesReportListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []StorageTaskReportInstance
}

type InstancesReportListCustomPager added in v0.20240628.1153531

type InstancesReportListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *InstancesReportListCustomPager) NextPageLink() *odata.Link

type InstancesReportListOperationOptions

type InstancesReportListOperationOptions struct {
	Filter      *string
	Maxpagesize *int64
}

func DefaultInstancesReportListOperationOptions

func DefaultInstancesReportListOperationOptions() InstancesReportListOperationOptions

func (InstancesReportListOperationOptions) ToHeaders

func (InstancesReportListOperationOptions) ToOData

func (InstancesReportListOperationOptions) ToQuery

type InstancesReportListOperationResponse

type InstancesReportListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]StorageTaskReportInstance
}

type IntervalUnit

type IntervalUnit string
const (
	IntervalUnitDays IntervalUnit = "Days"
)

func (*IntervalUnit) UnmarshalJSON

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

type ListCompleteResult

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []StorageTaskAssignment
}

type ListCustomPager added in v0.20240628.1153531

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationOptions

type ListOperationOptions struct {
	Maxpagesize *int64
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]StorageTaskAssignment
}

type ProvisioningState

type ProvisioningState string
const (
	ProvisioningStateCanceled                       ProvisioningState = "Canceled"
	ProvisioningStateCreating                       ProvisioningState = "Creating"
	ProvisioningStateDeleting                       ProvisioningState = "Deleting"
	ProvisioningStateFailed                         ProvisioningState = "Failed"
	ProvisioningStateSucceeded                      ProvisioningState = "Succeeded"
	ProvisioningStateValidateSubscriptionQuotaBegin ProvisioningState = "ValidateSubscriptionQuotaBegin"
	ProvisioningStateValidateSubscriptionQuotaEnd   ProvisioningState = "ValidateSubscriptionQuotaEnd"
)

func (*ProvisioningState) UnmarshalJSON

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

type RunResult

type RunResult string
const (
	RunResultFailed    RunResult = "Failed"
	RunResultSucceeded RunResult = "Succeeded"
)

func (*RunResult) UnmarshalJSON

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

type RunStatusEnum

type RunStatusEnum string
const (
	RunStatusEnumFinished   RunStatusEnum = "Finished"
	RunStatusEnumInProgress RunStatusEnum = "InProgress"
)

func (*RunStatusEnum) UnmarshalJSON

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

type StorageTaskAssignment

type StorageTaskAssignment struct {
	Id         *string                         `json:"id,omitempty"`
	Name       *string                         `json:"name,omitempty"`
	Properties StorageTaskAssignmentProperties `json:"properties"`
	Type       *string                         `json:"type,omitempty"`
}

type StorageTaskAssignmentExecutionContext

type StorageTaskAssignmentExecutionContext struct {
	Target  *ExecutionTarget `json:"target,omitempty"`
	Trigger ExecutionTrigger `json:"trigger"`
}

type StorageTaskAssignmentId

type StorageTaskAssignmentId struct {
	SubscriptionId            string
	ResourceGroupName         string
	StorageAccountName        string
	StorageTaskAssignmentName string
}

StorageTaskAssignmentId is a struct representing the Resource ID for a Storage Task Assignment

func NewStorageTaskAssignmentID

func NewStorageTaskAssignmentID(subscriptionId string, resourceGroupName string, storageAccountName string, storageTaskAssignmentName string) StorageTaskAssignmentId

NewStorageTaskAssignmentID returns a new StorageTaskAssignmentId struct

func ParseStorageTaskAssignmentID

func ParseStorageTaskAssignmentID(input string) (*StorageTaskAssignmentId, error)

ParseStorageTaskAssignmentID parses 'input' into a StorageTaskAssignmentId

func ParseStorageTaskAssignmentIDInsensitively

func ParseStorageTaskAssignmentIDInsensitively(input string) (*StorageTaskAssignmentId, error)

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

func (*StorageTaskAssignmentId) FromParseResult

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

func (StorageTaskAssignmentId) ID

ID returns the formatted Storage Task Assignment ID

func (StorageTaskAssignmentId) Segments

Segments returns a slice of Resource ID Segments which comprise this Storage Task Assignment ID

func (StorageTaskAssignmentId) String

func (id StorageTaskAssignmentId) String() string

String returns a human-readable description of this Storage Task Assignment ID

type StorageTaskAssignmentInstancesReportListCompleteResult

type StorageTaskAssignmentInstancesReportListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []StorageTaskReportInstance
}

type StorageTaskAssignmentInstancesReportListCustomPager added in v0.20240628.1153531

type StorageTaskAssignmentInstancesReportListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

type StorageTaskAssignmentInstancesReportListOperationOptions

type StorageTaskAssignmentInstancesReportListOperationOptions struct {
	Filter      *string
	Maxpagesize *int64
}

func (StorageTaskAssignmentInstancesReportListOperationOptions) ToHeaders

func (StorageTaskAssignmentInstancesReportListOperationOptions) ToOData

func (StorageTaskAssignmentInstancesReportListOperationOptions) ToQuery

type StorageTaskAssignmentInstancesReportListOperationResponse

type StorageTaskAssignmentInstancesReportListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]StorageTaskReportInstance
}

type StorageTaskAssignmentOperationPredicate

type StorageTaskAssignmentOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (StorageTaskAssignmentOperationPredicate) Matches

type StorageTaskAssignmentProperties

type StorageTaskAssignmentProperties struct {
	Description       string                                `json:"description"`
	Enabled           bool                                  `json:"enabled"`
	ExecutionContext  StorageTaskAssignmentExecutionContext `json:"executionContext"`
	ProvisioningState *ProvisioningState                    `json:"provisioningState,omitempty"`
	Report            StorageTaskAssignmentReport           `json:"report"`
	RunStatus         *StorageTaskReportProperties          `json:"runStatus,omitempty"`
	TaskId            string                                `json:"taskId"`
}

type StorageTaskAssignmentReport

type StorageTaskAssignmentReport struct {
	Prefix string `json:"prefix"`
}

type StorageTaskAssignmentUpdateExecutionContext

type StorageTaskAssignmentUpdateExecutionContext struct {
	Target  *ExecutionTarget        `json:"target,omitempty"`
	Trigger *ExecutionTriggerUpdate `json:"trigger,omitempty"`
}

type StorageTaskAssignmentUpdateParameters

type StorageTaskAssignmentUpdateParameters struct {
	Properties *StorageTaskAssignmentUpdateProperties `json:"properties,omitempty"`
}

type StorageTaskAssignmentUpdateProperties

type StorageTaskAssignmentUpdateProperties struct {
	Description       *string                                      `json:"description,omitempty"`
	Enabled           *bool                                        `json:"enabled,omitempty"`
	ExecutionContext  *StorageTaskAssignmentUpdateExecutionContext `json:"executionContext,omitempty"`
	ProvisioningState *ProvisioningState                           `json:"provisioningState,omitempty"`
	Report            *StorageTaskAssignmentUpdateReport           `json:"report,omitempty"`
	RunStatus         *StorageTaskReportProperties                 `json:"runStatus,omitempty"`
	TaskId            *string                                      `json:"taskId,omitempty"`
}

type StorageTaskAssignmentUpdateReport

type StorageTaskAssignmentUpdateReport struct {
	Prefix *string `json:"prefix,omitempty"`
}

type StorageTaskAssignmentsClient

type StorageTaskAssignmentsClient struct {
	Client *resourcemanager.Client
}

func NewStorageTaskAssignmentsClientWithBaseURI

func NewStorageTaskAssignmentsClientWithBaseURI(sdkApi sdkEnv.Api) (*StorageTaskAssignmentsClient, error)

func (StorageTaskAssignmentsClient) Create

Create ...

func (StorageTaskAssignmentsClient) CreateThenPoll

CreateThenPoll performs Create then polls until it's completed

func (StorageTaskAssignmentsClient) Delete

Delete ...

func (StorageTaskAssignmentsClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (StorageTaskAssignmentsClient) Get

Get ...

func (StorageTaskAssignmentsClient) InstancesReportList

InstancesReportList ...

func (StorageTaskAssignmentsClient) InstancesReportListComplete

InstancesReportListComplete retrieves all the results into a single object

func (StorageTaskAssignmentsClient) InstancesReportListCompleteMatchingPredicate

InstancesReportListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (StorageTaskAssignmentsClient) List

List ...

func (StorageTaskAssignmentsClient) ListComplete

ListComplete retrieves all the results into a single object

func (StorageTaskAssignmentsClient) ListCompleteMatchingPredicate

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (StorageTaskAssignmentsClient) StorageTaskAssignmentInstancesReportList

StorageTaskAssignmentInstancesReportList ...

func (StorageTaskAssignmentsClient) StorageTaskAssignmentInstancesReportListComplete

StorageTaskAssignmentInstancesReportListComplete retrieves all the results into a single object

func (StorageTaskAssignmentsClient) StorageTaskAssignmentInstancesReportListCompleteMatchingPredicate

StorageTaskAssignmentInstancesReportListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (StorageTaskAssignmentsClient) Update

Update ...

func (StorageTaskAssignmentsClient) UpdateThenPoll

UpdateThenPoll performs Update then polls until it's completed

type StorageTaskReportInstance

type StorageTaskReportInstance struct {
	Id         *string                      `json:"id,omitempty"`
	Name       *string                      `json:"name,omitempty"`
	Properties *StorageTaskReportProperties `json:"properties,omitempty"`
	Type       *string                      `json:"type,omitempty"`
}

type StorageTaskReportInstanceOperationPredicate

type StorageTaskReportInstanceOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (StorageTaskReportInstanceOperationPredicate) Matches

type StorageTaskReportProperties

type StorageTaskReportProperties struct {
	FinishTime             *string        `json:"finishTime,omitempty"`
	ObjectFailedCount      *string        `json:"objectFailedCount,omitempty"`
	ObjectsOperatedOnCount *string        `json:"objectsOperatedOnCount,omitempty"`
	ObjectsSucceededCount  *string        `json:"objectsSucceededCount,omitempty"`
	ObjectsTargetedCount   *string        `json:"objectsTargetedCount,omitempty"`
	RunResult              *RunResult     `json:"runResult,omitempty"`
	RunStatusEnum          *RunStatusEnum `json:"runStatusEnum,omitempty"`
	RunStatusError         *string        `json:"runStatusError,omitempty"`
	StartTime              *string        `json:"startTime,omitempty"`
	StorageAccountId       *string        `json:"storageAccountId,omitempty"`
	SummaryReportPath      *string        `json:"summaryReportPath,omitempty"`
	TaskAssignmentId       *string        `json:"taskAssignmentId,omitempty"`
	TaskId                 *string        `json:"taskId,omitempty"`
	TaskVersion            *string        `json:"taskVersion,omitempty"`
}

type TriggerParameters

type TriggerParameters struct {
	EndBy        *string       `json:"endBy,omitempty"`
	Interval     *int64        `json:"interval,omitempty"`
	IntervalUnit *IntervalUnit `json:"intervalUnit,omitempty"`
	StartFrom    *string       `json:"startFrom,omitempty"`
	StartOn      *string       `json:"startOn,omitempty"`
}

func (*TriggerParameters) GetEndByAsTime

func (o *TriggerParameters) GetEndByAsTime() (*time.Time, error)

func (*TriggerParameters) GetStartFromAsTime

func (o *TriggerParameters) GetStartFromAsTime() (*time.Time, error)

func (*TriggerParameters) GetStartOnAsTime

func (o *TriggerParameters) GetStartOnAsTime() (*time.Time, error)

func (*TriggerParameters) SetEndByAsTime

func (o *TriggerParameters) SetEndByAsTime(input time.Time)

func (*TriggerParameters) SetStartFromAsTime

func (o *TriggerParameters) SetStartFromAsTime(input time.Time)

func (*TriggerParameters) SetStartOnAsTime

func (o *TriggerParameters) SetStartOnAsTime(input time.Time)

type TriggerParametersUpdate

type TriggerParametersUpdate struct {
	EndBy        *string       `json:"endBy,omitempty"`
	Interval     *int64        `json:"interval,omitempty"`
	IntervalUnit *IntervalUnit `json:"intervalUnit,omitempty"`
	StartFrom    *string       `json:"startFrom,omitempty"`
	StartOn      *string       `json:"startOn,omitempty"`
}

func (*TriggerParametersUpdate) GetEndByAsTime

func (o *TriggerParametersUpdate) GetEndByAsTime() (*time.Time, error)

func (*TriggerParametersUpdate) GetStartFromAsTime

func (o *TriggerParametersUpdate) GetStartFromAsTime() (*time.Time, error)

func (*TriggerParametersUpdate) GetStartOnAsTime

func (o *TriggerParametersUpdate) GetStartOnAsTime() (*time.Time, error)

func (*TriggerParametersUpdate) SetEndByAsTime

func (o *TriggerParametersUpdate) SetEndByAsTime(input time.Time)

func (*TriggerParametersUpdate) SetStartFromAsTime

func (o *TriggerParametersUpdate) SetStartFromAsTime(input time.Time)

func (*TriggerParametersUpdate) SetStartOnAsTime

func (o *TriggerParametersUpdate) SetStartOnAsTime(input time.Time)

type TriggerType

type TriggerType string
const (
	TriggerTypeOnSchedule TriggerType = "OnSchedule"
	TriggerTypeRunOnce    TriggerType = "RunOnce"
)

func (*TriggerType) UnmarshalJSON

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

type UpdateOperationResponse

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *StorageTaskAssignment
}

Jump to

Keyboard shortcuts

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