@azure/arm-healthcareapis package

Classes

HealthcareApisManagementClient

Interfaces

CheckNameAvailabilityParameters	Input values.
CorsConfiguration	The settings for the CORS configuration of the service instance.
DicomService	The description of Dicom Service
DicomServiceAuthenticationConfiguration	Authentication configuration information
DicomServiceCollection	The collection of Dicom Services.
DicomServicePatchResource	Dicom Service patch properties
DicomServices	Interface representing a DicomServices.
DicomServicesCreateOrUpdateOptionalParams	Optional parameters.
DicomServicesDeleteOptionalParams	Optional parameters.
DicomServicesGetOptionalParams	Optional parameters.
DicomServicesListByWorkspaceNextOptionalParams	Optional parameters.
DicomServicesListByWorkspaceOptionalParams	Optional parameters.
DicomServicesUpdateOptionalParams	Optional parameters.
Encryption	Settings to encrypt a service
EncryptionCustomerManagedKeyEncryption	The encryption settings for the customer-managed key
ErrorDetails	Error details.
ErrorDetailsInternal	Error details.
ErrorModel	Error details.
FhirDestinations	Interface representing a FhirDestinations.
FhirDestinationsListByIotConnectorNextOptionalParams	Optional parameters.
FhirDestinationsListByIotConnectorOptionalParams	Optional parameters.
FhirService	The description of Fhir Service
FhirServiceAcrConfiguration	Azure container registry configuration information
FhirServiceAuthenticationConfiguration	Authentication configuration information
FhirServiceCollection	A collection of Fhir services.
FhirServiceCorsConfiguration	The settings for the CORS configuration of the service instance.
FhirServiceExportConfiguration	Export operation configuration information
FhirServiceImportConfiguration	Import operation configuration information
FhirServicePatchResource	FhirService patch properties
FhirServices	Interface representing a FhirServices.
FhirServicesCreateOrUpdateOptionalParams	Optional parameters.
FhirServicesDeleteOptionalParams	Optional parameters.
FhirServicesGetOptionalParams	Optional parameters.
FhirServicesListByWorkspaceNextOptionalParams	Optional parameters.
FhirServicesListByWorkspaceOptionalParams	Optional parameters.
FhirServicesUpdateOptionalParams	Optional parameters.
HealthcareApisManagementClientOptionalParams	Optional parameters.
ImplementationGuidesConfiguration	The settings for Implementation Guides - defining capabilities for national standards, vendor consortiums, clinical societies, etc.
IotConnector	IoT Connector definition.
IotConnectorCollection	A collection of IoT Connectors.
IotConnectorFhirDestination	Interface representing a IotConnectorFhirDestination.
IotConnectorFhirDestinationCreateOrUpdateOptionalParams	Optional parameters.
IotConnectorFhirDestinationDeleteOptionalParams	Optional parameters.
IotConnectorFhirDestinationGetOptionalParams	Optional parameters.
IotConnectorPatchResource	Iot Connector patch properties
IotConnectors	Interface representing a IotConnectors.
IotConnectorsCreateOrUpdateOptionalParams	Optional parameters.
IotConnectorsDeleteOptionalParams	Optional parameters.
IotConnectorsGetOptionalParams	Optional parameters.
IotConnectorsListByWorkspaceNextOptionalParams	Optional parameters.
IotConnectorsListByWorkspaceOptionalParams	Optional parameters.
IotConnectorsUpdateOptionalParams	Optional parameters.
IotDestinationProperties	Common IoT Connector destination properties.
IotEventHubIngestionEndpointConfiguration	Event Hub ingestion endpoint configuration
IotFhirDestination	IoT Connector FHIR destination definition.
IotFhirDestinationCollection	A collection of IoT Connector FHIR destinations.
IotFhirDestinationProperties	IoT Connector destination properties for an Azure FHIR service.
IotMappingProperties	The mapping content.
ListOperations	Available operations of the service
LocationBasedResource	The common properties for any location based resource, tracked or proxy.
LogSpecification	Specifications of the Log for Azure Monitoring
MetricDimension	Specifications of the Dimension of metrics
MetricSpecification	Specifications of the Metrics for Azure Monitoring
OperationDetail	Service REST API operation.
OperationDisplay	The object that represents the operation.
OperationProperties	Extra Operation properties
OperationResults	Interface representing a OperationResults.
OperationResultsDescription	The properties indicating the operation result of an operation on a service.
OperationResultsGetOptionalParams	Optional parameters.
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
PrivateEndpoint	The Private Endpoint resource.
PrivateEndpointConnection	The Private Endpoint Connection resource.
PrivateEndpointConnectionDescription	The Private Endpoint Connection resource.
PrivateEndpointConnectionListResult	List of private endpoint connection associated with the specified storage account
PrivateEndpointConnectionListResultDescription	List of private endpoint connection associated with the specified storage account
PrivateEndpointConnections	Interface representing a PrivateEndpointConnections.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByServiceOptionalParams	Optional parameters.
PrivateLinkResource	A private link resource
PrivateLinkResourceDescription	The Private Endpoint Connection resource.
PrivateLinkResourceListResultDescription	A list of private link resources
PrivateLinkResources	Interface representing a PrivateLinkResources.
PrivateLinkResourcesGetOptionalParams	Optional parameters.
PrivateLinkResourcesListByServiceOptionalParams	Optional parameters.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceCore	The common properties for any resource, tracked or proxy.
ResourceTags	List of key value pairs that describe the resource. This will overwrite the existing tags.
ResourceVersionPolicyConfiguration	The settings for history tracking for FHIR resources.
ServiceAccessPolicyEntry	An access policy entry.
ServiceAcrConfigurationInfo	Azure container registry configuration information
ServiceAuthenticationConfigurationInfo	Authentication configuration information
ServiceCorsConfigurationInfo	The settings for the CORS configuration of the service instance.
ServiceCosmosDbConfigurationInfo	The settings for the Cosmos DB database backing the service.
ServiceExportConfigurationInfo	Export operation configuration information
ServiceImportConfigurationInfo	Import operation configuration information
ServiceManagedIdentity	Managed service identity (system assigned and/or user assigned identities)
ServiceManagedIdentityIdentity	Setting indicating whether the service has a managed identity associated with it.
ServiceOciArtifactEntry	An Open Container Initiative (OCI) artifact.
ServiceSpecification	Service specification payload
Services	Interface representing a Services.
ServicesCheckNameAvailabilityOptionalParams	Optional parameters.
ServicesCreateOrUpdateOptionalParams	Optional parameters.
ServicesDeleteOptionalParams	Optional parameters.
ServicesDescription	The description of the service.
ServicesDescriptionListResult	A list of service description objects with a next link.
ServicesGetOptionalParams	Optional parameters.
ServicesListByResourceGroupNextOptionalParams	Optional parameters.
ServicesListByResourceGroupOptionalParams	Optional parameters.
ServicesListNextOptionalParams	Optional parameters.
ServicesListOptionalParams	Optional parameters.
ServicesNameAvailabilityInfo	The properties indicating whether a given service name is available.
ServicesPatchDescription	The description of the service.
ServicesProperties	The properties of a service instance.
ServicesResource	The common properties of a service.
ServicesResourceIdentity	Setting indicating whether the service has a managed identity associated with it.
ServicesUpdateOptionalParams	Optional parameters.
SmartIdentityProviderApplication	An Application configured in the Identity Provider used to access FHIR resources.
SmartIdentityProviderConfiguration	An object to configure an identity provider for use with SMART on FHIR authentication.
StorageConfiguration	The configuration of connected storage
SystemData	Metadata pertaining to creation and last modification of the resource.
TaggedResource	The common properties of tracked resources in the service.
UserAssignedIdentity	User assigned identity properties
Workspace	Workspace resource.
WorkspaceList	Collection of workspace object with a next link
WorkspacePatchResource	Workspace patch properties
WorkspacePrivateEndpointConnections	Interface representing a WorkspacePrivateEndpointConnections.
WorkspacePrivateEndpointConnectionsCreateOrUpdateOptionalParams	Optional parameters.
WorkspacePrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
WorkspacePrivateEndpointConnectionsGetOptionalParams	Optional parameters.
WorkspacePrivateEndpointConnectionsListByWorkspaceOptionalParams	Optional parameters.
WorkspacePrivateLinkResources	Interface representing a WorkspacePrivateLinkResources.
WorkspacePrivateLinkResourcesGetOptionalParams	Optional parameters.
WorkspacePrivateLinkResourcesListByWorkspaceOptionalParams	Optional parameters.
WorkspaceProperties	Workspaces resource specific properties.
Workspaces	Interface representing a Workspaces.
WorkspacesCreateOrUpdateOptionalParams	Optional parameters.
WorkspacesDeleteOptionalParams	Optional parameters.
WorkspacesGetOptionalParams	Optional parameters.
WorkspacesListByResourceGroupNextOptionalParams	Optional parameters.
WorkspacesListByResourceGroupOptionalParams	Optional parameters.
WorkspacesListBySubscriptionNextOptionalParams	Optional parameters.
WorkspacesListBySubscriptionOptionalParams	Optional parameters.
WorkspacesUpdateOptionalParams	Optional parameters.

