fhirservices

package
v0.20240506.1094936 Latest Latest
Warning

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

Go to latest
Published: May 6, 2024 License: MPL-2.0 Imports: 14 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/healthcareapis/2024-03-31/fhirservices Documentation

The fhirservices SDK allows for interaction with the Azure Resource Manager Service healthcareapis (API Version 2024-03-31).

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/2024-03-31/fhirservices"

Client Initialization

client := fhirservices.NewFhirServicesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: FhirServicesClient.CreateOrUpdate

ctx := context.TODO()
id := fhirservices.NewFhirServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "fhirServiceValue")

payload := fhirservices.FhirService{
	// ...
}


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

Example Usage: FhirServicesClient.Delete

ctx := context.TODO()
id := fhirservices.NewFhirServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "fhirServiceValue")

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

Example Usage: FhirServicesClient.Get

ctx := context.TODO()
id := fhirservices.NewFhirServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "fhirServiceValue")

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: FhirServicesClient.ListByWorkspace

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

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

ctx := context.TODO()
id := fhirservices.NewFhirServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "fhirServiceValue")

payload := fhirservices.FhirServicePatchResource{
	// ...
}


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 PossibleValuesForFhirResourceVersionPolicy

func PossibleValuesForFhirResourceVersionPolicy() []string

func PossibleValuesForFhirServiceKind

func PossibleValuesForFhirServiceKind() []string

func PossibleValuesForPrivateEndpointConnectionProvisioningState

func PossibleValuesForPrivateEndpointConnectionProvisioningState() []string

func PossibleValuesForPrivateEndpointServiceConnectionStatus

func PossibleValuesForPrivateEndpointServiceConnectionStatus() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func PossibleValuesForPublicNetworkAccess

func PossibleValuesForPublicNetworkAccess() []string

func PossibleValuesForServiceEventState

func PossibleValuesForServiceEventState() []string

func PossibleValuesForSmartDataActions

func PossibleValuesForSmartDataActions() []string

func ValidateFhirServiceID

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

ValidateFhirServiceID checks that 'input' can be parsed as a Fhir Service 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        *FhirService
}

type DeleteOperationResponse

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

type Encryption

type Encryption struct {
	CustomerManagedKeyEncryption *EncryptionCustomerManagedKeyEncryption `json:"customerManagedKeyEncryption,omitempty"`
}

type EncryptionCustomerManagedKeyEncryption

type EncryptionCustomerManagedKeyEncryption struct {
	KeyEncryptionKeyUrl *string `json:"keyEncryptionKeyUrl,omitempty"`
}

type FhirResourceVersionPolicy

type FhirResourceVersionPolicy string
const (
	FhirResourceVersionPolicyNoNegativeversion       FhirResourceVersionPolicy = "no-version"
	FhirResourceVersionPolicyVersioned               FhirResourceVersionPolicy = "versioned"
	FhirResourceVersionPolicyVersionedNegativeupdate FhirResourceVersionPolicy = "versioned-update"
)

func (*FhirResourceVersionPolicy) UnmarshalJSON

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

type FhirService

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

type FhirServiceAcrConfiguration

type FhirServiceAcrConfiguration struct {
	LoginServers *[]string                  `json:"loginServers,omitempty"`
	OciArtifacts *[]ServiceOciArtifactEntry `json:"ociArtifacts,omitempty"`
}

type FhirServiceAuthenticationConfiguration

type FhirServiceAuthenticationConfiguration struct {
	Audience               *string                               `json:"audience,omitempty"`
	Authority              *string                               `json:"authority,omitempty"`
	SmartIdentityProviders *[]SmartIdentityProviderConfiguration `json:"smartIdentityProviders,omitempty"`
	SmartProxyEnabled      *bool                                 `json:"smartProxyEnabled,omitempty"`
}

type FhirServiceCorsConfiguration

type FhirServiceCorsConfiguration struct {
	AllowCredentials *bool     `json:"allowCredentials,omitempty"`
	Headers          *[]string `json:"headers,omitempty"`
	MaxAge           *int64    `json:"maxAge,omitempty"`
	Methods          *[]string `json:"methods,omitempty"`
	Origins          *[]string `json:"origins,omitempty"`
}

type FhirServiceExportConfiguration

type FhirServiceExportConfiguration struct {
	StorageAccountName *string `json:"storageAccountName,omitempty"`
}

type FhirServiceId

