deploymentoperations

package
v0.20241209.1115630 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/resources/2015-11-01/deploymentoperations Documentation

The deploymentoperations SDK allows for interaction with Azure Resource Manager resources (API Version 2015-11-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/resources/2015-11-01/deploymentoperations"

Client Initialization

client := deploymentoperations.NewDeploymentOperationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DeploymentOperationsClient.Get

ctx := context.TODO()
id := deploymentoperations.NewOperationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "deploymentName", "operationId")

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

ctx := context.TODO()
id := deploymentoperations.NewDeploymentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "deploymentName")

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

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

ValidateDeploymentID checks that 'input' can be parsed as a Deployment ID

func ValidateOperationID 

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

ValidateOperationID checks that 'input' can be parsed as a Operation ID

Types

type DeploymentId 

type DeploymentId struct {
	SubscriptionId    string
	ResourceGroupName string
	DeploymentName    string
}

DeploymentId is a struct representing the Resource ID for a Deployment

func NewDeploymentID 

func NewDeploymentID(subscriptionId string, resourceGroupName string, deploymentName string) DeploymentId

NewDeploymentID returns a new DeploymentId struct

func ParseDeploymentID 

func ParseDeploymentID(input string) (*DeploymentId, error)

ParseDeploymentID parses 'input' into a DeploymentId

func ParseDeploymentIDInsensitively 

func ParseDeploymentIDInsensitively(input string) (*DeploymentId, error)

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

func (*DeploymentId) FromParseResult 

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

func (DeploymentId) ID 

func (id DeploymentId) ID() string

ID returns the formatted Deployment ID

func (DeploymentId) Segments 

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

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

func (DeploymentId) String 

func (id DeploymentId) String() string

String returns a human-readable description of this Deployment ID

type DeploymentOperation 

type DeploymentOperation struct {
	Id          *string                        `json:"id,omitempty"`
	OperationId *string                        `json:"operationId,omitempty"`
	Properties  *DeploymentOperationProperties `json:"properties,omitempty"`
}

type DeploymentOperationOperationPredicate 

type DeploymentOperationOperationPredicate struct {
	Id          *string
	OperationId *string
}

func (DeploymentOperationOperationPredicate) Matches 

func (p DeploymentOperationOperationPredicate) Matches(input DeploymentOperation) bool

type DeploymentOperationProperties 

type DeploymentOperationProperties struct {
	ProvisioningState *string         `json:"provisioningState,omitempty"`
	StatusCode        *string         `json:"statusCode,omitempty"`
	StatusMessage     *interface{}    `json:"statusMessage,omitempty"`
	TargetResource    *TargetResource `json:"targetResource,omitempty"`
	Timestamp         *string         `json:"timestamp,omitempty"`
}

func (*DeploymentOperationProperties) GetTimestampAsTime 

func (o *DeploymentOperationProperties) GetTimestampAsTime() (*time.Time, error)

func (*DeploymentOperationProperties) SetTimestampAsTime 

func (o *DeploymentOperationProperties) SetTimestampAsTime(input time.Time)

type DeploymentOperationsClient 

type DeploymentOperationsClient struct {
	Client *resourcemanager.Client
}

func NewDeploymentOperationsClientWithBaseURI 

func NewDeploymentOperationsClientWithBaseURI(sdkApi sdkEnv.Api) (*DeploymentOperationsClient, error)

func (DeploymentOperationsClient) Get 

func (c DeploymentOperationsClient) Get(ctx context.Context, id OperationId) (result GetOperationResponse, err error)

Get ...

func (DeploymentOperationsClient) List 

func (c DeploymentOperationsClient) List(ctx context.Context, id DeploymentId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (DeploymentOperationsClient) ListComplete 

func (c DeploymentOperationsClient) ListComplete(ctx context.Context, id DeploymentId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (DeploymentOperationsClient) ListCompleteMatchingPredicate 

func (c DeploymentOperationsClient) ListCompleteMatchingPredicate(ctx context.Context, id DeploymentId, options ListOperationOptions, predicate DeploymentOperationOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GetOperationResponse 

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

type ListCompleteResult 

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

type ListCustomPager added in v0.20240628.1153531 

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

type ListOperationOptions 

type ListOperationOptions struct {
	Top *int64
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders 

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

func (ListOperationOptions) ToOData 

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

func (ListOperationOptions) ToQuery 

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

type ListOperationResponse 

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

type OperationId 

type OperationId struct {
	SubscriptionId    string
	ResourceGroupName string
	DeploymentName    string
	OperationId       string
}

OperationId is a struct representing the Resource ID for a Operation

func NewOperationID 

func NewOperationID(subscriptionId string, resourceGroupName string, deploymentName string, operationId string) OperationId

NewOperationID returns a new OperationId struct

func ParseOperationID 

func ParseOperationID(input string) (*OperationId, error)

ParseOperationID parses 'input' into a OperationId

func ParseOperationIDInsensitively 

func ParseOperationIDInsensitively(input string) (*OperationId, error)

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

func (*OperationId) FromParseResult 

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

func (OperationId) ID 

func (id OperationId) ID() string

ID returns the formatted Operation ID

func (OperationId) Segments 

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

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

func (OperationId) String 

func (id OperationId) String() string

String returns a human-readable description of this Operation ID

type TargetResource 

type TargetResource struct {
	Id           *string `json:"id,omitempty"`
	ResourceName *string `json:"resourceName,omitempty"`
	ResourceType *string `json:"resourceType,omitempty"`
}

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.