Type Aliases

ActionType	Defines values for ActionType. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
DicomServicesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
DicomServicesGetResponse	Contains response data for the get operation.
DicomServicesListByWorkspaceNextResponse	Contains response data for the listByWorkspaceNext operation.
DicomServicesListByWorkspaceResponse	Contains response data for the listByWorkspace operation.
DicomServicesUpdateResponse	Contains response data for the update operation.
FhirDestinationsListByIotConnectorNextResponse	Contains response data for the listByIotConnectorNext operation.
FhirDestinationsListByIotConnectorResponse	Contains response data for the listByIotConnector operation.
FhirResourceVersionPolicy	Defines values for FhirResourceVersionPolicy. KnownFhirResourceVersionPolicy can be used interchangeably with FhirResourceVersionPolicy, this enum contains the known values that the service supports. Known values supported by the service no-version versioned versioned-update
FhirServiceKind	Defines values for FhirServiceKind. KnownFhirServiceKind can be used interchangeably with FhirServiceKind, this enum contains the known values that the service supports. Known values supported by the service fhir-Stu3 fhir-R4
FhirServicesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
FhirServicesGetResponse	Contains response data for the get operation.
FhirServicesListByWorkspaceNextResponse	Contains response data for the listByWorkspaceNext operation.
FhirServicesListByWorkspaceResponse	Contains response data for the listByWorkspace operation.
FhirServicesUpdateResponse	Contains response data for the update operation.
IotConnectorFhirDestinationCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
IotConnectorFhirDestinationGetResponse	Contains response data for the get operation.
IotConnectorsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
IotConnectorsGetResponse	Contains response data for the get operation.
IotConnectorsListByWorkspaceNextResponse	Contains response data for the listByWorkspaceNext operation.
IotConnectorsListByWorkspaceResponse	Contains response data for the listByWorkspace operation.
IotConnectorsUpdateResponse	Contains response data for the update operation.
IotIdentityResolutionType	Defines values for IotIdentityResolutionType. KnownIotIdentityResolutionType can be used interchangeably with IotIdentityResolutionType, this enum contains the known values that the service supports. Known values supported by the service Create Lookup
Kind	Defines values for Kind.
ManagedServiceIdentityType	Defines values for ManagedServiceIdentityType. KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports. Known values supported by the service SystemAssigned None
OperationResultStatus	Defines values for OperationResultStatus. KnownOperationResultStatus can be used interchangeably with OperationResultStatus, this enum contains the known values that the service supports. Known values supported by the service Canceled Succeeded Failed Requested Running
OperationResultsGetResponse	Contains response data for the get operation.
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
PrivateEndpointConnectionProvisioningState	Defines values for PrivateEndpointConnectionProvisioningState. KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded Creating Deleting Failed
PrivateEndpointConnectionsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
PrivateEndpointConnectionsGetResponse	Contains response data for the get operation.
PrivateEndpointConnectionsListByServiceResponse	Contains response data for the listByService operation.
PrivateEndpointServiceConnectionStatus	Defines values for PrivateEndpointServiceConnectionStatus. KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Pending Approved Rejected
PrivateLinkResourcesGetResponse	Contains response data for the get operation.
PrivateLinkResourcesListByServiceResponse	Contains response data for the listByService operation.
ProvisioningState	Defines values for ProvisioningState. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Deleting Succeeded Creating Accepted Verifying Updating Failed Canceled Deprovisioned Moving Suspended Warned SystemMaintenance
PublicNetworkAccess	Defines values for PublicNetworkAccess. KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
ServiceEventState	Defines values for ServiceEventState. KnownServiceEventState can be used interchangeably with ServiceEventState, this enum contains the known values that the service supports. Known values supported by the service Disabled Enabled Updating
ServiceManagedIdentityType	Defines values for ServiceManagedIdentityType. KnownServiceManagedIdentityType can be used interchangeably with ServiceManagedIdentityType, this enum contains the known values that the service supports. Known values supported by the service None SystemAssigned UserAssigned SystemAssigned,UserAssigned
ServiceNameUnavailabilityReason	Defines values for ServiceNameUnavailabilityReason.
ServicesCheckNameAvailabilityResponse	Contains response data for the checkNameAvailability operation.
ServicesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ServicesGetResponse	Contains response data for the get operation.
ServicesListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
ServicesListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
ServicesListNextResponse	Contains response data for the listNext operation.
ServicesListResponse	Contains response data for the list operation.
ServicesUpdateResponse	Contains response data for the update operation.
SmartDataActions	Defines values for SmartDataActions. KnownSmartDataActions can be used interchangeably with SmartDataActions, this enum contains the known values that the service supports. Known values supported by the service Read
WorkspacePrivateEndpointConnectionsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
WorkspacePrivateEndpointConnectionsGetResponse	Contains response data for the get operation.
WorkspacePrivateEndpointConnectionsListByWorkspaceResponse	Contains response data for the listByWorkspace operation.
WorkspacePrivateLinkResourcesGetResponse	Contains response data for the get operation.
WorkspacePrivateLinkResourcesListByWorkspaceResponse	Contains response data for the listByWorkspace operation.
WorkspacesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
WorkspacesGetResponse	Contains response data for the get operation.
WorkspacesListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
WorkspacesListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
WorkspacesListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
WorkspacesListBySubscriptionResponse	Contains response data for the listBySubscription operation.
WorkspacesUpdateResponse	Contains response data for the update operation.

Enums

KnownActionType	Known values of ActionType that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownFhirResourceVersionPolicy	Known values of FhirResourceVersionPolicy that the service accepts.
KnownFhirServiceKind	Known values of FhirServiceKind that the service accepts.
KnownIotIdentityResolutionType	Known values of IotIdentityResolutionType that the service accepts.
KnownManagedServiceIdentityType	Known values of ManagedServiceIdentityType that the service accepts.
KnownOperationResultStatus	Known values of OperationResultStatus that the service accepts.
KnownPrivateEndpointConnectionProvisioningState	Known values of PrivateEndpointConnectionProvisioningState that the service accepts.
KnownPrivateEndpointServiceConnectionStatus	Known values of PrivateEndpointServiceConnectionStatus that the service accepts.
KnownProvisioningState	Known values of ProvisioningState that the service accepts.
KnownPublicNetworkAccess	Known values of PublicNetworkAccess that the service accepts.
KnownServiceEventState	Known values of ServiceEventState that the service accepts.
KnownServiceManagedIdentityType	Known values of ServiceManagedIdentityType that the service accepts.
KnownSmartDataActions	Known values of SmartDataActions that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.