connectedregistries

package
v0.20230807.1063129 Latest Latest
Warning

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

 Go to latest Published: Aug 7, 2023 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/containerregistry/2021-08-01-preview/connectedregistries Documentation

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

Client Initialization

client := connectedregistries.NewConnectedRegistriesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ConnectedRegistriesClient.Create

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

payload := connectedregistries.ConnectedRegistry{
	// ...
}


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

Example Usage: ConnectedRegistriesClient.Deactivate

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

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

Example Usage: ConnectedRegistriesClient.Delete

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

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

Example Usage: ConnectedRegistriesClient.Get

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

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

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

// alternatively `client.List(ctx, id, connectedregistries.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, connectedregistries.DefaultListOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ConnectedRegistriesClient.Update

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

payload := connectedregistries.ConnectedRegistryUpdateParameters{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForActivationStatus 

func PossibleValuesForActivationStatus() []string

func PossibleValuesForAuditLogStatus 

func PossibleValuesForAuditLogStatus() []string

func PossibleValuesForCertificateType 

func PossibleValuesForCertificateType() []string

func PossibleValuesForConnectedRegistryMode 

func PossibleValuesForConnectedRegistryMode() []string

func PossibleValuesForConnectionState 

func PossibleValuesForConnectionState() []string

func PossibleValuesForLogLevel 

func PossibleValuesForLogLevel() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForTlsStatus 

func PossibleValuesForTlsStatus() []string

func ValidateConnectedRegistryID 

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

ValidateConnectedRegistryID checks that 'input' can be parsed as a Connected Registry 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 ActivationProperties 

type ActivationProperties struct {
	Status *ActivationStatus `json:"status,omitempty"`
}

type ActivationStatus 

type ActivationStatus string
const (
	ActivationStatusActive   ActivationStatus = "Active"
	ActivationStatusInactive ActivationStatus = "Inactive"
)

func (*ActivationStatus) UnmarshalJSON added in v0.20230406.1124617 

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

type AuditLogStatus 

type AuditLogStatus string
const (
	AuditLogStatusDisabled AuditLogStatus = "Disabled"
	AuditLogStatusEnabled  AuditLogStatus = "Enabled"
)

func (*AuditLogStatus) UnmarshalJSON added in v0.20230406.1124617 

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

type CertificateType 

type CertificateType string
const (
	CertificateTypeLocalDirectory CertificateType = "LocalDirectory"
)

func (*CertificateType) UnmarshalJSON added in v0.20230406.1124617 

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

type ConnectedRegistriesClient 

type ConnectedRegistriesClient struct {
	Client *resourcemanager.Client
}

func NewConnectedRegistriesClientWithBaseURI 

func NewConnectedRegistriesClientWithBaseURI(sdkApi sdkEnv.Api) (*ConnectedRegistriesClient, error)

func (ConnectedRegistriesClient) Create 

func (c ConnectedRegistriesClient) Create(ctx context.Context, id ConnectedRegistryId, input ConnectedRegistry) (result CreateOperationResponse, err error)

Create ...

func (ConnectedRegistriesClient) CreateThenPoll 

func (c ConnectedRegistriesClient) CreateThenPoll(ctx context.Context, id ConnectedRegistryId, input ConnectedRegistry) error

CreateThenPoll performs Create then polls until it's completed

func (ConnectedRegistriesClient) Deactivate 

func (c ConnectedRegistriesClient) Deactivate(ctx context.Context, id ConnectedRegistryId) (result DeactivateOperationResponse, err error)

Deactivate ...

func (ConnectedRegistriesClient) DeactivateThenPoll 

func (c ConnectedRegistriesClient) DeactivateThenPoll(ctx context.Context, id ConnectedRegistryId) error

DeactivateThenPoll performs Deactivate then polls until it's completed

func (ConnectedRegistriesClient) Delete 

func (c ConnectedRegistriesClient) Delete(ctx context.Context, id ConnectedRegistryId) (result DeleteOperationResponse, err error)

Delete ...

func (ConnectedRegistriesClient) DeleteThenPoll 

func (c ConnectedRegistriesClient) DeleteThenPoll(ctx context.Context, id ConnectedRegistryId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ConnectedRegistriesClient) Get 

func (c ConnectedRegistriesClient) Get(ctx context.Context, id ConnectedRegistryId) (result GetOperationResponse, err error)

Get ...

func (ConnectedRegistriesClient) List 

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

List ...

func (ConnectedRegistriesClient) ListComplete 

func (c ConnectedRegistriesClient) ListComplete(ctx context.Context, id RegistryId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (ConnectedRegistriesClient) ListCompleteMatchingPredicate 

func (c ConnectedRegistriesClient) ListCompleteMatchingPredicate(ctx context.Context, id RegistryId, options ListOperationOptions, predicate ConnectedRegistryOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ConnectedRegistriesClient) Update 

func (c ConnectedRegistriesClient) Update(ctx context.Context, id ConnectedRegistryId, input ConnectedRegistryUpdateParameters) (result UpdateOperationResponse, err error)

Update ...

func (ConnectedRegistriesClient) UpdateThenPoll 

func (c ConnectedRegistriesClient) UpdateThenPoll(ctx context.Context, id ConnectedRegistryId, input ConnectedRegistryUpdateParameters) error

UpdateThenPoll performs Update then polls until it's completed

type ConnectedRegistry 

type ConnectedRegistry struct {
	Id         *string                      `json:"id,omitempty"`
	Name       *string                      `json:"name,omitempty"`
	Properties *ConnectedRegistryProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData       `json:"systemData,omitempty"`
	Type       *string                      `json:"type,omitempty"`
}

type ConnectedRegistryId 

type ConnectedRegistryId struct {
	SubscriptionId        string
	ResourceGroupName     string
	RegistryName          string
	ConnectedRegistryName string
}

ConnectedRegistryId is a struct representing the Resource ID for a Connected Registry

func NewConnectedRegistryID 

func NewConnectedRegistryID(subscriptionId string, resourceGroupName string, registryName string, connectedRegistryName string) ConnectedRegistryId

NewConnectedRegistryID returns a new ConnectedRegistryId struct

func ParseConnectedRegistryID 

func ParseConnectedRegistryID(input string) (*ConnectedRegistryId, error)

ParseConnectedRegistryID parses 'input' into a ConnectedRegistryId

func ParseConnectedRegistryIDInsensitively 

func ParseConnectedRegistryIDInsensitively(input string) (*ConnectedRegistryId, error)

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

func (ConnectedRegistryId) ID 

func (id ConnectedRegistryId) ID() string

ID returns the formatted Connected Registry ID

func (ConnectedRegistryId) Segments 

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

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

func (ConnectedRegistryId) String 

func (id ConnectedRegistryId) String() string

String returns a human-readable description of this Connected Registry ID

type ConnectedRegistryMode 

type ConnectedRegistryMode string
const (
	ConnectedRegistryModeMirror    ConnectedRegistryMode = "Mirror"
	ConnectedRegistryModeReadOnly  ConnectedRegistryMode = "ReadOnly"
	ConnectedRegistryModeReadWrite ConnectedRegistryMode = "ReadWrite"
	ConnectedRegistryModeRegistry  ConnectedRegistryMode = "Registry"
)

func (*ConnectedRegistryMode) UnmarshalJSON added in v0.20230406.1124617 

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

type ConnectedRegistryOperationPredicate 

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

func (ConnectedRegistryOperationPredicate) Matches 

func (p ConnectedRegistryOperationPredicate) Matches(input ConnectedRegistry) bool

type ConnectedRegistryProperties 

type ConnectedRegistryProperties struct {
	Activation        *ActivationProperties     `json:"activation,omitempty"`
	ClientTokenIds    *[]string                 `json:"clientTokenIds,omitempty"`
	ConnectionState   *ConnectionState          `json:"connectionState,omitempty"`
	LastActivityTime  *string                   `json:"lastActivityTime,omitempty"`
	Logging           *LoggingProperties        `json:"logging,omitempty"`
	LoginServer       *LoginServerProperties    `json:"loginServer,omitempty"`
	Mode              ConnectedRegistryMode     `json:"mode"`
	NotificationsList *[]string                 `json:"notificationsList,omitempty"`
	Parent            ParentProperties          `json:"parent"`
	ProvisioningState *ProvisioningState        `json:"provisioningState,omitempty"`
	StatusDetails     *[]StatusDetailProperties `json:"statusDetails,omitempty"`
	Version           *string                   `json:"version,omitempty"`
}

func (*ConnectedRegistryProperties) GetLastActivityTimeAsTime 

func (o *ConnectedRegistryProperties) GetLastActivityTimeAsTime() (*time.Time, error)

func (*ConnectedRegistryProperties) SetLastActivityTimeAsTime 

func (o *ConnectedRegistryProperties) SetLastActivityTimeAsTime(input time.Time)

type ConnectedRegistryUpdateParameters 

type ConnectedRegistryUpdateParameters struct {
	Properties *ConnectedRegistryUpdateProperties `json:"properties,omitempty"`
}

type ConnectedRegistryUpdateProperties 

type ConnectedRegistryUpdateProperties struct {
	ClientTokenIds    *[]string             `json:"clientTokenIds,omitempty"`
	Logging           *LoggingProperties    `json:"logging,omitempty"`
	NotificationsList *[]string             `json:"notificationsList,omitempty"`
	SyncProperties    *SyncUpdateProperties `json:"syncProperties,omitempty"`
}

type ConnectionState 

type ConnectionState string
const (
	ConnectionStateOffline   ConnectionState = "Offline"
	ConnectionStateOnline    ConnectionState = "Online"
	ConnectionStateSyncing   ConnectionState = "Syncing"
	ConnectionStateUnhealthy ConnectionState = "Unhealthy"
)

func (*ConnectionState) UnmarshalJSON added in v0.20230406.1124617 

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

type CreateOperationResponse 

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

type DeactivateOperationResponse 

type DeactivateOperationResponse 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        *ConnectedRegistry
}

type ListCompleteResult 

type ListCompleteResult struct {
	Items []ConnectedRegistry
}

type ListOperationOptions 

type ListOperationOptions struct {
	Filter *string
}

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        *[]ConnectedRegistry
}

