daprcomponents

package
v0.20240923.1142107 Latest Latest
Warning

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

 Go to latest Published: Sep 23, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/containerapps/2023-05-01/daprcomponents Documentation

The daprcomponents SDK allows for interaction with Azure Resource Manager containerapps (API Version 2023-05-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/containerapps/2023-05-01/daprcomponents"

Client Initialization

client := daprcomponents.NewDaprComponentsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DaprComponentsClient.ConnectedEnvironmentsDaprComponentsCreateOrUpdate

ctx := context.TODO()
id := daprcomponents.NewConnectedEnvironmentDaprComponentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "connectedEnvironmentName", "componentName")

payload := daprcomponents.DaprComponent{
	// ...
}


read, err := client.ConnectedEnvironmentsDaprComponentsCreateOrUpdate(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DaprComponentsClient.ConnectedEnvironmentsDaprComponentsDelete

ctx := context.TODO()
id := daprcomponents.NewConnectedEnvironmentDaprComponentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "connectedEnvironmentName", "componentName")

read, err := client.ConnectedEnvironmentsDaprComponentsDelete(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DaprComponentsClient.ConnectedEnvironmentsDaprComponentsGet

ctx := context.TODO()
id := daprcomponents.NewConnectedEnvironmentDaprComponentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "connectedEnvironmentName", "componentName")

read, err := client.ConnectedEnvironmentsDaprComponentsGet(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DaprComponentsClient.ConnectedEnvironmentsDaprComponentsList

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

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

Example Usage: DaprComponentsClient.ConnectedEnvironmentsDaprComponentsListSecrets

ctx := context.TODO()
id := daprcomponents.NewConnectedEnvironmentDaprComponentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "connectedEnvironmentName", "componentName")

read, err := client.ConnectedEnvironmentsDaprComponentsListSecrets(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DaprComponentsClient.CreateOrUpdate

ctx := context.TODO()
id := daprcomponents.NewDaprComponentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "environmentName", "componentName")

payload := daprcomponents.DaprComponent{
	// ...
}


read, err := client.CreateOrUpdate(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DaprComponentsClient.Delete

ctx := context.TODO()
id := daprcomponents.NewDaprComponentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "environmentName", "componentName")

read, err := client.Delete(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DaprComponentsClient.Get

ctx := context.TODO()
id := daprcomponents.NewDaprComponentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "environmentName", "componentName")

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

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

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

Example Usage: DaprComponentsClient.ListSecrets

ctx := context.TODO()
id := daprcomponents.NewDaprComponentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "environmentName", "componentName")

