dsccompilationjob

package
v0.20230130.1140358 Latest Latest
Warning

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

 Go to latest Published: Jan 30, 2023 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/automation/2020-01-13-preview/dsccompilationjob Documentation

The dsccompilationjob SDK allows for interaction with the Azure Resource Manager Service automation (API Version 2020-01-13-preview).

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/2020-01-13-preview/dsccompilationjob"

Client Initialization

client := dsccompilationjob.NewDscCompilationJobClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DscCompilationJobClient.Create

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

payload := dsccompilationjob.DscCompilationJobCreateParameters{
	// ...
}


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

Example Usage: DscCompilationJobClient.Get

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

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: DscCompilationJobClient.GetStream

ctx := context.TODO()
id := dsccompilationjob.NewStreamID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "jobIdValue", "jobStreamIdValue")

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

Example Usage: DscCompilationJobClient.ListByAutomationAccount

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

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

Example Usage: DscCompilationJobClient.StreamListByJob

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForJobProvisioningState 

func PossibleValuesForJobProvisioningState() []string

func PossibleValuesForJobStatus 

func PossibleValuesForJobStatus() []string

func PossibleValuesForJobStreamType 

func PossibleValuesForJobStreamType() []string

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 ValidateCompilationJobID 

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

ValidateCompilationJobID checks that 'input' can be parsed as a Compilation Job ID

func ValidateStreamID 

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

ValidateStreamID checks that 'input' can be parsed as a Stream 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 CompilationJobId 

type CompilationJobId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
	CompilationJobName    string
}

CompilationJobId is a struct representing the Resource ID for a Compilation Job

func NewCompilationJobID 

func NewCompilationJobID(subscriptionId string, resourceGroupName string, automationAccountName string, compilationJobName string) CompilationJobId

NewCompilationJobID returns a new CompilationJobId struct

func ParseCompilationJobID 

func ParseCompilationJobID(input string) (*CompilationJobId, error)

ParseCompilationJobID parses 'input' into a CompilationJobId

func ParseCompilationJobIDInsensitively 

func ParseCompilationJobIDInsensitively(input string) (*CompilationJobId, error)

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

func (CompilationJobId) ID 

func (id CompilationJobId) ID() string

ID returns the formatted Compilation Job ID

func (CompilationJobId) Segments 

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

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

func (CompilationJobId) String 

func (id CompilationJobId) String() string

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

type CreateOperationResponse 

type CreateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DscCompilationJob 

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

type DscCompilationJobClient 

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

func NewDscCompilationJobClientWithBaseURI 

func NewDscCompilationJobClientWithBaseURI(endpoint string) DscCompilationJobClient

func (DscCompilationJobClient) Create 

func (c DscCompilationJobClient) Create(ctx context.Context, id CompilationJobId, input DscCompilationJobCreateParameters) (result CreateOperationResponse, err error)

Create ...

func (DscCompilationJobClient) CreateThenPoll 

func (c DscCompilationJobClient) CreateThenPoll(ctx context.Context, id CompilationJobId, input DscCompilationJobCreateParameters) error

CreateThenPoll performs Create then polls until it's completed

func (DscCompilationJobClient) Get 

func (c DscCompilationJobClient) Get(ctx context.Context, id CompilationJobId) (result GetOperationResponse, err error)

Get ...

func (DscCompilationJobClient) GetStream 

func (c DscCompilationJobClient) GetStream(ctx context.Context, id StreamId) (result GetStreamOperationResponse, err error)

GetStream ...

func (DscCompilationJobClient) ListByAutomationAccount 

func (c DscCompilationJobClient) ListByAutomationAccount(ctx context.Context, id AutomationAccountId, options ListByAutomationAccountOperationOptions) (resp ListByAutomationAccountOperationResponse, err error)

ListByAutomationAccount ...

func (DscCompilationJobClient) ListByAutomationAccountComplete 

func (c DscCompilationJobClient) ListByAutomationAccountComplete(ctx context.Context, id AutomationAccountId, options ListByAutomationAccountOperationOptions) (ListByAutomationAccountCompleteResult, error)

ListByAutomationAccountComplete retrieves all of the results into a single object

func (DscCompilationJobClient) ListByAutomationAccountCompleteMatchingPredicate 

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

ListByAutomationAccountCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (DscCompilationJobClient) StreamListByJob 

