שתף באמצעות

az iot central file-upload-config

  • Reference

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.46.0 or higher). The extension will automatically install the first time you run an az iot central file-upload-config command. Learn more about extensions.

Manage and configure IoT Central file upload.

Commands

Name Description Type Status
az iot central file-upload-config create

Create file upload storage account configuration.

 Extension GA
az iot central file-upload-config delete

Delete file upload storage account configuration.

 Extension GA
az iot central file-upload-config show

Get the details of file upload storage account configuration.

 Extension GA
az iot central file-upload-config update

Update file upload storage account configuration.

 Extension GA

az iot central file-upload-config create

Create file upload storage account configuration.

az iot central file-upload-config create --app-id
                                         --connection-string
                                         --container
                                         [--account]
                                         [--api-version {2022-07-31}]
                                         [--central-api-uri]
                                         [--sas-ttl]
                                         [--token]

Examples

Create file upload

az iot central file-upload-config create --app-id {appid} --connection-string {conn_string} --container {container}

Required Parameters

--app-id -n

The App ID of the IoT Central app you want to manage. You can find the App ID in the "About" page for your application under the help menu.

--connection-string -s

The connection string used to configure the storage account.

--container -c

The name of the container inside the storage account.

Optional Parameters

--account -a

The storage account name where to upload the file to.

--api-version --av
Deprecated

Argument 'api_version' has been deprecated and will be removed in a future release.

The API version for the requested operation.

Accepted values: 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

The IoT Central DNS suffix associated with your application.

Default value: azureiotcentral.com
--sas-ttl

The amount of time the device’s request to upload a file is valid before it expires. ISO 8601 duration standard. Default: 1h.

--token

If you'd prefer to submit your request without authenticating against the Azure CLI, you can specify a valid user token to authenticate your request. You must specify the type of key as part of the request. Learn more at https://aka.ms/iotcentraldocsapi.

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 iot central file-upload-config delete

Delete file upload storage account configuration.

az iot central file-upload-config delete --app-id
                                         [--api-version {2022-07-31}]
                                         [--central-api-uri]
                                         [--token]

Examples

Delete file upload

az iot central file-upload-config delete --app-id {appid}

Required Parameters

--app-id -n

The App ID of the IoT Central app you want to manage. You can find the App ID in the "About" page for your application under the help menu.

Optional Parameters

--api-version --av
Deprecated

Argument 'api_version' has been deprecated and will be removed in a future release.

The API version for the requested operation.

Accepted values: 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

The IoT Central DNS suffix associated with your application.

Default value: azureiotcentral.com
--token

If you'd prefer to submit your request without authenticating against the Azure CLI, you can specify a valid user token to authenticate your request. You must specify the type of key as part of the request. Learn more at https://aka.ms/iotcentraldocsapi.

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 iot central file-upload-config show

Get the details of file upload storage account configuration.

az iot central file-upload-config show --app-id
                                       [--api-version {2022-07-31}]
                                       [--central-api-uri]
                                       [--token]

Examples

Get details of file upload configuration

az iot central file-upload-config show --app-id {appid}

Required Parameters

--app-id -n

The App ID of the IoT Central app you want to manage. You can find the App ID in the "About" page for your application under the help menu.

Optional Parameters

--api-version --av
Deprecated

Argument 'api_version' has been deprecated and will be removed in a future release.

The API version for the requested operation.

Accepted values: 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

The IoT Central DNS suffix associated with your application.

Default value: azureiotcentral.com
--token

If you'd prefer to submit your request without authenticating against the Azure CLI, you can specify a valid user token to authenticate your request. You must specify the type of key as part of the request. Learn more at https://aka.ms/iotcentraldocsapi.

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 iot central file-upload-config update

Update file upload storage account configuration.

az iot central file-upload-config update --app-id
                                         [--account]
                                         [--api-version {2022-07-31}]
                                         [--central-api-uri]
                                         [--connection-string]
                                         [--container]
                                         [--sas-ttl]
                                         [--token]

Examples

Update file upload

az iot central file-upload-config update --app-id {appid} --container {container}

Required Parameters

--app-id -n

The App ID of the IoT Central app you want to manage. You can find the App ID in the "About" page for your application under the help menu.

Optional Parameters

--account -a

The storage account name where to upload the file to.

--api-version --av
Deprecated

Argument 'api_version' has been deprecated and will be removed in a future release.

The API version for the requested operation.

Accepted values: 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

The IoT Central DNS suffix associated with your application.

Default value: azureiotcentral.com
--connection-string -s

The connection string used to configure the storage account.

--container -c

The name of the container inside the storage account.

--sas-ttl

The amount of time the device’s request to upload a file is valid before it expires. ISO 8601 duration standard. Default: 1h.

--token

If you'd prefer to submit your request without authenticating against the Azure CLI, you can specify a valid user token to authenticate your request. You must specify the type of key as part of the request. Learn more at https://aka.ms/iotcentraldocsapi.

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.