schemaregistries

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: 15 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/deviceregistry/2024-09-01-preview/schemaregistries Documentation

The schemaregistries SDK allows for interaction with Azure Resource Manager deviceregistry (API Version 2024-09-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/deviceregistry/2024-09-01-preview/schemaregistries"

Client Initialization

client := schemaregistries.NewSchemaRegistriesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SchemaRegistriesClient.CreateOrReplace

ctx := context.TODO()
id := schemaregistries.NewSchemaRegistryID("12345678-1234-9876-4563-123456789012", "example-resource-group", "schemaRegistryName")

payload := schemaregistries.SchemaRegistry{
	// ...
}


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

Example Usage: SchemaRegistriesClient.Delete

ctx := context.TODO()
id := schemaregistries.NewSchemaRegistryID("12345678-1234-9876-4563-123456789012", "example-resource-group", "schemaRegistryName")

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

Example Usage: SchemaRegistriesClient.Get

ctx := context.TODO()
id := schemaregistries.NewSchemaRegistryID("12345678-1234-9876-4563-123456789012", "example-resource-group", "schemaRegistryName")

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: SchemaRegistriesClient.ListByResourceGroup

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

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

Example Usage: SchemaRegistriesClient.ListBySubscription

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: SchemaRegistriesClient.Update

ctx := context.TODO()
id := schemaregistries.NewSchemaRegistryID("12345678-1234-9876-4563-123456789012", "example-resource-group", "schemaRegistryName")

payload := schemaregistries.SchemaRegistryUpdate{
	// ...
}


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 PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateSchemaRegistryID 

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

ValidateSchemaRegistryID checks that 'input' can be parsed as a Schema Registry ID

Types

type CreateOrReplaceOperationResponse 

type CreateOrReplaceOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SchemaRegistry
}

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        *SchemaRegistry
}

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SchemaRegistry
}

type ListByResourceGroupCustomPager 

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

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SchemaRegistry
}

type ListBySubscriptionCompleteResult 

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SchemaRegistry
}

type ListBySubscriptionCustomPager 

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

type ListBySubscriptionOperationResponse 

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SchemaRegistry
}

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted  ProvisioningState = "Accepted"
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

func (*ProvisioningState) UnmarshalJSON 

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

type SchemaRegistriesClient 

type SchemaRegistriesClient struct {
	Client *resourcemanager.Client
}

func NewSchemaRegistriesClientWithBaseURI 

func NewSchemaRegistriesClientWithBaseURI(sdkApi sdkEnv.Api) (*SchemaRegistriesClient, error)

func (SchemaRegistriesClient) CreateOrReplace 

func (c SchemaRegistriesClient) CreateOrReplace(ctx context.Context, id SchemaRegistryId, input SchemaRegistry) (result CreateOrReplaceOperationResponse, err error)

CreateOrReplace ...

func (SchemaRegistriesClient) CreateOrReplaceThenPoll 

func (c SchemaRegistriesClient) CreateOrReplaceThenPoll(ctx context.Context, id SchemaRegistryId, input SchemaRegistry) error

CreateOrReplaceThenPoll performs CreateOrReplace then polls until it's completed

func (SchemaRegistriesClient) Delete 

func (c SchemaRegistriesClient) Delete(ctx context.Context, id SchemaRegistryId) (result DeleteOperationResponse, err error)

Delete ...

func (SchemaRegistriesClient) DeleteThenPoll 

func (c SchemaRegistriesClient) DeleteThenPoll(ctx context.Context, id SchemaRegistryId) error

DeleteThenPoll performs Delete then polls until it's completed

func (SchemaRegistriesClient) Get 

func (c SchemaRegistriesClient) Get(ctx context.Context, id SchemaRegistryId) (result GetOperationResponse, err error)

Get ...

func (SchemaRegistriesClient) ListByResourceGroup 

