jobschedule

package
v0.20230725.1143138 Latest Latest
Warning

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

Go to latest
Published: Jul 25, 2023 License: MPL-2.0 Imports: 8 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/automation/2019-06-01/jobschedule Documentation

The jobschedule SDK allows for interaction with the Azure Resource Manager Service automation (API Version 2019-06-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/automation/2019-06-01/jobschedule"

Client Initialization

client := jobschedule.NewJobScheduleClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: JobScheduleClient.Create

ctx := context.TODO()
id := jobschedule.NewJobScheduleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "jobScheduleIdValue")

payload := jobschedule.JobScheduleCreateParameters{
	// ...
}


read, err := client.Create(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: JobScheduleClient.Delete

ctx := context.TODO()
id := jobschedule.NewJobScheduleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "jobScheduleIdValue")

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: JobScheduleClient.Get

ctx := context.TODO()
id := jobschedule.NewJobScheduleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "jobScheduleIdValue")

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: JobScheduleClient.ListByAutomationAccount

ctx := context.TODO()
id := jobschedule.NewAutomationAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateAutomationAccountID

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

ValidateAutomationAccountID checks that 'input' can be parsed as a Automation Account ID

func ValidateJobScheduleID

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

ValidateJobScheduleID checks that 'input' can be parsed as a Job Schedule ID

Types

type AutomationAccountId

type AutomationAccountId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
}

AutomationAccountId is a struct representing the Resource ID for a Automation Account

func NewAutomationAccountID

func NewAutomationAccountID(subscriptionId string, resourceGroupName string, automationAccountName string) AutomationAccountId

NewAutomationAccountID returns a new AutomationAccountId struct

func ParseAutomationAccountID

func ParseAutomationAccountID(input string) (*AutomationAccountId, error)

ParseAutomationAccountID parses 'input' into a AutomationAccountId

func ParseAutomationAccountIDInsensitively

func ParseAutomationAccountIDInsensitively(input string) (*AutomationAccountId, error)

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

func (AutomationAccountId) ID

func (id AutomationAccountId) ID() string

ID returns the formatted Automation Account ID

func (AutomationAccountId) Segments

func (id AutomationAccountId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Automation Account ID

func (AutomationAccountId) String

func (id AutomationAccountId) String() string

String returns a human-readable description of this Automation Account ID

type CreateOperationResponse

type CreateOperationResponse struct {
	HttpResponse *http.Response
	Model        *JobSchedule
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *JobSchedule
}

type JobSchedule

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

type JobScheduleClient

type JobScheduleClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewJobScheduleClientWithBaseURI

func NewJobScheduleClientWithBaseURI(endpoint string) JobScheduleClient

func (JobScheduleClient) Create

Create ...

func (JobScheduleClient) Delete

Delete ...

func (JobScheduleClient) Get

Get ...

func (JobScheduleClient) ListByAutomationAccount

ListByAutomationAccount ...

func (JobScheduleClient) ListByAutomationAccountComplete

ListByAutomationAccountComplete retrieves all of the results into a single object

func (JobScheduleClient) ListByAutomationAccountCompleteMatchingPredicate

func (c JobScheduleClient) ListByAutomationAccountCompleteMatchingPredicate(ctx context.Context, id AutomationAccountId, options ListByAutomationAccountOperationOptions, predicate JobScheduleOperationPredicate) (resp ListByAutomationAccountCompleteResult, err error)

ListByAutomationAccountCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type JobScheduleCreateParameters

type JobScheduleCreateParameters struct {
	Properties JobScheduleCreateProperties `json:"properties"`
}

type JobScheduleCreateProperties

type JobScheduleCreateProperties struct {
	Parameters *map[string]string          `json:"parameters,omitempty"`
	RunOn      *string                     `json:"runOn,omitempty"`
	Runbook    RunbookAssociationProperty  `json:"runbook"`
	Schedule   ScheduleAssociationProperty `json:"schedule"`
}

type JobScheduleId

type JobScheduleId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
	JobScheduleId         string
}

JobScheduleId is a struct representing the Resource ID for a Job Schedule

func NewJobScheduleID

func NewJobScheduleID(subscriptionId string, resourceGroupName string, automationAccountName string, jobScheduleId string) JobScheduleId

NewJobScheduleID returns a new JobScheduleId struct

func ParseJobScheduleID

func ParseJobScheduleID(input string) (*JobScheduleId, error)

ParseJobScheduleID parses 'input' into a JobScheduleId

func ParseJobScheduleIDInsensitively

func ParseJobScheduleIDInsensitively(input string) (*JobScheduleId, error)

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

func (JobScheduleId) ID

func (id JobScheduleId) ID() string

ID returns the formatted Job Schedule ID

func (JobScheduleId) Segments

func (id JobScheduleId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Job Schedule ID

func (JobScheduleId) String

func (id JobScheduleId) String() string

String returns a human-readable description of this Job Schedule ID

type JobScheduleOperationPredicate

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

func (JobScheduleOperationPredicate) Matches

type JobScheduleProperties

type JobScheduleProperties struct {
	JobScheduleId *string                      `json:"jobScheduleId,omitempty"`
	Parameters    *map[string]string           `json:"parameters,omitempty"`
	RunOn         *string                      `json:"runOn,omitempty"`
	Runbook       *RunbookAssociationProperty  `json:"runbook,omitempty"`
	Schedule      *ScheduleAssociationProperty `json:"schedule,omitempty"`
}

type ListByAutomationAccountCompleteResult

type ListByAutomationAccountCompleteResult struct {
	Items []JobSchedule
}

type ListByAutomationAccountOperationOptions

type ListByAutomationAccountOperationOptions struct {
	Filter *string
}

func DefaultListByAutomationAccountOperationOptions

func DefaultListByAutomationAccountOperationOptions() ListByAutomationAccountOperationOptions

type ListByAutomationAccountOperationResponse

type ListByAutomationAccountOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]JobSchedule
	// contains filtered or unexported fields
}

func (ListByAutomationAccountOperationResponse) HasMore

func (ListByAutomationAccountOperationResponse) LoadMore

type RunbookAssociationProperty

type RunbookAssociationProperty struct {
	Name *string `json:"name,omitempty"`
}

type ScheduleAssociationProperty

type ScheduleAssociationProperty struct {
	Name *string `json:"name,omitempty"`
}

Jump to

Keyboard shortcuts

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