package
0.20240715.1103416
Repository: https://github.com/hashicorp/go-azure-sdk.git
Documentation: pkg.go.dev

# README

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

The daprcomponents SDK allows for interaction with the Azure Resource Manager Service 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", "connectedEnvironmentValue", "daprComponentValue")

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", "connectedEnvironmentValue", "daprComponentValue")

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", "connectedEnvironmentValue", "daprComponentValue")

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", "connectedEnvironmentValue")

// 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", "connectedEnvironmentValue", "daprComponentValue")

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", "managedEnvironmentValue", "daprComponentValue")

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", "managedEnvironmentValue", "daprComponentValue")

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", "managedEnvironmentValue", "daprComponentValue")

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", "managedEnvironmentValue")

// 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", "managedEnvironmentValue", "daprComponentValue")

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
}

# Functions

NewConnectedEnvironmentDaprComponentID returns a new ConnectedEnvironmentDaprComponentId struct.
NewConnectedEnvironmentID returns a new ConnectedEnvironmentId struct.
NewDaprComponentID returns a new DaprComponentId struct.
No description provided by the author
NewManagedEnvironmentID returns a new ManagedEnvironmentId struct.
ParseConnectedEnvironmentDaprComponentID parses 'input' into a ConnectedEnvironmentDaprComponentId.
ParseConnectedEnvironmentDaprComponentIDInsensitively parses 'input' case-insensitively into a ConnectedEnvironmentDaprComponentId note: this method should only be used for API response data and not user input.
ParseConnectedEnvironmentID parses 'input' into a ConnectedEnvironmentId.
ParseConnectedEnvironmentIDInsensitively parses 'input' case-insensitively into a ConnectedEnvironmentId note: this method should only be used for API response data and not user input.
ParseDaprComponentID parses 'input' into a DaprComponentId.
ParseDaprComponentIDInsensitively parses 'input' case-insensitively into a DaprComponentId note: this method should only be used for API response data and not user input.
ParseManagedEnvironmentID parses 'input' into a ManagedEnvironmentId.
ParseManagedEnvironmentIDInsensitively parses 'input' case-insensitively into a ManagedEnvironmentId note: this method should only be used for API response data and not user input.
ValidateConnectedEnvironmentDaprComponentID checks that 'input' can be parsed as a Connected Environment Dapr Component ID.
ValidateConnectedEnvironmentID checks that 'input' can be parsed as a Connected Environment ID.
ValidateDaprComponentID checks that 'input' can be parsed as a Dapr Component ID.
ValidateManagedEnvironmentID checks that 'input' can be parsed as a Managed Environment ID.

# Structs

ConnectedEnvironmentDaprComponentId is a struct representing the Resource ID for a Connected Environment Dapr Component.
ConnectedEnvironmentId is a struct representing the Resource ID for a Connected Environment.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DaprComponentId is a struct representing the Resource ID for a Dapr Component.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ManagedEnvironmentId is a struct representing the Resource ID for a Managed Environment.
No description provided by the author