read, err := client.ListSecrets(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateConnectedEnvironmentDaprComponentID 

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

ValidateConnectedEnvironmentDaprComponentID checks that 'input' can be parsed as a Connected Environment Dapr Component ID

func ValidateConnectedEnvironmentID 

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

ValidateConnectedEnvironmentID checks that 'input' can be parsed as a Connected Environment ID

func ValidateDaprComponentID 

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

ValidateDaprComponentID checks that 'input' can be parsed as a Dapr Component ID

func ValidateManagedEnvironmentID 

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

ValidateManagedEnvironmentID checks that 'input' can be parsed as a Managed Environment ID

Types

type ConnectedEnvironmentDaprComponentId 

type ConnectedEnvironmentDaprComponentId struct {
	SubscriptionId           string
	ResourceGroupName        string
	ConnectedEnvironmentName string
	DaprComponentName        string
}

ConnectedEnvironmentDaprComponentId is a struct representing the Resource ID for a Connected Environment Dapr Component

func NewConnectedEnvironmentDaprComponentID 

func NewConnectedEnvironmentDaprComponentID(subscriptionId string, resourceGroupName string, connectedEnvironmentName string, daprComponentName string) ConnectedEnvironmentDaprComponentId

NewConnectedEnvironmentDaprComponentID returns a new ConnectedEnvironmentDaprComponentId struct

func ParseConnectedEnvironmentDaprComponentID 

func ParseConnectedEnvironmentDaprComponentID(input string) (*ConnectedEnvironmentDaprComponentId, error)

ParseConnectedEnvironmentDaprComponentID parses 'input' into a ConnectedEnvironmentDaprComponentId

func ParseConnectedEnvironmentDaprComponentIDInsensitively 

func ParseConnectedEnvironmentDaprComponentIDInsensitively(input string) (*ConnectedEnvironmentDaprComponentId, error)

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

func (*ConnectedEnvironmentDaprComponentId) FromParseResult 

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

func (ConnectedEnvironmentDaprComponentId) ID 

func (id ConnectedEnvironmentDaprComponentId) ID() string

ID returns the formatted Connected Environment Dapr Component ID

func (ConnectedEnvironmentDaprComponentId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Connected Environment Dapr Component ID

func (ConnectedEnvironmentDaprComponentId) String 

func (id ConnectedEnvironmentDaprComponentId) String() string

String returns a human-readable description of this Connected Environment Dapr Component ID

type ConnectedEnvironmentId 

type ConnectedEnvironmentId struct {
	SubscriptionId           string
	ResourceGroupName        string
	ConnectedEnvironmentName string
}

ConnectedEnvironmentId is a struct representing the Resource ID for a Connected Environment

func NewConnectedEnvironmentID 

func NewConnectedEnvironmentID(subscriptionId string, resourceGroupName string, connectedEnvironmentName string) ConnectedEnvironmentId

NewConnectedEnvironmentID returns a new ConnectedEnvironmentId struct

func ParseConnectedEnvironmentID 

func ParseConnectedEnvironmentID(input string) (*ConnectedEnvironmentId, error)

ParseConnectedEnvironmentID parses 'input' into a ConnectedEnvironmentId

func ParseConnectedEnvironmentIDInsensitively 

func ParseConnectedEnvironmentIDInsensitively(input string) (*ConnectedEnvironmentId, error)

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

func (*ConnectedEnvironmentId) FromParseResult 

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

func (ConnectedEnvironmentId) ID 

func (id ConnectedEnvironmentId) ID() string

ID returns the formatted Connected Environment ID

func (ConnectedEnvironmentId) Segments 

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

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

func (ConnectedEnvironmentId) String 

func (id ConnectedEnvironmentId) String() string

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

type ConnectedEnvironmentsDaprComponentsCreateOrUpdateOperationResponse 

type ConnectedEnvironmentsDaprComponentsCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DaprComponent
}

type ConnectedEnvironmentsDaprComponentsDeleteOperationResponse 

type ConnectedEnvironmentsDaprComponentsDeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type ConnectedEnvironmentsDaprComponentsGetOperationResponse 

type ConnectedEnvironmentsDaprComponentsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DaprComponent
}

type ConnectedEnvironmentsDaprComponentsListCompleteResult 

type ConnectedEnvironmentsDaprComponentsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DaprComponent
}

type ConnectedEnvironmentsDaprComponentsListCustomPager added in v0.20240628.1153531 

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

type ConnectedEnvironmentsDaprComponentsListOperationResponse 

type ConnectedEnvironmentsDaprComponentsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DaprComponent
}

type ConnectedEnvironmentsDaprComponentsListSecretsOperationResponse 

type ConnectedEnvironmentsDaprComponentsListSecretsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DaprSecretsCollection
}

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DaprComponent
}

type DaprComponent 

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

type DaprComponentId 

type DaprComponentId struct {
	SubscriptionId         string
	ResourceGroupName      string
	ManagedEnvironmentName string
	DaprComponentName      string
}

DaprComponentId is a struct representing the Resource ID for a Dapr Component

func NewDaprComponentID 

func NewDaprComponentID(subscriptionId string, resourceGroupName string, managedEnvironmentName string, daprComponentName string) DaprComponentId

NewDaprComponentID returns a new DaprComponentId struct

func ParseDaprComponentID 

func ParseDaprComponentID(input string) (*DaprComponentId, error)

ParseDaprComponentID parses 'input' into a DaprComponentId

