exportpipelines

package
v0.20231018.1171511 Latest Latest
Warning

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

 Go to latest Published: Oct 18, 2023 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/containerregistry/2023-06-01-preview/exportpipelines Documentation

The exportpipelines SDK allows for interaction with the Azure Resource Manager Service containerregistry (API Version 2023-06-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/containerregistry/2023-06-01-preview/exportpipelines"

Client Initialization

client := exportpipelines.NewExportPipelinesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ExportPipelinesClient.Create

ctx := context.TODO()
id := exportpipelines.NewExportPipelineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryValue", "exportPipelineValue")

payload := exportpipelines.ExportPipeline{
	// ...
}


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

Example Usage: ExportPipelinesClient.Delete

ctx := context.TODO()
id := exportpipelines.NewExportPipelineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryValue", "exportPipelineValue")

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

Example Usage: ExportPipelinesClient.Get

ctx := context.TODO()
id := exportpipelines.NewExportPipelineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryValue", "exportPipelineValue")

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

ctx := context.TODO()
id := exportpipelines.NewRegistryID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryValue")

// 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 PossibleValuesForPipelineOptions 

func PossibleValuesForPipelineOptions() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateExportPipelineID 

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

ValidateExportPipelineID checks that 'input' can be parsed as a Export Pipeline ID

func ValidateRegistryID 

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

ValidateRegistryID checks that 'input' can be parsed as a Registry ID

Types

type CreateOperationResponse 

type CreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type ExportPipeline 

type ExportPipeline struct {
	Id         *string                            `json:"id,omitempty"`
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   *string                            `json:"location,omitempty"`
	Name       *string                            `json:"name,omitempty"`
	Properties *ExportPipelineProperties          `json:"properties,omitempty"`
	SystemData *systemdata.SystemData             `json:"systemData,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

type ExportPipelineId 

type ExportPipelineId struct {
	SubscriptionId     string
	ResourceGroupName  string
	RegistryName       string
	ExportPipelineName string
}

ExportPipelineId is a struct representing the Resource ID for a Export Pipeline

func NewExportPipelineID 

func NewExportPipelineID(subscriptionId string, resourceGroupName string, registryName string, exportPipelineName string) ExportPipelineId

NewExportPipelineID returns a new ExportPipelineId struct

func ParseExportPipelineID 

func ParseExportPipelineID(input string) (*ExportPipelineId, error)

ParseExportPipelineID parses 'input' into a ExportPipelineId

func ParseExportPipelineIDInsensitively 

func ParseExportPipelineIDInsensitively(input string) (*ExportPipelineId, error)

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

func (ExportPipelineId) ID 

func (id ExportPipelineId) ID() string

ID returns the formatted Export Pipeline ID

func (ExportPipelineId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Export Pipeline ID

func (ExportPipelineId) String 

func (id ExportPipelineId) String() string

String returns a human-readable description of this Export Pipeline ID

type ExportPipelineOperationPredicate 

type ExportPipelineOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (ExportPipelineOperationPredicate) Matches 

func (p ExportPipelineOperationPredicate) Matches(input ExportPipeline) bool

type ExportPipelineProperties 

type ExportPipelineProperties struct {
	Options           *[]PipelineOptions             `json:"options,omitempty"`
	ProvisioningState *ProvisioningState             `json:"provisioningState,omitempty"`
	Target            ExportPipelineTargetProperties `json:"target"`
}

type ExportPipelineTargetProperties 

type ExportPipelineTargetProperties struct {
	KeyVaultUri string  `json:"keyVaultUri"`
	Type        *string `json:"type,omitempty"`
	Uri         *string `json:"uri,omitempty"`
}

type ExportPipelinesClient 

type ExportPipelinesClient struct {
	Client *resourcemanager.Client
}

func NewExportPipelinesClientWithBaseURI 

func NewExportPipelinesClientWithBaseURI(sdkApi sdkEnv.Api) (*ExportPipelinesClient, error)

func (ExportPipelinesClient) Create 

func (c ExportPipelinesClient) Create(ctx context.Context, id ExportPipelineId, input ExportPipeline) (result CreateOperationResponse, err error)

Create ...

func (ExportPipelinesClient) CreateThenPoll 

func (c ExportPipelinesClient) CreateThenPoll(ctx context.Context, id ExportPipelineId, input ExportPipeline) error

CreateThenPoll performs Create then polls until it's completed

func (ExportPipelinesClient) Delete 

func (c ExportPipelinesClient) Delete(ctx context.Context, id ExportPipelineId) (result DeleteOperationResponse, err error)

Delete ...

func (ExportPipelinesClient) DeleteThenPoll 

func (c ExportPipelinesClient) DeleteThenPoll(ctx context.Context, id ExportPipelineId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ExportPipelinesClient) Get 

func (c ExportPipelinesClient) Get(ctx context.Context, id ExportPipelineId) (result GetOperationResponse, err error)

Get ...

func (ExportPipelinesClient) List 

func (c ExportPipelinesClient) List(ctx context.Context, id RegistryId) (result ListOperationResponse, err error)

List ...

func (ExportPipelinesClient) ListComplete 

func (c ExportPipelinesClient) ListComplete(ctx context.Context, id RegistryId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (ExportPipelinesClient) ListCompleteMatchingPredicate 

func (c ExportPipelinesClient) ListCompleteMatchingPredicate(ctx context.Context, id RegistryId, predicate ExportPipelineOperationPredicate) (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        *ExportPipeline
}

type ListCompleteResult 

type ListCompleteResult struct {
	Items []ExportPipeline
}

type ListOperationResponse 

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

type PipelineOptions 

type PipelineOptions string
const (
	PipelineOptionsContinueOnErrors          PipelineOptions = "ContinueOnErrors"
	PipelineOptionsDeleteSourceBlobOnSuccess PipelineOptions = "DeleteSourceBlobOnSuccess"
	PipelineOptionsOverwriteBlobs            PipelineOptions = "OverwriteBlobs"
	PipelineOptionsOverwriteTags             PipelineOptions = "OverwriteTags"
)

func (*PipelineOptions) UnmarshalJSON 

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

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

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

type RegistryId 

type RegistryId struct {
	SubscriptionId    string
	ResourceGroupName string
	RegistryName      string
}

RegistryId is a struct representing the Resource ID for a Registry

func NewRegistryID 

func NewRegistryID(subscriptionId string, resourceGroupName string, registryName string) RegistryId

NewRegistryID returns a new RegistryId struct

func ParseRegistryID 

func ParseRegistryID(input string) (*RegistryId, error)

ParseRegistryID parses 'input' into a RegistryId

func ParseRegistryIDInsensitively 

func ParseRegistryIDInsensitively(input string) (*RegistryId, error)

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

func (RegistryId) ID 

func (id RegistryId) ID() string

ID returns the formatted Registry ID

func (RegistryId) Segments 

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

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

func (RegistryId) String 

func (id RegistryId) String() string

String returns a human-readable description of this Registry ID

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.