@azure/arm-hanaonazure 2.2.0 → 4.0.0-beta.1

package/types/arm-hanaonazure.d.ts

@@ -0,0 +1,444 @@
+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';
+
+/** Detailed HANA operation information */
+export declare interface Display {
+    /**
+     * The localized friendly form of the resource provider name. This form is also expected to include the publisher/company responsible. Use Title Casing. Begin with "Microsoft" for 1st party services.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provider?: string;
+    /**
+     * The localized friendly form of the resource type related to this action/operation. This form should match the public documentation for the resource provider. Use Title Casing. For examples, refer to the “name” section.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly resource?: string;
+    /**
+     * The localized friendly name for the operation as shown to the user. This name should be concise (to fit in drop downs), but clear (self-documenting). Use Title Casing and include the entity/resource to which it applies.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly operation?: string;
+    /**
+     * The localized friendly description for the operation as shown to the user. This description should be thorough, yet concise. It will be used in tool-tips and detailed views.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly description?: string;
+    /**
+     * The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. Default value is 'user,system'
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly origin?: string;
+}
+
+/** Describes the format of Error response. */
+export declare interface ErrorResponse {
+    /** Describes the error object. */
+    error?: ErrorResponseError;
+}
+
+/** Describes the error object. */
+export declare interface ErrorResponseError {
+    /**
+     * Error code
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly code?: string;
+    /**
+     * Error message indicating why the operation failed.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly message?: string;
+}
+
+export declare class HanaManagementClient extends coreClient.ServiceClient {
+    $host: string;
+    apiVersion: string;
+    subscriptionId: string;
+    /**
+     * Initializes a new instance of the HanaManagementClient class.
+     * @param credentials Subscription credentials which uniquely identify client subscription.
+     * @param subscriptionId Subscription ID which uniquely identify Microsoft Azure subscription. The
+     *                       subscription ID forms part of the URI for every service call.
+     * @param options The parameter options
+     */
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: HanaManagementClientOptionalParams);
+    operations: Operations;
+    sapMonitors: SapMonitors;
+    providerInstances: ProviderInstances;
+}
+
+/** Optional parameters. */
+export declare interface HanaManagementClientOptionalParams extends coreClient.ServiceClientOptions {
+    /** server parameter */
+    $host?: string;
+    /** Api Version */
+    apiVersion?: string;
+    /** Overrides client endpoint. */
+    endpoint?: string;
+}
+
+/**
+ * Defines values for HanaProvisioningStatesEnum. \
+ * {@link KnownHanaProvisioningStatesEnum} can be used interchangeably with HanaProvisioningStatesEnum,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Accepted** \
+ * **Creating** \
+ * **Updating** \
+ * **Failed** \
+ * **Succeeded** \
+ * **Deleting** \
+ * **Migrating**
+ */
+export declare type HanaProvisioningStatesEnum = string;
+
+/** Known values of {@link HanaProvisioningStatesEnum} that the service accepts. */
+export declare enum KnownHanaProvisioningStatesEnum {
+    Accepted = "Accepted",
+    Creating = "Creating",
+    Updating = "Updating",
+    Failed = "Failed",
+    Succeeded = "Succeeded",
+    Deleting = "Deleting",
+    Migrating = "Migrating"
+}
+
+/** HANA operation information */
+export declare interface Operation {
+    /**
+     * The name of the operation being performed on this particular object. This name should match the action name that appears in RBAC / the event service.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly name?: string;
+    /** Displayed HANA operation information */
+    display?: Display;
+}
+
+/** List of HANA operations */
+export declare interface OperationList {
+    /** List of HANA operations */
+    value?: Operation[];
+}
+
+/** Interface representing a Operations. */
+export declare interface Operations {
+    /**
+     * Gets a list of SAP HANA management operations.
+     * @param options The options parameters.
+     */
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+/** Optional parameters. */
+export declare interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type OperationsListResponse = OperationList;
+
+/** A provider instance associated with a SAP monitor. */
+export declare type ProviderInstance = ProxyResource & {
+    /** The type of provider instance. */
+    typePropertiesType?: string;
+    /** A JSON string containing the properties of the provider instance. */
+    properties?: string;
+    /** A JSON string containing metadata of the provider instance. */
+    metadata?: string;
+    /**
+     * State of provisioning of the provider instance
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provisioningState?: HanaProvisioningStatesEnum;
+};
+
+/** The response from the List provider instances operation. */
+export declare interface ProviderInstanceListResult {
+    /** The list of provider instances. */
+    value?: ProviderInstance[];
+    /** The URL to get the next set of provider instances. */
+    nextLink?: string;
+}
+
+/** Interface representing a ProviderInstances. */
+export declare interface ProviderInstances {
+    /**
+     * Gets a list of provider instances in the specified SAP monitor. The operations returns various
+     * properties of each provider instances.
+     * @param resourceGroupName Name of the resource group.
+     * @param sapMonitorName Name of the SAP monitor resource.
+     * @param options The options parameters.
+     */
+    list(resourceGroupName: string, sapMonitorName: string, options?: ProviderInstancesListOptionalParams): PagedAsyncIterableIterator<ProviderInstance>;
+    /**
+     * Gets properties of a provider instance for the specified subscription, resource group, SapMonitor
+     * name, and resource name.
+     * @param resourceGroupName Name of the resource group.
+     * @param sapMonitorName Name of the SAP monitor resource.
+     * @param providerInstanceName Name of the provider instance.
+     * @param options The options parameters.
+     */
+    get(resourceGroupName: string, sapMonitorName: string, providerInstanceName: string, options?: ProviderInstancesGetOptionalParams): Promise<ProviderInstancesGetResponse>;
+    /**
+     * Creates a provider instance for the specified subscription, resource group, SapMonitor name, and
+     * resource name.
+     * @param resourceGroupName Name of the resource group.
+     * @param sapMonitorName Name of the SAP monitor resource.
+     * @param providerInstanceName Name of the provider instance.
+     * @param providerInstanceParameter Request body representing a provider instance
+     * @param options The options parameters.
+     */
+    beginCreate(resourceGroupName: string, sapMonitorName: string, providerInstanceName: string, providerInstanceParameter: ProviderInstance, options?: ProviderInstancesCreateOptionalParams): Promise<PollerLike<PollOperationState<ProviderInstancesCreateResponse>, ProviderInstancesCreateResponse>>;
+    /**
+     * Creates a provider instance for the specified subscription, resource group, SapMonitor name, and
+     * resource name.
+     * @param resourceGroupName Name of the resource group.
+     * @param sapMonitorName Name of the SAP monitor resource.
+     * @param providerInstanceName Name of the provider instance.
+     * @param providerInstanceParameter Request body representing a provider instance
+     * @param options The options parameters.
+     */
+    beginCreateAndWait(resourceGroupName: string, sapMonitorName: string, providerInstanceName: string, providerInstanceParameter: ProviderInstance, options?: ProviderInstancesCreateOptionalParams): Promise<ProviderInstancesCreateResponse>;
+    /**
+     * Deletes a provider instance for the specified subscription, resource group, SapMonitor name, and
+     * resource name.
+     * @param resourceGroupName Name of the resource group.
+     * @param sapMonitorName Name of the SAP monitor resource.
+     * @param providerInstanceName Name of the provider instance.
+     * @param options The options parameters.
+     */
+    beginDelete(resourceGroupName: string, sapMonitorName: string, providerInstanceName: string, options?: ProviderInstancesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    /**
+     * Deletes a provider instance for the specified subscription, resource group, SapMonitor name, and
+     * resource name.
+     * @param resourceGroupName Name of the resource group.
+     * @param sapMonitorName Name of the SAP monitor resource.
+     * @param providerInstanceName Name of the provider instance.
+     * @param options The options parameters.
+     */
+    beginDeleteAndWait(resourceGroupName: string, sapMonitorName: string, providerInstanceName: string, options?: ProviderInstancesDeleteOptionalParams): Promise<void>;
+}
+
+/** Optional parameters. */
+export declare interface ProviderInstancesCreateOptionalParams 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;
+}
+
+/** Contains response data for the create operation. */
+export declare type ProviderInstancesCreateResponse = ProviderInstance;
+
+/** Optional parameters. */
+export declare interface ProviderInstancesDeleteOptionalParams 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 ProviderInstancesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type ProviderInstancesGetResponse = ProviderInstance;
+
+/** Optional parameters. */
+export declare interface ProviderInstancesListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listNext operation. */
+export declare type ProviderInstancesListNextResponse = ProviderInstanceListResult;
+
+/** Optional parameters. */
+export declare interface ProviderInstancesListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type ProviderInstancesListResponse = ProviderInstanceListResult;
+
+/** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
+export declare type ProxyResource = Resource & {};
+
+/** Common fields that are returned in the response for all Azure Resource Manager resources */
+export declare interface Resource {
+    /**
+     * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
+     * 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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly type?: string;
+}
+
+/** SAP monitor info on Azure (ARM properties and SAP monitor properties) */
+export declare type SapMonitor = TrackedResource & {
+    /**
+     * State of provisioning of the HanaInstance
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provisioningState?: HanaProvisioningStatesEnum;
+    /**
+     * The name of the resource group the SAP Monitor resources get deployed into.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly managedResourceGroupName?: string;
+    /** The ARM ID of the Log Analytics Workspace that is used for monitoring */
+    logAnalyticsWorkspaceArmId?: string;
+    /** The value indicating whether to send analytics to Microsoft */
+    enableCustomerAnalytics?: boolean;
+    /** The workspace ID of the log analytics workspace to be used for monitoring */
+    logAnalyticsWorkspaceId?: string;
+    /** The shared key of the log analytics workspace that is used for monitoring */
+    logAnalyticsWorkspaceSharedKey?: string;
+    /**
+     * The version of the payload running in the Collector VM
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly sapMonitorCollectorVersion?: string;
+    /** The subnet which the SAP monitor will be deployed in */
+    monitorSubnet?: string;
+};
+
+/** The response from the List SAP monitors operation. */
+export declare interface SapMonitorListResult {
+    /** The list of SAP monitors. */
+    value?: SapMonitor[];
+    /** The URL to get the next set of SAP monitors. */
+    nextLink?: string;
+}
+
+/** Interface representing a SapMonitors. */
+export declare interface SapMonitors {
+    /**
+     * Gets a list of SAP monitors in the specified subscription. The operations returns various properties
+     * of each SAP monitor.
+     * @param options The options parameters.
+     */
+    list(options?: SapMonitorsListOptionalParams): PagedAsyncIterableIterator<SapMonitor>;
+    /**
+     * Gets properties of a SAP monitor for the specified subscription, resource group, and resource name.
+     * @param resourceGroupName Name of the resource group.
+     * @param sapMonitorName Name of the SAP monitor resource.
+     * @param options The options parameters.
+     */
+    get(resourceGroupName: string, sapMonitorName: string, options?: SapMonitorsGetOptionalParams): Promise<SapMonitorsGetResponse>;
+    /**
+     * Creates a SAP monitor for the specified subscription, resource group, and resource name.
+     * @param resourceGroupName Name of the resource group.
+     * @param sapMonitorName Name of the SAP monitor resource.
+     * @param sapMonitorParameter Request body representing a SAP Monitor
+     * @param options The options parameters.
+     */
+    beginCreate(resourceGroupName: string, sapMonitorName: string, sapMonitorParameter: SapMonitor, options?: SapMonitorsCreateOptionalParams): Promise<PollerLike<PollOperationState<SapMonitorsCreateResponse>, SapMonitorsCreateResponse>>;
+    /**
+     * Creates a SAP monitor for the specified subscription, resource group, and resource name.
+     * @param resourceGroupName Name of the resource group.
+     * @param sapMonitorName Name of the SAP monitor resource.
+     * @param sapMonitorParameter Request body representing a SAP Monitor
+     * @param options The options parameters.
+     */
+    beginCreateAndWait(resourceGroupName: string, sapMonitorName: string, sapMonitorParameter: SapMonitor, options?: SapMonitorsCreateOptionalParams): Promise<SapMonitorsCreateResponse>;
+    /**
+     * Deletes a SAP monitor with the specified subscription, resource group, and monitor name.
+     * @param resourceGroupName Name of the resource group.
+     * @param sapMonitorName Name of the SAP monitor resource.
+     * @param options The options parameters.
+     */
+    beginDelete(resourceGroupName: string, sapMonitorName: string, options?: SapMonitorsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    /**
+     * Deletes a SAP monitor with the specified subscription, resource group, and monitor name.
+     * @param resourceGroupName Name of the resource group.
+     * @param sapMonitorName Name of the SAP monitor resource.
+     * @param options The options parameters.
+     */
+    beginDeleteAndWait(resourceGroupName: string, sapMonitorName: string, options?: SapMonitorsDeleteOptionalParams): Promise<void>;
+    /**
+     * Patches the Tags field of a SAP monitor for the specified subscription, resource group, and monitor
+     * name.
+     * @param resourceGroupName Name of the resource group.
+     * @param sapMonitorName Name of the SAP monitor resource.
+     * @param tagsParameter Request body that only contains the new Tags field
+     * @param options The options parameters.
+     */
+    update(resourceGroupName: string, sapMonitorName: string, tagsParameter: Tags, options?: SapMonitorsUpdateOptionalParams): Promise<SapMonitorsUpdateResponse>;
+}
+
+/** Optional parameters. */
+export declare interface SapMonitorsCreateOptionalParams 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;
+}
+
+/** Contains response data for the create operation. */
+export declare type SapMonitorsCreateResponse = SapMonitor;
+
+/** Optional parameters. */
+export declare interface SapMonitorsDeleteOptionalParams 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 SapMonitorsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type SapMonitorsGetResponse = SapMonitor;
+
+/** Optional parameters. */
+export declare interface SapMonitorsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listNext operation. */
+export declare type SapMonitorsListNextResponse = SapMonitorListResult;
+
+/** Optional parameters. */
+export declare interface SapMonitorsListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type SapMonitorsListResponse = SapMonitorListResult;
+
+/** Optional parameters. */
+export declare interface SapMonitorsUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the update operation. */
+export declare type SapMonitorsUpdateResponse = SapMonitor;
+
+/** Tags field of the resource. */
+export declare interface Tags {
+    /** Tags field of the resource. */
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+/** The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */
+export declare type TrackedResource = Resource & {
+    /** Resource tags. */
+    tags?: {
+        [propertyName: string]: string;
+    };
+    /** The geo-location where the resource lives */
+    location: string;
+};
+
+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"
+    }
+  ]
+}