azure-sdk-for-js/sdk/hybridkubernetes/arm-hybridkubernetes
Will Temple c7f3a2a70b Replace master with main in homepage links. 2021-06-22 16:09:11 -07:00
..
src arm-hybridkubernetes-release (#13937) 2021-03-01 10:58:27 +08:00
LICENSE.txt arm-hybridkubernetes-release (#13937) 2021-03-01 10:58:27 +08:00
README.md arm-hybridkubernetes-release (#13937) 2021-03-01 10:58:27 +08:00
package.json Replace master with main in homepage links. 2021-06-22 16:09:11 -07:00
rollup.config.js arm-hybridkubernetes-release (#13937) 2021-03-01 10:58:27 +08:00
tsconfig.json arm-hybridkubernetes-release (#13937) 2021-03-01 10:58:27 +08:00

README.md

Azure ConnectedKubernetesClient SDK for JavaScript

This package contains an isomorphic SDK for ConnectedKubernetesClient.

Currently supported environments

  • Node.js version 6.x.x or higher
  • Browser JavaScript

How to Install

npm install @azure/arm-hybridkubernetes

How to use

nodejs - client creation and get connectedCluster as an example written in TypeScript.

Install @azure/ms-rest-nodeauth
  • Please install minimum version of "@azure/ms-rest-nodeauth": "^3.0.0".
npm install @azure/ms-rest-nodeauth@"^3.0.0"
Sample code

While the below sample uses the interactive login, other authentication options can be found in the README.md file of @azure/ms-rest-nodeauth package

const msRestNodeAuth = require("@azure/ms-rest-nodeauth");
const { ConnectedKubernetesClient } = require("@azure/arm-hybridkubernetes");
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];

msRestNodeAuth.interactiveLogin().then((creds) => {
  const client = new ConnectedKubernetesClient(creds, subscriptionId);
  const resourceGroupName = "testresourceGroupName";
  const clusterName = "testclusterName";
  client.connectedCluster.get(resourceGroupName, clusterName).then((result) => {
    console.log("The result is:");
    console.log(result);
  });
}).catch((err) => {
  console.error(err);
});

browser - Authentication, client creation and get connectedCluster as an example written in JavaScript.

Install @azure/ms-rest-browserauth
npm install @azure/ms-rest-browserauth
Sample code

See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser.

  • index.html
<!DOCTYPE html>
<html lang="en">
  <head>
    <title>@azure/arm-hybridkubernetes sample</title>
    <script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
    <script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script>
    <script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script>
    <script src="node_modules/@azure/arm-hybridkubernetes/dist/arm-hybridkubernetes.js"></script>
    <script type="text/javascript">
      const subscriptionId = "<Subscription_Id>";
      const authManager = new msAuth.AuthManager({
        clientId: "<client id for your Azure AD app>",
        tenant: "<optional tenant for your organization>"
      });
      authManager.finalizeLogin().then((res) => {
        if (!res.isLoggedIn) {
          // may cause redirects
          authManager.login();
        }
        const client = new Azure.ArmHybridkubernetes.ConnectedKubernetesClient(res.creds, subscriptionId);
        const resourceGroupName = "testresourceGroupName";
        const clusterName = "testclusterName";
        client.connectedCluster.get(resourceGroupName, clusterName).then((result) => {
          console.log("The result is:");
          console.log(result);
        }).catch((err) => {
          console.log("An error occurred:");
          console.error(err);
        });
      });
    </script>
  </head>
  <body></body>
</html>

Impressions