@azure/arm-containerinstance

What is @azure/arm-containerinstance?

The @azure/arm-containerinstance package is a client library for managing Azure Container Instances. It allows developers to create, update, delete, and manage container groups and their configurations in Azure.

What are @azure/arm-containerinstance's main functionalities?

Create a Container Group

This feature allows you to create a new container group in Azure. The code sample demonstrates how to use the @azure/arm-containerinstance package to create a container group with a single container running the Nginx image.

const { ContainerInstanceManagementClient } = require('@azure/arm-containerinstance');
const { DefaultAzureCredential } = require('@azure/identity');

async function createContainerGroup() {
  const credential = new DefaultAzureCredential();
  const client = new ContainerInstanceManagementClient(credential, '<subscription-id>');
  const resourceGroupName = '<resource-group-name>';
  const containerGroupName = '<container-group-name>';
  const containerGroup = {
    location: 'eastus',
    containers: [
      {
        name: 'mycontainer',
        image: 'nginx',
        resources: {
          requests: {
            cpu: 1,
            memoryInGB: 1.5
          }
        }
      }
    ],
    osType: 'Linux'
  };
  const result = await client.containerGroups.createOrUpdate(resourceGroupName, containerGroupName, containerGroup);
  console.log(result);
}

createContainerGroup();

List Container Groups

This feature allows you to list all container groups within a specific resource group. The code sample shows how to retrieve and print the list of container groups using the @azure/arm-containerinstance package.

const { ContainerInstanceManagementClient } = require('@azure/arm-containerinstance');
const { DefaultAzureCredential } = require('@azure/identity');

async function listContainerGroups() {
  const credential = new DefaultAzureCredential();
  const client = new ContainerInstanceManagementClient(credential, '<subscription-id>');
  const resourceGroupName = '<resource-group-name>';
  const containerGroups = await client.containerGroups.listByResourceGroup(resourceGroupName);
  console.log(containerGroups);
}

listContainerGroups();

Delete a Container Group

This feature allows you to delete a specified container group. The code sample demonstrates how to use the @azure/arm-containerinstance package to delete a container group by its name.

const { ContainerInstanceManagementClient } = require('@azure/arm-containerinstance');
const { DefaultAzureCredential } = require('@azure/identity');

async function deleteContainerGroup() {
  const credential = new DefaultAzureCredential();
  const client = new ContainerInstanceManagementClient(credential, '<subscription-id>');
  const resourceGroupName = '<resource-group-name>';
  const containerGroupName = '<container-group-name>';
  await client.containerGroups.deleteMethod(resourceGroupName, containerGroupName);
  console.log(`Container group ${containerGroupName} deleted.`);
}

deleteContainerGroup();

Other packages similar to @azure/arm-containerinstance

kubernetes-client

The kubernetes-client package is a JavaScript client for the Kubernetes API. It provides similar functionalities for managing containerized applications, but it is focused on Kubernetes clusters rather than Azure Container Instances. It allows developers to interact with Kubernetes resources such as pods, services, and deployments.

dockerode

Dockerode is a Node.js Docker client. It provides functionalities to manage Docker containers, images, and networks. While it offers similar container management capabilities, it is specific to Docker environments and does not directly interact with Azure services like @azure/arm-containerinstance does.

README

Azure ContainerInstanceManagement client library for JavaScript

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

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

Getting started

Currently supported environments

• LTS versions of Node.js
• Latest versions of Safari, Chrome, Edge and Firefox.

See our support policy for more details.

Prerequisites

• An Azure subscription.

Install the @azure/arm-containerinstance package

Install the Azure ContainerInstanceManagement client library for JavaScript with npm:

npm install @azure/arm-containerinstance

Create and authenticate a ContainerInstanceManagementClient

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

You can authenticate with Azure Active Directory using a credential from the @azure/identity library or an existing AAD Token.

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 ContainerInstanceManagement 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.

For more information about how to create an Azure AD Application check out this guide.

const { ContainerInstanceManagementClient } = require("@azure/arm-containerinstance");
const { DefaultAzureCredential } = require("@azure/identity");
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new ContainerInstanceManagementClient(new DefaultAzureCredential(), subscriptionId);

// For client-side applications running in the browser, use this code instead:
// const credential = new InteractiveBrowserCredential({
//   tenantId: "<YOUR_TENANT_ID>",
//   clientId: "<YOUR_CLIENT_ID>"
// });
// const client = new ContainerInstanceManagementClient(credential, subscriptionId);

JavaScript Bundle

To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our bundling documentation.

Key concepts

ContainerInstanceManagementClient

ContainerInstanceManagementClient is the primary interface for developers using the Azure ContainerInstanceManagement client library. Explore the methods on this client object to understand the different features of the Azure ContainerInstanceManagement 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:

const { setLogLevel } = require("@azure/logger");
setLogLevel("info");

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

Next steps

Please take a look at the samples directory for detailed examples on how to use this library.

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

• Microsoft Azure SDK for JavaScript