@azure/arm-apimanagement 9.0.1-alpha.20230811.1 → 9.1.0

package/src/operations/portalConfig.ts

@@ -0,0 +1,286 @@
+/*
+ * 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 { PortalConfig } from "../operationsInterfaces";
+import * as coreClient from "@azure/core-client";
+import * as Mappers from "../models/mappers";
+import * as Parameters from "../models/parameters";
+import { ApiManagementClient } from "../apiManagementClient";
+import {
+  PortalConfigListByServiceOptionalParams,
+  PortalConfigListByServiceResponse,
+  PortalConfigGetEntityTagOptionalParams,
+  PortalConfigGetEntityTagResponse,
+  PortalConfigGetOptionalParams,
+  PortalConfigGetResponse,
+  PortalConfigContract,
+  PortalConfigUpdateOptionalParams,
+  PortalConfigUpdateResponse,
+  PortalConfigCreateOrUpdateOptionalParams,
+  PortalConfigCreateOrUpdateResponse
+} from "../models";
+
+/** Class containing PortalConfig operations. */
+export class PortalConfigImpl implements PortalConfig {
+  private readonly client: ApiManagementClient;
+
+  /**
+   * Initialize a new instance of the class PortalConfig class.
+   * @param client Reference to the service client
+   */
+  constructor(client: ApiManagementClient) {
+    this.client = client;
+  }
+
+  /**
+   * Lists the developer portal configurations.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param serviceName The name of the API Management service.
+   * @param options The options parameters.
+   */
+  listByService(
+    resourceGroupName: string,
+    serviceName: string,
+    options?: PortalConfigListByServiceOptionalParams
+  ): Promise<PortalConfigListByServiceResponse> {
+    return this.client.sendOperationRequest(
+      { resourceGroupName, serviceName, options },
+      listByServiceOperationSpec
+    );
+  }
+
+  /**
+   * Gets the entity state (Etag) version of the developer portal configuration.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param serviceName The name of the API Management service.
+   * @param portalConfigId Portal configuration identifier.
+   * @param options The options parameters.
+   */
+  getEntityTag(
+    resourceGroupName: string,
+    serviceName: string,
+    portalConfigId: string,
+    options?: PortalConfigGetEntityTagOptionalParams
+  ): Promise<PortalConfigGetEntityTagResponse> {
+    return this.client.sendOperationRequest(
+      { resourceGroupName, serviceName, portalConfigId, options },
+      getEntityTagOperationSpec
+    );
+  }
+
+  /**
+   * Get the developer portal configuration.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param serviceName The name of the API Management service.
+   * @param portalConfigId Portal configuration identifier.
+   * @param options The options parameters.
+   */
+  get(
+    resourceGroupName: string,
+    serviceName: string,
+    portalConfigId: string,
+    options?: PortalConfigGetOptionalParams
+  ): Promise<PortalConfigGetResponse> {
+    return this.client.sendOperationRequest(
+      { resourceGroupName, serviceName, portalConfigId, options },
+      getOperationSpec
+    );
+  }
+
+  /**
+   * Update the developer portal configuration.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param serviceName The name of the API Management service.
+   * @param portalConfigId Portal configuration identifier.
+   * @param ifMatch ETag of the Entity. ETag should match the current entity state from the header
+   *                response of the GET request or it should be * for unconditional update.
+   * @param parameters Update the developer portal configuration.
+   * @param options The options parameters.
+   */
+  update(
+    resourceGroupName: string,
+    serviceName: string,
+    portalConfigId: string,
+    ifMatch: string,
+    parameters: PortalConfigContract,
+    options?: PortalConfigUpdateOptionalParams
+  ): Promise<PortalConfigUpdateResponse> {
+    return this.client.sendOperationRequest(
+      {
+        resourceGroupName,
+        serviceName,
+        portalConfigId,
+        ifMatch,
+        parameters,
+        options
+      },
+      updateOperationSpec
+    );
+  }
+
+  /**
+   * Create or update the developer portal configuration.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param serviceName The name of the API Management service.
+   * @param portalConfigId Portal configuration identifier.
+   * @param ifMatch ETag of the Entity. ETag should match the current entity state from the header
+   *                response of the GET request or it should be * for unconditional update.
+   * @param parameters Update the developer portal configuration.
+   * @param options The options parameters.
+   */
+  createOrUpdate(
+    resourceGroupName: string,
+    serviceName: string,
+    portalConfigId: string,
+    ifMatch: string,
+    parameters: PortalConfigContract,
+    options?: PortalConfigCreateOrUpdateOptionalParams
+  ): Promise<PortalConfigCreateOrUpdateResponse> {
+    return this.client.sendOperationRequest(
+      {
+        resourceGroupName,
+        serviceName,
+        portalConfigId,
+        ifMatch,
+        parameters,
+        options
+      },
+      createOrUpdateOperationSpec
+    );
+  }
+}
+// Operation Specifications
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+
+const listByServiceOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalconfigs",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.PortalConfigCollection
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.resourceGroupName,
+    Parameters.serviceName,
+    Parameters.subscriptionId
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const getEntityTagOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalconfigs/{portalConfigId}",
+  httpMethod: "HEAD",
+  responses: {
+    200: {
+      headersMapper: Mappers.PortalConfigGetEntityTagHeaders
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.resourceGroupName,
+    Parameters.serviceName,
+    Parameters.subscriptionId,
+    Parameters.portalConfigId
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const getOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalconfigs/{portalConfigId}",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.PortalConfigContract,
+      headersMapper: Mappers.PortalConfigGetHeaders
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.resourceGroupName,
+    Parameters.serviceName,
+    Parameters.subscriptionId,
+    Parameters.portalConfigId
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const updateOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalconfigs/{portalConfigId}",
+  httpMethod: "PATCH",
+  responses: {
+    200: {
+      bodyMapper: Mappers.PortalConfigContract
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  requestBody: Parameters.parameters58,
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.resourceGroupName,
+    Parameters.serviceName,
+    Parameters.subscriptionId,
+    Parameters.portalConfigId
+  ],
+  headerParameters: [
+    Parameters.accept,
+    Parameters.contentType,
+    Parameters.ifMatch1
+  ],
+  mediaType: "json",
+  serializer
+};
+const createOrUpdateOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalconfigs/{portalConfigId}",
+  httpMethod: "PUT",
+  responses: {
+    200: {
+      bodyMapper: Mappers.PortalConfigContract
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  requestBody: Parameters.parameters58,
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.resourceGroupName,
+    Parameters.serviceName,
+    Parameters.subscriptionId,
+    Parameters.portalConfigId
+  ],
+  headerParameters: [
+    Parameters.accept,
+    Parameters.contentType,
+    Parameters.ifMatch1
+  ],
+  mediaType: "json",
+  serializer
+};

package/src/operations/portalRevision.ts

@@ -13,8 +13,12 @@ import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
 import * as Parameters from "../models/parameters";
 import { ApiManagementClient } from "../apiManagementClient";
-import { PollerLike, PollOperationState, LroEngine } from "@azure/core-lro";
-import { LroImpl } from "../lroImpl";
+import {
+  SimplePollerLike,
+  OperationState,
+  createHttpPoller
+} from "@azure/core-lro";
+import { createLroSpec } from "../lroImpl";
 import {
   PortalRevisionContract,
   PortalRevisionListByServiceNextOptionalParams,
@@ -46,7 +50,7 @@ export class PortalRevisionImpl implements PortalRevision {
 
   /**
    * Lists developer portal's revisions.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param serviceName The name of the API Management service.
    * @param options The options parameters.
    */
@@ -130,7 +134,7 @@ export class PortalRevisionImpl implements PortalRevision {
 
   /**
    * Lists developer portal's revisions.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param serviceName The name of the API Management service.
    * @param options The options parameters.
    */
@@ -147,7 +151,7 @@ export class PortalRevisionImpl implements PortalRevision {
 
   /**
    * Gets the developer portal revision specified by its identifier.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param serviceName The name of the API Management service.
    * @param portalRevisionId Portal revision identifier. Must be unique in the current API Management
    *                         service instance.
@@ -167,7 +171,7 @@ export class PortalRevisionImpl implements PortalRevision {
 
   /**
    * Gets the developer portal's revision specified by its identifier.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param serviceName The name of the API Management service.
    * @param portalRevisionId Portal revision identifier. Must be unique in the current API Management
    *                         service instance.
@@ -188,7 +192,7 @@ export class PortalRevisionImpl implements PortalRevision {
   /**
    * Creates a new developer portal's revision by running the portal's publishing. The `isCurrent`
    * property indicates if the revision is publicly accessible.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param serviceName The name of the API Management service.
    * @param portalRevisionId Portal revision identifier. Must be unique in the current API Management
    *                         service instance.
@@ -202,8 +206,8 @@ export class PortalRevisionImpl implements PortalRevision {
     parameters: PortalRevisionContract,
     options?: PortalRevisionCreateOrUpdateOptionalParams
   ): Promise<
-    PollerLike<
-      PollOperationState<PortalRevisionCreateOrUpdateResponse>,
+    SimplePollerLike<
+      OperationState<PortalRevisionCreateOrUpdateResponse>,
       PortalRevisionCreateOrUpdateResponse
     >
   > {
@@ -213,7 +217,7 @@ export class PortalRevisionImpl implements PortalRevision {
     ): Promise<PortalRevisionCreateOrUpdateResponse> => {
       return this.client.sendOperationRequest(args, spec);
     };
-    const sendOperation = async (
+    const sendOperationFn = async (
       args: coreClient.OperationArguments,
       spec: coreClient.OperationSpec
     ) => {
@@ -246,15 +250,24 @@ export class PortalRevisionImpl implements PortalRevision {
       };
     };
 
-    const lro = new LroImpl(
-      sendOperation,
-      { resourceGroupName, serviceName, portalRevisionId, parameters, options },
-      createOrUpdateOperationSpec
-    );
-    const poller = new LroEngine(lro, {
-      resumeFrom: options?.resumeFrom,
+    const lro = createLroSpec({
+      sendOperationFn,
+      args: {
+        resourceGroupName,
+        serviceName,
+        portalRevisionId,
+        parameters,
+        options
+      },
+      spec: createOrUpdateOperationSpec
+    });
+    const poller = await createHttpPoller<
+      PortalRevisionCreateOrUpdateResponse,
+      OperationState<PortalRevisionCreateOrUpdateResponse>
+    >(lro, {
+      restoreFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs,
-      lroResourceLocationConfig: "location"
+      resourceLocationConfig: "location"
     });
     await poller.poll();
     return poller;
@@ -263,7 +276,7 @@ export class PortalRevisionImpl implements PortalRevision {
   /**
    * Creates a new developer portal's revision by running the portal's publishing. The `isCurrent`
    * property indicates if the revision is publicly accessible.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param serviceName The name of the API Management service.
    * @param portalRevisionId Portal revision identifier. Must be unique in the current API Management
    *                         service instance.
@@ -289,7 +302,7 @@ export class PortalRevisionImpl implements PortalRevision {
 
   /**
    * Updates the description of specified portal revision or makes it current.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param serviceName The name of the API Management service.
    * @param portalRevisionId Portal revision identifier. Must be unique in the current API Management
    *                         service instance.
@@ -306,8 +319,8 @@ export class PortalRevisionImpl implements PortalRevision {
     parameters: PortalRevisionContract,
     options?: PortalRevisionUpdateOptionalParams
   ): Promise<
-    PollerLike<
-      PollOperationState<PortalRevisionUpdateResponse>,
+    SimplePollerLike<
+      OperationState<PortalRevisionUpdateResponse>,
       PortalRevisionUpdateResponse
     >
   > {
@@ -317,7 +330,7 @@ export class PortalRevisionImpl implements PortalRevision {
     ): Promise<PortalRevisionUpdateResponse> => {
       return this.client.sendOperationRequest(args, spec);
     };
-    const sendOperation = async (
+    const sendOperationFn = async (
       args: coreClient.OperationArguments,
       spec: coreClient.OperationSpec
     ) => {
@@ -350,9 +363,9 @@ export class PortalRevisionImpl implements PortalRevision {
       };
     };
 
-    const lro = new LroImpl(
-      sendOperation,
-      {
+    const lro = createLroSpec({
+      sendOperationFn,
+      args: {
         resourceGroupName,
         serviceName,
         portalRevisionId,
@@ -360,12 +373,15 @@ export class PortalRevisionImpl implements PortalRevision {
         parameters,
         options
       },
-      updateOperationSpec
-    );
-    const poller = new LroEngine(lro, {
-      resumeFrom: options?.resumeFrom,
+      spec: updateOperationSpec
+    });
+    const poller = await createHttpPoller<
+      PortalRevisionUpdateResponse,
+      OperationState<PortalRevisionUpdateResponse>
+    >(lro, {
+      restoreFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs,
-      lroResourceLocationConfig: "location"
+      resourceLocationConfig: "location"
     });
     await poller.poll();
     return poller;
@@ -373,7 +389,7 @@ export class PortalRevisionImpl implements PortalRevision {
 
   /**
    * Updates the description of specified portal revision or makes it current.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param serviceName The name of the API Management service.
    * @param portalRevisionId Portal revision identifier. Must be unique in the current API Management
    *                         service instance.
@@ -403,7 +419,7 @@ export class PortalRevisionImpl implements PortalRevision {
 
   /**
    * ListByServiceNext
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param serviceName The name of the API Management service.
    * @param nextLink The nextLink from the previous successful call to the ListByService method.
    * @param options The options parameters.
@@ -522,7 +538,7 @@ const createOrUpdateOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorResponse
     }
   },
-  requestBody: Parameters.parameters48,
+  requestBody: Parameters.parameters59,
   queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,
@@ -560,7 +576,7 @@ const updateOperationSpec: coreClient.OperationSpec = {
       bodyMapper: Mappers.ErrorResponse
     }
   },
-  requestBody: Parameters.parameters48,
+  requestBody: Parameters.parameters59,
   queryParameters: [Parameters.apiVersion],
   urlParameters: [
     Parameters.$host,

package/src/operations/portalSettings.ts

@@ -30,7 +30,7 @@ export class PortalSettingsImpl implements PortalSettings {
 
   /**
    * Lists a collection of portalsettings defined within a service instance..
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param serviceName The name of the API Management service.
    * @param options The options parameters.
    */