type LogLevel 

type LogLevel string
const (
	LogLevelDebug       LogLevel = "Debug"
	LogLevelError       LogLevel = "Error"
	LogLevelInformation LogLevel = "Information"
	LogLevelNone        LogLevel = "None"
	LogLevelWarning     LogLevel = "Warning"
)

func (*LogLevel) UnmarshalJSON added in v0.20230406.1124617 

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

type LoggingProperties 

type LoggingProperties struct {
	AuditLogStatus *AuditLogStatus `json:"auditLogStatus,omitempty"`
	LogLevel       *LogLevel       `json:"logLevel,omitempty"`
}

type LoginServerProperties 

type LoginServerProperties struct {
	Host *string        `json:"host,omitempty"`
	Tls  *TlsProperties `json:"tls,omitempty"`
}

type ParentProperties 

type ParentProperties struct {
	Id             *string        `json:"id,omitempty"`
	SyncProperties SyncProperties `json:"syncProperties"`
}

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 added in v0.20230406.1124617 

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

type StatusDetailProperties 

type StatusDetailProperties struct {
	Code          *string `json:"code,omitempty"`
	CorrelationId *string `json:"correlationId,omitempty"`
	Description   *string `json:"description,omitempty"`
	Timestamp     *string `json:"timestamp,omitempty"`
	Type          *string `json:"type,omitempty"`
}

