az healthcareapis workspace iot-connector

Note

This reference is part of the healthcareapis extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az healthcareapis workspace iot-connector command. Learn more about extensions.

Manage iot connector with healthcareapis.

Commands

Name	Description	Type	Status
az healthcareapis workspace iot-connector create	Create an IoT Connector resource with the specified parameters.	Extension	GA
az healthcareapis workspace iot-connector delete	Deletes an IoT Connector.	Extension	GA
az healthcareapis workspace iot-connector fhir-destination	Manage iot connector fhir destination with healthcareapis.	Extension	GA
az healthcareapis workspace iot-connector fhir-destination create	Create an IoT Connector FHIR destination resource with the specified parameters.	Extension	GA
az healthcareapis workspace iot-connector fhir-destination delete	Deletes an IoT Connector FHIR destination.	Extension	GA
az healthcareapis workspace iot-connector fhir-destination list	Lists all FHIR destinations for the given IoT Connector.	Extension	GA
az healthcareapis workspace iot-connector fhir-destination show	Gets the properties of the specified Iot Connector FHIR destination.	Extension	GA
az healthcareapis workspace iot-connector fhir-destination update	Update an IoT Connector FHIR destination resource with the specified parameters.	Extension	GA
az healthcareapis workspace iot-connector fhir-destination wait	Place the CLI in a waiting state until a condition of the healthcareapis workspace iot-connector fhir-destination is met.	Extension	GA
az healthcareapis workspace iot-connector list	Lists all IoT Connectors for the given workspace.	Extension	GA
az healthcareapis workspace iot-connector show	Gets the properties of the specified IoT Connector.	Extension	GA
az healthcareapis workspace iot-connector update	Patch an IoT Connector.	Extension	GA
az healthcareapis workspace iot-connector wait	Place the CLI in a waiting state until a condition of the healthcareapis workspace iot-connector is met.	Extension	GA

az healthcareapis workspace iot-connector create

Create an IoT Connector resource with the specified parameters.

az healthcareapis workspace iot-connector create --iot-connector-name
                                                 --resource-group
                                                 --workspace-name
                                                 [--content]
                                                 [--etag]
                                                 [--identity-type {None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned}]
                                                 [--ingestion-endpoint-configuration]
                                                 [--location]
                                                 [--no-wait]
                                                 [--tags]
                                                 [--user-assigned-identities]

Examples

Create an IoT Connector

az healthcareapis workspace iot-connector create --identity-type "SystemAssigned" --location "westus" --content "{\"template\":[{\"template\":{\"deviceIdExpression\":\"$.deviceid\",\"timestampExpression\":\"$.measurementdatetime\",\"typeMatchExpression\":\"$..[?(@heartrate)]\",\"typeName\":\"heartrate\",\"values\":[{\"required\":\"true\",\"valueExpression\":\"$.heartrate\",\"valueName\":\"hr\"}]},\"templateType\":\"JsonPathContent\"}],\"templateType\":\"CollectionContent\"}" --ingestion-endpoint-configuration consumer-group="ConsumerGroupA" event-hub-name="MyEventHubName" fully-qualified-event-hub-namespace="myeventhub.servicesbus.windows.net" --tags additionalProp1="string" additionalProp2="string" additionalProp3="string" --name "blue" --resource-group "testRG" --workspace-name "workspace1"

Required Parameters

--iot-connector-name --name -n

The name of IoT Connector resource.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The name of workspace resource.

Optional Parameters

--content

The mapping. Expected value: json-string/json-file/@json-file.

--etag

An etag associated with the resource, used for optimistic concurrency when editing it.

--identity-type

Type of identity being specified, currently SystemAssigned and None are allowed.

accepted values: None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned

--ingestion-endpoint-configuration -c

Source configuration.

Usage: --ingestion-endpoint-configuration event-hub-name=XX consumer-group=XX fully-qualified-event-hub-namespace=XX

event-hub-name: Event Hub name to connect to. consumer-group: Consumer group of the event hub to connected to. fully-qualified-event-hub-namespace: Fully qualified namespace of the Event Hub to connect to.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

