az iot pnp capability-model

Manage device capability models in an IoT Plug and Play model repository.

Commands

az iot pnp capability-model create

Create a capability-model in the company repository.

az iot pnp capability-model delete

Delete the capability-model in the company repository.

az iot pnp capability-model list

List all capability-model.

az iot pnp capability-model publish

Publish the capability-model to public repository.

az iot pnp capability-model show

Get the details of a capability-model.

az iot pnp capability-model update

Update the capability-model in the company repository.

az iot pnp capability-model create

Create a capability-model in the company repository.

az iot pnp capability-model create --def
                                   [--endpoint]
                                   [--login]
                                   [--repo-id]

Examples

Create a capability-model in the company repository.

az iot pnp capability-model create --def {plug_and_play_capability_model_file_path} -r {pnp_repository}

Required Parameters

--def --definition

IoT Plug and Play capability-model definition written in PPDL (JSON-LD). Can be directly input or a file path where the content is extracted.

Optional Parameters

--endpoint -e

IoT Plug and Play endpoint.

default value: <a href="https://provider.azureiotrepository.com">https://provider.azureiotrepository.com</a>
--login -l

This command supports an entity connection string with rights to perform action. Use to avoid session login via "az login". If both an entity connection string and name are provided the connection string takes priority.

--repo-id -r

IoT Plug and Play repository Id.

az iot pnp capability-model delete

Delete the capability-model in the company repository.

az iot pnp capability-model delete --model
                                   [--endpoint]
                                   [--login]
                                   [--repo-id]

Examples

Delete the capability-model in the company repository.

az iot pnp capability-model delete -r {pnp_repository} --model {plug_and_play_capability_model_id}

Required Parameters

--model -m

Target capability-model urn-id. Example: urn:example:capabilityModels:Mxchip:1.

Optional Parameters

--endpoint -e

IoT Plug and Play endpoint.

default value: <a href="https://provider.azureiotrepository.com">https://provider.azureiotrepository.com</a>
--login -l

This command supports an entity connection string with rights to perform action. Use to avoid session login via "az login". If both an entity connection string and name are provided the connection string takes priority.

--repo-id -r

IoT Plug and Play repository Id.

az iot pnp capability-model list

List all capability-model.

az iot pnp capability-model list [--endpoint]
                                 [--login]
                                 [--repo-id]
                                 [--search]
                                 [--top]

Examples

List all company repository's capability-model.

az iot pnp capability-model list -r {pnp_repository}

List all public capability-model.

az iot pnp capability-model list

Optional Parameters

--endpoint -e

IoT Plug and Play endpoint.

default value: <a href="https://provider.azureiotrepository.com">https://provider.azureiotrepository.com</a>
--login -l

This command supports an entity connection string with rights to perform action. Use to avoid session login via "az login". If both an entity connection string and name are provided the connection string takes priority.

--repo-id -r

IoT Plug and Play repository Id.

--search --ss

Searches IoT Plug and Play models for given string in the "Description, DisplayName, comment and Id".

--top

Maximum number of capability-model to return.

default value: 1000

az iot pnp capability-model publish

Publish the capability-model to public repository.

az iot pnp capability-model publish --model
                                    [--endpoint]
                                    [--login]
                                    [--repo-id]

Examples

Publish the capability-model to public repository.

az iot pnp capability-model publish -r {pnp_repository} --model {plug_and_play_capability_model_id}

Required Parameters

--model -m

Target capability-model urn-id. Example: urn:example:capabilityModels:Mxchip:1.

Optional Parameters

--endpoint -e

IoT Plug and Play endpoint.

default value: <a href="https://provider.azureiotrepository.com">https://provider.azureiotrepository.com</a>
--login -l

This command supports an entity connection string with rights to perform action. Use to avoid session login via "az login". If both an entity connection string and name are provided the connection string takes priority.

--repo-id -r

IoT Plug and Play repository Id.

az iot pnp capability-model show

Get the details of a capability-model.

az iot pnp capability-model show --model
                                 [--endpoint]
                                 [--expand]
                                 [--login]
                                 [--repo-id]

Examples

Get the details of a company repository capability-model.

az iot pnp capability-model show -r {pnp_repository} --model {plug_and_play_capability_model_id}

Get the details of public capability-model.

az iot pnp capability-model show --model {plug_and_play_capability_model_id}

Required Parameters

--model -m

Target capability-model urn-id. Example: urn:example:capabilityModels:Mxchip:1.

Optional Parameters

--endpoint -e

IoT Plug and Play endpoint.

default value: <a href="https://provider.azureiotrepository.com">https://provider.azureiotrepository.com</a>
--expand

Indicates whether to expand the device capability model's interface definitions or not.

--login -l

This command supports an entity connection string with rights to perform action. Use to avoid session login via "az login". If both an entity connection string and name are provided the connection string takes priority.

--repo-id -r

IoT Plug and Play repository Id.

az iot pnp capability-model update

Update the capability-model in the company repository.

az iot pnp capability-model update --def
                                   [--endpoint]
                                   [--login]
                                   [--repo-id]

Examples

Update the capability-model in the company repository.

az iot pnp capability-model update --def {updated_plug_and_play_capability_model_file_path} -r {pnp_repository}

Required Parameters

--def --definition

IoT Plug and Play capability-model definition written in PPDL (JSON-LD). Can be directly input or a file path where the content is extracted.

Optional Parameters

--endpoint -e

IoT Plug and Play endpoint.

default value: <a href="https://provider.azureiotrepository.com">https://provider.azureiotrepository.com</a>
--login -l

This command supports an entity connection string with rights to perform action. Use to avoid session login via "az login". If both an entity connection string and name are provided the connection string takes priority.

--repo-id -r

IoT Plug and Play repository Id.