type FhirServiceId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	FhirServiceName   string
}

FhirServiceId is a struct representing the Resource ID for a Fhir Service

func NewFhirServiceID

func NewFhirServiceID(subscriptionId string, resourceGroupName string, workspaceName string, fhirServiceName string) FhirServiceId

NewFhirServiceID returns a new FhirServiceId struct

func ParseFhirServiceID

func ParseFhirServiceID(input string) (*FhirServiceId, error)

ParseFhirServiceID parses 'input' into a FhirServiceId

func ParseFhirServiceIDInsensitively

func ParseFhirServiceIDInsensitively(input string) (*FhirServiceId, error)

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

func (*FhirServiceId) FromParseResult

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

func (FhirServiceId) ID

func (id FhirServiceId) ID() string

ID returns the formatted Fhir Service ID

func (FhirServiceId) Segments

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

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

func (FhirServiceId) String

func (id FhirServiceId) String() string

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

type FhirServiceImportConfiguration

type FhirServiceImportConfiguration struct {
	Enabled              *bool   `json:"enabled,omitempty"`
	InitialImportMode    *bool   `json:"initialImportMode,omitempty"`
	IntegrationDataStore *string `json:"integrationDataStore,omitempty"`
}

type FhirServiceKind

type FhirServiceKind string
const (
	FhirServiceKindFhirNegativeRFour    FhirServiceKind = "fhir-R4"
	FhirServiceKindFhirNegativeStuThree FhirServiceKind = "fhir-Stu3"
)

func (*FhirServiceKind) UnmarshalJSON

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

type FhirServiceOperationPredicate

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

func (FhirServiceOperationPredicate) Matches

type FhirServicePatchResource

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

type FhirServiceProperties

type FhirServiceProperties struct {
	AcrConfiguration                   *FhirServiceAcrConfiguration            `json:"acrConfiguration,omitempty"`
	AuthenticationConfiguration        *FhirServiceAuthenticationConfiguration `json:"authenticationConfiguration,omitempty"`
	CorsConfiguration                  *FhirServiceCorsConfiguration           `json:"corsConfiguration,omitempty"`
	Encryption                         *Encryption                             `json:"encryption,omitempty"`
	EventState                         *ServiceEventState                      `json:"eventState,omitempty"`
	ExportConfiguration                *FhirServiceExportConfiguration         `json:"exportConfiguration,omitempty"`
	ImplementationGuidesConfiguration  *ImplementationGuidesConfiguration      `json:"implementationGuidesConfiguration,omitempty"`
	ImportConfiguration                *FhirServiceImportConfiguration         `json:"importConfiguration,omitempty"`
	PrivateEndpointConnections         *[]PrivateEndpointConnection            `json:"privateEndpointConnections,omitempty"`
	ProvisioningState                  *ProvisioningState                      `json:"provisioningState,omitempty"`
	PublicNetworkAccess                *PublicNetworkAccess                    `json:"publicNetworkAccess,omitempty"`
	ResourceVersionPolicyConfiguration *ResourceVersionPolicyConfiguration     `json:"resourceVersionPolicyConfiguration,omitempty"`
}

type FhirServicesClient

type FhirServicesClient struct {
	Client *resourcemanager.Client
}

func NewFhirServicesClientWithBaseURI

func NewFhirServicesClientWithBaseURI(sdkApi sdkEnv.Api) (*FhirServicesClient, error)

func (FhirServicesClient) CreateOrUpdate

func (c FhirServicesClient) CreateOrUpdate(ctx context.Context, id FhirServiceId, input FhirService) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (FhirServicesClient) CreateOrUpdateThenPoll

func (c FhirServicesClient) CreateOrUpdateThenPoll(ctx context.Context, id FhirServiceId, input FhirService) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (FhirServicesClient) Delete

Delete ...

func (FhirServicesClient) DeleteThenPoll

func (c FhirServicesClient) DeleteThenPoll(ctx context.Context, id FhirServiceId) error

DeleteThenPoll performs Delete then polls until it's completed

func (FhirServicesClient) Get

Get ...

func (FhirServicesClient) ListByWorkspace

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

ListByWorkspace ...

func (FhirServicesClient) ListByWorkspaceComplete

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

ListByWorkspaceComplete retrieves all the results into a single object

func (FhirServicesClient) ListByWorkspaceCompleteMatchingPredicate

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

ListByWorkspaceCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (FhirServicesClient) Update