func ParseDaprComponentIDInsensitively 

func ParseDaprComponentIDInsensitively(input string) (*DaprComponentId, error)

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

func (*DaprComponentId) FromParseResult 

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

func (DaprComponentId) ID 

func (id DaprComponentId) ID() string

ID returns the formatted Dapr Component ID

func (DaprComponentId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Dapr Component ID

func (DaprComponentId) String 

func (id DaprComponentId) String() string

String returns a human-readable description of this Dapr Component ID

type DaprComponentOperationPredicate 

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

func (DaprComponentOperationPredicate) Matches 

func (p DaprComponentOperationPredicate) Matches(input DaprComponent) bool

type DaprComponentProperties 

type DaprComponentProperties struct {
	ComponentType        *string         `json:"componentType,omitempty"`
	IgnoreErrors         *bool           `json:"ignoreErrors,omitempty"`
	InitTimeout          *string         `json:"initTimeout,omitempty"`
	Metadata             *[]DaprMetadata `json:"metadata,omitempty"`
	Scopes               *[]string       `json:"scopes,omitempty"`
	SecretStoreComponent *string         `json:"secretStoreComponent,omitempty"`
	Secrets              *[]Secret       `json:"secrets,omitempty"`
	Version              *string         `json:"version,omitempty"`
}

type DaprComponentsClient 

type DaprComponentsClient struct {
	Client *resourcemanager.Client
}

func NewDaprComponentsClientWithBaseURI 

func NewDaprComponentsClientWithBaseURI(sdkApi sdkEnv.Api) (*DaprComponentsClient, error)

func (DaprComponentsClient) ConnectedEnvironmentsDaprComponentsCreateOrUpdate 

func (c DaprComponentsClient) ConnectedEnvironmentsDaprComponentsCreateOrUpdate(ctx context.Context, id ConnectedEnvironmentDaprComponentId, input DaprComponent) (result ConnectedEnvironmentsDaprComponentsCreateOrUpdateOperationResponse, err error)

ConnectedEnvironmentsDaprComponentsCreateOrUpdate ...

func (DaprComponentsClient) ConnectedEnvironmentsDaprComponentsDelete 

func (c DaprComponentsClient) ConnectedEnvironmentsDaprComponentsDelete(ctx context.Context, id ConnectedEnvironmentDaprComponentId) (result ConnectedEnvironmentsDaprComponentsDeleteOperationResponse, err error)

ConnectedEnvironmentsDaprComponentsDelete ...

func (DaprComponentsClient) ConnectedEnvironmentsDaprComponentsGet 

func (c DaprComponentsClient) ConnectedEnvironmentsDaprComponentsGet(ctx context.Context, id ConnectedEnvironmentDaprComponentId) (result ConnectedEnvironmentsDaprComponentsGetOperationResponse, err error)

ConnectedEnvironmentsDaprComponentsGet ...

func (DaprComponentsClient) ConnectedEnvironmentsDaprComponentsList 

func (c DaprComponentsClient) ConnectedEnvironmentsDaprComponentsList(ctx context.Context, id ConnectedEnvironmentId) (result ConnectedEnvironmentsDaprComponentsListOperationResponse, err error)

ConnectedEnvironmentsDaprComponentsList ...

func (DaprComponentsClient) ConnectedEnvironmentsDaprComponentsListComplete 

func (c DaprComponentsClient) ConnectedEnvironmentsDaprComponentsListComplete(ctx context.Context, id ConnectedEnvironmentId) (ConnectedEnvironmentsDaprComponentsListCompleteResult, error)

ConnectedEnvironmentsDaprComponentsListComplete retrieves all the results into a single object

func (DaprComponentsClient) ConnectedEnvironmentsDaprComponentsListCompleteMatchingPredicate 

func (c DaprComponentsClient) ConnectedEnvironmentsDaprComponentsListCompleteMatchingPredicate(ctx context.Context, id ConnectedEnvironmentId, predicate DaprComponentOperationPredicate) (result ConnectedEnvironmentsDaprComponentsListCompleteResult, err error)

ConnectedEnvironmentsDaprComponentsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DaprComponentsClient) ConnectedEnvironmentsDaprComponentsListSecrets 