Do not wait for the long-running operation to finish.

default value: False

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--user-assigned-identities -i

The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. Expected value: json-string/json-file/@json-file.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az healthcareapis workspace iot-connector delete

Deletes an IoT Connector.

az healthcareapis workspace iot-connector delete [--ids]
                                                 [--iot-connector-name]
                                                 [--no-wait]
                                                 [--resource-group]
                                                 [--subscription]
                                                 [--workspace-name]
                                                 [--yes]

Examples

Delete an IoT Connector

az healthcareapis workspace iot-connector delete --name "blue" --resource-group "testRG" --workspace-name "workspace1"

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--iot-connector-name --name -n

The name of IoT Connector resource.

--no-wait

Do not wait for the long-running operation to finish.

default value: False

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--workspace-name

The name of workspace resource.

--yes -y

Do not prompt for confirmation.

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az healthcareapis workspace iot-connector list

Lists all IoT Connectors for the given workspace.

az healthcareapis workspace iot-connector list --resource-group
                                               --workspace-name

Examples

List iotconnectors

az healthcareapis workspace iot-connector list --resource-group "testRG" --workspace-name "workspace1"

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The name of workspace resource.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az healthcareapis workspace iot-connector show

Gets the properties of the specified IoT Connector.

az healthcareapis workspace iot-connector show [--ids]
                                               [--iot-connector-name]
                                               [--resource-group]
                                               [--subscription]
                                               [--workspace-name]

Examples

Get an IoT Connector

az healthcareapis workspace iot-connector show --name "blue" --resource-group "testRG" --workspace-name "workspace1"

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--iot-connector-name --name -n

The name of IoT Connector resource.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--workspace-name

The name of workspace resource.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az healthcareapis workspace iot-connector update

Patch an IoT Connector.

az healthcareapis workspace iot-connector update [--identity-type {None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned}]
                                                 [--ids]
                                                 [--iot-connector-name]
                                                 [--no-wait]
                                                 [--resource-group]
                                                 [--subscription]
                                                 [--tags]
                                                 [--user-assigned-identities]
                                                 [--workspace-name]

Examples

Patch an IoT Connector

az healthcareapis workspace iot-connector update --name "blue" --identity-type "SystemAssigned" --tags additionalProp1="string" additionalProp2="string" additionalProp3="string" --resource-group "testRG" --workspace-name "workspace1"

Optional Parameters

--identity-type

Type of identity being specified, currently SystemAssigned and None are allowed.

accepted values: None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--iot-connector-name --name -n

The name of IoT Connector resource.

--no-wait

Do not wait for the long-running operation to finish.

default value: False

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--user-assigned-identities -i

The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. Expected value: json-string/json-file/@json-file.

--workspace-name

The name of workspace resource.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az healthcareapis workspace iot-connector wait

Place the CLI in a waiting state until a condition of the healthcareapis workspace iot-connector is met.

az healthcareapis workspace iot-connector wait [--created]
                                               [--custom]
                                               [--deleted]
                                               [--exists]
                                               [--ids]
                                               [--interval]
                                               [--iot-connector-name]
                                               [--resource-group]
                                               [--subscription]
                                               [--timeout]
                                               [--updated]
                                               [--workspace-name]

Examples

Pause executing next line of CLI script until the healthcareapis workspace iot-connector is successfully created.

az healthcareapis workspace iot-connector wait --name "blue" --resource-group "testRG" --workspace-name "workspace1" --created

Pause executing next line of CLI script until the healthcareapis workspace iot-connector is successfully updated.

az healthcareapis workspace iot-connector wait --name "blue" --resource-group "testRG" --workspace-name "workspace1" --updated

Pause executing next line of CLI script until the healthcareapis workspace iot-connector is successfully deleted.

az healthcareapis workspace iot-connector wait --name "blue" --resource-group "testRG" --workspace-name "workspace1" --deleted

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

default value: False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

default value: False

--exists

Wait until the resource exists.

default value: False

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

default value: 30

--iot-connector-name --name -n

The name of IoT Connector resource.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False

--workspace-name

The name of workspace resource.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.