Skip to content
This repository was archived by the owner on May 5, 2023. It is now read-only.
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/services/containerservicesManagement/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2018 Microsoft
Copyright (c) 2019 Microsoft

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
31 changes: 16 additions & 15 deletions lib/services/containerservicesManagement/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,40 +3,41 @@ uid: azure-arm-containerservice
summary: *content

---
# Microsoft Azure SDK for Node.js - ContainerServiceClient
**This SDK will be deprecated next year and will be replaced by a new TypeScript-based isomorphic SDK (found at https://github.com/Azure/azure-sdk-for-js) which works on Node.js and browsers.**
## Microsoft Azure SDK for Node.js - ContainerServiceClient

This project provides a Node.js package for accessing Azure. Right now it supports:
- **Node.js version 6.x.x or higher**

## Features
### Features


## How to Install
### How to Install

```bash
npm install azure-arm-containerservice
```

## How to use
### How to use

### Authentication, client creation and get openShiftManagedClusters as an example.
#### Authentication, client creation, and list operations as an example.

```javascript
const msRestAzure = require("ms-rest-azure");
const ContainerServiceClient = require("azure-arm-containerservice");
msRestAzure.interactiveLogin().then((creds) => {
const subscriptionId = "<Subscription_Id>";
const client = new ContainerServiceClient(creds, subscriptionId);
const resourceGroupName = "testresourceGroupName";
const resourceName = "testresourceName";
return client.openShiftManagedClusters.get(resourceGroupName, resourceName).then((result) => {
console.log("The result is:");
console.log(result);
});
const subscriptionId = "<Subscription_Id>";
const client = new ContainerServiceClient(creds, subscriptionId);

return client.operations.list().then((result) => {
console.log("The result is:");
console.log(result);
});
}).catch((err) => {
console.log('An error occurred:');
console.dir(err, {depth: null, colors: true});
});

## Related projects
```
### Related projects

- [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node)
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,15 @@ export default class ContainerServiceClient extends AzureServiceClient {

subscriptionId: string;

apiVersion: string;

acceptLanguage: string;

longRunningOperationRetryTimeout: number;

generateClientRequestId: boolean;

// Operation groups
openShiftManagedClusters: operations.OpenShiftManagedClusters;
containerServices: operations.ContainerServices;
operations: operations.Operations;
managedClusters: operations.ManagedClusters;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ class ContainerServiceClient extends ServiceClient {

super(credentials, options);

this.apiVersion = '2019-02-01';
this.acceptLanguage = 'en-US';
this.longRunningOperationRetryTimeout = 30;
this.generateClientRequestId = true;
Expand All @@ -71,8 +72,6 @@ class ContainerServiceClient extends ServiceClient {
if(options.generateClientRequestId !== null && options.generateClientRequestId !== undefined) {
this.generateClientRequestId = options.generateClientRequestId;
}
this.openShiftManagedClusters = new operations.OpenShiftManagedClusters(this);
this.containerServices = new operations.ContainerServices(this);
this.operations = new operations.Operations(this);
this.managedClusters = new operations.ManagedClusters(this);
this.models = models;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,85 +20,86 @@ const models = require('./index');
class ContainerService extends models['Resource'] {
/**
* Create a ContainerService.
* @member {string} [provisioningState] The current deployment or
* @property {string} [provisioningState] The current deployment or
* provisioning state, which only appears in the response.
* @member {object} orchestratorProfile Profile for the container service
* @property {object} orchestratorProfile Profile for the container service
* orchestrator.
* @member {string} [orchestratorProfile.orchestratorType] The orchestrator
* @property {string} [orchestratorProfile.orchestratorType] The orchestrator
* to use to manage container service cluster resources. Valid values are
* Kubernetes, Swarm, DCOS, DockerCE and Custom. Possible values include:
* 'Kubernetes', 'Swarm', 'DCOS', 'DockerCE', 'Custom'
* @member {string} [orchestratorProfile.orchestratorVersion] The version of
* the orchestrator to use. You can specify the major.minor.patch part of the
* actual version.For example, you can specify version as "1.6.11".
* @member {object} [customProfile] Properties to configure a custom
* @property {string} [orchestratorProfile.orchestratorVersion] The version
* of the orchestrator to use. You can specify the major.minor.patch part of
* the actual version.For example, you can specify version as "1.6.11".
* @property {object} [customProfile] Properties to configure a custom
* container service cluster.
* @member {string} [customProfile.orchestrator] The name of the custom
* @property {string} [customProfile.orchestrator] The name of the custom
* orchestrator to use.
* @member {object} [servicePrincipalProfile] Information about a service
* @property {object} [servicePrincipalProfile] Information about a service
* principal identity for the cluster to use for manipulating Azure APIs.
* Exact one of secret or keyVaultSecretRef need to be specified.
* @member {string} [servicePrincipalProfile.clientId] The ID for the service
* principal.
* @member {string} [servicePrincipalProfile.secret] The secret password
* @property {string} [servicePrincipalProfile.clientId] The ID for the
* service principal.
* @property {string} [servicePrincipalProfile.secret] The secret password
* associated with the service principal in plain text.
* @member {object} [servicePrincipalProfile.keyVaultSecretRef] Reference to
* a secret stored in Azure Key Vault.
* @member {string} [servicePrincipalProfile.keyVaultSecretRef.vaultID] Key
* @property {object} [servicePrincipalProfile.keyVaultSecretRef] Reference
* to a secret stored in Azure Key Vault.
* @property {string} [servicePrincipalProfile.keyVaultSecretRef.vaultID] Key
* vault identifier.
* @member {string} [servicePrincipalProfile.keyVaultSecretRef.secretName]
* @property {string} [servicePrincipalProfile.keyVaultSecretRef.secretName]
* The secret name.
* @member {string} [servicePrincipalProfile.keyVaultSecretRef.version] The
* @property {string} [servicePrincipalProfile.keyVaultSecretRef.version] The
* secret version.
* @member {object} masterProfile Profile for the container service master.
* @member {number} [masterProfile.count] Number of masters (VMs) in the
* @property {object} masterProfile Profile for the container service master.
* @property {number} [masterProfile.count] Number of masters (VMs) in the
* container service cluster. Allowed values are 1, 3, and 5. The default
* value is 1.
* @member {string} [masterProfile.dnsPrefix] DNS prefix to be used to create
* the FQDN for the master pool.
* @member {string} [masterProfile.vmSize] Size of agent VMs. Possible values
* include: 'Standard_A1', 'Standard_A10', 'Standard_A11', 'Standard_A1_v2',
* 'Standard_A2', 'Standard_A2_v2', 'Standard_A2m_v2', 'Standard_A3',
* 'Standard_A4', 'Standard_A4_v2', 'Standard_A4m_v2', 'Standard_A5',
* 'Standard_A6', 'Standard_A7', 'Standard_A8', 'Standard_A8_v2',
* 'Standard_A8m_v2', 'Standard_A9', 'Standard_B2ms', 'Standard_B2s',
* 'Standard_B4ms', 'Standard_B8ms', 'Standard_D1', 'Standard_D11',
* 'Standard_D11_v2', 'Standard_D11_v2_Promo', 'Standard_D12',
* 'Standard_D12_v2', 'Standard_D12_v2_Promo', 'Standard_D13',
* 'Standard_D13_v2', 'Standard_D13_v2_Promo', 'Standard_D14',
* 'Standard_D14_v2', 'Standard_D14_v2_Promo', 'Standard_D15_v2',
* 'Standard_D16_v3', 'Standard_D16s_v3', 'Standard_D1_v2', 'Standard_D2',
* 'Standard_D2_v2', 'Standard_D2_v2_Promo', 'Standard_D2_v3',
* 'Standard_D2s_v3', 'Standard_D3', 'Standard_D32_v3', 'Standard_D32s_v3',
* 'Standard_D3_v2', 'Standard_D3_v2_Promo', 'Standard_D4', 'Standard_D4_v2',
* 'Standard_D4_v2_Promo', 'Standard_D4_v3', 'Standard_D4s_v3',
* 'Standard_D5_v2', 'Standard_D5_v2_Promo', 'Standard_D64_v3',
* 'Standard_D64s_v3', 'Standard_D8_v3', 'Standard_D8s_v3', 'Standard_DS1',
* 'Standard_DS11', 'Standard_DS11_v2', 'Standard_DS11_v2_Promo',
* 'Standard_DS12', 'Standard_DS12_v2', 'Standard_DS12_v2_Promo',
* 'Standard_DS13', 'Standard_DS13-2_v2', 'Standard_DS13-4_v2',
* 'Standard_DS13_v2', 'Standard_DS13_v2_Promo', 'Standard_DS14',
* 'Standard_DS14-4_v2', 'Standard_DS14-8_v2', 'Standard_DS14_v2',
* 'Standard_DS14_v2_Promo', 'Standard_DS15_v2', 'Standard_DS1_v2',
* 'Standard_DS2', 'Standard_DS2_v2', 'Standard_DS2_v2_Promo',
* 'Standard_DS3', 'Standard_DS3_v2', 'Standard_DS3_v2_Promo',
* 'Standard_DS4', 'Standard_DS4_v2', 'Standard_DS4_v2_Promo',
* 'Standard_DS5_v2', 'Standard_DS5_v2_Promo', 'Standard_E16_v3',
* 'Standard_E16s_v3', 'Standard_E2_v3', 'Standard_E2s_v3',
* 'Standard_E32-16s_v3', 'Standard_E32-8s_v3', 'Standard_E32_v3',
* 'Standard_E32s_v3', 'Standard_E4_v3', 'Standard_E4s_v3',
* 'Standard_E64-16s_v3', 'Standard_E64-32s_v3', 'Standard_E64_v3',
* 'Standard_E64s_v3', 'Standard_E8_v3', 'Standard_E8s_v3', 'Standard_F1',
* 'Standard_F16', 'Standard_F16s', 'Standard_F16s_v2', 'Standard_F1s',
* 'Standard_F2', 'Standard_F2s', 'Standard_F2s_v2', 'Standard_F32s_v2',
* 'Standard_F4', 'Standard_F4s', 'Standard_F4s_v2', 'Standard_F64s_v2',
* 'Standard_F72s_v2', 'Standard_F8', 'Standard_F8s', 'Standard_F8s_v2',
* 'Standard_G1', 'Standard_G2', 'Standard_G3', 'Standard_G4', 'Standard_G5',
* 'Standard_GS1', 'Standard_GS2', 'Standard_GS3', 'Standard_GS4',
* 'Standard_GS4-4', 'Standard_GS4-8', 'Standard_GS5', 'Standard_GS5-16',
* 'Standard_GS5-8', 'Standard_H16', 'Standard_H16m', 'Standard_H16mr',
* 'Standard_H16r', 'Standard_H8', 'Standard_H8m', 'Standard_L16s',
* 'Standard_L32s', 'Standard_L4s', 'Standard_L8s', 'Standard_M128-32ms',
* @property {string} [masterProfile.dnsPrefix] DNS prefix to be used to
* create the FQDN for the master pool.
* @property {string} [masterProfile.vmSize] Size of agent VMs. Possible
* values include: 'Standard_A1', 'Standard_A10', 'Standard_A11',
* 'Standard_A1_v2', 'Standard_A2', 'Standard_A2_v2', 'Standard_A2m_v2',
* 'Standard_A3', 'Standard_A4', 'Standard_A4_v2', 'Standard_A4m_v2',
* 'Standard_A5', 'Standard_A6', 'Standard_A7', 'Standard_A8',
* 'Standard_A8_v2', 'Standard_A8m_v2', 'Standard_A9', 'Standard_B2ms',
* 'Standard_B2s', 'Standard_B4ms', 'Standard_B8ms', 'Standard_D1',
* 'Standard_D11', 'Standard_D11_v2', 'Standard_D11_v2_Promo',
* 'Standard_D12', 'Standard_D12_v2', 'Standard_D12_v2_Promo',
* 'Standard_D13', 'Standard_D13_v2', 'Standard_D13_v2_Promo',
* 'Standard_D14', 'Standard_D14_v2', 'Standard_D14_v2_Promo',
* 'Standard_D15_v2', 'Standard_D16_v3', 'Standard_D16s_v3',
* 'Standard_D1_v2', 'Standard_D2', 'Standard_D2_v2', 'Standard_D2_v2_Promo',
* 'Standard_D2_v3', 'Standard_D2s_v3', 'Standard_D3', 'Standard_D32_v3',
* 'Standard_D32s_v3', 'Standard_D3_v2', 'Standard_D3_v2_Promo',
* 'Standard_D4', 'Standard_D4_v2', 'Standard_D4_v2_Promo', 'Standard_D4_v3',
* 'Standard_D4s_v3', 'Standard_D5_v2', 'Standard_D5_v2_Promo',
* 'Standard_D64_v3', 'Standard_D64s_v3', 'Standard_D8_v3',
* 'Standard_D8s_v3', 'Standard_DS1', 'Standard_DS11', 'Standard_DS11_v2',
* 'Standard_DS11_v2_Promo', 'Standard_DS12', 'Standard_DS12_v2',
* 'Standard_DS12_v2_Promo', 'Standard_DS13', 'Standard_DS13-2_v2',
* 'Standard_DS13-4_v2', 'Standard_DS13_v2', 'Standard_DS13_v2_Promo',
* 'Standard_DS14', 'Standard_DS14-4_v2', 'Standard_DS14-8_v2',
* 'Standard_DS14_v2', 'Standard_DS14_v2_Promo', 'Standard_DS15_v2',
* 'Standard_DS1_v2', 'Standard_DS2', 'Standard_DS2_v2',
* 'Standard_DS2_v2_Promo', 'Standard_DS3', 'Standard_DS3_v2',
* 'Standard_DS3_v2_Promo', 'Standard_DS4', 'Standard_DS4_v2',
* 'Standard_DS4_v2_Promo', 'Standard_DS5_v2', 'Standard_DS5_v2_Promo',
* 'Standard_E16_v3', 'Standard_E16s_v3', 'Standard_E2_v3',
* 'Standard_E2s_v3', 'Standard_E32-16s_v3', 'Standard_E32-8s_v3',
* 'Standard_E32_v3', 'Standard_E32s_v3', 'Standard_E4_v3',
* 'Standard_E4s_v3', 'Standard_E64-16s_v3', 'Standard_E64-32s_v3',
* 'Standard_E64_v3', 'Standard_E64s_v3', 'Standard_E8_v3',
* 'Standard_E8s_v3', 'Standard_F1', 'Standard_F16', 'Standard_F16s',
* 'Standard_F16s_v2', 'Standard_F1s', 'Standard_F2', 'Standard_F2s',
* 'Standard_F2s_v2', 'Standard_F32s_v2', 'Standard_F4', 'Standard_F4s',
* 'Standard_F4s_v2', 'Standard_F64s_v2', 'Standard_F72s_v2', 'Standard_F8',
* 'Standard_F8s', 'Standard_F8s_v2', 'Standard_G1', 'Standard_G2',
* 'Standard_G3', 'Standard_G4', 'Standard_G5', 'Standard_GS1',
* 'Standard_GS2', 'Standard_GS3', 'Standard_GS4', 'Standard_GS4-4',
* 'Standard_GS4-8', 'Standard_GS5', 'Standard_GS5-16', 'Standard_GS5-8',
* 'Standard_H16', 'Standard_H16m', 'Standard_H16mr', 'Standard_H16r',
* 'Standard_H8', 'Standard_H8m', 'Standard_L16s', 'Standard_L32s',
* 'Standard_L4s', 'Standard_L8s', 'Standard_M128-32ms',
* 'Standard_M128-64ms', 'Standard_M128ms', 'Standard_M128s',
* 'Standard_M64-16ms', 'Standard_M64-32ms', 'Standard_M64ms',
* 'Standard_M64s', 'Standard_NC12', 'Standard_NC12s_v2',
Expand All @@ -107,42 +108,44 @@ class ContainerService extends models['Resource'] {
* 'Standard_NC24s_v3', 'Standard_NC6', 'Standard_NC6s_v2',
* 'Standard_NC6s_v3', 'Standard_ND12s', 'Standard_ND24rs', 'Standard_ND24s',
* 'Standard_ND6s', 'Standard_NV12', 'Standard_NV24', 'Standard_NV6'
* @member {number} [masterProfile.osDiskSizeGB] OS Disk Size in GB to be
* @property {number} [masterProfile.osDiskSizeGB] OS Disk Size in GB to be
* used to specify the disk size for every machine in this master/agent pool.
* If you specify 0, it will apply the default osDisk size according to the
* vmSize specified.
* @member {string} [masterProfile.vnetSubnetID] VNet SubnetID specifies the
* vnet's subnet identifier.
* @member {string} [masterProfile.firstConsecutiveStaticIP]
* @property {string} [masterProfile.vnetSubnetID] VNet SubnetID specifies
* the VNet's subnet identifier.
* @property {string} [masterProfile.firstConsecutiveStaticIP]
* FirstConsecutiveStaticIP used to specify the first static ip of masters.
* @member {string} [masterProfile.storageProfile] Storage profile specifies
* what kind of storage used. Choose from StorageAccount and ManagedDisks.
* Leave it empty, we will choose for you based on the orchestrator choice.
* Possible values include: 'StorageAccount', 'ManagedDisks'
* @member {string} [masterProfile.fqdn] FDQN for the master pool.
* @member {array} [agentPoolProfiles] Properties of the agent pool.
* @member {object} [windowsProfile] Profile for Windows VMs in the container
* service cluster.
* @member {string} [windowsProfile.adminUsername] The administrator username
* to use for Windows VMs.
* @member {string} [windowsProfile.adminPassword] The administrator password
* to use for Windows VMs.
* @member {object} linuxProfile Profile for Linux VMs in the container
* @property {string} [masterProfile.storageProfile] Storage profile
* specifies what kind of storage used. Choose from StorageAccount and
* ManagedDisks. Leave it empty, we will choose for you based on the
* orchestrator choice. Possible values include: 'StorageAccount',
* 'ManagedDisks'
* @property {string} [masterProfile.fqdn] FQDN for the master pool.
* @property {array} [agentPoolProfiles] Properties of the agent pool.
* @property {object} [windowsProfile] Profile for Windows VMs in the
* container service cluster.
* @property {string} [windowsProfile.adminUsername] The administrator
* username to use for Windows VMs.
* @property {string} [windowsProfile.adminPassword] The administrator
* password to use for Windows VMs.
* @property {object} linuxProfile Profile for Linux VMs in the container
* service cluster.
* @member {string} [linuxProfile.adminUsername] The administrator username
* @property {string} [linuxProfile.adminUsername] The administrator username
* to use for Linux VMs.
* @member {object} [linuxProfile.ssh] SSH configuration for Linux-based VMs
* running on Azure.
* @member {array} [linuxProfile.ssh.publicKeys] The list of SSH public keys
* used to authenticate with Linux-based VMs. Only expect one key specified.
* @member {object} [diagnosticsProfile] Profile for diagnostics in the
* @property {object} [linuxProfile.ssh] SSH configuration for Linux-based
* VMs running on Azure.
* @property {array} [linuxProfile.ssh.publicKeys] The list of SSH public
* keys used to authenticate with Linux-based VMs. Only expect one key
* specified.
* @property {object} [diagnosticsProfile] Profile for diagnostics in the
* container service cluster.
* @member {object} [diagnosticsProfile.vmDiagnostics] Profile for
* @property {object} [diagnosticsProfile.vmDiagnostics] Profile for
* diagnostics on the container service VMs.
* @member {boolean} [diagnosticsProfile.vmDiagnostics.enabled] Whether the
* @property {boolean} [diagnosticsProfile.vmDiagnostics.enabled] Whether the
* VM diagnostic agent is provisioned on the VM.
* @member {string} [diagnosticsProfile.vmDiagnostics.storageUri] The URI of
* the storage account where diagnostics are stored.
* @property {string} [diagnosticsProfile.vmDiagnostics.storageUri] The URI
* of the storage account where diagnostics are stored.
*/
constructor() {
super();
Expand Down
Loading