README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/devtestlab/2018-09-15/servicefabricschedules
Documentation
The servicefabricschedules
SDK allows for interaction with the Azure Resource Manager Service devtestlab
(API Version 2018-09-15
).
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/devtestlab/2018-09-15/servicefabricschedules"
Client Initialization
client := servicefabricschedules.NewServiceFabricSchedulesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: ServiceFabricSchedulesClient.CreateOrUpdate
ctx := context.TODO()
id := servicefabricschedules.NewServiceFabricScheduleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "userValue", "serviceFabricValue", "scheduleValue")
payload := servicefabricschedules.Schedule{
// ...
}
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: ServiceFabricSchedulesClient.Delete
ctx := context.TODO()
id := servicefabricschedules.NewServiceFabricScheduleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "userValue", "serviceFabricValue", "scheduleValue")
read, err := client.Delete(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: ServiceFabricSchedulesClient.Execute
ctx := context.TODO()
id := servicefabricschedules.NewServiceFabricScheduleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "userValue", "serviceFabricValue", "scheduleValue")
if err := client.ExecuteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: ServiceFabricSchedulesClient.Get
ctx := context.TODO()
id := servicefabricschedules.NewServiceFabricScheduleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "userValue", "serviceFabricValue", "scheduleValue")
read, err := client.Get(ctx, id, servicefabricschedules.DefaultGetOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: ServiceFabricSchedulesClient.List
ctx := context.TODO()
id := servicefabricschedules.NewServiceFabricID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "userValue", "serviceFabricValue")
// alternatively `client.List(ctx, id, servicefabricschedules.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, servicefabricschedules.DefaultListOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: ServiceFabricSchedulesClient.Update
ctx := context.TODO()
id := servicefabricschedules.NewServiceFabricScheduleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "userValue", "serviceFabricValue", "scheduleValue")
payload := servicefabricschedules.UpdateResource{
// ...
}
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 PossibleValuesForEnableStatus() []string
- func ValidateServiceFabricID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateServiceFabricScheduleID(input interface{}, key string) (warnings []string, errors []error)
- type CreateOrUpdateOperationResponse
- type DayDetails
- type DeleteOperationResponse
- type EnableStatus
- type ExecuteOperationResponse
- type GetOperationOptions
- type GetOperationResponse
- type HourDetails
- type ListCompleteResult
- type ListOperationOptions
- type ListOperationResponse
- type NotificationSettings
- type Schedule
- type ScheduleOperationPredicate
- type ScheduleProperties
- type ServiceFabricId
- type ServiceFabricScheduleId
- func NewServiceFabricScheduleID(subscriptionId string, resourceGroupName string, labName string, ...) ServiceFabricScheduleId
- func ParseServiceFabricScheduleID(input string) (*ServiceFabricScheduleId, error)
- func ParseServiceFabricScheduleIDInsensitively(input string) (*ServiceFabricScheduleId, error)
- type ServiceFabricSchedulesClient
- func (c ServiceFabricSchedulesClient) CreateOrUpdate(ctx context.Context, id ServiceFabricScheduleId, input Schedule) (result CreateOrUpdateOperationResponse, err error)
- func (c ServiceFabricSchedulesClient) Delete(ctx context.Context, id ServiceFabricScheduleId) (result DeleteOperationResponse, err error)
- func (c ServiceFabricSchedulesClient) Execute(ctx context.Context, id ServiceFabricScheduleId) (result ExecuteOperationResponse, err error)
- func (c ServiceFabricSchedulesClient) ExecuteThenPoll(ctx context.Context, id ServiceFabricScheduleId) error
- func (c ServiceFabricSchedulesClient) Get(ctx context.Context, id ServiceFabricScheduleId, options GetOperationOptions) (result GetOperationResponse, err error)
- func (c ServiceFabricSchedulesClient) List(ctx context.Context, id ServiceFabricId, options ListOperationOptions) (result ListOperationResponse, err error)
- func (c ServiceFabricSchedulesClient) ListComplete(ctx context.Context, id ServiceFabricId, options ListOperationOptions) (ListCompleteResult, error)
- func (c ServiceFabricSchedulesClient) ListCompleteMatchingPredicate(ctx context.Context, id ServiceFabricId, options ListOperationOptions, ...) (result ListCompleteResult, err error)
- func (c ServiceFabricSchedulesClient) Update(ctx context.Context, id ServiceFabricScheduleId, input UpdateResource) (result UpdateOperationResponse, err error)
- type UpdateOperationResponse
- type UpdateResource
- type WeekDetails
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForEnableStatus ¶
func PossibleValuesForEnableStatus() []string
func ValidateServiceFabricID ¶
ValidateServiceFabricID checks that 'input' can be parsed as a Service Fabric ID
func ValidateServiceFabricScheduleID ¶
func ValidateServiceFabricScheduleID(input interface{}, key string) (warnings []string, errors []error)
ValidateServiceFabricScheduleID checks that 'input' can be parsed as a Service Fabric Schedule ID
Types ¶
type DayDetails ¶
type DayDetails struct {
Time *string `json:"time,omitempty"`
}
type DeleteOperationResponse ¶
type EnableStatus ¶
type EnableStatus string
const ( EnableStatusDisabled EnableStatus = "Disabled" EnableStatusEnabled EnableStatus = "Enabled" )
func (*EnableStatus) UnmarshalJSON ¶ added in v0.20230815.1165905
func (s *EnableStatus) UnmarshalJSON(bytes []byte) error
type GetOperationOptions ¶
type GetOperationOptions struct {
Expand *string
}
func DefaultGetOperationOptions ¶
func DefaultGetOperationOptions() GetOperationOptions
func (GetOperationOptions) ToHeaders ¶ added in v0.20230815.1165905
func (o GetOperationOptions) ToHeaders() *client.Headers
func (GetOperationOptions) ToOData ¶ added in v0.20230815.1165905
func (o GetOperationOptions) ToOData() *odata.Query
func (GetOperationOptions) ToQuery ¶ added in v0.20230815.1165905
func (o GetOperationOptions) ToQuery() *client.QueryParams
type GetOperationResponse ¶
type HourDetails ¶
type HourDetails struct {
Minute *int64 `json:"minute,omitempty"`
}
type ListCompleteResult ¶
type ListOperationOptions ¶
func DefaultListOperationOptions ¶
func DefaultListOperationOptions() ListOperationOptions
func (ListOperationOptions) ToHeaders ¶ added in v0.20230815.1165905
func (o ListOperationOptions) ToHeaders() *client.Headers
func (ListOperationOptions) ToOData ¶ added in v0.20230815.1165905
func (o ListOperationOptions) ToOData() *odata.Query
func (ListOperationOptions) ToQuery ¶ added in v0.20230815.1165905
func (o ListOperationOptions) ToQuery() *client.QueryParams
type ListOperationResponse ¶
type NotificationSettings ¶
type NotificationSettings struct { EmailRecipient *string `json:"emailRecipient,omitempty"` NotificationLocale *string `json:"notificationLocale,omitempty"` Status *EnableStatus `json:"status,omitempty"` TimeInMinutes *int64 `json:"timeInMinutes,omitempty"` WebhookUrl *string `json:"webhookUrl,omitempty"` }
type ScheduleOperationPredicate ¶
func (ScheduleOperationPredicate) Matches ¶
func (p ScheduleOperationPredicate) Matches(input Schedule) bool
type ScheduleProperties ¶
type ScheduleProperties struct { CreatedDate *string `json:"createdDate,omitempty"` DailyRecurrence *DayDetails `json:"dailyRecurrence,omitempty"` HourlyRecurrence *HourDetails `json:"hourlyRecurrence,omitempty"` NotificationSettings *NotificationSettings `json:"notificationSettings,omitempty"` ProvisioningState *string `json:"provisioningState,omitempty"` Status *EnableStatus `json:"status,omitempty"` TargetResourceId *string `json:"targetResourceId,omitempty"` TaskType *string `json:"taskType,omitempty"` TimeZoneId *string `json:"timeZoneId,omitempty"` UniqueIdentifier *string `json:"uniqueIdentifier,omitempty"` WeeklyRecurrence *WeekDetails `json:"weeklyRecurrence,omitempty"` }
func (*ScheduleProperties) GetCreatedDateAsTime ¶
func (o *ScheduleProperties) GetCreatedDateAsTime() (*time.Time, error)
func (*ScheduleProperties) SetCreatedDateAsTime ¶
func (o *ScheduleProperties) SetCreatedDateAsTime(input time.Time)
type ServiceFabricId ¶
type ServiceFabricId struct { SubscriptionId string ResourceGroupName string LabName string UserName string ServiceFabricName string }
ServiceFabricId is a struct representing the Resource ID for a Service Fabric
func NewServiceFabricID ¶
func NewServiceFabricID(subscriptionId string, resourceGroupName string, labName string, userName string, serviceFabricName string) ServiceFabricId
NewServiceFabricID returns a new ServiceFabricId struct
func ParseServiceFabricID ¶
func ParseServiceFabricID(input string) (*ServiceFabricId, error)
ParseServiceFabricID parses 'input' into a ServiceFabricId
func ParseServiceFabricIDInsensitively ¶
func ParseServiceFabricIDInsensitively(input string) (*ServiceFabricId, error)
ParseServiceFabricIDInsensitively parses 'input' case-insensitively into a ServiceFabricId note: this method should only be used for API response data and not user input
func (*ServiceFabricId) FromParseResult ¶ added in v0.20231127.1171502
func (id *ServiceFabricId) FromParseResult(input resourceids.ParseResult) error
func (ServiceFabricId) ID ¶
func (id ServiceFabricId) ID() string
ID returns the formatted Service Fabric ID
func (ServiceFabricId) Segments ¶
func (id ServiceFabricId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Service Fabric ID
func (ServiceFabricId) String ¶
func (id ServiceFabricId) String() string
String returns a human-readable description of this Service Fabric ID
type ServiceFabricScheduleId ¶
type ServiceFabricScheduleId struct { SubscriptionId string ResourceGroupName string LabName string UserName string ServiceFabricName string ScheduleName string }
ServiceFabricScheduleId is a struct representing the Resource ID for a Service Fabric Schedule
func NewServiceFabricScheduleID ¶
func NewServiceFabricScheduleID(subscriptionId string, resourceGroupName string, labName string, userName string, serviceFabricName string, scheduleName string) ServiceFabricScheduleId
NewServiceFabricScheduleID returns a new ServiceFabricScheduleId struct
func ParseServiceFabricScheduleID ¶
func ParseServiceFabricScheduleID(input string) (*ServiceFabricScheduleId, error)
ParseServiceFabricScheduleID parses 'input' into a ServiceFabricScheduleId
func ParseServiceFabricScheduleIDInsensitively ¶
func ParseServiceFabricScheduleIDInsensitively(input string) (*ServiceFabricScheduleId, error)
ParseServiceFabricScheduleIDInsensitively parses 'input' case-insensitively into a ServiceFabricScheduleId note: this method should only be used for API response data and not user input
func (*ServiceFabricScheduleId) FromParseResult ¶ added in v0.20231127.1171502
func (id *ServiceFabricScheduleId) FromParseResult(input resourceids.ParseResult) error
func (ServiceFabricScheduleId) ID ¶
func (id ServiceFabricScheduleId) ID() string
ID returns the formatted Service Fabric Schedule ID
func (ServiceFabricScheduleId) Segments ¶
func (id ServiceFabricScheduleId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Service Fabric Schedule ID
func (ServiceFabricScheduleId) String ¶
func (id ServiceFabricScheduleId) String() string
String returns a human-readable description of this Service Fabric Schedule ID
type ServiceFabricSchedulesClient ¶
type ServiceFabricSchedulesClient struct {
Client *resourcemanager.Client
}
func NewServiceFabricSchedulesClientWithBaseURI ¶
func NewServiceFabricSchedulesClientWithBaseURI(sdkApi sdkEnv.Api) (*ServiceFabricSchedulesClient, error)
func (ServiceFabricSchedulesClient) CreateOrUpdate ¶
func (c ServiceFabricSchedulesClient) CreateOrUpdate(ctx context.Context, id ServiceFabricScheduleId, input Schedule) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (ServiceFabricSchedulesClient) Delete ¶
func (c ServiceFabricSchedulesClient) Delete(ctx context.Context, id ServiceFabricScheduleId) (result DeleteOperationResponse, err error)
Delete ...
func (ServiceFabricSchedulesClient) Execute ¶
func (c ServiceFabricSchedulesClient) Execute(ctx context.Context, id ServiceFabricScheduleId) (result ExecuteOperationResponse, err error)
Execute ...
func (ServiceFabricSchedulesClient) ExecuteThenPoll ¶
func (c ServiceFabricSchedulesClient) ExecuteThenPoll(ctx context.Context, id ServiceFabricScheduleId) error
ExecuteThenPoll performs Execute then polls until it's completed
func (ServiceFabricSchedulesClient) Get ¶
func (c ServiceFabricSchedulesClient) Get(ctx context.Context, id ServiceFabricScheduleId, options GetOperationOptions) (result GetOperationResponse, err error)
Get ...
func (ServiceFabricSchedulesClient) List ¶
func (c ServiceFabricSchedulesClient) List(ctx context.Context, id ServiceFabricId, options ListOperationOptions) (result ListOperationResponse, err error)
List ...
func (ServiceFabricSchedulesClient) ListComplete ¶
func (c ServiceFabricSchedulesClient) ListComplete(ctx context.Context, id ServiceFabricId, options ListOperationOptions) (ListCompleteResult, error)
ListComplete retrieves all the results into a single object
func (ServiceFabricSchedulesClient) ListCompleteMatchingPredicate ¶
func (c ServiceFabricSchedulesClient) ListCompleteMatchingPredicate(ctx context.Context, id ServiceFabricId, options ListOperationOptions, predicate ScheduleOperationPredicate) (result ListCompleteResult, err error)
ListCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (ServiceFabricSchedulesClient) Update ¶
func (c ServiceFabricSchedulesClient) Update(ctx context.Context, id ServiceFabricScheduleId, input UpdateResource) (result UpdateOperationResponse, err error)
Update ...
type UpdateOperationResponse ¶
type UpdateResource ¶
type WeekDetails ¶
Source Files ¶
- client.go
- constants.go
- id_servicefabric.go
- id_servicefabricschedule.go
- method_createorupdate.go
- method_delete.go
- method_execute.go
- method_get.go
- method_list.go
- method_update.go
- model_daydetails.go
- model_hourdetails.go
- model_notificationsettings.go
- model_schedule.go
- model_scheduleproperties.go
- model_updateresource.go
- model_weekdetails.go
- predicates.go
- version.go