assignmentoperations

package
v0.20240612.1084144 Latest Latest
Warning

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

Go to latest
Published: Jun 12, 2024 License: MPL-2.0 Imports: 10 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/blueprints/2018-11-01-preview/assignmentoperations Documentation

The assignmentoperations SDK allows for interaction with the Azure Resource Manager Service blueprints (API Version 2018-11-01-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/blueprints/2018-11-01-preview/assignmentoperations"

Client Initialization

client := assignmentoperations.NewAssignmentOperationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AssignmentOperationsClient.Get

ctx := context.TODO()
id := assignmentoperations.NewScopedAssignmentOperationID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "blueprintAssignmentValue", "assignmentOperationValue")

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: AssignmentOperationsClient.List

ctx := context.TODO()
id := assignmentoperations.NewScopedBlueprintAssignmentID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "blueprintAssignmentValue")

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

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

ValidateScopedAssignmentOperationID checks that 'input' can be parsed as a Scoped Assignment Operation ID

func ValidateScopedBlueprintAssignmentID

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

ValidateScopedBlueprintAssignmentID checks that 'input' can be parsed as a Scoped Blueprint Assignment ID

Types

type AssignmentDeploymentJob

type AssignmentDeploymentJob struct {
	Action     *string                          `json:"action,omitempty"`
	History    *[]AssignmentDeploymentJobResult `json:"history,omitempty"`
	JobId      *string                          `json:"jobId,omitempty"`
	JobState   *string                          `json:"jobState,omitempty"`
	Kind       *string                          `json:"kind,omitempty"`
	RequestUri *string                          `json:"requestUri,omitempty"`
	Result     *AssignmentDeploymentJobResult   `json:"result,omitempty"`
}

type AssignmentDeploymentJobResult

type AssignmentDeploymentJobResult struct {
	Error     *AzureResourceManagerError      `json:"error,omitempty"`
	Resources *[]AssignmentJobCreatedResource `json:"resources,omitempty"`
}

type AssignmentJobCreatedResource

type AssignmentJobCreatedResource struct {
	Id         *string            `json:"id,omitempty"`
	Name       *string            `json:"name,omitempty"`
	Properties *map[string]string `json:"properties,omitempty"`
	Type       *string            `json:"type,omitempty"`
}

type AssignmentOperation

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

type AssignmentOperationOperationPredicate

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

func (AssignmentOperationOperationPredicate) Matches

type AssignmentOperationProperties

type AssignmentOperationProperties struct {
	AssignmentState  *string                    `json:"assignmentState,omitempty"`
	BlueprintVersion *string                    `json:"blueprintVersion,omitempty"`
	Deployments      *[]AssignmentDeploymentJob `json:"deployments,omitempty"`
	TimeCreated      *string                    `json:"timeCreated,omitempty"`
	TimeFinished     *string                    `json:"timeFinished,omitempty"`
	TimeStarted      *string                    `json:"timeStarted,omitempty"`
}

type AssignmentOperationsClient

type AssignmentOperationsClient struct {
	Client *resourcemanager.Client
}

func NewAssignmentOperationsClientWithBaseURI

func NewAssignmentOperationsClientWithBaseURI(sdkApi sdkEnv.Api) (*AssignmentOperationsClient, error)

func (AssignmentOperationsClient) Get

Get ...

func (AssignmentOperationsClient) List

List ...

func (AssignmentOperationsClient) ListComplete

ListComplete retrieves all the results into a single object

func (AssignmentOperationsClient) ListCompleteMatchingPredicate

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type AzureResourceManagerError

type AzureResourceManagerError struct {
	Code    *string `json:"code,omitempty"`
	Message *string `json:"message,omitempty"`
}

type GetOperationResponse

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

type ListCompleteResult

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

type ListOperationResponse

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

type ScopedAssignmentOperationId

type ScopedAssignmentOperationId struct {
	ResourceScope           string
	BlueprintAssignmentName string
	AssignmentOperationName string
}

ScopedAssignmentOperationId is a struct representing the Resource ID for a Scoped Assignment Operation

func NewScopedAssignmentOperationID

func NewScopedAssignmentOperationID(resourceScope string, blueprintAssignmentName string, assignmentOperationName string) ScopedAssignmentOperationId

NewScopedAssignmentOperationID returns a new ScopedAssignmentOperationId struct

func ParseScopedAssignmentOperationID

func ParseScopedAssignmentOperationID(input string) (*ScopedAssignmentOperationId, error)

ParseScopedAssignmentOperationID parses 'input' into a ScopedAssignmentOperationId

func ParseScopedAssignmentOperationIDInsensitively

func ParseScopedAssignmentOperationIDInsensitively(input string) (*ScopedAssignmentOperationId, error)

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

func (*ScopedAssignmentOperationId) FromParseResult

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

func (ScopedAssignmentOperationId) ID

ID returns the formatted Scoped Assignment Operation ID

func (ScopedAssignmentOperationId) Segments

Segments returns a slice of Resource ID Segments which comprise this Scoped Assignment Operation ID

func (ScopedAssignmentOperationId) String

func (id ScopedAssignmentOperationId) String() string

String returns a human-readable description of this Scoped Assignment Operation ID

type ScopedBlueprintAssignmentId

type ScopedBlueprintAssignmentId struct {
	ResourceScope           string
	BlueprintAssignmentName string
}

ScopedBlueprintAssignmentId is a struct representing the Resource ID for a Scoped Blueprint Assignment

func NewScopedBlueprintAssignmentID

func NewScopedBlueprintAssignmentID(resourceScope string, blueprintAssignmentName string) ScopedBlueprintAssignmentId

NewScopedBlueprintAssignmentID returns a new ScopedBlueprintAssignmentId struct

func ParseScopedBlueprintAssignmentID

func ParseScopedBlueprintAssignmentID(input string) (*ScopedBlueprintAssignmentId, error)

ParseScopedBlueprintAssignmentID parses 'input' into a ScopedBlueprintAssignmentId

func ParseScopedBlueprintAssignmentIDInsensitively

func ParseScopedBlueprintAssignmentIDInsensitively(input string) (*ScopedBlueprintAssignmentId, error)

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

func (*ScopedBlueprintAssignmentId) FromParseResult

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

func (ScopedBlueprintAssignmentId) ID

ID returns the formatted Scoped Blueprint Assignment ID

func (ScopedBlueprintAssignmentId) Segments

Segments returns a slice of Resource ID Segments which comprise this Scoped Blueprint Assignment ID

func (ScopedBlueprintAssignmentId) String

func (id ScopedBlueprintAssignmentId) String() string

String returns a human-readable description of this Scoped Blueprint Assignment ID

Jump to

Keyboard shortcuts

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