func (*StatusDetailProperties) GetTimestampAsTime 

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

func (*StatusDetailProperties) SetTimestampAsTime 

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

type SyncProperties 

type SyncProperties struct {
	GatewayEndpoint *string `json:"gatewayEndpoint,omitempty"`
	LastSyncTime    *string `json:"lastSyncTime,omitempty"`
	MessageTtl      string  `json:"messageTtl"`
	Schedule        *string `json:"schedule,omitempty"`
	SyncWindow      *string `json:"syncWindow,omitempty"`
	TokenId         string  `json:"tokenId"`
}

func (*SyncProperties) GetLastSyncTimeAsTime 

func (o *SyncProperties) GetLastSyncTimeAsTime() (*time.Time, error)

func (*SyncProperties) SetLastSyncTimeAsTime 

func (o *SyncProperties) SetLastSyncTimeAsTime(input time.Time)

type SyncUpdateProperties 

type SyncUpdateProperties struct {
	MessageTtl *string `json:"messageTtl,omitempty"`
	Schedule   *string `json:"schedule,omitempty"`
	SyncWindow *string `json:"syncWindow,omitempty"`
}

type TlsCertificateProperties 

type TlsCertificateProperties struct {
	Location *string          `json:"location,omitempty"`
	Type     *CertificateType `json:"type,omitempty"`
}

type TlsProperties 

type TlsProperties struct {
	Certificate *TlsCertificateProperties `json:"certificate,omitempty"`
	Status      *TlsStatus                `json:"status,omitempty"`
}

type TlsStatus 

type TlsStatus string
const (
	TlsStatusDisabled TlsStatus = "Disabled"
	TlsStatusEnabled  TlsStatus = "Enabled"
)

func (*TlsStatus) UnmarshalJSON added in v0.20230406.1124617 

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

type UpdateOperationResponse 

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

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.