@azure/arm-databoundaries 1.0.0-beta.1

package/types/arm-databoundaries.d.ts

@@ -0,0 +1,276 @@
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+
+/**
+ * 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;
+
+/** Interface representing a DataBoundaries. */
+export declare interface DataBoundaries {
+    /**
+     * Opt-in tenant to data boundary.
+     * @param defaultParam Default string modeled as parameter for auto generation to work correctly.
+     * @param dataBoundaryDefinition The data boundary to opt the tenant to.
+     * @param options The options parameters.
+     */
+    put(defaultParam: DefaultName, dataBoundaryDefinition: DataBoundaryDefinition, options?: DataBoundariesPutOptionalParams): Promise<DataBoundariesPutResponse>;
+    /**
+     * Get data boundary of tenant.
+     * @param defaultParam Default string modeled as parameter for auto generation to work correctly.
+     * @param options The options parameters.
+     */
+    getTenant(defaultParam: DefaultName, options?: DataBoundariesGetTenantOptionalParams): Promise<DataBoundariesGetTenantResponse>;
+    /**
+     * Get data boundary at specified scope
+     * @param scope The scope at which the operation is performed.
+     * @param defaultParam Default string modeled as parameter for auto generation to work correctly.
+     * @param options The options parameters.
+     */
+    getScope(scope: string, defaultParam: DefaultName, options?: DataBoundariesGetScopeOptionalParams): Promise<DataBoundariesGetScopeResponse>;
+}
+
+/** Optional parameters. */
+export declare interface DataBoundariesGetScopeOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the getScope operation. */
+export declare type DataBoundariesGetScopeResponse = DataBoundaryDefinition;
+
+/** Optional parameters. */
+export declare interface DataBoundariesGetTenantOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the getTenant operation. */
+export declare type DataBoundariesGetTenantResponse = DataBoundaryDefinition;
+
+export declare class DataboundariesManegementClient extends coreClient.ServiceClient {
+    $host: string;
+    apiVersion: string;
+    /**
+     * Initializes a new instance of the DataboundariesManegementClient class.
+     * @param credentials Subscription credentials which uniquely identify client subscription.
+     * @param options The parameter options
+     */
+    constructor(credentials: coreAuth.TokenCredential, options?: DataboundariesManegementClientOptionalParams);
+    /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+    private addCustomApiVersionPolicy;
+    dataBoundaries: DataBoundaries;
+}
+
+/** Optional parameters. */
+export declare interface DataboundariesManegementClientOptionalParams extends coreClient.ServiceClientOptions {
+    /** server parameter */
+    $host?: string;
+    /** Api Version */
+    apiVersion?: string;
+    /** Overrides client endpoint. */
+    endpoint?: string;
+}
+
+/** Optional parameters. */
+export declare interface DataBoundariesPutOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the put operation. */
+export declare type DataBoundariesPutResponse = DataBoundaryDefinition;
+
+/**
+ * Defines values for DataBoundary. \
+ * {@link KnownDataBoundary} can be used interchangeably with DataBoundary,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **NotDefined** \
+ * **Global** \
+ * **EU**
+ */
+export declare type DataBoundary = string;
+
+/** A data boundary definition. */
+export declare interface DataBoundaryDefinition extends ProxyResource {
+    /** Data boundary properties */
+    properties?: DataBoundaryProperties;
+}
+
+/** Data boundary properties */
+export declare interface DataBoundaryProperties {
+    /** The data boundary definition. */
+    dataBoundary?: DataBoundary;
+    /**
+     * Denotes the state of provisioning.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provisioningState?: ProvisioningState;
+}
+
+/**
+ * Defines values for DefaultName. \
+ * {@link KnownDefaultName} can be used interchangeably with DefaultName,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **default**
+ */
+export declare type DefaultName = 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;
+}
+
+/** 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 DataBoundary} that the service accepts. */
+export declare enum KnownDataBoundary {
+    /** NotDefined */
+    NotDefined = "NotDefined",
+    /** Global */
+    Global = "Global",
+    /** EU */
+    EU = "EU"
+}
+
+/** Known values of {@link DefaultName} that the service accepts. */
+export declare enum KnownDefaultName {
+    /** Default */
+    Default = "default"
+}
+
+/** Known values of {@link ProvisioningState} that the service accepts. */
+export declare enum KnownProvisioningState {
+    /** Accepted */
+    Accepted = "Accepted",
+    /** Running */
+    Running = "Running",
+    /** Creating */
+    Creating = "Creating",
+    /** Canceled */
+    Canceled = "Canceled",
+    /** Failed */
+    Failed = "Failed",
+    /** Succeeded */
+    Succeeded = "Succeeded",
+    /** Updating */
+    Updating = "Updating"
+}
+
+/**
+ * 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** \
+ * **Running** \
+ * **Creating** \
+ * **Canceled** \
+ * **Failed** \
+ * **Succeeded** \
+ * **Updating**
+ */
+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. E.g. "/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;
+}
+
+/** 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.47.11"
+    }
+  ]
+}