@azure/arm-graphservices 1.0.0-beta.1

package/types/arm-graphservices.d.ts

@@ -0,0 +1,459 @@
+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';
+
+/** Interface representing a Account. */
+export declare interface Account {
+    /**
+     * Returns account resource for a given name.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param resourceName The name of the resource.
+     * @param options The options parameters.
+     */
+    get(resourceGroupName: string, resourceName: string, options?: AccountGetOptionalParams): Promise<AccountGetResponse>;
+    /**
+     * Create or update account resource.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param resourceName The name of the resource.
+     * @param accountResource Account details.
+     * @param options The options parameters.
+     */
+    beginCreateAndUpdate(resourceGroupName: string, resourceName: string, accountResource: AccountResource, options?: AccountCreateAndUpdateOptionalParams): Promise<SimplePollerLike<OperationState<AccountCreateAndUpdateResponse>, AccountCreateAndUpdateResponse>>;
+    /**
+     * Create or update account resource.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param resourceName The name of the resource.
+     * @param accountResource Account details.
+     * @param options The options parameters.
+     */
+    beginCreateAndUpdateAndWait(resourceGroupName: string, resourceName: string, accountResource: AccountResource, options?: AccountCreateAndUpdateOptionalParams): Promise<AccountCreateAndUpdateResponse>;
+    /**
+     * Update account details.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param resourceName The name of the resource.
+     * @param accountResource Account patch details.
+     * @param options The options parameters.
+     */
+    update(resourceGroupName: string, resourceName: string, accountResource: AccountPatchResource, options?: AccountUpdateOptionalParams): Promise<AccountUpdateResponse>;
+    /**
+     * Deletes a account resource.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param resourceName The name of the resource.
+     * @param options The options parameters.
+     */
+    delete(resourceGroupName: string, resourceName: string, options?: AccountDeleteOptionalParams): Promise<void>;
+}
+
+/** Optional parameters. */
+export declare interface AccountCreateAndUpdateOptionalParams 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 createAndUpdate operation. */
+export declare type AccountCreateAndUpdateResponse = AccountResource;
+
+/** Optional parameters. */
+export declare interface AccountDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Optional parameters. */
+export declare interface AccountGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type AccountGetResponse = AccountResource;
+
+/** Account patch properties */
+export declare interface AccountPatchResource extends TagUpdate {
+}
+
+/** Account details */
+export declare interface AccountResource extends Resource {
+    /**
+     * 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?: AccountResourceSystemData;
+    /** Property bag from billing account */
+    properties: AccountResourceProperties;
+}
+
+/** The list of accounts. */
+export declare interface AccountResourceList {
+    /** The link to the next page of items */
+    nextLink?: string;
+    /** The list of recommendations. */
+    value?: AccountResource[];
+}
+
+/** Property bag from billing account */
+export declare interface AccountResourceProperties {
+    /**
+     * Provisioning state.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provisioningState?: ProvisioningState;
+    /** Customer owned application ID */
+    appId: string;
+    /**
+     * Billing Plan Id
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly billingPlanId?: string;
+}
+
+/** Metadata pertaining to creation and last modification of the resource. */
+export declare interface AccountResourceSystemData {
+    /** The type of identity that created the resource. */
+    createdByType?: CreatedByType;
+    /** The timestamp of resource creation (UTC). */
+    createdAt?: Date;
+    /** The type of identity that last modified the resource. */
+    lastModifiedByType?: CreatedByType;
+    /** The timestamp of resource last modification (UTC) */
+    lastModifiedAt?: Date;
+}
+
+/** Interface representing a Accounts. */
+export declare interface Accounts {
+    /**
+     * Returns list of accounts apps.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param options The options parameters.
+     */
+    listByResourceGroup(resourceGroupName: string, options?: AccountsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<AccountResource>;
+    /**
+     * Returns list of accounts belonging to a subscription.
+     * @param options The options parameters.
+     */
+    listBySubscription(options?: AccountsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<AccountResource>;
+}
+
+/** Optional parameters. */
+export declare interface AccountsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listByResourceGroupNext operation. */
+export declare type AccountsListByResourceGroupNextResponse = AccountResourceList;
+
+/** Optional parameters. */
+export declare interface AccountsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listByResourceGroup operation. */
+export declare type AccountsListByResourceGroupResponse = AccountResourceList;
+
+/** Optional parameters. */
+export declare interface AccountsListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listBySubscriptionNext operation. */
+export declare type AccountsListBySubscriptionNextResponse = AccountResourceList;
+
+/** Optional parameters. */
+export declare interface AccountsListBySubscriptionOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listBySubscription operation. */
+export declare type AccountsListBySubscriptionResponse = AccountResourceList;
+
+/** Optional parameters. */
+export declare interface AccountUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the update operation. */
+export declare type AccountUpdateResponse = AccountResource;
+
+/**
+ * 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 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;
+
+/** 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;
+}
+
+/**
+ * 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 GraphServices extends coreClient.ServiceClient {
+    $host: string;
+    apiVersion: string;
+    subscriptionId: string;
+    /**
+     * Initializes a new instance of the GraphServices class.
+     * @param credentials Subscription credentials which uniquely identify client subscription.
+     * @param subscriptionId The ID of the target subscription.
+     * @param options The parameter options
+     */
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: GraphServicesOptionalParams);
+    /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+    private addCustomApiVersionPolicy;
+    accounts: Accounts;
+    account: Account;
+    operationOperations: OperationOperations;
+}
+
+/** Optional parameters. */
+export declare interface GraphServicesOptionalParams extends coreClient.ServiceClientOptions {
+    /** server parameter */
+    $host?: string;
+    /** Api Version */
+    apiVersion?: string;
+    /** Overrides client endpoint. */
+    endpoint?: string;
+}
+
+/** 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 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 {
+    /** Succeeded */
+    Succeeded = "Succeeded",
+    /** Failed */
+    Failed = "Failed",
+    /** Canceled */
+    Canceled = "Canceled"
+}
+
+/** 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;
+}
+
+/** Optional parameters. */
+export declare interface OperationListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listNext operation. */
+export declare type OperationListNextResponse = OperationListResult;
+
+/** Optional parameters. */
+export declare interface OperationListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type OperationListResponse = OperationListResult;
+
+/** 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 OperationOperations. */
+export declare interface OperationOperations {
+    /**
+     * Returns list of operations.
+     * @param options The options parameters.
+     */
+    list(options?: OperationListOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+/**
+ * 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** \
+ * **Failed** \
+ * **Canceled**
+ */
+export declare type ProvisioningState = string;
+
+/** An Azure resource. */
+export declare interface Resource {
+    /**
+     * Azure resource ID.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly id?: string;
+    /**
+     * Azure resource name.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly name?: string;
+    /**
+     * Azure resource type.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly type?: string;
+    /** Location of the resource. */
+    location?: string;
+    /** resource tags. */
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+/** Request payload used to update an existing resource's tags. */
+export declare interface TagUpdate {
+    /** List of key value pairs that describe the resource. This will overwrite the existing tags. */
+    tags?: {
+        [propertyName: string]: 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.34.4"
+    }
+  ]
+}