Update ...

func (FhirServicesClient) UpdateThenPoll

UpdateThenPoll performs Update then polls until it's completed

type GetOperationResponse

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

type ImplementationGuidesConfiguration

type ImplementationGuidesConfiguration struct {
	UsCoreMissingData *bool `json:"usCoreMissingData,omitempty"`
}

type ListByWorkspaceCompleteResult

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

type ListByWorkspaceOperationResponse

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

type PrivateEndpoint

type PrivateEndpoint struct {
	Id *string `json:"id,omitempty"`
}

type PrivateEndpointConnection

type PrivateEndpointConnection struct {
	Id         *string                              `json:"id,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type PrivateEndpointConnectionProperties

type PrivateEndpointConnectionProperties struct {
	PrivateEndpoint                   *PrivateEndpoint                            `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState PrivateLinkServiceConnectionState           `json:"privateLinkServiceConnectionState"`
	ProvisioningState                 *PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty"`
}

type PrivateEndpointConnectionProvisioningState

type PrivateEndpointConnectionProvisioningState string
const (
	PrivateEndpointConnectionProvisioningStateCreating  PrivateEndpointConnectionProvisioningState = "Creating"
	PrivateEndpointConnectionProvisioningStateDeleting  PrivateEndpointConnectionProvisioningState = "Deleting"
	PrivateEndpointConnectionProvisioningStateFailed    PrivateEndpointConnectionProvisioningState = "Failed"
	PrivateEndpointConnectionProvisioningStateSucceeded PrivateEndpointConnectionProvisioningState = "Succeeded"
)

func (*PrivateEndpointConnectionProvisioningState) UnmarshalJSON

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

type PrivateEndpointServiceConnectionStatus

type PrivateEndpointServiceConnectionStatus string
const (
	PrivateEndpointServiceConnectionStatusApproved PrivateEndpointServiceConnectionStatus = "Approved"
	PrivateEndpointServiceConnectionStatusPending  PrivateEndpointServiceConnectionStatus = "Pending"
	PrivateEndpointServiceConnectionStatusRejected PrivateEndpointServiceConnectionStatus = "Rejected"
)

func (*PrivateEndpointServiceConnectionStatus) UnmarshalJSON

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

type PrivateLinkServiceConnectionState

type PrivateLinkServiceConnectionState struct {
	ActionsRequired *string                                 `json:"actionsRequired,omitempty"`
	Description     *string                                 `json:"description,omitempty"`
	Status          *PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
}

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 PublicNetworkAccess

type PublicNetworkAccess string
const (
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	PublicNetworkAccessEnabled  PublicNetworkAccess = "Enabled"
)

func (*PublicNetworkAccess) UnmarshalJSON

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

type ResourceVersionPolicyConfiguration

type ResourceVersionPolicyConfiguration struct {
	Default               *FhirResourceVersionPolicy            `json:"default,omitempty"`
	ResourceTypeOverrides *map[string]FhirResourceVersionPolicy `json:"resourceTypeOverrides,omitempty"`
}

type ServiceEventState

type ServiceEventState string
const (
	ServiceEventStateDisabled ServiceEventState = "Disabled"
	ServiceEventStateEnabled  ServiceEventState = "Enabled"
	ServiceEventStateUpdating ServiceEventState = "Updating"
)

func (*ServiceEventState) UnmarshalJSON

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

type ServiceOciArtifactEntry

type ServiceOciArtifactEntry struct {
	Digest      *string `json:"digest,omitempty"`
	ImageName   *string `json:"imageName,omitempty"`
	LoginServer *string `json:"loginServer,omitempty"`
}

type SmartDataActions

type SmartDataActions string
const (
	SmartDataActionsRead SmartDataActions = "Read"
)

func (*SmartDataActions) UnmarshalJSON

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

type SmartIdentityProviderApplication

type SmartIdentityProviderApplication struct {
	AllowedDataActions *[]SmartDataActions `json:"allowedDataActions,omitempty"`
	Audience           *string             `json:"audience,omitempty"`
	ClientId           *string             `json:"clientId,omitempty"`
}

type SmartIdentityProviderConfiguration

type SmartIdentityProviderConfiguration struct {
	Applications *[]SmartIdentityProviderApplication `json:"applications,omitempty"`
	Authority    *string                             `json:"authority,omitempty"`
}

type UpdateOperationResponse

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

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL