@azure/arm-devspaces 2.0.1-alpha.20221101.1 → 2.1.0

package/CHANGELOG.md

@@ -1,15 +1,14 @@
 # Release History
-
-## 2.0.1 (Unreleased)
-
-### Features Added
-
-### Breaking Changes
-
-### Bugs Fixed
-
-### Other Changes
-
+    
+## 2.1.0 (2022-11-22)
+    
+**Features**
+
+  - Added Interface Controller
+  - Added Interface KubernetesConnectionDetails
+  - Added Interface TrackedResource
+    
+    
 ## 2.0.0 (2022-01-13)
 
 The package of @azure/arm-devspaces is using our next generation design principles since version 2.0.0, which contains breaking changes.

package/README.md

@@ -16,6 +16,8 @@ Dev Spaces Client
 - [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule)
 - Latest versions of Safari, Chrome, Edge and Firefox.
 
+See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details.
+
 ### Prerequisites
 
 - An [Azure subscription][azure_sub].
@@ -49,8 +51,17 @@ For more information about how to create an Azure AD Application check out [this
 ```javascript
 const { DevSpacesManagementClient } = require("@azure/arm-devspaces");
 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 DevSpacesManagementClient(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 DevSpacesManagementClient(credential, subscriptionId);
 ```
 
 

package/dist/index.js

@@ -2,10 +2,32 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var coreClient = require('@azure/core-client');
 var tslib = require('tslib');
+var coreClient = require('@azure/core-client');
+var coreRestPipeline = require('@azure/core-rest-pipeline');
 var coreLro = require('@azure/core-lro');
 
+function _interopNamespace(e) {
+    if (e && e.__esModule) return e;
+    var n = Object.create(null);
+    if (e) {
+        Object.keys(e).forEach(function (k) {
+            if (k !== 'default') {
+                var d = Object.getOwnPropertyDescriptor(e, k);
+                Object.defineProperty(n, k, d.get ? d : {
+                    enumerable: true,
+                    get: function () { return e[k]; }
+                });
+            }
+        });
+    }
+    n["default"] = e;
+    return Object.freeze(n);
+}
+
+var coreClient__namespace = /*#__PURE__*/_interopNamespace(coreClient);
+var coreRestPipeline__namespace = /*#__PURE__*/_interopNamespace(coreRestPipeline);
+
 /*
  * Copyright (c) Microsoft Corporation.
  * Licensed under the MIT License.
@@ -13,19 +35,66 @@ var coreLro = require('@azure/core-lro');
  * Code generated by Microsoft (R) AutoRest Code Generator.
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
+const pageMap = new WeakMap();
+/**
+ * Given a result page from a pageable operation, returns a
+ * continuation token that can be used to begin paging from
+ * that point later.
+ * @param page A result object from calling .byPage() on a paged operation.
+ * @returns The continuation token that can be passed into byPage().
+ */
+function getContinuationToken(page) {
+    var _a;
+    if (typeof page !== "object" || page === null) {
+        return undefined;
+    }
+    return (_a = pageMap.get(page)) === null || _a === void 0 ? void 0 : _a.continuationToken;
+}
+function setContinuationToken(page, continuationToken) {
+    var _a;
+    if (typeof page !== "object" || page === null || !continuationToken) {
+        return;
+    }
+    const pageInfo = (_a = pageMap.get(page)) !== null && _a !== void 0 ? _a : {};
+    pageInfo.continuationToken = continuationToken;
+    pageMap.set(page, pageInfo);
+}
+
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+/** Known values of {@link ProvisioningState} that the service accepts. */
+exports.KnownProvisioningState = void 0;
 (function (KnownProvisioningState) {
+    /** Succeeded */
     KnownProvisioningState["Succeeded"] = "Succeeded";
+    /** Failed */
     KnownProvisioningState["Failed"] = "Failed";
+    /** Canceled */
     KnownProvisioningState["Canceled"] = "Canceled";
+    /** Updating */
     KnownProvisioningState["Updating"] = "Updating";
+    /** Creating */
     KnownProvisioningState["Creating"] = "Creating";
+    /** Deleting */
     KnownProvisioningState["Deleting"] = "Deleting";
+    /** Deleted */
     KnownProvisioningState["Deleted"] = "Deleted";
 })(exports.KnownProvisioningState || (exports.KnownProvisioningState = {}));
+/** Known values of {@link SkuName} that the service accepts. */
+exports.KnownSkuName = void 0;
 (function (KnownSkuName) {
+    /** S1 */
     KnownSkuName["S1"] = "S1";
 })(exports.KnownSkuName || (exports.KnownSkuName = {}));
+/** Known values of {@link SkuTier} that the service accepts. */
+exports.KnownSkuTier = void 0;
 (function (KnownSkuTier) {
+    /** Standard */
     KnownSkuTier["Standard"] = "Standard";
 })(exports.KnownSkuTier || (exports.KnownSkuTier = {}));
 
@@ -341,6 +410,7 @@ const OrchestratorSpecificConnectionDetails = {
         modelProperties: {
             instanceType: {
                 serializedName: "instanceType",
+                required: true,
                 readOnly: true,
                 type: {
                     name: "String"
@@ -616,7 +686,7 @@ class ContainerHostMappingsImpl {
     }
 }
 // Operation Specifications
-const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+const serializer$2 = coreClient__namespace.createSerializer(Mappers, /* isXml */ false);
 const getContainerHostMappingOperationSpec = {
     path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/locations/{location}/checkContainerHostMapping",
     httpMethod: "POST",
@@ -639,7 +709,7 @@ const getContainerHostMappingOperationSpec = {
     ],
     headerParameters: [contentType, accept],
     mediaType: "json",
-    serializer
+    serializer: serializer$2
 };
 
 /*
@@ -673,20 +743,31 @@ class OperationsImpl {
             [Symbol.asyncIterator]() {
                 return this;
             },
-            byPage: () => {
-                return this.listPagingPage(options);
+            byPage: (settings) => {
+                if (settings === null || settings === void 0 ? void 0 : settings.maxPageSize) {
+                    throw new Error("maxPageSize is not supported by this operation.");
+                }
+                return this.listPagingPage(options, settings);
             }
         };
     }
-    listPagingPage(options) {
+    listPagingPage(options, settings) {
         return tslib.__asyncGenerator(this, arguments, function* listPagingPage_1() {
-            let result = yield tslib.__await(this._list(options));
-            yield yield tslib.__await(result.value || []);
-            let continuationToken = result.nextLink;
+            let result;
+            let continuationToken = settings === null || settings === void 0 ? void 0 : settings.continuationToken;
+            if (!continuationToken) {
+                result = yield tslib.__await(this._list(options));
+                let page = result.value || [];
+                continuationToken = result.nextLink;
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
+            }
             while (continuationToken) {
                 result = yield tslib.__await(this._listNext(continuationToken, options));
                 continuationToken = result.nextLink;
-                yield yield tslib.__await(result.value || []);
+                let page = result.value || [];
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
             }
         });
     }
@@ -714,7 +795,7 @@ class OperationsImpl {
      * @param options The options parameters.
      */
     _list(options) {
-        return this.client.sendOperationRequest({ options }, listOperationSpec);
+        return this.client.sendOperationRequest({ options }, listOperationSpec$1);
     }
     /**
      * ListNext
@@ -722,12 +803,12 @@ class OperationsImpl {
      * @param options The options parameters.
      */
     _listNext(nextLink, options) {
-        return this.client.sendOperationRequest({ nextLink, options }, listNextOperationSpec);
+        return this.client.sendOperationRequest({ nextLink, options }, listNextOperationSpec$1);
     }
 }
 // Operation Specifications
-const serializer$1 = coreClient.createSerializer(Mappers, /* isXml */ false);
-const listOperationSpec = {
+const serializer$1 = coreClient__namespace.createSerializer(Mappers, /* isXml */ false);
+const listOperationSpec$1 = {
     path: "/providers/Microsoft.DevSpaces/operations",
     httpMethod: "GET",
     responses: {
@@ -740,7 +821,7 @@ const listOperationSpec = {
     headerParameters: [accept],
     serializer: serializer$1
 };
-const listNextOperationSpec = {
+const listNextOperationSpec$1 = {
     path: "{nextLink}",
     httpMethod: "GET",
     responses: {
@@ -814,20 +895,31 @@ class ControllersImpl {
             [Symbol.asyncIterator]() {
                 return this;
             },
-            byPage: () => {
-                return this.listByResourceGroupPagingPage(resourceGroupName, options);
+            byPage: (settings) => {
+                if (settings === null || settings === void 0 ? void 0 : settings.maxPageSize) {
+                    throw new Error("maxPageSize is not supported by this operation.");
+                }
+                return this.listByResourceGroupPagingPage(resourceGroupName, options, settings);
             }
         };
     }
-    listByResourceGroupPagingPage(resourceGroupName, options) {
+    listByResourceGroupPagingPage(resourceGroupName, options, settings) {
         return tslib.__asyncGenerator(this, arguments, function* listByResourceGroupPagingPage_1() {
-            let result = yield tslib.__await(this._listByResourceGroup(resourceGroupName, options));
-            yield yield tslib.__await(result.value || []);
-            let continuationToken = result.nextLink;
+            let result;
+            let continuationToken = settings === null || settings === void 0 ? void 0 : settings.continuationToken;
+            if (!continuationToken) {
+                result = yield tslib.__await(this._listByResourceGroup(resourceGroupName, options));
+                let page = result.value || [];
+                continuationToken = result.nextLink;
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
+            }
             while (continuationToken) {
                 result = yield tslib.__await(this._listByResourceGroupNext(resourceGroupName, continuationToken, options));
                 continuationToken = result.nextLink;
-                yield yield tslib.__await(result.value || []);
+                let page = result.value || [];
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
             }
         });
     }
@@ -862,20 +954,31 @@ class ControllersImpl {
             [Symbol.asyncIterator]() {
                 return this;
             },
-            byPage: () => {
-                return this.listPagingPage(options);
+            byPage: (settings) => {
+                if (settings === null || settings === void 0 ? void 0 : settings.maxPageSize) {
+                    throw new Error("maxPageSize is not supported by this operation.");
+                }
+                return this.listPagingPage(options, settings);
             }
         };
     }
-    listPagingPage(options) {
+    listPagingPage(options, settings) {
         return tslib.__asyncGenerator(this, arguments, function* listPagingPage_1() {
-            let result = yield tslib.__await(this._list(options));
-            yield yield tslib.__await(result.value || []);
-            let continuationToken = result.nextLink;
+            let result;
+            let continuationToken = settings === null || settings === void 0 ? void 0 : settings.continuationToken;
+            if (!continuationToken) {
+                result = yield tslib.__await(this._list(options));
+                let page = result.value || [];
+                continuationToken = result.nextLink;
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
+            }
             while (continuationToken) {
                 result = yield tslib.__await(this._listNext(continuationToken, options));
                 continuationToken = result.nextLink;
-                yield yield tslib.__await(result.value || []);
+                let page = result.value || [];
+                setContinuationToken(page, continuationToken);
+                yield yield tslib.__await(page);
             }
         });
     }
@@ -938,10 +1041,12 @@ class ControllersImpl {
                 };
             });
             const lro = new LroImpl(sendOperation, { resourceGroupName, name, controller, options }, createOperationSpec);
-            return new coreLro.LroEngine(lro, {
+            const poller = new coreLro.LroEngine(lro, {
                 resumeFrom: options === null || options === void 0 ? void 0 : options.resumeFrom,
                 intervalInMs: options === null || options === void 0 ? void 0 : options.updateIntervalInMs
             });
+            yield poller.poll();
+            return poller;
         });
     }
     /**
@@ -988,10 +1093,12 @@ class ControllersImpl {
                 };
             });
             const lro = new LroImpl(sendOperation, { resourceGroupName, name, options }, deleteOperationSpec);
-            return new coreLro.LroEngine(lro, {
+            const poller = new coreLro.LroEngine(lro, {
                 resumeFrom: options === null || options === void 0 ? void 0 : options.resumeFrom,
                 intervalInMs: options === null || options === void 0 ? void 0 : options.updateIntervalInMs
             });
+            yield poller.poll();
+            return poller;
         });
     }
     /**
@@ -1031,7 +1138,7 @@ class ControllersImpl {
      * @param options The options parameters.
      */
     _list(options) {
-        return this.client.sendOperationRequest({ options }, listOperationSpec$1);
+        return this.client.sendOperationRequest({ options }, listOperationSpec);
     }
     /**
      * Lists connection details for the underlying container resources of an Azure Dev Spaces Controller.
@@ -1059,11 +1166,11 @@ class ControllersImpl {
      * @param options The options parameters.
      */
     _listNext(nextLink, options) {
-        return this.client.sendOperationRequest({ nextLink, options }, listNextOperationSpec$1);
+        return this.client.sendOperationRequest({ nextLink, options }, listNextOperationSpec);
     }
 }
 // Operation Specifications
-const serializer$2 = coreClient.createSerializer(Mappers, /* isXml */ false);
+const serializer = coreClient__namespace.createSerializer(Mappers, /* isXml */ false);
 const getOperationSpec = {
     path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/controllers/{name}",
     httpMethod: "GET",
@@ -1083,7 +1190,7 @@ const getOperationSpec = {
         name
     ],
     headerParameters: [accept],
-    serializer: serializer$2
+    serializer
 };
 const createOperationSpec = {
     path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/controllers/{name}",
@@ -1115,7 +1222,7 @@ const createOperationSpec = {
     ],
     headerParameters: [contentType, accept],
     mediaType: "json",
-    serializer: serializer$2
+    serializer
 };
 const deleteOperationSpec = {
     path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/controllers/{name}",
@@ -1137,7 +1244,7 @@ const deleteOperationSpec = {
         name
     ],
     headerParameters: [accept],
-    serializer: serializer$2
+    serializer
 };
 const updateOperationSpec = {
     path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/controllers/{name}",
@@ -1163,7 +1270,7 @@ const updateOperationSpec = {
     ],
     headerParameters: [contentType, accept],
     mediaType: "json",
-    serializer: serializer$2
+    serializer
 };
 const listByResourceGroupOperationSpec = {
     path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/controllers",
@@ -1183,9 +1290,9 @@ const listByResourceGroupOperationSpec = {
         resourceGroupName
     ],
     headerParameters: [accept],
-    serializer: serializer$2
+    serializer
 };
-const listOperationSpec$1 = {
+const listOperationSpec = {
     path: "/subscriptions/{subscriptionId}/providers/Microsoft.DevSpaces/controllers",
     httpMethod: "GET",
     responses: {
@@ -1199,7 +1306,7 @@ const listOperationSpec$1 = {
     queryParameters: [apiVersion],
     urlParameters: [$host, subscriptionId],
     headerParameters: [accept],
-    serializer: serializer$2
+    serializer
 };
 const listConnectionDetailsOperationSpec = {
     path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/controllers/{name}/listConnectionDetails",
@@ -1222,7 +1329,7 @@ const listConnectionDetailsOperationSpec = {
     ],
     headerParameters: [contentType, accept],
     mediaType: "json",
-    serializer: serializer$2
+    serializer
 };
 const listByResourceGroupNextOperationSpec = {
     path: "{nextLink}",
@@ -1243,9 +1350,9 @@ const listByResourceGroupNextOperationSpec = {
         nextLink
     ],
     headerParameters: [accept],
-    serializer: serializer$2
+    serializer
 };
-const listNextOperationSpec$1 = {
+const listNextOperationSpec = {
     path: "{nextLink}",
     httpMethod: "GET",
     responses: {
@@ -1263,7 +1370,7 @@ const listNextOperationSpec$1 = {
         nextLink
     ],
     headerParameters: [accept],
-    serializer: serializer$2
+    serializer
 };
 
 /*
@@ -1273,7 +1380,7 @@ const listNextOperationSpec$1 = {
  * Code generated by Microsoft (R) AutoRest Code Generator.
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
-class DevSpacesManagementClient extends coreClient.ServiceClient {
+class DevSpacesManagementClient extends coreClient__namespace.ServiceClient {
     /**
      * Initializes a new instance of the DevSpacesManagementClient class.
      * @param credentials Subscription credentials which uniquely identify client subscription.
@@ -1281,6 +1388,7 @@ class DevSpacesManagementClient extends coreClient.ServiceClient {
      * @param options The parameter options
      */
     constructor(credentials, subscriptionId, options) {
+        var _a, _b, _c;
         if (credentials === undefined) {
             throw new Error("'credentials' cannot be null");
         }
@@ -1295,17 +1403,35 @@ class DevSpacesManagementClient extends coreClient.ServiceClient {
             requestContentType: "application/json; charset=utf-8",
             credential: credentials
         };
-        const packageDetails = `azsdk-js-arm-devspaces/2.0.0`;
+        const packageDetails = `azsdk-js-arm-devspaces/2.1.0`;
         const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
             ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
             : `${packageDetails}`;
-        if (!options.credentialScopes) {
-            options.credentialScopes = ["https://management.azure.com/.default"];
-        }
         const optionsWithDefaults = Object.assign(Object.assign(Object.assign({}, defaults), options), { userAgentOptions: {
                 userAgentPrefix
-            }, baseUri: options.endpoint || "https://management.azure.com" });
+            }, endpoint: (_b = (_a = options.endpoint) !== null && _a !== void 0 ? _a : options.baseUri) !== null && _b !== void 0 ? _b : "https://management.azure.com" });
         super(optionsWithDefaults);
+        let bearerTokenAuthenticationPolicyFound = false;
+        if ((options === null || options === void 0 ? void 0 : options.pipeline) && options.pipeline.getOrderedPolicies().length > 0) {
+            const pipelinePolicies = options.pipeline.getOrderedPolicies();
+            bearerTokenAuthenticationPolicyFound = pipelinePolicies.some((pipelinePolicy) => pipelinePolicy.name ===
+                coreRestPipeline__namespace.bearerTokenAuthenticationPolicyName);
+        }
+        if (!options ||
+            !options.pipeline ||
+            options.pipeline.getOrderedPolicies().length == 0 ||
+            !bearerTokenAuthenticationPolicyFound) {
+            this.pipeline.removePolicy({
+                name: coreRestPipeline__namespace.bearerTokenAuthenticationPolicyName
+            });
+            this.pipeline.addPolicy(coreRestPipeline__namespace.bearerTokenAuthenticationPolicy({
+                credential: credentials,
+                scopes: (_c = optionsWithDefaults.credentialScopes) !== null && _c !== void 0 ? _c : `${optionsWithDefaults.endpoint}/.default`,
+                challengeCallbacks: {
+                    authorizeRequestOnChallenge: coreClient__namespace.authorizeRequestOnClaimChallenge
+                }
+            }));
+        }
         // Parameter assignments
         this.subscriptionId = subscriptionId;
         // Assigning values to Constant parameters
@@ -1314,8 +1440,37 @@ class DevSpacesManagementClient extends coreClient.ServiceClient {
         this.containerHostMappings = new ContainerHostMappingsImpl(this);
         this.operations = new OperationsImpl(this);
         this.controllers = new ControllersImpl(this);
+        this.addCustomApiVersionPolicy(options.apiVersion);
+    }
+    /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+    addCustomApiVersionPolicy(apiVersion) {
+        if (!apiVersion) {
+            return;
+        }
+        const apiVersionPolicy = {
+            name: "CustomApiVersionPolicy",
+            sendRequest(request, next) {
+                return tslib.__awaiter(this, void 0, void 0, function* () {
+                    const param = request.url.split("?");
+                    if (param.length > 1) {
+                        const newParams = param[1].split("&").map((item) => {
+                            if (item.indexOf("api-version") > -1) {
+                                return "api-version=" + apiVersion;
+                            }
+                            else {
+                                return item;
+                            }
+                        });
+                        request.url = param[0] + "?" + newParams.join("&");
+                    }
+                    return next(request);
+                });
+            }
+        };
+        this.pipeline.addPolicy(apiVersionPolicy);
     }
 }
 
 exports.DevSpacesManagementClient = DevSpacesManagementClient;
+exports.getContinuationToken = getContinuationToken;
 //# sourceMappingURL=index.js.map