integrationfabric

package
v0.20250211.1133646 Latest Latest
Warning

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

 Go to latest Published: Feb 11, 2025 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/dashboard/2024-10-01/integrationfabric Documentation

The integrationfabric SDK allows for interaction with Azure Resource Manager dashboard (API Version 2024-10-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/dashboard/2024-10-01/integrationfabric"

Client Initialization

client := integrationfabric.NewIntegrationFabricClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: IntegrationFabricClient.Create

ctx := context.TODO()
id := integrationfabric.NewIntegrationFabricID("12345678-1234-9876-4563-123456789012", "example-resource-group", "grafanaName", "integrationFabricName")

payload := integrationfabric.IntegrationFabric{
	// ...
}


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

Example Usage: IntegrationFabricClient.Delete

ctx := context.TODO()
id := integrationfabric.NewIntegrationFabricID("12345678-1234-9876-4563-123456789012", "example-resource-group", "grafanaName", "integrationFabricName")

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

Example Usage: IntegrationFabricClient.Get

ctx := context.TODO()
id := integrationfabric.NewIntegrationFabricID("12345678-1234-9876-4563-123456789012", "example-resource-group", "grafanaName", "integrationFabricName")

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

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

// 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: IntegrationFabricClient.Update

ctx := context.TODO()
id := integrationfabric.NewIntegrationFabricID("12345678-1234-9876-4563-123456789012", "example-resource-group", "grafanaName", "integrationFabricName")

payload := integrationfabric.IntegrationFabricUpdateParameters{
	// ...
}


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 ValidateGrafanaID 

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

ValidateGrafanaID checks that 'input' can be parsed as a Grafana ID

func ValidateIntegrationFabricID 

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

ValidateIntegrationFabricID checks that 'input' can be parsed as a Integration Fabric ID

Types

type CreateOperationResponse 

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

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

type GrafanaId 

type GrafanaId struct {
	SubscriptionId    string
	ResourceGroupName string
	GrafanaName       string
}

GrafanaId is a struct representing the Resource ID for a Grafana

func NewGrafanaID 

func NewGrafanaID(subscriptionId string, resourceGroupName string, grafanaName string) GrafanaId

NewGrafanaID returns a new GrafanaId struct

func ParseGrafanaID 

func ParseGrafanaID(input string) (*GrafanaId, error)

ParseGrafanaID parses 'input' into a GrafanaId

func ParseGrafanaIDInsensitively 

func ParseGrafanaIDInsensitively(input string) (*GrafanaId, error)

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

func (*GrafanaId) FromParseResult 

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

func (GrafanaId) ID 

func (id GrafanaId) ID() string

ID returns the formatted Grafana ID

func (GrafanaId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Grafana ID

func (GrafanaId) String 

func (id GrafanaId) String() string

String returns a human-readable description of this Grafana ID

type IntegrationFabric 

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

type IntegrationFabricClient 

type IntegrationFabricClient struct {
	Client *resourcemanager.Client
}

func NewIntegrationFabricClientWithBaseURI 

func NewIntegrationFabricClientWithBaseURI(sdkApi sdkEnv.Api) (*IntegrationFabricClient, error)

func (IntegrationFabricClient) Create 

func (c IntegrationFabricClient) Create(ctx context.Context, id IntegrationFabricId, input IntegrationFabric) (result CreateOperationResponse, err error)

Create ...

func (IntegrationFabricClient) CreateThenPoll 

func (c IntegrationFabricClient) CreateThenPoll(ctx context.Context, id IntegrationFabricId, input IntegrationFabric) error

CreateThenPoll performs Create then polls until it's completed

func (IntegrationFabricClient) Delete 

func (c IntegrationFabricClient) Delete(ctx context.Context, id IntegrationFabricId) (result DeleteOperationResponse, err error)

Delete ...

func (IntegrationFabricClient) DeleteThenPoll 

func (c IntegrationFabricClient) DeleteThenPoll(ctx context.Context, id IntegrationFabricId) error

DeleteThenPoll performs Delete then polls until it's completed

func (IntegrationFabricClient) Get 

func (c IntegrationFabricClient) Get(ctx context.Context, id IntegrationFabricId) (result GetOperationResponse, err error)

Get ...

func (IntegrationFabricClient) List 

func (c IntegrationFabricClient) List(ctx context.Context, id GrafanaId) (result ListOperationResponse, err error)

List ...

func (IntegrationFabricClient) ListComplete 

func (c IntegrationFabricClient) ListComplete(ctx context.Context, id GrafanaId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (IntegrationFabricClient) ListCompleteMatchingPredicate 

func (c IntegrationFabricClient) ListCompleteMatchingPredicate(ctx context.Context, id GrafanaId, predicate IntegrationFabricOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (IntegrationFabricClient) Update 

func (c IntegrationFabricClient) Update(ctx context.Context, id IntegrationFabricId, input IntegrationFabricUpdateParameters) (result UpdateOperationResponse, err error)

Update ...

func (IntegrationFabricClient) UpdateThenPoll 

func (c IntegrationFabricClient) UpdateThenPoll(ctx context.Context, id IntegrationFabricId, input IntegrationFabricUpdateParameters) error

UpdateThenPoll performs Update then polls until it's completed

type IntegrationFabricId 

type IntegrationFabricId struct {
	SubscriptionId        string
	ResourceGroupName     string
	GrafanaName           string
	IntegrationFabricName string
}

IntegrationFabricId is a struct representing the Resource ID for a Integration Fabric

func NewIntegrationFabricID 

func NewIntegrationFabricID(subscriptionId string, resourceGroupName string, grafanaName string, integrationFabricName string) IntegrationFabricId

NewIntegrationFabricID returns a new IntegrationFabricId struct

func ParseIntegrationFabricID 

func ParseIntegrationFabricID(input string) (*IntegrationFabricId, error)

ParseIntegrationFabricID parses 'input' into a IntegrationFabricId

func ParseIntegrationFabricIDInsensitively 

func ParseIntegrationFabricIDInsensitively(input string) (*IntegrationFabricId, error)

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

func (*IntegrationFabricId) FromParseResult 

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

func (IntegrationFabricId) ID 

func (id IntegrationFabricId) ID() string

ID returns the formatted Integration Fabric ID

func (IntegrationFabricId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Integration Fabric ID

func (IntegrationFabricId) String 

func (id IntegrationFabricId) String() string

String returns a human-readable description of this Integration Fabric ID

type IntegrationFabricOperationPredicate 

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

func (IntegrationFabricOperationPredicate) Matches 

func (p IntegrationFabricOperationPredicate) Matches(input IntegrationFabric) bool

type IntegrationFabricProperties 

type IntegrationFabricProperties struct {
	DataSourceResourceId *string            `json:"dataSourceResourceId,omitempty"`
	ProvisioningState    *ProvisioningState `json:"provisioningState,omitempty"`
	Scenarios            *[]string          `json:"scenarios,omitempty"`
	TargetResourceId     *string            `json:"targetResourceId,omitempty"`
}

type IntegrationFabricPropertiesUpdateParameters 

type IntegrationFabricPropertiesUpdateParameters struct {
	Scenarios *[]string `json:"scenarios,omitempty"`
}

type IntegrationFabricUpdateParameters 

type IntegrationFabricUpdateParameters struct {
	Properties *IntegrationFabricPropertiesUpdateParameters `json:"properties,omitempty"`
	Tags       *map[string]string                           `json:"tags,omitempty"`
}

type ListCompleteResult 

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

type ListCustomPager 

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

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted     ProvisioningState = "Accepted"
	ProvisioningStateCanceled     ProvisioningState = "Canceled"
	ProvisioningStateCreating     ProvisioningState = "Creating"
	ProvisioningStateDeleted      ProvisioningState = "Deleted"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateNotSpecified ProvisioningState = "NotSpecified"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
	ProvisioningStateUpdating     ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

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

type UpdateOperationResponse 

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

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.