az iot pnp interface

Manage interfaces in an IoT Plug and Play model repository.

Commands

az iot pnp interface create

Create an interface in the company repository.

az iot pnp interface delete

Delete an interface in the company repository.

az iot pnp interface list

List all interfaces.

az iot pnp interface publish

Publish an interface to public repository.

az iot pnp interface show

Get the details of an interface.

az iot pnp interface update

Update an interface in the company repository.

az iot pnp interface create

Create an interface in the company repository.

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

Examples

Create an interface in the company repository.

az iot pnp interface create --def {plug_and_play_interface_file_path} -r {pnp_repository}

Required Parameters

--def --definition

IoT Plug and Play interface 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 interface delete

Delete an interface in the company repository.

az iot pnp interface delete --interface
                            [--endpoint]
                            [--login]
                            [--repo-id]

Examples

Delete an interface in the company repository.

az iot pnp interface delete -r {pnp_repository} --interface {plug_and_play_interface_id}

Required Parameters

--interface -i

Target interface urn-id. Example: urn:example:interfaces: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 interface list

List all interfaces.

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

Examples

List all company repository's interfaces.

az iot pnp interface list -r {pnp_repository}

List all public interfaces.

az iot pnp interface 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 interfaces for given string in the "Description, DisplayName, comment and Id".

--top

Maximum number of interface to return.

default value: 1000

az iot pnp interface publish

Publish an interface to public repository.

az iot pnp interface publish --interface
                             [--endpoint]
                             [--login]
                             [--repo-id]

Examples

Publish an interface to public repository.

az iot pnp interface publish -r {pnp_repository} --interface {plug_and_play_interface_id}

Required Parameters

--interface -i

Target interface urn-id. Example: urn:example:interfaces: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 interface show

Get the details of an interface.

az iot pnp interface show --interface
                          [--endpoint]
                          [--login]
                          [--repo-id]

Examples

Get the details of a company repository interface.

az iot pnp interface show -r {pnp_repository} --interface {plug_and_play_interface_id}

Get the details of public interface.

az iot pnp interface show --interface {plug_and_play_interface_id}

Required Parameters

--interface -i

Target interface urn-id. Example: urn:example:interfaces: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 interface update

Update an interface in the company repository.

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

Examples

Update an interface in the company repository.

az iot pnp interface update --def {updated_plug_and_play_interface_file_path} -r {pnp_repository}

Required Parameters

--def --definition

IoT Plug and Play interface 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.