az iot central organization
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 organization command. Learn more about extensions.
Manage and configure organizations for an IoT Central application.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az iot central organization create |
Create an organization in the application. |
Extension | GA |
| az iot central organization delete |
Delete an organization by ID. |
Extension | GA |
| az iot central organization list |
Get the list of organizations for an IoT Central application. |
Extension | GA |
| az iot central organization show |
Get the details of a organization by ID. |
Extension | GA |
| az iot central organization update |
Update an organization in the application. |
Extension | GA |
az iot central organization create
Create an organization in the application.
az iot central organization create --app-id
--org-id
[--api-version {2022-07-31}]
[--central-api-uri]
[--org-name]
[--parent-id]
[--token]Examples
Create an organization
az iot central organization create --app-id {appid} --org-id {organizationId}Create an organization, child of a parent one in the application.
az iot central organization create --app-id {appid} --org-id {organizationId} --parent-id {parentId}Required Parameters
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.
Unique identifier for the organization.
Optional Parameters
Argument 'api_version' has been deprecated and will be removed in a future release.
The API version for the requested operation.
The IoT Central DNS suffix associated with your application.
Display name of the organization.
The ID of the parent of the organization.
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
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az iot central organization delete
Delete an organization by ID.
az iot central organization delete --app-id
--org-id
[--api-version {2022-07-31}]
[--central-api-uri]
[--token]Examples
Delete an organization
az iot central organization delete --app-id {appid} --org-id {organizationId}Required Parameters
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.
Unique identifier for the organization.
Optional Parameters
Argument 'api_version' has been deprecated and will be removed in a future release.
The API version for the requested operation.
The IoT Central DNS suffix associated with your application.
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
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az iot central organization list
Get the list of organizations for an IoT Central application.
az iot central organization list --app-id
[--api-version {2022-07-31}]
[--central-api-uri]
[--token]Examples
List organizations in an application
az iot central organization list --app-id {appid}Required Parameters
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
Argument 'api_version' has been deprecated and will be removed in a future release.
The API version for the requested operation.
The IoT Central DNS suffix associated with your application.
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
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az iot central organization show
Get the details of a organization by ID.
az iot central organization show --app-id
--org-id
[--api-version {2022-07-31}]
[--central-api-uri]
[--token]Examples
Get details of organization
az iot central organization show --app-id {appid} --org-id {organizationId}Required Parameters
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.
Unique identifier for the organization.
Optional Parameters
Argument 'api_version' has been deprecated and will be removed in a future release.
The API version for the requested operation.
The IoT Central DNS suffix associated with your application.
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
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az iot central organization update
Update an organization in the application.
az iot central organization update --app-id
--org-id
[--api-version {2022-07-31}]
[--central-api-uri]
[--org-name]
[--parent-id]
[--token]Examples
Update parent of an organization
az iot central organization update --app-id {appid} --org-id {organizationId} --parent-id {parentId}Update name of an organization
az iot central organization update --app-id {appid} --org-id {organizationId} --org-name {organizationName}Required Parameters
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.
Unique identifier for the organization.
Optional Parameters
Argument 'api_version' has been deprecated and will be removed in a future release.
The API version for the requested operation.
The IoT Central DNS suffix associated with your application.
Display name of the organization.
The ID of the parent of the organization.
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
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