func (c DscCompilationJobClient) StreamListByJob(ctx context.Context, id CompilationJobId) (result StreamListByJobOperationResponse, err error)

StreamListByJob ...

type DscCompilationJobCreateParameters 

type DscCompilationJobCreateParameters struct {
	Location   *string                           `json:"location,omitempty"`
	Name       *string                           `json:"name,omitempty"`
	Properties DscCompilationJobCreateProperties `json:"properties"`
	Tags       *map[string]string                `json:"tags,omitempty"`
}

type DscCompilationJobCreateProperties 

type DscCompilationJobCreateProperties struct {
	Configuration                   DscConfigurationAssociationProperty `json:"configuration"`
	IncrementNodeConfigurationBuild *bool                               `json:"incrementNodeConfigurationBuild,omitempty"`
	Parameters                      *map[string]string                  `json:"parameters,omitempty"`
}

type DscCompilationJobOperationPredicate 

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

func (DscCompilationJobOperationPredicate) Matches 

func (p DscCompilationJobOperationPredicate) Matches(input DscCompilationJob) bool

type DscCompilationJobProperties 

type DscCompilationJobProperties struct {
	Configuration          *DscConfigurationAssociationProperty `json:"configuration,omitempty"`
	CreationTime           *string                              `json:"creationTime,omitempty"`
	EndTime                *string                              `json:"endTime,omitempty"`
	Exception              *string                              `json:"exception,omitempty"`
	JobId                  *string                              `json:"jobId,omitempty"`
	LastModifiedTime       *string                              `json:"lastModifiedTime,omitempty"`
	LastStatusModifiedTime *string                              `json:"lastStatusModifiedTime,omitempty"`
	Parameters             *map[string]string                   `json:"parameters,omitempty"`
	ProvisioningState      *JobProvisioningState                `json:"provisioningState,omitempty"`
	RunOn                  *string                              `json:"runOn,omitempty"`
	StartTime              *string                              `json:"startTime,omitempty"`
	StartedBy              *string                              `json:"startedBy,omitempty"`
	Status                 *JobStatus                           `json:"status,omitempty"`
	StatusDetails          *string                              `json:"statusDetails,omitempty"`
}

func (*DscCompilationJobProperties) GetCreationTimeAsTime 

func (o *DscCompilationJobProperties) GetCreationTimeAsTime() (*time.Time, error)

func (*DscCompilationJobProperties) GetEndTimeAsTime 

func (o *DscCompilationJobProperties) GetEndTimeAsTime() (*time.Time, error)

func (*DscCompilationJobProperties) GetLastModifiedTimeAsTime 

func (o *DscCompilationJobProperties) GetLastModifiedTimeAsTime() (*time.Time, error)

func (*DscCompilationJobProperties) GetLastStatusModifiedTimeAsTime 

func (o *DscCompilationJobProperties) GetLastStatusModifiedTimeAsTime() (*time.Time, error)

func (*DscCompilationJobProperties) GetStartTimeAsTime 

func (o *DscCompilationJobProperties) GetStartTimeAsTime() (*time.Time, error)

func (*DscCompilationJobProperties) SetCreationTimeAsTime 

func (o *DscCompilationJobProperties) SetCreationTimeAsTime(input time.Time)

func (*DscCompilationJobProperties) SetEndTimeAsTime 

func (o *DscCompilationJobProperties) SetEndTimeAsTime(input time.Time)

func (*DscCompilationJobProperties) SetLastModifiedTimeAsTime 

func (o *DscCompilationJobProperties) SetLastModifiedTimeAsTime(input time.Time)

func (*DscCompilationJobProperties) SetLastStatusModifiedTimeAsTime 

func (o *DscCompilationJobProperties) SetLastStatusModifiedTimeAsTime(input time.Time)

func (*DscCompilationJobProperties) SetStartTimeAsTime 

func (o *DscCompilationJobProperties) SetStartTimeAsTime(input time.Time)

type DscConfigurationAssociationProperty 

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

type GetOperationResponse 

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

type GetStreamOperationResponse 

type GetStreamOperationResponse struct {
	HttpResponse *http.Response
	Model        *JobStream
}

type JobProvisioningState 

