@azure/arm-dashboard 1.0.0-beta.1

package/types/arm-dashboard.d.ts

@@ -0,0 +1,556 @@
+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';
+
+/**
+ * Defines values for ActionType. \
+ * {@link KnownActionType} can be used interchangeably with ActionType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Internal**
+ */
+export declare type ActionType = string;
+
+/**
+ * Defines values for AutoGeneratedDomainNameLabelScope. \
+ * {@link KnownAutoGeneratedDomainNameLabelScope} can be used interchangeably with AutoGeneratedDomainNameLabelScope,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **TenantReuse**
+ */
+export declare type AutoGeneratedDomainNameLabelScope = 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;
+
+export declare class DashboardManagementClient extends coreClient.ServiceClient {
+    $host: string;
+    apiVersion: string;
+    subscriptionId: string;
+    /**
+     * Initializes a new instance of the DashboardManagementClient class.
+     * @param credentials Subscription credentials which uniquely identify client subscription.
+     * @param subscriptionId Gets subscription credentials 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?: DashboardManagementClientOptionalParams);
+    operations: Operations;
+    grafana: Grafana;
+}
+
+/** Optional parameters. */
+export declare interface DashboardManagementClientOptionalParams extends coreClient.ServiceClientOptions {
+    /** server parameter */
+    $host?: string;
+    /** Api Version */
+    apiVersion?: string;
+    /** Overrides client endpoint. */
+    endpoint?: string;
+}
+
+/** The resource management error additional info. */
+export declare interface ErrorAdditionalInfo {
+    /**
+     * The additional info type.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly type?: string;
+    /**
+     * The additional info.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly info?: Record<string, unknown>;
+}
+
+/** The error detail. */
+export declare interface ErrorDetail {
+    /**
+     * The error code.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly code?: string;
+    /**
+     * The error message.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly message?: string;
+    /**
+     * The error target.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly target?: string;
+    /**
+     * The error details.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly details?: ErrorDetail[];
+    /**
+     * The error additional info.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly additionalInfo?: ErrorAdditionalInfo[];
+}
+
+/** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */
+export declare interface ErrorResponse {
+    /** The error object. */
+    error?: ErrorDetail;
+}
+
+/** Interface representing a Grafana. */
+export declare interface Grafana {
+    /**
+     * List all resources of workspaces for Grafana under the specified subscription.
+     * @param options The options parameters.
+     */
+    list(options?: GrafanaListOptionalParams): PagedAsyncIterableIterator<ManagedGrafana>;
+    /**
+     * List all resources of workspaces for Grafana under the specified resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param options The options parameters.
+     */
+    listByResourceGroup(resourceGroupName: string, options?: GrafanaListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ManagedGrafana>;
+    /**
+     * Get the properties of a specific workspace for Grafana resource.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param workspaceName The workspace name of Azure Managed Grafana.
+     * @param options The options parameters.
+     */
+    get(resourceGroupName: string, workspaceName: string, options?: GrafanaGetOptionalParams): Promise<GrafanaGetResponse>;
+    /**
+     * Create or update a workspace for Grafana resource. This API is idempotent, so user can either create
+     * a new grafana or update an existing grafana.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param workspaceName The workspace name of Azure Managed Grafana.
+     * @param requestBodyParameters The grafana resource type.
+     * @param options The options parameters.
+     */
+    beginCreate(resourceGroupName: string, workspaceName: string, requestBodyParameters: ManagedGrafana, options?: GrafanaCreateOptionalParams): Promise<PollerLike<PollOperationState<GrafanaCreateResponse>, GrafanaCreateResponse>>;
+    /**
+     * Create or update a workspace for Grafana resource. This API is idempotent, so user can either create
+     * a new grafana or update an existing grafana.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param workspaceName The workspace name of Azure Managed Grafana.
+     * @param requestBodyParameters The grafana resource type.
+     * @param options The options parameters.
+     */
+    beginCreateAndWait(resourceGroupName: string, workspaceName: string, requestBodyParameters: ManagedGrafana, options?: GrafanaCreateOptionalParams): Promise<GrafanaCreateResponse>;
+    /**
+     * Update a workspace for Grafana resource.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param workspaceName The workspace name of Azure Managed Grafana.
+     * @param requestBodyParameters The parameters for a PATCH request to a grafana resource.
+     * @param options The options parameters.
+     */
+    update(resourceGroupName: string, workspaceName: string, requestBodyParameters: ManagedGrafanaUpdateParameters, options?: GrafanaUpdateOptionalParams): Promise<GrafanaUpdateResponse>;
+    /**
+     * Delete a workspace for Grafana resource.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param workspaceName The workspace name of Azure Managed Grafana.
+     * @param options The options parameters.
+     */
+    beginDelete(resourceGroupName: string, workspaceName: string, options?: GrafanaDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    /**
+     * Delete a workspace for Grafana resource.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param workspaceName The workspace name of Azure Managed Grafana.
+     * @param options The options parameters.
+     */
+    beginDeleteAndWait(resourceGroupName: string, workspaceName: string, options?: GrafanaDeleteOptionalParams): Promise<void>;
+}
+
+/** Optional parameters. */
+export declare interface GrafanaCreateOptionalParams 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 GrafanaCreateResponse = ManagedGrafana;
+
+/** Optional parameters. */
+export declare interface GrafanaDeleteOptionalParams 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 GrafanaGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type GrafanaGetResponse = ManagedGrafana;
+
+/** Optional parameters. */
+export declare interface GrafanaListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listByResourceGroupNext operation. */
+export declare type GrafanaListByResourceGroupNextResponse = ManagedGrafanaListResponse;
+
+/** Optional parameters. */
+export declare interface GrafanaListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listByResourceGroup operation. */
+export declare type GrafanaListByResourceGroupResponse = ManagedGrafanaListResponse;
+
+/** Optional parameters. */
+export declare interface GrafanaListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listNext operation. */
+export declare type GrafanaListNextResponse = ManagedGrafanaListResponse;
+
+/** Optional parameters. */
+export declare interface GrafanaListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type GrafanaListResponse = ManagedGrafanaListResponse;
+
+/** Optional parameters. */
+export declare interface GrafanaUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the update operation. */
+export declare type GrafanaUpdateResponse = ManagedGrafana;
+
+/**
+ * Defines values for IdentityType. \
+ * {@link KnownIdentityType} can be used interchangeably with IdentityType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **None** \
+ * **SystemAssigned**
+ */
+export declare type IdentityType = string;
+
+/** Known values of {@link ActionType} that the service accepts. */
+export declare enum KnownActionType {
+    Internal = "Internal"
+}
+
+/** Known values of {@link AutoGeneratedDomainNameLabelScope} that the service accepts. */
+export declare enum KnownAutoGeneratedDomainNameLabelScope {
+    TenantReuse = "TenantReuse"
+}
+
+/** 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 IdentityType} that the service accepts. */
+export declare enum KnownIdentityType {
+    None = "None",
+    SystemAssigned = "SystemAssigned"
+}
+
+/** Known values of {@link LastModifiedByType} that the service accepts. */
+export declare enum KnownLastModifiedByType {
+    User = "User",
+    Application = "Application",
+    ManagedIdentity = "ManagedIdentity",
+    Key = "Key"
+}
+
+/** Known values of {@link Origin} that the service accepts. */
+export declare enum KnownOrigin {
+    User = "user",
+    System = "system",
+    UserSystem = "user,system"
+}
+
+/** Known values of {@link ProvisioningState} that the service accepts. */
+export declare enum KnownProvisioningState {
+    Accepted = "Accepted",
+    Creating = "Creating",
+    Updating = "Updating",
+    Deleting = "Deleting",
+    Succeeded = "Succeeded",
+    Failed = "Failed",
+    Canceled = "Canceled",
+    Deleted = "Deleted",
+    NotSpecified = "NotSpecified"
+}
+
+/** Known values of {@link ZoneRedundancy} that the service accepts. */
+export declare enum KnownZoneRedundancy {
+    Disabled = "Disabled",
+    Enabled = "Enabled"
+}
+
+/**
+ * Defines values for LastModifiedByType. \
+ * {@link KnownLastModifiedByType} can be used interchangeably with LastModifiedByType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **User** \
+ * **Application** \
+ * **ManagedIdentity** \
+ * **Key**
+ */
+export declare type LastModifiedByType = string;
+
+/** The grafana resource type. */
+export declare interface ManagedGrafana {
+    /**
+     * ARM id of the grafana resource
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly id?: string;
+    /**
+     * Name of the grafana resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly name?: string;
+    /**
+     * The type of the grafana resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly type?: string;
+    /** The Sku of the grafana resource. */
+    sku?: ResourceSku;
+    /** Properties specific to the grafana resource. */
+    properties?: ManagedGrafanaProperties;
+    /** The managed identity of the grafana resource. */
+    identity?: ManagedIdentity;
+    /**
+     * The system meta data relating to this grafana resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly systemData?: SystemData;
+    /** The tags for grafana resource. */
+    tags?: {
+        [propertyName: string]: string;
+    };
+    /** The geo-location where the grafana resource lives */
+    location?: string;
+}
+
+export declare interface ManagedGrafanaListResponse {
+    value?: ManagedGrafana[];
+    nextLink?: string;
+}
+
+/** Properties specific to the grafana resource. */
+export declare interface ManagedGrafanaProperties {
+    /** Provisioning state of the resource. */
+    provisioningState?: ProvisioningState;
+    /**
+     * The Grafana software version.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly grafanaVersion?: string;
+    /**
+     * The endpoint of the Grafana instance.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly endpoint?: string;
+    zoneRedundancy?: ZoneRedundancy;
+    autoGeneratedDomainNameLabelScope?: AutoGeneratedDomainNameLabelScope;
+}
+
+/** The parameters for a PATCH request to a grafana resource. */
+export declare interface ManagedGrafanaUpdateParameters {
+    /** The managed identity of the grafana resource. */
+    identity?: ManagedIdentity;
+    /** The new tags of the grafana resource. */
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+/** The managed identity of a resource. */
+export declare interface ManagedIdentity {
+    /** The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the resource. */
+    type?: IdentityType;
+    /**
+     * The principal id of the system assigned identity.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly principalId?: string;
+    /**
+     * The tenant id of the system assigned identity.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly tenantId?: string;
+    /** Dictionary of user assigned identities. */
+    userAssignedIdentities?: {
+        [propertyName: string]: UserAssignedIdentity;
+    };
+}
+
+/** Localized display information for this particular operation. */
+export declare interface OperationDisplay {
+    /**
+     * The localized friendly form of the resource provider name, i.e., Microsoft.Dashboard.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provider?: string;
+    /**
+     * The localized friendly name of the resource type related to this operation, e.g., 'grafana'.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly resource?: string;
+    /**
+     * Operation type, e.g., read, write, delete, etc.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly operation?: string;
+    /**
+     * Description of the operation, e.g., 'Read grafana'.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly description?: string;
+}
+
+/** A list of REST API operations supported by Microsoft.Dashboard provider. It contains an URL link to get the next set of results. */
+export declare interface OperationListResult {
+    /**
+     * List of operations supported by the Microsoft.Dashboard provider.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly value?: OperationResult[];
+    /**
+     * URL to get the next set of operation list results if there are any.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly nextLink?: string;
+}
+
+/** A Microsoft.Dashboard REST API operation. */
+export declare interface OperationResult {
+    /**
+     * Operation name, i.e., {provider}/{resource}/{operation}.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly name?: string;
+    /**
+     * Indicates whether the operation applies to data-plane. Set "true" for data-plane operations and "false" for ARM/control-plane operations.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly isDataAction?: boolean;
+    /** Localized display information for this particular operation. */
+    display?: OperationDisplay;
+    /**
+     * The intended executor of the operation.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly origin?: Origin;
+    /**
+     * Indicates the action type. "Internal" refers to actions that are for internal only APIs.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly actionType?: ActionType;
+}
+
+/** Interface representing a Operations. */
+export declare interface Operations {
+    /**
+     * List all available API operations provided by Microsoft.Dashboard.
+     * @param options The options parameters.
+     */
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<OperationResult>;
+}
+
+/** Optional parameters. */
+export declare interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listNext operation. */
+export declare type OperationsListNextResponse = OperationListResult;
+
+/** Optional parameters. */
+export declare interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type OperationsListResponse = OperationListResult;
+
+/**
+ * Defines values for Origin. \
+ * {@link KnownOrigin} can be used interchangeably with Origin,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **user** \
+ * **system** \
+ * **user,system**
+ */
+export declare type Origin = string;
+
+/**
+ * Defines values for ProvisioningState. \
+ * {@link KnownProvisioningState} can be used interchangeably with ProvisioningState,
+ *  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 ProvisioningState = string;
+
+export declare interface ResourceSku {
+    name: string;
+}
+
+export declare interface SystemData {
+    createdBy?: string;
+    /** The type of identity that created the resource. */
+    createdByType?: CreatedByType;
+    createdAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: LastModifiedByType;
+    lastModifiedAt?: Date;
+}
+
+export declare interface UserAssignedIdentity {
+    /**
+     * The principal id of user assigned identity.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly principalId?: string;
+    /**
+     * The client id of user assigned identity.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly clientId?: string;
+}
+
+/**
+ * Defines values for ZoneRedundancy. \
+ * {@link KnownZoneRedundancy} can be used interchangeably with ZoneRedundancy,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Disabled** \
+ * **Enabled**
+ */
+export declare type ZoneRedundancy = 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.4"
+    }
+  ]
+}