This package has been deprecated

    Author message:

    it was for test

    @azure/arm-template
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0-beta.2 • Public • Published

    Azure IoTSpaces client library for JavaScript

    This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure IoTSpaces client.

    Use this API to manage the IoTSpaces service instances in your Azure subscription.

    Source code | Package (NPM) | API reference documentation |

    Getting started

    Currently supported environments

    Prerequisites

    Install the @azure/arm-template package

    Install the Azure IoTSpaces client library for JavaScript with npm:

    npm install @azure/arm-template

    Create and authenticate a IoTSpacesClient

    To create a client object to access the Azure IoTSpaces API, you will need the endpoint of your Azure IoTSpaces resource and a credential. The Azure IoTSpaces client can use Azure Active Directory credentials to authenticate. You can find the endpoint for your Azure IoTSpaces resource in the Azure Portal.

    Using an Azure Active Directory Credential

    You can authenticate with Azure Active Directory using the Azure Identity library. To use the DefaultAzureCredential provider shown below, or other credential providers provided with the Azure SDK, please install the @azure/identity package:

    npm install @azure/identity

    You will also need to register a new AAD application and grant access to Azure IoTSpaces by assigning the suitable role to your service principal (note: roles such as "Owner" will not grant the necessary permissions). Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET.

    const { IoTSpacesClient } = require("@azure/arm-template");
    const { DefaultAzureCredential } = require("@azure/identity");
    const client = new IoTSpacesClient("<endpoint>", new DefaultAzureCredential());

    Key concepts

    IoTSpacesClient

    IoTSpacesClient is the primary interface for developers using the Azure IoTSpaces client library. Explore the methods on this client object to understand the different features of the Azure IoTSpaces service that you can access.

    Troubleshooting

    Logging

    Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the AZURE_LOG_LEVEL environment variable to info. Alternatively, logging can be enabled at runtime by calling setLogLevel in the @azure/logger:

    import { setLogLevel } from "@azure/logger";
    setLogLevel("info");

    For more detailed instructions on how to enable logs, you can look at the @azure/logger package docs.

    Contributing

    If you'd like to contribute to this library, please read the contributing guide to learn more about how to build and test the code.

    Related projects

    Impressions

    Install

    npm i @azure/arm-template

    DownloadsWeekly Downloads

    6

    Version

    1.0.0-beta.2

    License

    MIT

    Unpacked Size

    492 kB

    Total Files

    125

    Last publish

    Collaborators

    • azure-sdk
    • christopheranderson
    • southpolesteve