func (c SchemaRegistriesClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (SchemaRegistriesClient) ListByResourceGroupComplete 

func (c SchemaRegistriesClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (SchemaRegistriesClient) ListByResourceGroupCompleteMatchingPredicate 

func (c SchemaRegistriesClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate SchemaRegistryOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SchemaRegistriesClient) ListBySubscription 

func (c SchemaRegistriesClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (SchemaRegistriesClient) ListBySubscriptionComplete 

func (c SchemaRegistriesClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (SchemaRegistriesClient) ListBySubscriptionCompleteMatchingPredicate 

func (c SchemaRegistriesClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate SchemaRegistryOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SchemaRegistriesClient) Update 

func (c SchemaRegistriesClient) Update(ctx context.Context, id SchemaRegistryId, input SchemaRegistryUpdate) (result UpdateOperationResponse, err error)

Update ...

func (SchemaRegistriesClient) UpdateThenPoll 

func (c SchemaRegistriesClient) UpdateThenPoll(ctx context.Context, id SchemaRegistryId, input SchemaRegistryUpdate) error

UpdateThenPoll performs Update then polls until it's completed

type SchemaRegistry 

type SchemaRegistry struct {
	Id         *string                   `json:"id,omitempty"`
	Identity   *identity.SystemAssigned  `json:"identity,omitempty"`
	Location   string                    `json:"location"`
	Name       *string                   `json:"name,omitempty"`
	Properties *SchemaRegistryProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData    `json:"systemData,omitempty"`
	Tags       *map[string]string        `json:"tags,omitempty"`
	Type       *string                   `json:"type,omitempty"`
}

type SchemaRegistryId 

type SchemaRegistryId struct {
	SubscriptionId     string
	ResourceGroupName  string
	SchemaRegistryName string
}

SchemaRegistryId is a struct representing the Resource ID for a Schema Registry

func NewSchemaRegistryID 

func NewSchemaRegistryID(subscriptionId string, resourceGroupName string, schemaRegistryName string) SchemaRegistryId

NewSchemaRegistryID returns a new SchemaRegistryId struct

func ParseSchemaRegistryID 

func ParseSchemaRegistryID(input string) (*SchemaRegistryId, error)

ParseSchemaRegistryID parses 'input' into a SchemaRegistryId

func ParseSchemaRegistryIDInsensitively 

func ParseSchemaRegistryIDInsensitively(input string) (*SchemaRegistryId, error)

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

func (*SchemaRegistryId) FromParseResult 

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

func (SchemaRegistryId) ID 

func (id SchemaRegistryId) ID() string

ID returns the formatted Schema Registry ID

func (SchemaRegistryId) Segments 

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

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

func (SchemaRegistryId) String 

func (id SchemaRegistryId) String() string

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

type SchemaRegistryOperationPredicate 

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

func (SchemaRegistryOperationPredicate) Matches 

func (p SchemaRegistryOperationPredicate) Matches(input SchemaRegistry) bool

type SchemaRegistryProperties 

type SchemaRegistryProperties struct {
	Description                *string            `json:"description,omitempty"`
	DisplayName                *string            `json:"displayName,omitempty"`
	Namespace                  string             `json:"namespace"`
	ProvisioningState          *ProvisioningState `json:"provisioningState,omitempty"`
	StorageAccountContainerURL string             `json:"storageAccountContainerUrl"`
	Uuid                       *string            `json:"uuid,omitempty"`
}

type SchemaRegistryUpdate 

type SchemaRegistryUpdate struct {
	Identity   *identity.SystemAssigned        `json:"identity,omitempty"`
	Properties *SchemaRegistryUpdateProperties `json:"properties,omitempty"`
	Tags       *map[string]string              `json:"tags,omitempty"`
}

type SchemaRegistryUpdateProperties 

type SchemaRegistryUpdateProperties struct {
	Description *string `json:"description,omitempty"`
	DisplayName *string `json:"displayName,omitempty"`
}

type UpdateOperationResponse 

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

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.