importpipelines

package
v0.20231213.1165453 Latest Latest
Warning

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

Go to latest
Published: Dec 13, 2023 License: MPL-2.0 Imports: 13 Imported by: 0

README

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

The importpipelines 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/importpipelines"

Client Initialization

client := importpipelines.NewImportPipelinesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ImportPipelinesClient.Create

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

payload := importpipelines.ImportPipeline{
	// ...
}


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

Example Usage: ImportPipelinesClient.Delete

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

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

Example Usage: ImportPipelinesClient.Get

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

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

ctx := context.TODO()
id := importpipelines.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 PossibleValuesForPipelineSourceType

func PossibleValuesForPipelineSourceType() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func PossibleValuesForTriggerStatus

func PossibleValuesForTriggerStatus() []string

func ValidateImportPipelineID

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

ValidateImportPipelineID checks that 'input' can be parsed as a Import 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 GetOperationResponse

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

type ImportPipeline

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

type ImportPipelineId

type ImportPipelineId struct {
	SubscriptionId     string
	ResourceGroupName  string
	RegistryName       string
	ImportPipelineName string
}

ImportPipelineId is a struct representing the Resource ID for a Import Pipeline

func NewImportPipelineID

func NewImportPipelineID(subscriptionId string, resourceGroupName string, registryName string, importPipelineName string) ImportPipelineId

NewImportPipelineID returns a new ImportPipelineId struct

func ParseImportPipelineID

func ParseImportPipelineID(input string) (*ImportPipelineId, error)

ParseImportPipelineID parses 'input' into a ImportPipelineId

func ParseImportPipelineIDInsensitively

func ParseImportPipelineIDInsensitively(input string) (*ImportPipelineId, error)

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

func (*ImportPipelineId) FromParseResult added in v0.20231127.1171502

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

func (ImportPipelineId) ID

func (id ImportPipelineId) ID() string

ID returns the formatted Import Pipeline ID

func (ImportPipelineId) Segments

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

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

func (ImportPipelineId) String

func (id ImportPipelineId) String() string

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

type ImportPipelineOperationPredicate

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

func (ImportPipelineOperationPredicate) Matches

type ImportPipelineProperties

type ImportPipelineProperties struct {
	Options           *[]PipelineOptions             `json:"options,omitempty"`
	ProvisioningState *ProvisioningState             `json:"provisioningState,omitempty"`
	Source            ImportPipelineSourceProperties `json:"source"`
	Trigger           *PipelineTriggerProperties     `json:"trigger,omitempty"`
}

type ImportPipelineSourceProperties

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

type ImportPipelinesClient

type ImportPipelinesClient struct {
	Client *resourcemanager.Client
}

func NewImportPipelinesClientWithBaseURI

func NewImportPipelinesClientWithBaseURI(sdkApi sdkEnv.Api) (*ImportPipelinesClient, error)

func (ImportPipelinesClient) Create

Create ...

func (ImportPipelinesClient) CreateThenPoll

func (c ImportPipelinesClient) CreateThenPoll(ctx context.Context, id ImportPipelineId, input ImportPipeline) error

CreateThenPoll performs Create then polls until it's completed

func (ImportPipelinesClient) Delete

Delete ...

func (ImportPipelinesClient) DeleteThenPoll

func (c ImportPipelinesClient) DeleteThenPoll(ctx context.Context, id ImportPipelineId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ImportPipelinesClient) Get

Get ...

func (ImportPipelinesClient) List

List ...

func (ImportPipelinesClient) ListComplete

ListComplete retrieves all the results into a single object

func (ImportPipelinesClient) ListCompleteMatchingPredicate

func (c ImportPipelinesClient) ListCompleteMatchingPredicate(ctx context.Context, id RegistryId, predicate ImportPipelineOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ListCompleteResult

type ListCompleteResult struct {
	Items []ImportPipeline
}

type ListOperationResponse

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

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 PipelineSourceTriggerProperties

type PipelineSourceTriggerProperties struct {
	Status TriggerStatus `json:"status"`
}

type PipelineSourceType

type PipelineSourceType string
const (
	PipelineSourceTypeAzureStorageBlobContainer PipelineSourceType = "AzureStorageBlobContainer"
)

func (*PipelineSourceType) UnmarshalJSON

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

type PipelineTriggerProperties

type PipelineTriggerProperties struct {
	SourceTrigger *PipelineSourceTriggerProperties `json:"sourceTrigger,omitempty"`
}

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) FromParseResult added in v0.20231127.1171502

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

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

type TriggerStatus

type TriggerStatus string
const (
	TriggerStatusDisabled TriggerStatus = "Disabled"
	TriggerStatusEnabled  TriggerStatus = "Enabled"
)

func (*TriggerStatus) UnmarshalJSON

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

Jump to

Keyboard shortcuts

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