func (c DaprComponentsClient) ConnectedEnvironmentsDaprComponentsListSecrets(ctx context.Context, id ConnectedEnvironmentDaprComponentId) (result ConnectedEnvironmentsDaprComponentsListSecretsOperationResponse, err error)

ConnectedEnvironmentsDaprComponentsListSecrets ...

func (DaprComponentsClient) CreateOrUpdate 

func (c DaprComponentsClient) CreateOrUpdate(ctx context.Context, id DaprComponentId, input DaprComponent) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (DaprComponentsClient) Delete 

func (c DaprComponentsClient) Delete(ctx context.Context, id DaprComponentId) (result DeleteOperationResponse, err error)

Delete ...

func (DaprComponentsClient) Get 

func (c DaprComponentsClient) Get(ctx context.Context, id DaprComponentId) (result GetOperationResponse, err error)

Get ...

func (DaprComponentsClient) List 

func (c DaprComponentsClient) List(ctx context.Context, id ManagedEnvironmentId) (result ListOperationResponse, err error)

List ...

func (DaprComponentsClient) ListComplete 

func (c DaprComponentsClient) ListComplete(ctx context.Context, id ManagedEnvironmentId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (DaprComponentsClient) ListCompleteMatchingPredicate 

func (c DaprComponentsClient) ListCompleteMatchingPredicate(ctx context.Context, id ManagedEnvironmentId, predicate DaprComponentOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DaprComponentsClient) ListSecrets 

func (c DaprComponentsClient) ListSecrets(ctx context.Context, id DaprComponentId) (result ListSecretsOperationResponse, err error)

ListSecrets ...

type DaprMetadata 

type DaprMetadata struct {
	Name      *string `json:"name,omitempty"`
	SecretRef *string `json:"secretRef,omitempty"`
	Value     *string `json:"value,omitempty"`
}

type DaprSecret 

type DaprSecret struct {
	Name  *string `json:"name,omitempty"`
	Value *string `json:"value,omitempty"`
}

type DaprSecretsCollection 

type DaprSecretsCollection struct {
	Value []DaprSecret `json:"value"`
}

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListCompleteResult 

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

type ListCustomPager added in v0.20240628.1153531 

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

type ListOperationResponse 

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

type ListSecretsOperationResponse 

type ListSecretsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DaprSecretsCollection
}

type ManagedEnvironmentId 

type ManagedEnvironmentId struct {
	SubscriptionId         string
	ResourceGroupName      string
	ManagedEnvironmentName string
}

ManagedEnvironmentId is a struct representing the Resource ID for a Managed Environment

func NewManagedEnvironmentID 

func NewManagedEnvironmentID(subscriptionId string, resourceGroupName string, managedEnvironmentName string) ManagedEnvironmentId

NewManagedEnvironmentID returns a new ManagedEnvironmentId struct

func ParseManagedEnvironmentID 

func ParseManagedEnvironmentID(input string) (*ManagedEnvironmentId, error)

ParseManagedEnvironmentID parses 'input' into a ManagedEnvironmentId

func ParseManagedEnvironmentIDInsensitively 

func ParseManagedEnvironmentIDInsensitively(input string) (*ManagedEnvironmentId, error)

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

func (*ManagedEnvironmentId) FromParseResult 

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

func (ManagedEnvironmentId) ID 

func (id ManagedEnvironmentId) ID() string

ID returns the formatted Managed Environment ID

func (ManagedEnvironmentId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Managed Environment ID

func (ManagedEnvironmentId) String 

func (id ManagedEnvironmentId) String() string

String returns a human-readable description of this Managed Environment ID

type Secret 

type Secret struct {
	Identity    *string `json:"identity,omitempty"`
	KeyVaultUrl *string `json:"keyVaultUrl,omitempty"`
	Name        *string `json:"name,omitempty"`
	Value       *string `json:"value,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.