@azure/arm-confluent 2.2.0 → 3.0.0-beta.1

package/types/arm-confluent.d.ts

@@ -0,0 +1,543 @@
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+import { PollerLike } from '@azure/core-lro';
+import { PollOperationState } from '@azure/core-lro';
+
+/** Agreement Terms definition */
+export declare interface ConfluentAgreementResource {
+    /**
+     * The ARM id of the resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly id?: string;
+    /**
+     * The name of the agreement.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly name?: string;
+    /**
+     * The type of the agreement.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly type?: string;
+    /**
+     * Metadata pertaining to creation and last modification of the resource
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly systemData?: SystemData;
+    /** Publisher identifier string. */
+    publisher?: string;
+    /** Product identifier string. */
+    product?: string;
+    /** Plan identifier string. */
+    plan?: string;
+    /** Link to HTML with Microsoft and Publisher terms. */
+    licenseTextLink?: string;
+    /** Link to the privacy policy of the publisher. */
+    privacyPolicyLink?: string;
+    /** Date and time in UTC of when the terms were accepted. This is empty if Accepted is false. */
+    retrieveDatetime?: Date;
+    /** Terms signature. */
+    signature?: string;
+    /** If any version of the terms have been accepted, otherwise false. */
+    accepted?: boolean;
+}
+
+/** Response of a list operation. */
+export declare interface ConfluentAgreementResourceListResponse {
+    /** Results of a list operation. */
+    value?: ConfluentAgreementResource[];
+    /** Link to the next set of results, if any. */
+    nextLink?: string;
+}
+
+export declare class ConfluentManagementClient extends coreClient.ServiceClient {
+    $host: string;
+    apiVersion: 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 options The parameter options
+     */
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: ConfluentManagementClientOptionalParams);
+    marketplaceAgreements: MarketplaceAgreements;
+    organizationOperations: OrganizationOperations;
+    organization: Organization;
+    validations: Validations;
+}
+
+/** Optional parameters. */
+export declare interface ConfluentManagementClientOptionalParams extends coreClient.ServiceClientOptions {
+    /** server parameter */
+    $host?: string;
+    /** Api Version */
+    apiVersion?: string;
+    /** Overrides client endpoint. */
+    endpoint?: string;
+}
+
+/**
+ * Defines values for CreatedByType. \
+ * {@link KnownCreatedByType} can be used interchangeably with CreatedByType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **User** \
+ * **Application** \
+ * **ManagedIdentity** \
+ * **Key**
+ */
+export declare type CreatedByType = string;
+
+/** Response body of Error */
+export declare interface ErrorResponseBody {
+    /**
+     * Error code
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly code?: string;
+    /**
+     * Error message
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly message?: string;
+    /**
+     * Error target
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly target?: string;
+    /**
+     * Error detail
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly details?: ErrorResponseBody[];
+}
+
+/** Known values of {@link CreatedByType} that the service accepts. */
+export declare enum KnownCreatedByType {
+    User = "User",
+    Application = "Application",
+    ManagedIdentity = "ManagedIdentity",
+    Key = "Key"
+}
+
+/** Known values of {@link ProvisionState} that the service accepts. */
+export declare enum KnownProvisionState {
+    Accepted = "Accepted",
+    Creating = "Creating",
+    Updating = "Updating",
+    Deleting = "Deleting",
+    Succeeded = "Succeeded",
+    Failed = "Failed",
+    Canceled = "Canceled",
+    Deleted = "Deleted",
+    NotSpecified = "NotSpecified"
+}
+
+/** Known values of {@link SaaSOfferStatus} that the service accepts. */
+export declare enum KnownSaaSOfferStatus {
+    Started = "Started",
+    PendingFulfillmentStart = "PendingFulfillmentStart",
+    InProgress = "InProgress",
+    Subscribed = "Subscribed",
+    Suspended = "Suspended",
+    Reinstated = "Reinstated",
+    Succeeded = "Succeeded",
+    Failed = "Failed",
+    Unsubscribed = "Unsubscribed",
+    Updating = "Updating"
+}
+
+/** Interface representing a MarketplaceAgreements. */
+export declare interface MarketplaceAgreements {
+    /**
+     * List Confluent marketplace agreements in the subscription.
+     * @param options The options parameters.
+     */
+    list(options?: MarketplaceAgreementsListOptionalParams): PagedAsyncIterableIterator<ConfluentAgreementResource>;
+    /**
+     * Create Confluent Marketplace agreement in the subscription.
+     * @param options The options parameters.
+     */
+    create(options?: MarketplaceAgreementsCreateOptionalParams): Promise<MarketplaceAgreementsCreateResponse>;
+}
+
+/** Optional parameters. */
+export declare interface MarketplaceAgreementsCreateOptionalParams extends coreClient.OperationOptions {
+    /** Confluent Marketplace Agreement resource */
+    body?: ConfluentAgreementResource;
+}
+
+/** Contains response data for the create operation. */
+export declare type MarketplaceAgreementsCreateResponse = ConfluentAgreementResource;
+
+/** Optional parameters. */
+export declare interface MarketplaceAgreementsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listNext operation. */
+export declare type MarketplaceAgreementsListNextResponse = ConfluentAgreementResourceListResponse;
+
+/** Optional parameters. */
+export declare interface MarketplaceAgreementsListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type MarketplaceAgreementsListResponse = ConfluentAgreementResourceListResponse;
+
+/** Confluent Offer detail */
+export declare interface OfferDetail {
+    /** Publisher Id */
+    publisherId: string;
+    /** Offer Id */
+    id: string;
+    /** Offer Plan Id */
+    planId: string;
+    /** Offer Plan Name */
+    planName: string;
+    /** Offer Plan Term unit */
+    termUnit: string;
+    /**
+     * SaaS Offer Status
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly status?: SaaSOfferStatus;
+}
+
+/** The object that represents the operation. */
+export declare interface OperationDisplay {
+    /** Service provider: Microsoft.Confluent */
+    provider?: string;
+    /** Type on which the operation is performed, e.g., 'clusters'. */
+    resource?: string;
+    /** Operation type, e.g., read, write, delete, etc. */
+    operation?: string;
+    /** Description of the operation, e.g., 'Write confluent'. */
+    description?: string;
+}
+
+/** Result of GET request to list Confluent operations. */
+export declare interface OperationListResult {
+    /** List of Confluent operations supported by the Microsoft.Confluent provider. */
+    value?: OperationResult[];
+    /** URL to get the next set of operation list results if there are any. */
+    nextLink?: string;
+}
+
+/** An Confluent REST API operation. */
+export declare interface OperationResult {
+    /** Operation name: {provider}/{resource}/{operation} */
+    name?: string;
+    /** The object that represents the operation. */
+    display?: OperationDisplay;
+    /** Indicates whether the operation is a data action */
+    isDataAction?: boolean;
+}
+
+/** Interface representing a Organization. */
+export declare interface Organization {
+    /**
+     * List all organizations under the specified subscription.
+     * @param options The options parameters.
+     */
+    listBySubscription(options?: OrganizationListBySubscriptionOptionalParams): PagedAsyncIterableIterator<OrganizationResource>;
+    /**
+     * List all Organizations under the specified resource group.
+     * @param resourceGroupName Resource group name
+     * @param options The options parameters.
+     */
+    listByResourceGroup(resourceGroupName: string, options?: OrganizationListByResourceGroupOptionalParams): PagedAsyncIterableIterator<OrganizationResource>;
+    /**
+     * Get the properties of a specific Organization resource.
+     * @param resourceGroupName Resource group name
+     * @param organizationName Organization resource name
+     * @param options The options parameters.
+     */
+    get(resourceGroupName: string, organizationName: string, options?: OrganizationGetOptionalParams): Promise<OrganizationGetResponse>;
+    /**
+     * Create Organization resource
+     * @param resourceGroupName Resource group name
+     * @param organizationName Organization resource name
+     * @param options The options parameters.
+     */
+    beginCreate(resourceGroupName: string, organizationName: string, options?: OrganizationCreateOptionalParams): Promise<PollerLike<PollOperationState<OrganizationCreateResponse>, OrganizationCreateResponse>>;
+    /**
+     * Create Organization resource
+     * @param resourceGroupName Resource group name
+     * @param organizationName Organization resource name
+     * @param options The options parameters.
+     */
+    beginCreateAndWait(resourceGroupName: string, organizationName: string, options?: OrganizationCreateOptionalParams): Promise<OrganizationCreateResponse>;
+    /**
+     * Update Organization resource
+     * @param resourceGroupName Resource group name
+     * @param organizationName Organization resource name
+     * @param options The options parameters.
+     */
+    update(resourceGroupName: string, organizationName: string, options?: OrganizationUpdateOptionalParams): Promise<OrganizationUpdateResponse>;
+    /**
+     * Delete Organization resource
+     * @param resourceGroupName Resource group name
+     * @param organizationName Organization resource name
+     * @param options The options parameters.
+     */
+    beginDelete(resourceGroupName: string, organizationName: string, options?: OrganizationDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    /**
+     * Delete Organization resource
+     * @param resourceGroupName Resource group name
+     * @param organizationName Organization resource name
+     * @param options The options parameters.
+     */
+    beginDeleteAndWait(resourceGroupName: string, organizationName: string, options?: OrganizationDeleteOptionalParams): Promise<void>;
+}
+
+/** Optional parameters. */
+export declare interface OrganizationCreateOptionalParams extends coreClient.OperationOptions {
+    /** Organization resource model */
+    body?: OrganizationResource;
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Contains response data for the create operation. */
+export declare type OrganizationCreateResponse = OrganizationResource;
+
+/** Optional parameters. */
+export declare interface OrganizationDeleteOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Optional parameters. */
+export declare interface OrganizationGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type OrganizationGetResponse = OrganizationResource;
+
+/** Optional parameters. */
+export declare interface OrganizationListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listByResourceGroupNext operation. */
+export declare type OrganizationListByResourceGroupNextResponse = OrganizationResourceListResult;
+
+/** Optional parameters. */
+export declare interface OrganizationListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listByResourceGroup operation. */
+export declare type OrganizationListByResourceGroupResponse = OrganizationResourceListResult;
+
+/** Optional parameters. */
+export declare interface OrganizationListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listBySubscriptionNext operation. */
+export declare type OrganizationListBySubscriptionNextResponse = OrganizationResourceListResult;
+
+/** Optional parameters. */
+export declare interface OrganizationListBySubscriptionOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listBySubscription operation. */
+export declare type OrganizationListBySubscriptionResponse = OrganizationResourceListResult;
+
+/** Interface representing a OrganizationOperations. */
+export declare interface OrganizationOperations {
+    /**
+     * List all operations provided by Microsoft.Confluent.
+     * @param options The options parameters.
+     */
+    list(options?: OrganizationOperationsListOptionalParams): PagedAsyncIterableIterator<OperationResult>;
+}
+
+/** Optional parameters. */
+export declare interface OrganizationOperationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listNext operation. */
+export declare type OrganizationOperationsListNextResponse = OperationListResult;
+
+/** Optional parameters. */
+export declare interface OrganizationOperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type OrganizationOperationsListResponse = OperationListResult;
+
+/** Organization resource. */
+export declare interface OrganizationResource {
+    /**
+     * The ARM id of the resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly id?: string;
+    /**
+     * The name of the resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly name?: string;
+    /**
+     * The type of the resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly type?: string;
+    /**
+     * Metadata pertaining to creation and last modification of the resource
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly systemData?: SystemData;
+    /** Organization resource tags */
+    tags?: {
+        [propertyName: string]: string;
+    };
+    /** Location of Organization resource */
+    location?: string;
+    /**
+     * The creation time of the resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly createdTime?: Date;
+    /**
+     * Provision states for confluent RP
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provisioningState?: ProvisionState;
+    /**
+     * Id of the Confluent organization.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly organizationId?: string;
+    /**
+     * SSO url for the Confluent organization.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly ssoUrl?: string;
+    /** Confluent offer detail */
+    offerDetail: OfferDetail;
+    /** Subscriber detail */
+    userDetail: UserDetail;
+}
+
+/** The response of a list operation. */
+export declare interface OrganizationResourceListResult {
+    /** Result of a list operation. */
+    value?: OrganizationResource[];
+    /** Link to the next set of results, if any. */
+    nextLink?: string;
+}
+
+/** Organization Resource update */
+export declare interface OrganizationResourceUpdate {
+    /** ARM resource tags */
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+/** Optional parameters. */
+export declare interface OrganizationUpdateOptionalParams extends coreClient.OperationOptions {
+    /** Updated Organization resource */
+    body?: OrganizationResourceUpdate;
+}
+
+/** Contains response data for the update operation. */
+export declare type OrganizationUpdateResponse = OrganizationResource;
+
+/**
+ * Defines values for ProvisionState. \
+ * {@link KnownProvisionState} can be used interchangeably with ProvisionState,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Accepted** \
+ * **Creating** \
+ * **Updating** \
+ * **Deleting** \
+ * **Succeeded** \
+ * **Failed** \
+ * **Canceled** \
+ * **Deleted** \
+ * **NotSpecified**
+ */
+export declare type ProvisionState = string;
+
+/** Default error response for resource provider */
+export declare interface ResourceProviderDefaultErrorResponse {
+    /**
+     * Response body of Error
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly error?: ErrorResponseBody;
+}
+
+/**
+ * Defines values for SaaSOfferStatus. \
+ * {@link KnownSaaSOfferStatus} can be used interchangeably with SaaSOfferStatus,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Started** \
+ * **PendingFulfillmentStart** \
+ * **InProgress** \
+ * **Subscribed** \
+ * **Suspended** \
+ * **Reinstated** \
+ * **Succeeded** \
+ * **Failed** \
+ * **Unsubscribed** \
+ * **Updating**
+ */
+export declare type SaaSOfferStatus = string;
+
+/** Metadata pertaining to creation and last modification of the resource. */
+export declare interface SystemData {
+    /** The identity that created the resource. */
+    createdBy?: string;
+    /** The type of identity that created the resource. */
+    createdByType?: CreatedByType;
+    /** The timestamp of resource creation (UTC). */
+    createdAt?: Date;
+    /** The identity that last modified the resource. */
+    lastModifiedBy?: string;
+    /** The type of identity that last modified the resource. */
+    lastModifiedByType?: CreatedByType;
+    /** The timestamp of resource last modification (UTC) */
+    lastModifiedAt?: Date;
+}
+
+/** Subscriber detail */
+export declare interface UserDetail {
+    /** First name */
+    firstName?: string;
+    /** Last name */
+    lastName?: string;
+    /** Email address */
+    emailAddress: string;
+}
+
+/** Interface representing a Validations. */
+export declare interface Validations {
+    /**
+     * Organization Validate proxy resource
+     * @param resourceGroupName Resource group name
+     * @param organizationName Organization resource name
+     * @param body Organization resource model
+     * @param options The options parameters.
+     */
+    validateOrganization(resourceGroupName: string, organizationName: string, body: OrganizationResource, options?: ValidationsValidateOrganizationOptionalParams): Promise<ValidationsValidateOrganizationResponse>;
+}
+
+/** Optional parameters. */
+export declare interface ValidationsValidateOrganizationOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the validateOrganization operation. */
+export declare type ValidationsValidateOrganizationResponse = OrganizationResource;
+
+export { }

package/types/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.19.2"
+    }
+  ]
+}