iotconnectors

package
v0.20241023.1122425 Latest Latest
Warning

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

 Go to latest Published: Oct 23, 2024 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/healthcareapis/2023-12-01/iotconnectors Documentation

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

Client Initialization

client := iotconnectors.NewIotConnectorsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: IotConnectorsClient.CreateOrUpdate

ctx := context.TODO()
id := iotconnectors.NewIotConnectorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "iotConnectorName")

payload := iotconnectors.IotConnector{
	// ...
}


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

Example Usage: IotConnectorsClient.Delete

ctx := context.TODO()
id := iotconnectors.NewIotConnectorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "iotConnectorName")

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

Example Usage: IotConnectorsClient.FhirDestinationsListByIotConnector

ctx := context.TODO()
id := iotconnectors.NewIotConnectorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "iotConnectorName")

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

Example Usage: IotConnectorsClient.Get

ctx := context.TODO()
id := iotconnectors.NewIotConnectorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "iotConnectorName")

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: IotConnectorsClient.IotConnectorFhirDestinationCreateOrUpdate

ctx := context.TODO()
id := iotconnectors.NewFhirDestinationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "iotConnectorName", "fhirDestinationName")

payload := iotconnectors.IotFhirDestination{
	// ...
}


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

Example Usage: IotConnectorsClient.IotConnectorFhirDestinationDelete

ctx := context.TODO()
id := iotconnectors.NewFhirDestinationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "iotConnectorName", "fhirDestinationName")

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

Example Usage: IotConnectorsClient.IotConnectorFhirDestinationGet

ctx := context.TODO()
id := iotconnectors.NewFhirDestinationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "iotConnectorName", "fhirDestinationName")

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

Example Usage: IotConnectorsClient.ListByWorkspace

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

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

Example Usage: IotConnectorsClient.Update

ctx := context.TODO()
id := iotconnectors.NewIotConnectorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "iotConnectorName")

payload := iotconnectors.IotConnectorPatchResource{
	// ...
}


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 PossibleValuesForIotIdentityResolutionType 

func PossibleValuesForIotIdentityResolutionType() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateFhirDestinationID 

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

ValidateFhirDestinationID checks that 'input' can be parsed as a Fhir Destination ID

func ValidateIotConnectorID 

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

ValidateIotConnectorID checks that 'input' can be parsed as a Iot Connector ID

func ValidateWorkspaceID 

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

ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *IotConnector
}

type DeleteOperationResponse 

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

type FhirDestinationId 

type FhirDestinationId struct {
	SubscriptionId      string
	ResourceGroupName   string
	WorkspaceName       string
	IotConnectorName    string
	FhirDestinationName string
}

FhirDestinationId is a struct representing the Resource ID for a Fhir Destination

func NewFhirDestinationID 

func NewFhirDestinationID(subscriptionId string, resourceGroupName string, workspaceName string, iotConnectorName string, fhirDestinationName string) FhirDestinationId

NewFhirDestinationID returns a new FhirDestinationId struct

func ParseFhirDestinationID 

func ParseFhirDestinationID(input string) (*FhirDestinationId, error)

ParseFhirDestinationID parses 'input' into a FhirDestinationId

func ParseFhirDestinationIDInsensitively 

func ParseFhirDestinationIDInsensitively(input string) (*FhirDestinationId, error)

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

func (*FhirDestinationId) FromParseResult 

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

func (FhirDestinationId) ID 

func (id FhirDestinationId) ID() string

ID returns the formatted Fhir Destination ID

func (FhirDestinationId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Fhir Destination ID

func (FhirDestinationId) String 

func (id FhirDestinationId) String() string

String returns a human-readable description of this Fhir Destination ID

type FhirDestinationsListByIotConnectorCompleteResult 

type FhirDestinationsListByIotConnectorCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []IotFhirDestination
}

type FhirDestinationsListByIotConnectorCustomPager added in v0.20240628.1153531 

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

type FhirDestinationsListByIotConnectorOperationResponse 

type FhirDestinationsListByIotConnectorOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]IotFhirDestination
}

type GetOperationResponse 

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

type IotConnector 

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

type IotConnectorFhirDestinationCreateOrUpdateOperationResponse 

type IotConnectorFhirDestinationCreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *IotFhirDestination
}

type IotConnectorFhirDestinationDeleteOperationResponse 

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

type IotConnectorFhirDestinationGetOperationResponse 

type IotConnectorFhirDestinationGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *IotFhirDestination
}

type IotConnectorId 

type IotConnectorId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	IotConnectorName  string
}

IotConnectorId is a struct representing the Resource ID for a Iot Connector

func NewIotConnectorID 

func NewIotConnectorID(subscriptionId string, resourceGroupName string, workspaceName string, iotConnectorName string) IotConnectorId

NewIotConnectorID returns a new IotConnectorId struct

func ParseIotConnectorID 

func ParseIotConnectorID(input string) (*IotConnectorId, error)

ParseIotConnectorID parses 'input' into a IotConnectorId

func ParseIotConnectorIDInsensitively 

func ParseIotConnectorIDInsensitively(input string) (*IotConnectorId, error)

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

func (*IotConnectorId) FromParseResult 

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

func (IotConnectorId) ID 

func (id IotConnectorId) ID() string

ID returns the formatted Iot Connector ID

