dsccompilationjob

package
v0.20241104.1140654 Latest Latest
Warning

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

 Go to latest Published: Nov 4, 2024 License: MPL-2.0 Imports: 14 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/automation/2015-10-31/dsccompilationjob Documentation

The dsccompilationjob SDK allows for interaction with Azure Resource Manager automation (API Version 2015-10-31).

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/automation/2015-10-31/dsccompilationjob"

Client Initialization

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

Example Usage: DscCompilationJobClient.Create

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

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


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

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

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.NewCompilationJobStreamID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountName", "jobId", "jobStreamId")

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", "automationAccountName")

// 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 := commonids.NewAutomationCompilationJobID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountName", "compilationJobId")

// alternatively `client.StreamListByJob(ctx, id)` can be used to do batched pagination
items, err := client.StreamListByJobComplete(ctx, id)
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 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 ValidateCompilationJobStreamID 

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

ValidateCompilationJobStreamID checks that 'input' can be parsed as a Compilation Job 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) FromParseResult 

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

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 CompilationJobStreamId 

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

CompilationJobStreamId is a struct representing the Resource ID for a Compilation Job Stream

func NewCompilationJobStreamID 

func NewCompilationJobStreamID(subscriptionId string, resourceGroupName string, automationAccountName string, jobId string, jobStreamId string) CompilationJobStreamId

NewCompilationJobStreamID returns a new CompilationJobStreamId struct

func ParseCompilationJobStreamID 

func ParseCompilationJobStreamID(input string) (*CompilationJobStreamId, error)

ParseCompilationJobStreamID parses 'input' into a CompilationJobStreamId

func ParseCompilationJobStreamIDInsensitively 

func ParseCompilationJobStreamIDInsensitively(input string) (*CompilationJobStreamId, error)

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

func (*CompilationJobStreamId) FromParseResult 

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

func (CompilationJobStreamId) ID 

func (id CompilationJobStreamId) ID() string

ID returns the formatted Compilation Job Stream ID

func (CompilationJobStreamId) Segments 

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

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

func (CompilationJobStreamId) String 

func (id CompilationJobStreamId) String() string

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

type CreateOperationResponse 

type CreateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DscCompilationJob
}

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 *resourcemanager.Client
}

func NewDscCompilationJobClientWithBaseURI 

func NewDscCompilationJobClientWithBaseURI(sdkApi sdkEnv.Api) (*DscCompilationJobClient, error)

func (DscCompilationJobClient) Create 

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

Create ...

func (DscCompilationJobClient) Get 

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

Get ...

func (DscCompilationJobClient) GetStream 

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

GetStream ...

func (DscCompilationJobClient) ListByAutomationAccount 

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

ListByAutomationAccount ...

func (DscCompilationJobClient) ListByAutomationAccountComplete 

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

ListByAutomationAccountComplete retrieves all the results into a single object

func (DscCompilationJobClient) ListByAutomationAccountCompleteMatchingPredicate 

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

ListByAutomationAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DscCompilationJobClient) StreamListByJob 

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

StreamListByJob ...

func (DscCompilationJobClient) StreamListByJobComplete added in v0.20240226.1173038 

func (c DscCompilationJobClient) StreamListByJobComplete(ctx context.Context, id commonids.AutomationCompilationJobId) (StreamListByJobCompleteResult, error)

StreamListByJobComplete retrieves all the results into a single object

func (DscCompilationJobClient) StreamListByJobCompleteMatchingPredicate added in v0.20240226.1173038 

func (c DscCompilationJobClient) StreamListByJobCompleteMatchingPredicate(ctx context.Context, id commonids.AutomationCompilationJobId, predicate JobStreamOperationPredicate) (result StreamListByJobCompleteResult, err error)

StreamListByJobCompleteMatchingPredicate retrieves all the results and then applies the predicate

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
	OData        *odata.OData
	Model        *DscCompilationJob
}

type GetStreamOperationResponse 

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

type JobProvisioningState 

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

func (*JobProvisioningState) UnmarshalJSON added in v0.20240209.1164150 

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

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"
)

func (*JobStatus) UnmarshalJSON added in v0.20240209.1164150 

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

type JobStream 

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

type JobStreamOperationPredicate added in v0.20240226.1173038 

type JobStreamOperationPredicate struct {
	Id *string
}

func (JobStreamOperationPredicate) Matches added in v0.20240226.1173038 

func (p JobStreamOperationPredicate) Matches(input JobStream) bool

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"
)

func (*JobStreamType) UnmarshalJSON added in v0.20240209.1164150 

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

type ListByAutomationAccountCompleteResult 

type ListByAutomationAccountCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DscCompilationJob
}

type ListByAutomationAccountCustomPager added in v0.20240628.1153531 

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

type ListByAutomationAccountOperationOptions 

type ListByAutomationAccountOperationOptions struct {
	Filter *string
}

func DefaultListByAutomationAccountOperationOptions 

func DefaultListByAutomationAccountOperationOptions() ListByAutomationAccountOperationOptions

func (ListByAutomationAccountOperationOptions) ToHeaders added in v0.20240209.1164150 

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

func (ListByAutomationAccountOperationOptions) ToOData added in v0.20240209.1164150 

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

func (ListByAutomationAccountOperationOptions) ToQuery added in v0.20240209.1164150 

func (o ListByAutomationAccountOperationOptions) ToQuery() *client.QueryParams

type ListByAutomationAccountOperationResponse 

type ListByAutomationAccountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DscCompilationJob
}

type StreamListByJobCompleteResult added in v0.20240226.1173038 

type StreamListByJobCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []JobStream
}

type StreamListByJobCustomPager added in v0.20240628.1153531 

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

type StreamListByJobOperationResponse 

type StreamListByJobOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]JobStream
}

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.