@azure/arm-selfhelp 1.0.0-alpha.20230428.1

package/types/arm-selfhelp.d.ts

@@ -0,0 +1,579 @@
+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 { SimplePollerLike } 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;
+
+/** The check availability request body. */
+export declare interface CheckNameAvailabilityRequest {
+    /** The name of the resource for which availability needs to be checked. */
+    name?: string;
+    /** The resource type. */
+    type?: string;
+}
+
+/** Response for whether the requested resource name is available or not. */
+export declare interface CheckNameAvailabilityResponse {
+    /** Returns true or false depending on the availability of the name */
+    nameAvailable?: boolean;
+    /** Reason for why value is not available. This field is returned if nameAvailable is false. */
+    reason?: string;
+    /** Gets an error message explaining the 'reason' value with more details. This field is returned iif nameAvailable is false. */
+    message?: 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;
+
+/** Properties returned with in an insight. */
+export declare interface Diagnostic {
+    /** Solution Id */
+    solutionId?: string;
+    /** Denotes the status of the diagnostic resource. */
+    status?: Status;
+    /** The problems (if any) detected by this insight. */
+    insights?: Insight[];
+    /** Error definition. */
+    error?: ErrorModel;
+}
+
+/** Solution Invocation with additional params needed for invocation. */
+export declare interface DiagnosticInvocation {
+    /** Solution Id to invoke. */
+    solutionId?: string;
+    /** Additional parameters required to invoke the solutionId. */
+    additionalParameters?: {
+        [propertyName: string]: string;
+    };
+}
+
+/** Diagnostic resource */
+export declare interface DiagnosticResource extends ProxyResource {
+    /** Global parameters that can be passed to all solutionIds. */
+    globalParameters?: {
+        [propertyName: string]: string;
+    };
+    /** SolutionIds that are needed to be invoked. */
+    insights?: DiagnosticInvocation[];
+    /**
+     * Diagnostic Request Accepted time.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly acceptedAt?: string;
+    /**
+     * Status of diagnostic provisioning.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provisioningState?: ProvisioningState;
+    /**
+     * Array of Diagnostics.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly diagnostics?: Diagnostic[];
+}
+
+/** Interface representing a Diagnostics. */
+export declare interface Diagnostics {
+    /**
+     * This API is used to check the uniqueness of a resource name used for a diagnostic check.
+     * @param scope This is an extension resource provider and only resource level extension is supported
+     *              at the moment.
+     * @param options The options parameters.
+     */
+    checkNameAvailability(scope: string, options?: DiagnosticsCheckNameAvailabilityOptionalParams): Promise<DiagnosticsCheckNameAvailabilityResponse>;
+    /**
+     * Diagnostics tells you precisely the root cause of the issue and how to address it. You can get
+     * diagnostics once you discover and identify the relevant solution for your Azure issue.<br/><br/> You
+     * can create diagnostics using the ‘solutionId’  from Solution Discovery API response and
+     * ‘additionalParameters’ <br/><br/> <b>Note: </b>‘requiredParameterSets’ from Solutions Discovery API
+     * response must be passed via ‘additionalParameters’ as an input to Diagnostics API
+     * @param scope This is an extension resource provider and only resource level extension is supported
+     *              at the moment.
+     * @param diagnosticsResourceName Unique resource name for insight resources
+     * @param options The options parameters.
+     */
+    beginCreate(scope: string, diagnosticsResourceName: string, options?: DiagnosticsCreateOptionalParams): Promise<SimplePollerLike<OperationState<DiagnosticsCreateResponse>, DiagnosticsCreateResponse>>;
+    /**
+     * Diagnostics tells you precisely the root cause of the issue and how to address it. You can get
+     * diagnostics once you discover and identify the relevant solution for your Azure issue.<br/><br/> You
+     * can create diagnostics using the ‘solutionId’  from Solution Discovery API response and
+     * ‘additionalParameters’ <br/><br/> <b>Note: </b>‘requiredParameterSets’ from Solutions Discovery API
+     * response must be passed via ‘additionalParameters’ as an input to Diagnostics API
+     * @param scope This is an extension resource provider and only resource level extension is supported
+     *              at the moment.
+     * @param diagnosticsResourceName Unique resource name for insight resources
+     * @param options The options parameters.
+     */
+    beginCreateAndWait(scope: string, diagnosticsResourceName: string, options?: DiagnosticsCreateOptionalParams): Promise<DiagnosticsCreateResponse>;
+    /**
+     * Get the diagnostics using the 'diagnosticsResourceName' you chose while creating the diagnostic.
+     * @param scope This is an extension resource provider and only resource level extension is supported
+     *              at the moment.
+     * @param diagnosticsResourceName Unique resource name for insight resources
+     * @param options The options parameters.
+     */
+    get(scope: string, diagnosticsResourceName: string, options?: DiagnosticsGetOptionalParams): Promise<DiagnosticsGetResponse>;
+}
+
+/** Optional parameters. */
+export declare interface DiagnosticsCheckNameAvailabilityOptionalParams extends coreClient.OperationOptions {
+    /** The required parameters for availability check. */
+    checkNameAvailabilityRequest?: CheckNameAvailabilityRequest;
+}
+
+/** Contains response data for the checkNameAvailability operation. */
+export declare type DiagnosticsCheckNameAvailabilityResponse = CheckNameAvailabilityResponse;
+
+/** Optional parameters. */
+export declare interface DiagnosticsCreateOptionalParams extends coreClient.OperationOptions {
+    /** The required request body for this insightResource invocation. */
+    diagnosticResourceRequest?: DiagnosticResource;
+    /** 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 DiagnosticsCreateResponse = DiagnosticResource;
+
+/** Optional parameters. */
+export declare interface DiagnosticsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type DiagnosticsGetResponse = DiagnosticResource;
+
+/** Discovery response. */
+export declare interface DiscoveryResponse {
+    /** The list of solution metadata. */
+    value?: SolutionMetadataResource[];
+    /** The link used to get the next page of solution metadata. */
+    nextLink?: string;
+}
+
+/** Interface representing a DiscoverySolution. */
+export declare interface DiscoverySolution {
+    /**
+     * Solutions Discovery is the initial point of entry within Help API, which helps you identify the
+     * relevant solutions for your Azure issue.<br/><br/> You can discover solutions using resourceUri OR
+     * resourceUri + problemClassificationId.<br/><br/>We will do our best in returning relevant
+     * diagnostics for your Azure issue.<br/><br/> Get the problemClassificationId(s) using this
+     * [reference](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP).<br/><br/>
+     * <b>Note: </b> ‘requiredParameterSets’ from Solutions Discovery API response must be passed via
+     * ‘additionalParameters’ as an input to Diagnostics API.
+     * @param scope This is an extension resource provider and only resource level extension is supported
+     *              at the moment.
+     * @param options The options parameters.
+     */
+    list(scope: string, options?: DiscoverySolutionListOptionalParams): PagedAsyncIterableIterator<SolutionMetadataResource>;
+}
+
+/** Optional parameters. */
+export declare interface DiscoverySolutionListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listNext operation. */
+export declare type DiscoverySolutionListNextResponse = DiscoveryResponse;
+
+/** Optional parameters. */
+export declare interface DiscoverySolutionListOptionalParams extends coreClient.OperationOptions {
+    /** Can be used to filter solutionIds by 'ProblemClassificationId'. The filter supports only 'and' and 'eq' operators. Example: $filter=ProblemClassificationId eq '1ddda5b4-cf6c-4d4f-91ad-bc38ab0e811e' and ProblemClassificationId eq '0a9673c2-7af6-4e19-90d3-4ee2461076d9'. */
+    filter?: string;
+    /** Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. */
+    skiptoken?: string;
+}
+
+/** Contains response data for the list operation. */
+export declare type DiscoverySolutionListResponse = DiscoveryResponse;
+
+/** 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[];
+}
+
+/** Error definition. */
+export declare interface ErrorModel {
+    /**
+     * Service specific error code which serves as the substatus for the HTTP error code.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly code?: string;
+    /**
+     * Service specific error type which serves as additional context for the error herein.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly type?: string;
+    /**
+     * Description of the error.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly message?: string;
+    /** An array of additional nested error response info objects, as described by this contract. */
+    details?: ErrorModel[];
+}
+
+/** 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;
+}
+
+/**
+ * Given the last `.value` produced by the `byPage` iterator,
+ * returns a continuation token that can be used to begin paging from
+ * that point later.
+ * @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
+ * @returns The continuation token that can be passed into byPage() during future calls.
+ */
+export declare function getContinuationToken(page: unknown): string | undefined;
+
+export declare class HelpRP extends coreClient.ServiceClient {
+    $host: string;
+    apiVersion: string;
+    /**
+     * Initializes a new instance of the HelpRP class.
+     * @param credentials Subscription credentials which uniquely identify client subscription.
+     * @param options The parameter options
+     */
+    constructor(credentials: coreAuth.TokenCredential, options?: HelpRPOptionalParams);
+    /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+    private addCustomApiVersionPolicy;
+    operations: Operations;
+    diagnostics: Diagnostics;
+    discoverySolution: DiscoverySolution;
+}
+
+/** Optional parameters. */
+export declare interface HelpRPOptionalParams extends coreClient.ServiceClientOptions {
+    /** server parameter */
+    $host?: string;
+    /** Api Version */
+    apiVersion?: string;
+    /** Overrides client endpoint. */
+    endpoint?: string;
+}
+
+/**
+ * Defines values for ImportanceLevel. \
+ * {@link KnownImportanceLevel} can be used interchangeably with ImportanceLevel,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Critical**: A critical insight has been found after running the diagnostic. \
+ * **Warning**: A warning insight has been found after running the diagnostic. \
+ * **Information**: An information insight has been found after running the diagnostic.
+ */
+export declare type ImportanceLevel = string;
+
+/** Detailed insights(s) obtained via the invocation of an insight diagnostic troubleshooter. */
+export declare interface Insight {
+    /** Article id. */
+    id?: string;
+    /** This insight's title. */
+    title?: string;
+    /** Detailed result content. */
+    results?: string;
+    /** Importance level of the insight. */
+    importanceLevel?: ImportanceLevel;
+}
+
+/** Known values of {@link ActionType} that the service accepts. */
+export declare enum KnownActionType {
+    /** Internal */
+    Internal = "Internal"
+}
+
+/** Known values of {@link CreatedByType} that the service accepts. */
+export declare enum KnownCreatedByType {
+    /** User */
+    User = "User",
+    /** Application */
+    Application = "Application",
+    /** ManagedIdentity */
+    ManagedIdentity = "ManagedIdentity",
+    /** Key */
+    Key = "Key"
+}
+
+/** Known values of {@link ImportanceLevel} that the service accepts. */
+export declare enum KnownImportanceLevel {
+    /** A critical insight has been found after running the diagnostic. */
+    Critical = "Critical",
+    /** A warning insight has been found after running the diagnostic. */
+    Warning = "Warning",
+    /** An information insight has been found after running the diagnostic. */
+    Information = "Information"
+}
+
+/** Known values of {@link Origin} that the service accepts. */
+export declare enum KnownOrigin {
+    /** User */
+    User = "user",
+    /** System */
+    System = "system",
+    /** UserSystem */
+    UserSystem = "user,system"
+}
+
+/** Known values of {@link ProvisioningState} that the service accepts. */
+export declare enum KnownProvisioningState {
+    /** All Diagnostics in the Batch succeeded. */
+    Succeeded = "Succeeded",
+    /** Some Diagnostics are still running or failed. */
+    PartialComplete = "PartialComplete",
+    /** All Diagnostics failed to run. */
+    Failed = "Failed",
+    /** When Diagnostic request gets canceled. */
+    Canceled = "Canceled"
+}
+
+/** Known values of {@link Status} that the service accepts. */
+export declare enum KnownStatus {
+    /** Diagnostic creation failed. */
+    Failed = "Failed",
+    /** Request is missing required inputs to run. */
+    MissingInputs = "MissingInputs",
+    /** Diagnostic is still running. */
+    Running = "Running",
+    /** Diagnostic creation succeeded. */
+    Succeeded = "Succeeded",
+    /** Diagnostic was timed out. */
+    Timeout = "Timeout"
+}
+
+/** Details of a REST API operation, returned from the Resource Provider Operations API */
+export declare interface Operation {
+    /**
+     * The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action"
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly name?: string;
+    /**
+     * Whether the operation applies to data-plane. This is "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; as in Resource Based Access Control (RBAC) and 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?: Origin;
+    /**
+     * Enum. 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;
+}
+
+/** Localized display information for this particular operation. */
+export declare interface OperationDisplay {
+    /**
+     * The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute".
+     * 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. "Virtual Machines" or "Job Schedule Collections".
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly resource?: string;
+    /**
+     * The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine".
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly operation?: string;
+    /**
+     * The short, localized friendly description of the operation; suitable for tool tips and detailed views.
+     * 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 an Azure Resource Provider. It contains an URL link to get the next set of results. */
+export declare interface OperationListResult {
+    /**
+     * List of operations supported by the resource provider
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly value?: Operation[];
+    /**
+     * 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;
+}
+
+/** Interface representing a Operations. */
+export declare interface Operations {
+    /**
+     * Returns list of operations.
+     * @param options The options parameters.
+     */
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+/** 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
+ * **Succeeded**: All Diagnostics in the Batch succeeded. \
+ * **PartialComplete**: Some Diagnostics are still running or failed. \
+ * **Failed**: All Diagnostics failed to run. \
+ * **Canceled**: When Diagnostic request gets canceled.
+ */
+export declare type ProvisioningState = string;
+
+/** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
+export declare interface ProxyResource extends 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;
+    /**
+     * Azure Resource Manager metadata containing createdBy and modifiedBy information.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly systemData?: SystemData;
+}
+
+/** Solution Metadata resource */
+export declare interface SolutionMetadataResource extends ProxyResource {
+    /** Solution Id. */
+    solutionId?: string;
+    /** Solution Type. */
+    solutionType?: string;
+    /** A detailed description of solution. */
+    description?: string;
+    /** Required parameters for invoking this particular solution. */
+    requiredParameterSets?: string[][];
+}
+
+/**
+ * Defines values for Status. \
+ * {@link KnownStatus} can be used interchangeably with Status,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Failed**: Diagnostic creation failed. \
+ * **MissingInputs**: Request is missing required inputs to run. \
+ * **Running**: Diagnostic is still running. \
+ * **Succeeded**: Diagnostic creation succeeded. \
+ * **Timeout**: Diagnostic was timed out.
+ */
+export declare type Status = 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;
+}
+
+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.34.4"
+    }
+  ]
+}