type JobProvisioningState string
const (
	JobProvisioningStateFailed     JobProvisioningState = "Failed"
	JobProvisioningStateProcessing JobProvisioningState = "Processing"
	JobProvisioningStateSucceeded  JobProvisioningState = "Succeeded"
	JobProvisioningStateSuspended  JobProvisioningState = "Suspended"
)

type JobStatus 

type JobStatus string
const (
	JobStatusActivating   JobStatus = "Activating"
	JobStatusBlocked      JobStatus = "Blocked"
	JobStatusCompleted    JobStatus = "Completed"
	JobStatusDisconnected JobStatus = "Disconnected"
	JobStatusFailed       JobStatus = "Failed"
	JobStatusNew          JobStatus = "New"
	JobStatusRemoving     JobStatus = "Removing"
	JobStatusResuming     JobStatus = "Resuming"
	JobStatusRunning      JobStatus = "Running"
	JobStatusStopped      JobStatus = "Stopped"
	JobStatusStopping     JobStatus = "Stopping"
	JobStatusSuspended    JobStatus = "Suspended"
	JobStatusSuspending   JobStatus = "Suspending"
)

type JobStream 

type JobStream struct {
	Id         *string              `json:"id,omitempty"`
	Properties *JobStreamProperties `json:"properties,omitempty"`
}

type JobStreamListResult 

type JobStreamListResult struct {
	NextLink *string      `json:"nextLink,omitempty"`
	Value    *[]JobStream `json:"value,omitempty"`
}

type JobStreamProperties 

type JobStreamProperties struct {
	JobStreamId *string                 `json:"jobStreamId,omitempty"`
	StreamText  *string                 `json:"streamText,omitempty"`
	StreamType  *JobStreamType          `json:"streamType,omitempty"`
	Summary     *string                 `json:"summary,omitempty"`
	Time        *string                 `json:"time,omitempty"`
	Value       *map[string]interface{} `json:"value,omitempty"`
}

func (*JobStreamProperties) GetTimeAsTime 

func (o *JobStreamProperties) GetTimeAsTime() (*time.Time, error)

func (*JobStreamProperties) SetTimeAsTime 

func (o *JobStreamProperties) SetTimeAsTime(input time.Time)

type JobStreamType 

type JobStreamType string
const (
	JobStreamTypeAny      JobStreamType = "Any"
	JobStreamTypeDebug    JobStreamType = "Debug"
	JobStreamTypeError    JobStreamType = "Error"
	JobStreamTypeOutput   JobStreamType = "Output"
	JobStreamTypeProgress JobStreamType = "Progress"
	JobStreamTypeVerbose  JobStreamType = "Verbose"
	JobStreamTypeWarning  JobStreamType = "Warning"
)

type ListByAutomationAccountCompleteResult 

type ListByAutomationAccountCompleteResult struct {
	Items []DscCompilationJob
}

type ListByAutomationAccountOperationOptions 

type ListByAutomationAccountOperationOptions struct {
	Filter *string
}

func DefaultListByAutomationAccountOperationOptions 

func DefaultListByAutomationAccountOperationOptions() ListByAutomationAccountOperationOptions

type ListByAutomationAccountOperationResponse 

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

func (ListByAutomationAccountOperationResponse) HasMore 

func (r ListByAutomationAccountOperationResponse) HasMore() bool

func (ListByAutomationAccountOperationResponse) LoadMore 

func (r ListByAutomationAccountOperationResponse) LoadMore(ctx context.Context) (resp ListByAutomationAccountOperationResponse, err error)

type StreamId 

type StreamId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
	JobId                 string
	JobStreamId           string
}

StreamId is a struct representing the Resource ID for a Stream

func NewStreamID 

func NewStreamID(subscriptionId string, resourceGroupName string, automationAccountName string, jobId string, jobStreamId string) StreamId

NewStreamID returns a new StreamId struct

func ParseStreamID 

func ParseStreamID(input string) (*StreamId, error)

ParseStreamID parses 'input' into a StreamId

func ParseStreamIDInsensitively 

func ParseStreamIDInsensitively(input string) (*StreamId, error)

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

func (StreamId) ID 

func (id StreamId) ID() string

ID returns the formatted Stream ID

func (StreamId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Stream ID

func (StreamId) String 

func (id StreamId) String() string

String returns a human-readable description of this Stream ID

type StreamListByJobOperationResponse 

type StreamListByJobOperationResponse struct {
	HttpResponse *http.Response
	Model        *JobStreamListResult
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.