@azure/arm-containerinstance 9.2.0-beta.1 → 9.2.0-beta.2

package/dist/esm/operations/containerGroups.js

@@ -0,0 +1,697 @@
+/*
+ * 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.
+ */
+import { setContinuationToken } from "../pagingHelper.js";
+import * as coreClient from "@azure/core-client";
+import * as Mappers from "../models/mappers.js";
+import * as Parameters from "../models/parameters.js";
+import { createHttpPoller, } from "@azure/core-lro";
+import { createLroSpec } from "../lroImpl.js";
+/// <reference lib="esnext.asynciterable" />
+/** Class containing ContainerGroups operations. */
+export class ContainerGroupsImpl {
+    client;
+    /**
+     * Initialize a new instance of the class ContainerGroups class.
+     * @param client Reference to the service client
+     */
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Get a list of container groups in the specified subscription. This operation returns properties of
+     * each container group including containers, image registry credentials, restart policy, IP address
+     * type, OS type, state, and volumes.
+     * @param options The options parameters.
+     */
+    list(options) {
+        const iter = this.listPagingAll(options);
+        return {
+            next() {
+                return iter.next();
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+            byPage: (settings) => {
+                if (settings?.maxPageSize) {
+                    throw new Error("maxPageSize is not supported by this operation.");
+                }
+                return this.listPagingPage(options, settings);
+            },
+        };
+    }
+    async *listPagingPage(options, settings) {
+        let result;
+        let continuationToken = settings?.continuationToken;
+        if (!continuationToken) {
+            result = await this._list(options);
+            let page = result.value || [];
+            continuationToken = result.nextLink;
+            setContinuationToken(page, continuationToken);
+            yield page;
+        }
+        while (continuationToken) {
+            result = await this._listNext(continuationToken, options);
+            continuationToken = result.nextLink;
+            let page = result.value || [];
+            setContinuationToken(page, continuationToken);
+            yield page;
+        }
+    }
+    async *listPagingAll(options) {
+        for await (const page of this.listPagingPage(options)) {
+            yield* page;
+        }
+    }
+    /**
+     * Get a list of container groups in a specified subscription and resource group. This operation
+     * returns properties of each container group including containers, image registry credentials, restart
+     * policy, IP address type, OS type, state, and volumes.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param options The options parameters.
+     */
+    listByResourceGroup(resourceGroupName, options) {
+        const iter = this.listByResourceGroupPagingAll(resourceGroupName, options);
+        return {
+            next() {
+                return iter.next();
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+            byPage: (settings) => {
+                if (settings?.maxPageSize) {
+                    throw new Error("maxPageSize is not supported by this operation.");
+                }
+                return this.listByResourceGroupPagingPage(resourceGroupName, options, settings);
+            },
+        };
+    }
+    async *listByResourceGroupPagingPage(resourceGroupName, options, settings) {
+        let result;
+        let continuationToken = settings?.continuationToken;
+        if (!continuationToken) {
+            result = await this._listByResourceGroup(resourceGroupName, options);
+            let page = result.value || [];
+            continuationToken = result.nextLink;
+            setContinuationToken(page, continuationToken);
+            yield page;
+        }
+        while (continuationToken) {
+            result = await this._listByResourceGroupNext(resourceGroupName, continuationToken, options);
+            continuationToken = result.nextLink;
+            let page = result.value || [];
+            setContinuationToken(page, continuationToken);
+            yield page;
+        }
+    }
+    async *listByResourceGroupPagingAll(resourceGroupName, options) {
+        for await (const page of this.listByResourceGroupPagingPage(resourceGroupName, options)) {
+            yield* page;
+        }
+    }
+    /**
+     * Get a list of container groups in the specified subscription. This operation returns properties of
+     * each container group including containers, image registry credentials, restart policy, IP address
+     * type, OS type, state, and volumes.
+     * @param options The options parameters.
+     */
+    _list(options) {
+        return this.client.sendOperationRequest({ options }, listOperationSpec);
+    }
+    /**
+     * Get a list of container groups in a specified subscription and resource group. This operation
+     * returns properties of each container group including containers, image registry credentials, restart
+     * policy, IP address type, OS type, state, and volumes.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param options The options parameters.
+     */
+    _listByResourceGroup(resourceGroupName, options) {
+        return this.client.sendOperationRequest({ resourceGroupName, options }, listByResourceGroupOperationSpec);
+    }
+    /**
+     * Gets the properties of the specified container group in the specified subscription and resource
+     * group. The operation returns the properties of each container group including containers, image
+     * registry credentials, restart policy, IP address type, OS type, state, and volumes.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param containerGroupName The name of the container group.
+     * @param options The options parameters.
+     */
+    get(resourceGroupName, containerGroupName, options) {
+        return this.client.sendOperationRequest({ resourceGroupName, containerGroupName, options }, getOperationSpec);
+    }
+    /**
+     * Create or update container groups with specified configurations.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param containerGroupName The name of the container group.
+     * @param containerGroup The properties of the container group to be created or updated.
+     * @param options The options parameters.
+     */
+    async beginCreateOrUpdate(resourceGroupName, containerGroupName, containerGroup, options) {
+        const directSendOperation = async (args, spec) => {
+            return this.client.sendOperationRequest(args, spec);
+        };
+        const sendOperationFn = async (args, spec) => {
+            let currentRawResponse = undefined;
+            const providedCallback = args.options?.onResponse;
+            const callback = (rawResponse, flatResponse) => {
+                currentRawResponse = rawResponse;
+                providedCallback?.(rawResponse, flatResponse);
+            };
+            const updatedArgs = {
+                ...args,
+                options: {
+                    ...args.options,
+                    onResponse: callback,
+                },
+            };
+            const flatResponse = await directSendOperation(updatedArgs, spec);
+            return {
+                flatResponse,
+                rawResponse: {
+                    statusCode: currentRawResponse.status,
+                    body: currentRawResponse.parsedBody,
+                    headers: currentRawResponse.headers.toJSON(),
+                },
+            };
+        };
+        const lro = createLroSpec({
+            sendOperationFn,
+            args: { resourceGroupName, containerGroupName, containerGroup, options },
+            spec: createOrUpdateOperationSpec,
+        });
+        const poller = await createHttpPoller(lro, {
+            restoreFrom: options?.resumeFrom,
+            intervalInMs: options?.updateIntervalInMs,
+        });
+        await poller.poll();
+        return poller;
+    }
+    /**
+     * Create or update container groups with specified configurations.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param containerGroupName The name of the container group.
+     * @param containerGroup The properties of the container group to be created or updated.
+     * @param options The options parameters.
+     */
+    async beginCreateOrUpdateAndWait(resourceGroupName, containerGroupName, containerGroup, options) {
+        const poller = await this.beginCreateOrUpdate(resourceGroupName, containerGroupName, containerGroup, options);
+        return poller.pollUntilDone();
+    }
+    /**
+     * Updates container group tags with specified values.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param containerGroupName The name of the container group.
+     * @param resource The container group resource with just the tags to be updated.
+     * @param options The options parameters.
+     */
+    update(resourceGroupName, containerGroupName, resource, options) {
+        return this.client.sendOperationRequest({ resourceGroupName, containerGroupName, resource, options }, updateOperationSpec);
+    }
+    /**
+     * Delete the specified container group in the specified subscription and resource group. The operation
+     * does not delete other resources provided by the user, such as volumes.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param containerGroupName The name of the container group.
+     * @param options The options parameters.
+     */
+    async beginDelete(resourceGroupName, containerGroupName, options) {
+        const directSendOperation = async (args, spec) => {
+            return this.client.sendOperationRequest(args, spec);
+        };
+        const sendOperationFn = async (args, spec) => {
+            let currentRawResponse = undefined;
+            const providedCallback = args.options?.onResponse;
+            const callback = (rawResponse, flatResponse) => {
+                currentRawResponse = rawResponse;
+                providedCallback?.(rawResponse, flatResponse);
+            };
+            const updatedArgs = {
+                ...args,
+                options: {
+                    ...args.options,
+                    onResponse: callback,
+                },
+            };
+            const flatResponse = await directSendOperation(updatedArgs, spec);
+            return {
+                flatResponse,
+                rawResponse: {
+                    statusCode: currentRawResponse.status,
+                    body: currentRawResponse.parsedBody,
+                    headers: currentRawResponse.headers.toJSON(),
+                },
+            };
+        };
+        const lro = createLroSpec({
+            sendOperationFn,
+            args: { resourceGroupName, containerGroupName, options },
+            spec: deleteOperationSpec,
+        });
+        const poller = await createHttpPoller(lro, {
+            restoreFrom: options?.resumeFrom,
+            intervalInMs: options?.updateIntervalInMs,
+        });
+        await poller.poll();
+        return poller;
+    }
+    /**
+     * Delete the specified container group in the specified subscription and resource group. The operation
+     * does not delete other resources provided by the user, such as volumes.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param containerGroupName The name of the container group.
+     * @param options The options parameters.
+     */
+    async beginDeleteAndWait(resourceGroupName, containerGroupName, options) {
+        const poller = await this.beginDelete(resourceGroupName, containerGroupName, options);
+        return poller.pollUntilDone();
+    }
+    /**
+     * Restarts all containers in a container group in place. If container image has updates, new image
+     * will be downloaded.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param containerGroupName The name of the container group.
+     * @param options The options parameters.
+     */
+    async beginRestart(resourceGroupName, containerGroupName, options) {
+        const directSendOperation = async (args, spec) => {
+            return this.client.sendOperationRequest(args, spec);
+        };
+        const sendOperationFn = async (args, spec) => {
+            let currentRawResponse = undefined;
+            const providedCallback = args.options?.onResponse;
+            const callback = (rawResponse, flatResponse) => {
+                currentRawResponse = rawResponse;
+                providedCallback?.(rawResponse, flatResponse);
+            };
+            const updatedArgs = {
+                ...args,
+                options: {
+                    ...args.options,
+                    onResponse: callback,
+                },
+            };
+            const flatResponse = await directSendOperation(updatedArgs, spec);
+            return {
+                flatResponse,
+                rawResponse: {
+                    statusCode: currentRawResponse.status,
+                    body: currentRawResponse.parsedBody,
+                    headers: currentRawResponse.headers.toJSON(),
+                },
+            };
+        };
+        const lro = createLroSpec({
+            sendOperationFn,
+            args: { resourceGroupName, containerGroupName, options },
+            spec: restartOperationSpec,
+        });
+        const poller = await createHttpPoller(lro, {
+            restoreFrom: options?.resumeFrom,
+            intervalInMs: options?.updateIntervalInMs,
+        });
+        await poller.poll();
+        return poller;
+    }
+    /**
+     * Restarts all containers in a container group in place. If container image has updates, new image
+     * will be downloaded.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param containerGroupName The name of the container group.
+     * @param options The options parameters.
+     */
+    async beginRestartAndWait(resourceGroupName, containerGroupName, options) {
+        const poller = await this.beginRestart(resourceGroupName, containerGroupName, options);
+        return poller.pollUntilDone();
+    }
+    /**
+     * Stops all containers in a container group. Compute resources will be deallocated and billing will
+     * stop.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param containerGroupName The name of the container group.
+     * @param options The options parameters.
+     */
+    stop(resourceGroupName, containerGroupName, options) {
+        return this.client.sendOperationRequest({ resourceGroupName, containerGroupName, options }, stopOperationSpec);
+    }
+    /**
+     * Starts all containers in a container group. Compute resources will be allocated and billing will
+     * start.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param containerGroupName The name of the container group.
+     * @param options The options parameters.
+     */
+    async beginStart(resourceGroupName, containerGroupName, options) {
+        const directSendOperation = async (args, spec) => {
+            return this.client.sendOperationRequest(args, spec);
+        };
+        const sendOperationFn = async (args, spec) => {
+            let currentRawResponse = undefined;
+            const providedCallback = args.options?.onResponse;
+            const callback = (rawResponse, flatResponse) => {
+                currentRawResponse = rawResponse;
+                providedCallback?.(rawResponse, flatResponse);
+            };
+            const updatedArgs = {
+                ...args,
+                options: {
+                    ...args.options,
+                    onResponse: callback,
+                },
+            };
+            const flatResponse = await directSendOperation(updatedArgs, spec);
+            return {
+                flatResponse,
+                rawResponse: {
+                    statusCode: currentRawResponse.status,
+                    body: currentRawResponse.parsedBody,
+                    headers: currentRawResponse.headers.toJSON(),
+                },
+            };
+        };
+        const lro = createLroSpec({
+            sendOperationFn,
+            args: { resourceGroupName, containerGroupName, options },
+            spec: startOperationSpec,
+        });
+        const poller = await createHttpPoller(lro, {
+            restoreFrom: options?.resumeFrom,
+            intervalInMs: options?.updateIntervalInMs,
+        });
+        await poller.poll();
+        return poller;
+    }
+    /**
+     * Starts all containers in a container group. Compute resources will be allocated and billing will
+     * start.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param containerGroupName The name of the container group.
+     * @param options The options parameters.
+     */
+    async beginStartAndWait(resourceGroupName, containerGroupName, options) {
+        const poller = await this.beginStart(resourceGroupName, containerGroupName, options);
+        return poller.pollUntilDone();
+    }
+    /**
+     * Gets all the network dependencies for this container group to allow complete control of network
+     * setting and configuration. For container groups, this will always be an empty list.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param containerGroupName The name of the container group.
+     * @param options The options parameters.
+     */
+    getOutboundNetworkDependenciesEndpoints(resourceGroupName, containerGroupName, options) {
+        return this.client.sendOperationRequest({ resourceGroupName, containerGroupName, options }, getOutboundNetworkDependenciesEndpointsOperationSpec);
+    }
+    /**
+     * ListNext
+     * @param nextLink The nextLink from the previous successful call to the List method.
+     * @param options The options parameters.
+     */
+    _listNext(nextLink, options) {
+        return this.client.sendOperationRequest({ nextLink, options }, listNextOperationSpec);
+    }
+    /**
+     * ListByResourceGroupNext
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param nextLink The nextLink from the previous successful call to the ListByResourceGroup method.
+     * @param options The options parameters.
+     */
+    _listByResourceGroupNext(resourceGroupName, nextLink, options) {
+        return this.client.sendOperationRequest({ resourceGroupName, nextLink, options }, listByResourceGroupNextOperationSpec);
+    }
+}
+// Operation Specifications
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+const listOperationSpec = {
+    path: "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/containerGroups",
+    httpMethod: "GET",
+    responses: {
+        200: {
+            bodyMapper: Mappers.ContainerGroupListResult,
+        },
+        default: {
+            bodyMapper: Mappers.CloudError,
+        },
+    },
+    queryParameters: [Parameters.apiVersion],
+    urlParameters: [Parameters.$host, Parameters.subscriptionId],
+    headerParameters: [Parameters.accept],
+    serializer,
+};
+const listByResourceGroupOperationSpec = {
+    path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups",
+    httpMethod: "GET",
+    responses: {
+        200: {
+            bodyMapper: Mappers.ContainerGroupListResult,
+        },
+        default: {
+            bodyMapper: Mappers.CloudError,
+        },
+    },
+    queryParameters: [Parameters.apiVersion],
+    urlParameters: [
+        Parameters.$host,
+        Parameters.subscriptionId,
+        Parameters.resourceGroupName,
+    ],
+    headerParameters: [Parameters.accept],
+    serializer,
+};
+const getOperationSpec = {
+    path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}",
+    httpMethod: "GET",
+    responses: {
+        200: {
+            bodyMapper: Mappers.ContainerGroup,
+        },
+        default: {
+            bodyMapper: Mappers.CloudError,
+        },
+    },
+    queryParameters: [Parameters.apiVersion],
+    urlParameters: [
+        Parameters.$host,
+        Parameters.subscriptionId,
+        Parameters.resourceGroupName,
+        Parameters.containerGroupName,
+    ],
+    headerParameters: [Parameters.accept],
+    serializer,
+};
+const createOrUpdateOperationSpec = {
+    path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}",
+    httpMethod: "PUT",
+    responses: {
+        200: {
+            bodyMapper: Mappers.ContainerGroup,
+        },
+        201: {
+            bodyMapper: Mappers.ContainerGroup,
+        },
+        202: {
+            bodyMapper: Mappers.ContainerGroup,
+        },
+        204: {
+            bodyMapper: Mappers.ContainerGroup,
+        },
+        default: {
+            bodyMapper: Mappers.CloudError,
+        },
+    },
+    requestBody: Parameters.containerGroup,
+    queryParameters: [Parameters.apiVersion],
+    urlParameters: [
+        Parameters.$host,
+        Parameters.subscriptionId,
+        Parameters.resourceGroupName,
+        Parameters.containerGroupName,
+    ],
+    headerParameters: [Parameters.accept, Parameters.contentType],
+    mediaType: "json",
+    serializer,
+};
+const updateOperationSpec = {
+    path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}",
+    httpMethod: "PATCH",
+    responses: {
+        200: {
+            bodyMapper: Mappers.ContainerGroup,
+        },
+        default: {
+            bodyMapper: Mappers.CloudError,
+        },
+    },
+    requestBody: Parameters.resource,
+    queryParameters: [Parameters.apiVersion],
+    urlParameters: [
+        Parameters.$host,
+        Parameters.subscriptionId,
+        Parameters.resourceGroupName,
+        Parameters.containerGroupName,
+    ],
+    headerParameters: [Parameters.accept, Parameters.contentType],
+    mediaType: "json",
+    serializer,
+};
+const deleteOperationSpec = {
+    path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}",
+    httpMethod: "DELETE",
+    responses: {
+        200: {
+            bodyMapper: Mappers.ContainerGroup,
+        },
+        201: {
+            bodyMapper: Mappers.ContainerGroup,
+        },
+        202: {
+            bodyMapper: Mappers.ContainerGroup,
+        },
+        204: {
+            bodyMapper: Mappers.ContainerGroup,
+        },
+        default: {
+            bodyMapper: Mappers.CloudError,
+        },
+    },
+    queryParameters: [Parameters.apiVersion],
+    urlParameters: [
+        Parameters.$host,
+        Parameters.subscriptionId,
+        Parameters.resourceGroupName,
+        Parameters.containerGroupName,
+    ],
+    headerParameters: [Parameters.accept],
+    serializer,
+};
+const restartOperationSpec = {
+    path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/restart",
+    httpMethod: "POST",
+    responses: {
+        200: {},
+        201: {},
+        202: {},
+        204: {},
+        default: {
+            bodyMapper: Mappers.CloudError,
+        },
+    },
+    queryParameters: [Parameters.apiVersion],
+    urlParameters: [
+        Parameters.$host,
+        Parameters.subscriptionId,
+        Parameters.resourceGroupName,
+        Parameters.containerGroupName,
+    ],
+    headerParameters: [Parameters.accept],
+    serializer,
+};
+const stopOperationSpec = {
+    path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/stop",
+    httpMethod: "POST",
+    responses: {
+        204: {},
+        default: {
+            bodyMapper: Mappers.CloudError,
+        },
+    },
+    queryParameters: [Parameters.apiVersion],
+    urlParameters: [
+        Parameters.$host,
+        Parameters.subscriptionId,
+        Parameters.resourceGroupName,
+        Parameters.containerGroupName,
+    ],
+    headerParameters: [Parameters.accept],
+    serializer,
+};
+const startOperationSpec = {
+    path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/start",
+    httpMethod: "POST",
+    responses: {
+        200: {},
+        201: {},
+        202: {},
+        204: {},
+        default: {
+            bodyMapper: Mappers.CloudError,
+        },
+    },
+    queryParameters: [Parameters.apiVersion],
+    urlParameters: [
+        Parameters.$host,
+        Parameters.subscriptionId,
+        Parameters.resourceGroupName,
+        Parameters.containerGroupName,
+    ],
+    headerParameters: [Parameters.accept],
+    serializer,
+};
+const getOutboundNetworkDependenciesEndpointsOperationSpec = {
+    path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/outboundNetworkDependenciesEndpoints",
+    httpMethod: "GET",
+    responses: {
+        200: {
+            bodyMapper: {
+                type: { name: "Sequence", element: { type: { name: "String" } } },
+            },
+        },
+        default: {
+            bodyMapper: Mappers.CloudError,
+        },
+    },
+    queryParameters: [Parameters.apiVersion],
+    urlParameters: [
+        Parameters.$host,
+        Parameters.subscriptionId,
+        Parameters.resourceGroupName,
+        Parameters.containerGroupName,
+    ],
+    headerParameters: [Parameters.accept],
+    serializer,
+};
+const listNextOperationSpec = {
+    path: "{nextLink}",
+    httpMethod: "GET",
+    responses: {
+        200: {
+            bodyMapper: Mappers.ContainerGroupListResult,
+        },
+        default: {
+            bodyMapper: Mappers.CloudError,
+        },
+    },
+    urlParameters: [
+        Parameters.$host,
+        Parameters.subscriptionId,
+        Parameters.nextLink,
+    ],
+    headerParameters: [Parameters.accept],
+    serializer,
+};
+const listByResourceGroupNextOperationSpec = {
+    path: "{nextLink}",
+    httpMethod: "GET",
+    responses: {
+        200: {
+            bodyMapper: Mappers.ContainerGroupListResult,
+        },
+        default: {
+            bodyMapper: Mappers.CloudError,
+        },
+    },
+    urlParameters: [
+        Parameters.$host,
+        Parameters.subscriptionId,
+        Parameters.resourceGroupName,
+        Parameters.nextLink,
+    ],
+    headerParameters: [Parameters.accept],
+    serializer,
+};
+//# sourceMappingURL=containerGroups.js.map