@azure/arm-confluent 3.0.0-beta.2 → 3.0.0

package/review/arm-confluent.api.md

@@ -6,9 +6,185 @@
 
 import * as coreAuth from '@azure/core-auth';
 import * as coreClient from '@azure/core-client';
+import { OperationState } from '@azure/core-lro';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
-import { PollerLike } from '@azure/core-lro';
-import { PollOperationState } from '@azure/core-lro';
+import { SimplePollerLike } from '@azure/core-lro';
+
+// @public
+export interface Access {
+    inviteUser(resourceGroupName: string, organizationName: string, body: AccessInviteUserAccountModel, options?: AccessInviteUserOptionalParams): Promise<AccessInviteUserResponse>;
+    listClusters(resourceGroupName: string, organizationName: string, body: ListAccessRequestModel, options?: AccessListClustersOptionalParams): Promise<AccessListClustersResponse>;
+    listEnvironments(resourceGroupName: string, organizationName: string, body: ListAccessRequestModel, options?: AccessListEnvironmentsOptionalParams): Promise<AccessListEnvironmentsResponse>;
+    listInvitations(resourceGroupName: string, organizationName: string, body: ListAccessRequestModel, options?: AccessListInvitationsOptionalParams): Promise<AccessListInvitationsResponse>;
+    listRoleBindings(resourceGroupName: string, organizationName: string, body: ListAccessRequestModel, options?: AccessListRoleBindingsOptionalParams): Promise<AccessListRoleBindingsResponse>;
+    listServiceAccounts(resourceGroupName: string, organizationName: string, body: ListAccessRequestModel, options?: AccessListServiceAccountsOptionalParams): Promise<AccessListServiceAccountsResponse>;
+    listUsers(resourceGroupName: string, organizationName: string, body: ListAccessRequestModel, options?: AccessListUsersOptionalParams): Promise<AccessListUsersResponse>;
+}
+
+// @public
+export interface AccessInvitedUserDetails {
+    authType?: string;
+    invitedEmail?: string;
+}
+
+// @public
+export interface AccessInviteUserAccountModel {
+    email?: string;
+    invitedUserDetails?: AccessInvitedUserDetails;
+    organizationId?: string;
+    upn?: string;
+}
+
+// @public
+export interface AccessInviteUserOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AccessInviteUserResponse = InvitationRecord;
+
+// @public
+export interface AccessListClustersOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AccessListClustersResponse = AccessListClusterSuccessResponse;
+
+// @public
+export interface AccessListClusterSuccessResponse {
+    data?: ClusterRecord[];
+    kind?: string;
+    metadata?: ConfluentListMetadata;
+}
+
+// @public
+export interface AccessListEnvironmentsOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AccessListEnvironmentsResponse = AccessListEnvironmentsSuccessResponse;
+
+// @public
+export interface AccessListEnvironmentsSuccessResponse {
+    data?: EnvironmentRecord[];
+    kind?: string;
+    metadata?: ConfluentListMetadata;
+}
+
+// @public
+export interface AccessListInvitationsOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AccessListInvitationsResponse = AccessListInvitationsSuccessResponse;
+
+// @public
+export interface AccessListInvitationsSuccessResponse {
+    data?: InvitationRecord[];
+    kind?: string;
+    metadata?: ConfluentListMetadata;
+}
+
+// @public
+export interface AccessListRoleBindingsOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AccessListRoleBindingsResponse = AccessListRoleBindingsSuccessResponse;
+
+// @public
+export interface AccessListRoleBindingsSuccessResponse {
+    data?: RoleBindingRecord[];
+    kind?: string;
+    metadata?: ConfluentListMetadata;
+}
+
+// @public
+export interface AccessListServiceAccountsOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AccessListServiceAccountsResponse = AccessListServiceAccountsSuccessResponse;
+
+// @public
+export interface AccessListServiceAccountsSuccessResponse {
+    data?: ServiceAccountRecord[];
+    kind?: string;
+    metadata?: ConfluentListMetadata;
+}
+
+// @public
+export interface AccessListUsersOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AccessListUsersResponse = AccessListUsersSuccessResponse;
+
+// @public
+export interface AccessListUsersSuccessResponse {
+    data?: UserRecord[];
+    kind?: string;
+    metadata?: ConfluentListMetadata;
+}
+
+// @public
+export interface ClusterByokEntity {
+    id?: string;
+    related?: string;
+    resourceName?: string;
+}
+
+// @public
+export interface ClusterConfigEntity {
+    kind?: string;
+}
+
+// @public
+export interface ClusterEnvironmentEntity {
+    environment?: string;
+    id?: string;
+    related?: string;
+    resourceName?: string;
+}
+
+// @public
+export interface ClusterNetworkEntity {
+    environment?: string;
+    id?: string;
+    related?: string;
+    resourceName?: string;
+}
+
+// @public
+export interface ClusterRecord {
+    displayName?: string;
+    id?: string;
+    kind?: string;
+    metadata?: MetadataEntity;
+    spec?: ClusterSpecEntity;
+    status?: ClusterStatusEntity;
+}
+
+// @public
+export interface ClusterSpecEntity {
+    apiEndpoint?: string;
+    availability?: string;
+    byok?: ClusterByokEntity;
+    cloud?: string;
+    config?: ClusterConfigEntity;
+    displayName?: string;
+    environment?: ClusterEnvironmentEntity;
+    httpEndpoint?: string;
+    kafkaBootstrapEndpoint?: string;
+    network?: ClusterNetworkEntity;
+    region?: string;
+    zone?: string;
+}
+
+// @public
+export interface ClusterStatusEntity {
+    cku?: number;
+    phase?: string;
+}
 
 // @public
 export interface ConfluentAgreementResource {
@@ -32,11 +208,23 @@ export interface ConfluentAgreementResourceListResponse {
     value?: ConfluentAgreementResource[];
 }
 
+// @public
+export interface ConfluentListMetadata {
+    first?: string;
+    last?: string;
+    next?: string;
+    prev?: string;
+    totalSize?: number;
+}
+
 // @public (undocumented)
 export class ConfluentManagementClient extends coreClient.ServiceClient {
     // (undocumented)
     $host: string;
     constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: ConfluentManagementClientOptionalParams);
+    constructor(credentials: coreAuth.TokenCredential, options?: ConfluentManagementClientOptionalParams);
+    // (undocumented)
+    access: Access;
     // (undocumented)
     apiVersion: string;
     // (undocumented)
@@ -46,7 +234,7 @@ export class ConfluentManagementClient extends coreClient.ServiceClient {
     // (undocumented)
     organizationOperations: OrganizationOperations;
     // (undocumented)
-    subscriptionId: string;
+    subscriptionId?: string;
     // (undocumented)
     validations: Validations;
 }
@@ -61,6 +249,14 @@ export interface ConfluentManagementClientOptionalParams extends coreClient.Serv
 // @public
 export type CreatedByType = string;
 
+// @public
+export interface EnvironmentRecord {
+    displayName?: string;
+    id?: string;
+    kind?: string;
+    metadata?: MetadataEntity;
+}
+
 // @public
 export interface ErrorResponseBody {
     readonly code?: string;
@@ -69,64 +265,68 @@ export interface ErrorResponseBody {
     readonly target?: string;
 }
 
+// @public
+export function getContinuationToken(page: unknown): string | undefined;
+
+// @public
+export interface InvitationRecord {
+    acceptedAt?: string;
+    authType?: string;
+    email?: string;
+    expiresAt?: string;
+    id?: string;
+    kind?: string;
+    metadata?: MetadataEntity;
+    status?: string;
+}
+
 // @public
 export enum KnownCreatedByType {
-    // (undocumented)
     Application = "Application",
-    // (undocumented)
     Key = "Key",
-    // (undocumented)
     ManagedIdentity = "ManagedIdentity",
-    // (undocumented)
     User = "User"
 }
 
 // @public
 export enum KnownProvisionState {
-    // (undocumented)
     Accepted = "Accepted",
-    // (undocumented)
     Canceled = "Canceled",
-    // (undocumented)
     Creating = "Creating",
-    // (undocumented)
     Deleted = "Deleted",
-    // (undocumented)
     Deleting = "Deleting",
-    // (undocumented)
     Failed = "Failed",
-    // (undocumented)
     NotSpecified = "NotSpecified",
-    // (undocumented)
     Succeeded = "Succeeded",
-    // (undocumented)
     Updating = "Updating"
 }
 
 // @public
 export enum KnownSaaSOfferStatus {
-    // (undocumented)
     Failed = "Failed",
-    // (undocumented)
     InProgress = "InProgress",
-    // (undocumented)
     PendingFulfillmentStart = "PendingFulfillmentStart",
-    // (undocumented)
     Reinstated = "Reinstated",
-    // (undocumented)
     Started = "Started",
-    // (undocumented)
     Subscribed = "Subscribed",
-    // (undocumented)
     Succeeded = "Succeeded",
-    // (undocumented)
     Suspended = "Suspended",
-    // (undocumented)
     Unsubscribed = "Unsubscribed",
-    // (undocumented)
     Updating = "Updating"
 }
 
+// @public
+export interface LinkOrganization {
+    token: string;
+}
+
+// @public
+export interface ListAccessRequestModel {
+    searchFilters?: {
+        [propertyName: string]: string;
+    };
+}
+
 // @public
 export interface MarketplaceAgreements {
     create(options?: MarketplaceAgreementsCreateOptionalParams): Promise<MarketplaceAgreementsCreateResponse>;
@@ -155,13 +355,25 @@ export interface MarketplaceAgreementsListOptionalParams extends coreClient.Oper
 // @public
 export type MarketplaceAgreementsListResponse = ConfluentAgreementResourceListResponse;
 
+// @public
+export interface MetadataEntity {
+    createdAt?: string;
+    deletedAt?: string;
+    resourceName?: string;
+    self?: string;
+    updatedAt?: string;
+}
+
 // @public
 export interface OfferDetail {
     id: string;
     planId: string;
     planName: string;
+    privateOfferId?: string;
+    privateOfferIds?: string[];
     publisherId: string;
-    readonly status?: SaaSOfferStatus;
+    status?: SaaSOfferStatus;
+    termId?: string;
     termUnit: string;
 }
 
@@ -188,9 +400,9 @@ export interface OperationResult {
 
 // @public
 export interface Organization {
-    beginCreate(resourceGroupName: string, organizationName: string, options?: OrganizationCreateOptionalParams): Promise<PollerLike<PollOperationState<OrganizationCreateResponse>, OrganizationCreateResponse>>;
+    beginCreate(resourceGroupName: string, organizationName: string, options?: OrganizationCreateOptionalParams): Promise<SimplePollerLike<OperationState<OrganizationCreateResponse>, OrganizationCreateResponse>>;
     beginCreateAndWait(resourceGroupName: string, organizationName: string, options?: OrganizationCreateOptionalParams): Promise<OrganizationCreateResponse>;
-    beginDelete(resourceGroupName: string, organizationName: string, options?: OrganizationDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDelete(resourceGroupName: string, organizationName: string, options?: OrganizationDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
     beginDeleteAndWait(resourceGroupName: string, organizationName: string, options?: OrganizationDeleteOptionalParams): Promise<void>;
     get(resourceGroupName: string, organizationName: string, options?: OrganizationGetOptionalParams): Promise<OrganizationGetResponse>;
     listByResourceGroup(resourceGroupName: string, options?: OrganizationListByResourceGroupOptionalParams): PagedAsyncIterableIterator<OrganizationResource>;
@@ -272,6 +484,7 @@ export type OrganizationOperationsListResponse = OperationListResult;
 export interface OrganizationResource {
     readonly createdTime?: Date;
     readonly id?: string;
+    linkOrganization?: LinkOrganization;
     location?: string;
     readonly name?: string;
     offerDetail: OfferDetail;
@@ -315,9 +528,28 @@ export interface ResourceProviderDefaultErrorResponse {
     readonly error?: ErrorResponseBody;
 }
 
+// @public
+export interface RoleBindingRecord {
+    crnPattern?: string;
+    id?: string;
+    kind?: string;
+    metadata?: MetadataEntity;
+    principal?: string;
+    roleName?: string;
+}
+
 // @public
 export type SaaSOfferStatus = string;
 
+// @public
+export interface ServiceAccountRecord {
+    description?: string;
+    displayName?: string;
+    id?: string;
+    kind?: string;
+    metadata?: MetadataEntity;
+}
+
 // @public
 export interface SystemData {
     createdAt?: Date;
@@ -330,14 +562,34 @@ export interface SystemData {
 
 // @public
 export interface UserDetail {
+    aadEmail?: string;
     emailAddress: string;
     firstName?: string;
     lastName?: string;
+    userPrincipalName?: string;
+}
+
+// @public
+export interface UserRecord {
+    authType?: string;
+    email?: string;
+    fullName?: string;
+    id?: string;
+    kind?: string;
+    metadata?: MetadataEntity;
+}
+
+// @public
+export interface ValidationResponse {
+    info?: {
+        [propertyName: string]: string;
+    };
 }
 
 // @public
 export interface Validations {
     validateOrganization(resourceGroupName: string, organizationName: string, body: OrganizationResource, options?: ValidationsValidateOrganizationOptionalParams): Promise<ValidationsValidateOrganizationResponse>;
+    validateOrganizationV2(resourceGroupName: string, organizationName: string, body: OrganizationResource, options?: ValidationsValidateOrganizationV2OptionalParams): Promise<ValidationsValidateOrganizationV2Response>;
 }
 
 // @public
@@ -347,6 +599,13 @@ export interface ValidationsValidateOrganizationOptionalParams extends coreClien
 // @public
 export type ValidationsValidateOrganizationResponse = OrganizationResource;
 
+// @public
+export interface ValidationsValidateOrganizationV2OptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ValidationsValidateOrganizationV2Response = ValidationResponse;
+
 // (No @packageDocumentation comment for this package)
 
 ```

package/src/confluentManagementClient.ts

@@ -7,42 +7,64 @@
  */
 
 import * as coreClient from "@azure/core-client";
+import * as coreRestPipeline from "@azure/core-rest-pipeline";
+import {
+  PipelineRequest,
+  PipelineResponse,
+  SendRequest
+} from "@azure/core-rest-pipeline";
 import * as coreAuth from "@azure/core-auth";
 import {
   MarketplaceAgreementsImpl,
   OrganizationOperationsImpl,
   OrganizationImpl,
-  ValidationsImpl
+  ValidationsImpl,
+  AccessImpl
 } from "./operations";
 import {
   MarketplaceAgreements,
   OrganizationOperations,
   Organization,
-  Validations
+  Validations,
+  Access
 } from "./operationsInterfaces";
 import { ConfluentManagementClientOptionalParams } from "./models";
 
 export class ConfluentManagementClient extends coreClient.ServiceClient {
   $host: string;
   apiVersion: string;
-  subscriptionId: string;
+  subscriptionId?: string;
 
   /**
    * Initializes a new instance of the ConfluentManagementClient class.
    * @param credentials Subscription credentials which uniquely identify client subscription.
-   * @param subscriptionId Microsoft Azure subscription id
+   * @param subscriptionId The ID of the target subscription. The value must be an UUID.
    * @param options The parameter options
    */
   constructor(
     credentials: coreAuth.TokenCredential,
     subscriptionId: string,
     options?: ConfluentManagementClientOptionalParams
+  );
+  constructor(
+    credentials: coreAuth.TokenCredential,
+    options?: ConfluentManagementClientOptionalParams
+  );
+  constructor(
+    credentials: coreAuth.TokenCredential,
+    subscriptionIdOrOptions?: ConfluentManagementClientOptionalParams | string,
+    options?: ConfluentManagementClientOptionalParams
   ) {
     if (credentials === undefined) {
       throw new Error("'credentials' cannot be null");
     }
-    if (subscriptionId === undefined) {
-      throw new Error("'subscriptionId' cannot be null");
+
+    let subscriptionId: string | undefined;
+
+    if (typeof subscriptionIdOrOptions === "string") {
+      subscriptionId = subscriptionIdOrOptions;
+    } else if (typeof subscriptionIdOrOptions === "object") {
+      options = subscriptionIdOrOptions;
     }
 
     // Initializing default values for options
@@ -54,39 +76,99 @@ export class ConfluentManagementClient extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-confluent/3.0.0-beta.2`;
+    const packageDetails = `azsdk-js-arm-confluent/3.0.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 = {
       ...defaults,
       ...options,
       userAgentOptions: {
         userAgentPrefix
       },
-      baseUri:
+      endpoint:
         options.endpoint ?? options.baseUri ?? "https://management.azure.com"
     };
     super(optionsWithDefaults);
+
+    let bearerTokenAuthenticationPolicyFound: boolean = false;
+    if (options?.pipeline && options.pipeline.getOrderedPolicies().length > 0) {
+      const pipelinePolicies: coreRestPipeline.PipelinePolicy[] = options.pipeline.getOrderedPolicies();
+      bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(
+        (pipelinePolicy) =>
+          pipelinePolicy.name ===
+          coreRestPipeline.bearerTokenAuthenticationPolicyName
+      );
+    }
+    if (
+      !options ||
+      !options.pipeline ||
+      options.pipeline.getOrderedPolicies().length == 0 ||
+      !bearerTokenAuthenticationPolicyFound
+    ) {
+      this.pipeline.removePolicy({
+        name: coreRestPipeline.bearerTokenAuthenticationPolicyName
+      });
+      this.pipeline.addPolicy(
+        coreRestPipeline.bearerTokenAuthenticationPolicy({
+          credential: credentials,
+          scopes:
+            optionsWithDefaults.credentialScopes ??
+            `${optionsWithDefaults.endpoint}/.default`,
+          challengeCallbacks: {
+            authorizeRequestOnChallenge:
+              coreClient.authorizeRequestOnClaimChallenge
+          }
+        })
+      );
+    }
     // Parameter assignments
     this.subscriptionId = subscriptionId;
 
     // Assigning values to Constant parameters
     this.$host = options.$host || "https://management.azure.com";
-    this.apiVersion = options.apiVersion || "2021-09-01-preview";
+    this.apiVersion = options.apiVersion || "2023-08-22";
     this.marketplaceAgreements = new MarketplaceAgreementsImpl(this);
     this.organizationOperations = new OrganizationOperationsImpl(this);
     this.organization = new OrganizationImpl(this);
     this.validations = new ValidationsImpl(this);
+    this.access = new AccessImpl(this);
+    this.addCustomApiVersionPolicy(options.apiVersion);
+  }
+
+  /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+  private addCustomApiVersionPolicy(apiVersion?: string) {
+    if (!apiVersion) {
+      return;
+    }
+    const apiVersionPolicy = {
+      name: "CustomApiVersionPolicy",
+      async sendRequest(
+        request: PipelineRequest,
+        next: SendRequest
+      ): Promise<PipelineResponse> {
+        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);
   }
 
   marketplaceAgreements: MarketplaceAgreements;
   organizationOperations: OrganizationOperations;
   organization: Organization;
   validations: Validations;
+  access: Access;
 }

package/src/index.ts

@@ -7,6 +7,7 @@
  */
 
 /// <reference lib="esnext.asynciterable" />
+export { getContinuationToken } from "./pagingHelper";
 export * from "./models";
 export { ConfluentManagementClient } from "./confluentManagementClient";
 export * from "./operationsInterfaces";

package/src/lroImpl.ts

@@ -6,29 +6,37 @@
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { AbortSignalLike } from "@azure/abort-controller";
 import { LongRunningOperation, LroResponse } from "@azure/core-lro";
 
-export class LroImpl<T> implements LongRunningOperation<T> {
-  constructor(
-    private sendOperationFn: (args: any, spec: any) => Promise<LroResponse<T>>,
-    private args: Record<string, unknown>,
-    private spec: {
-      readonly requestBody?: unknown;
-      readonly path?: string;
-      readonly httpMethod: string;
-    } & Record<string, any>,
-    public requestPath: string = spec.path!,
-    public requestMethod: string = spec.httpMethod
-  ) {}
-  public async sendInitialRequest(): Promise<LroResponse<T>> {
-    return this.sendOperationFn(this.args, this.spec);
-  }
-  public async sendPollRequest(path: string): Promise<LroResponse<T>> {
-    const { requestBody, ...restSpec } = this.spec;
-    return this.sendOperationFn(this.args, {
-      ...restSpec,
-      path,
-      httpMethod: "GET"
-    });
-  }
+export function createLroSpec<T>(inputs: {
+  sendOperationFn: (args: any, spec: any) => Promise<LroResponse<T>>;
+  args: Record<string, unknown>;
+  spec: {
+    readonly requestBody?: unknown;
+    readonly path?: string;
+    readonly httpMethod: string;
+  } & Record<string, any>;
+}): LongRunningOperation<T> {
+  const { args, spec, sendOperationFn } = inputs;
+  return {
+    requestMethod: spec.httpMethod,
+    requestPath: spec.path!,
+    sendInitialRequest: () => sendOperationFn(args, spec),
+    sendPollRequest: (
+      path: string,
+      options?: { abortSignal?: AbortSignalLike }
+    ) => {
+      const { requestBody, ...restSpec } = spec;
+      return sendOperationFn(args, {
+        ...restSpec,
+        httpMethod: "GET",
+        path,
+        abortSignal: options?.abortSignal
+      });
+    }
+  };
 }