func (IotConnectorId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Iot Connector ID

func (IotConnectorId) String 

func (id IotConnectorId) String() string

String returns a human-readable description of this Iot Connector ID

type IotConnectorOperationPredicate 

type IotConnectorOperationPredicate struct {
	Etag     *string
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (IotConnectorOperationPredicate) Matches 

func (p IotConnectorOperationPredicate) Matches(input IotConnector) bool

type IotConnectorPatchResource 

type IotConnectorPatchResource struct {
	Identity *identity.LegacySystemAndUserAssignedMap `json:"identity,omitempty"`
	Tags     *map[string]string                       `json:"tags,omitempty"`
}

type IotConnectorProperties 

type IotConnectorProperties struct {
	DeviceMapping                  *IotMappingProperties                      `json:"deviceMapping,omitempty"`
	IngestionEndpointConfiguration *IotEventHubIngestionEndpointConfiguration `json:"ingestionEndpointConfiguration,omitempty"`
	ProvisioningState              *ProvisioningState                         `json:"provisioningState,omitempty"`
}

type IotConnectorsClient 

type IotConnectorsClient struct {
	Client *resourcemanager.Client
}

func NewIotConnectorsClientWithBaseURI 

func NewIotConnectorsClientWithBaseURI(sdkApi sdkEnv.Api) (*IotConnectorsClient, error)

func (IotConnectorsClient) CreateOrUpdate 

func (c IotConnectorsClient) CreateOrUpdate(ctx context.Context, id IotConnectorId, input IotConnector) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (IotConnectorsClient) CreateOrUpdateThenPoll 

func (c IotConnectorsClient) CreateOrUpdateThenPoll(ctx context.Context, id IotConnectorId, input IotConnector) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (IotConnectorsClient) Delete 

func (c IotConnectorsClient) Delete(ctx context.Context, id IotConnectorId) (result DeleteOperationResponse, err error)

Delete ...

func (IotConnectorsClient) DeleteThenPoll 

func (c IotConnectorsClient) DeleteThenPoll(ctx context.Context, id IotConnectorId) error

DeleteThenPoll performs Delete then polls until it's completed

func (IotConnectorsClient) FhirDestinationsListByIotConnector 

func (c IotConnectorsClient) FhirDestinationsListByIotConnector(ctx context.Context, id IotConnectorId) (result FhirDestinationsListByIotConnectorOperationResponse, err error)

FhirDestinationsListByIotConnector ...

func (IotConnectorsClient) FhirDestinationsListByIotConnectorComplete 

func (c IotConnectorsClient) FhirDestinationsListByIotConnectorComplete(ctx context.Context, id IotConnectorId) (FhirDestinationsListByIotConnectorCompleteResult, error)

FhirDestinationsListByIotConnectorComplete retrieves all the results into a single object

func (IotConnectorsClient) FhirDestinationsListByIotConnectorCompleteMatchingPredicate 

func (c IotConnectorsClient) FhirDestinationsListByIotConnectorCompleteMatchingPredicate(ctx context.Context, id IotConnectorId, predicate IotFhirDestinationOperationPredicate) (result FhirDestinationsListByIotConnectorCompleteResult, err error)

FhirDestinationsListByIotConnectorCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (IotConnectorsClient) Get 

func (c IotConnectorsClient) Get(ctx context.Context, id IotConnectorId) (result GetOperationResponse, err error)

Get ...

func (IotConnectorsClient) IotConnectorFhirDestinationCreateOrUpdate 

func (c IotConnectorsClient) IotConnectorFhirDestinationCreateOrUpdate(ctx context.Context, id FhirDestinationId, input IotFhirDestination) (result IotConnectorFhirDestinationCreateOrUpdateOperationResponse, err error)

IotConnectorFhirDestinationCreateOrUpdate ...

func (IotConnectorsClient) IotConnectorFhirDestinationCreateOrUpdateThenPoll 

func (c IotConnectorsClient) IotConnectorFhirDestinationCreateOrUpdateThenPoll(ctx context.Context, id FhirDestinationId, input IotFhirDestination) error

IotConnectorFhirDestinationCreateOrUpdateThenPoll performs IotConnectorFhirDestinationCreateOrUpdate then polls until it's completed

func (IotConnectorsClient) IotConnectorFhirDestinationDelete 

func (c IotConnectorsClient) IotConnectorFhirDestinationDelete(ctx context.Context, id FhirDestinationId) (result IotConnectorFhirDestinationDeleteOperationResponse, err error)

IotConnectorFhirDestinationDelete ...

func (IotConnectorsClient) IotConnectorFhirDestinationDeleteThenPoll 

func (c IotConnectorsClient) IotConnectorFhirDestinationDeleteThenPoll(ctx context.Context, id FhirDestinationId) error

IotConnectorFhirDestinationDeleteThenPoll performs IotConnectorFhirDestinationDelete then polls until it's completed

func (IotConnectorsClient) IotConnectorFhirDestinationGet 

func (c IotConnectorsClient) IotConnectorFhirDestinationGet(ctx context.Context, id FhirDestinationId) (result IotConnectorFhirDestinationGetOperationResponse, err error)

IotConnectorFhirDestinationGet ...

func (IotConnectorsClient) ListByWorkspace 

func (c IotConnectorsClient) ListByWorkspace(ctx context.Context, id WorkspaceId) (result ListByWorkspaceOperationResponse, err error)

ListByWorkspace ...

func (IotConnectorsClient) ListByWorkspaceComplete 

func (c IotConnectorsClient) ListByWorkspaceComplete(ctx context.Context, id WorkspaceId) (ListByWorkspaceCompleteResult, error)

ListByWorkspaceComplete retrieves all the results into a single object

func (IotConnectorsClient) ListByWorkspaceCompleteMatchingPredicate 

func (c IotConnectorsClient) ListByWorkspaceCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, predicate IotConnectorOperationPredicate) (result ListByWorkspaceCompleteResult, err error)

ListByWorkspaceCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (IotConnectorsClient) Update 

func (c IotConnectorsClient) Update(ctx context.Context, id IotConnectorId, input IotConnectorPatchResource) (result UpdateOperationResponse, err error)

Update ...

func (IotConnectorsClient) UpdateThenPoll 

func (c IotConnectorsClient) UpdateThenPoll(ctx context.Context, id IotConnectorId, input IotConnectorPatchResource) error

UpdateThenPoll performs Update then polls until it's completed

type IotEventHubIngestionEndpointConfiguration 

type IotEventHubIngestionEndpointConfiguration struct {
	ConsumerGroup                   *string `json:"consumerGroup,omitempty"`
	EventHubName                    *string `json:"eventHubName,omitempty"`
	FullyQualifiedEventHubNamespace *string `json:"fullyQualifiedEventHubNamespace,omitempty"`
}

type IotFhirDestination 

type IotFhirDestination struct {
	Etag       *string                      `json:"etag,omitempty"`
	Id         *string                      `json:"id,omitempty"`
	Location   *string                      `json:"location,omitempty"`
	Name       *string                      `json:"name,omitempty"`
	Properties IotFhirDestinationProperties `json:"properties"`
	SystemData *systemdata.SystemData       `json:"systemData,omitempty"`
	Type       *string                      `json:"type,omitempty"`
}

type IotFhirDestinationOperationPredicate 

type IotFhirDestinationOperationPredicate struct {
	Etag     *string
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (IotFhirDestinationOperationPredicate) Matches 

func (p IotFhirDestinationOperationPredicate) Matches(input IotFhirDestination) bool

type IotFhirDestinationProperties 

type IotFhirDestinationProperties struct {
	FhirMapping                    IotMappingProperties      `json:"fhirMapping"`
	FhirServiceResourceId          string                    `json:"fhirServiceResourceId"`
	ProvisioningState              *ProvisioningState        `json:"provisioningState,omitempty"`
	ResourceIdentityResolutionType IotIdentityResolutionType `json:"resourceIdentityResolutionType"`
}

type IotIdentityResolutionType 

type IotIdentityResolutionType string
const (
	IotIdentityResolutionTypeCreate IotIdentityResolutionType = "Create"
	IotIdentityResolutionTypeLookup IotIdentityResolutionType = "Lookup"
)

func (*IotIdentityResolutionType) UnmarshalJSON 

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

type IotMappingProperties 

type IotMappingProperties struct {
	Content *interface{} `json:"content,omitempty"`
}

type ListByWorkspaceCompleteResult 

type ListByWorkspaceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []IotConnector
}

type ListByWorkspaceCustomPager added in v0.20240628.1153531 

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

type ListByWorkspaceOperationResponse 

type ListByWorkspaceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]IotConnector
}

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted          ProvisioningState = "Accepted"
	ProvisioningStateCanceled          ProvisioningState = "Canceled"
	ProvisioningStateCreating          ProvisioningState = "Creating"
	ProvisioningStateDeleting          ProvisioningState = "Deleting"
	ProvisioningStateDeprovisioned     ProvisioningState = "Deprovisioned"
	ProvisioningStateFailed            ProvisioningState = "Failed"
	ProvisioningStateMoving            ProvisioningState = "Moving"
	ProvisioningStateSucceeded         ProvisioningState = "Succeeded"
	ProvisioningStateSuspended         ProvisioningState = "Suspended"
	ProvisioningStateSystemMaintenance ProvisioningState = "SystemMaintenance"
	ProvisioningStateUpdating          ProvisioningState = "Updating"
	ProvisioningStateVerifying         ProvisioningState = "Verifying"
	ProvisioningStateWarned            ProvisioningState = "Warned"
)

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

type WorkspaceId 

type WorkspaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
}

WorkspaceId is a struct representing the Resource ID for a Workspace

func NewWorkspaceID 

func NewWorkspaceID(subscriptionId string, resourceGroupName string, workspaceName string) WorkspaceId

NewWorkspaceID returns a new WorkspaceId struct

func ParseWorkspaceID 

func ParseWorkspaceID(input string) (*WorkspaceId, error)

ParseWorkspaceID parses 'input' into a WorkspaceId

func ParseWorkspaceIDInsensitively 

func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)

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

func (*WorkspaceId) FromParseResult 

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

func (WorkspaceId) ID 

func (id WorkspaceId) ID() string

ID returns the formatted Workspace ID

func (WorkspaceId) Segments 

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

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

func (WorkspaceId) String 

func (id WorkspaceId) String() string

String returns a human-readable description of this Workspace ID

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.