@azure/arm-resourcesdeploymentstacks 1.0.0-beta.1

package/types/arm-resourcesdeploymentstacks.d.ts

@@ -0,0 +1,899 @@
+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';
+
+/** Common properties for all Azure resources. */
+export declare interface AzureResourceBase {
+    /**
+     * String Id used to locate any resource on Azure.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly id?: string;
+    /**
+     * Name of this resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly name?: string;
+    /**
+     * Type of this resource.
+     * 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;
+}
+
+/**
+ * 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;
+
+/** Defines how resources deployed by the deployment stack are locked. */
+export declare interface DenySettings {
+    /** denySettings Mode. */
+    mode: DenySettingsMode;
+    /** List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. */
+    excludedPrincipals?: string[];
+    /** List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. */
+    excludedActions?: string[];
+    /** DenySettings will be applied to child scopes. */
+    applyToChildScopes?: boolean;
+}
+
+/**
+ * Defines values for DenySettingsMode. \
+ * {@link KnownDenySettingsMode} can be used interchangeably with DenySettingsMode,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **denyDelete**: Authorized users are able to read and modify the resources, but cannot delete. \
+ * **denyWriteAndDelete**: Authorized users can only read from a resource, but cannot modify or delete it. \
+ * **none**: No denyAssignments have been applied.
+ */
+export declare type DenySettingsMode = string;
+
+/**
+ * Defines values for DenyStatusMode. \
+ * {@link KnownDenyStatusMode} can be used interchangeably with DenyStatusMode,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **denyDelete**: Authorized users are able to read and modify the resources, but cannot delete. \
+ * **notSupported**: Resource type does not support denyAssignments. \
+ * **inapplicable**: denyAssignments are not supported on resources outside the scope of the deployment stack. \
+ * **denyWriteAndDelete**: Authorized users can only read from a resource, but cannot modify or delete it. \
+ * **removedBySystem**: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) \
+ * **None**: No denyAssignments have been applied.
+ */
+export declare type DenyStatusMode = string;
+
+/** Deployment stack object. */
+export declare interface DeploymentStack extends AzureResourceBase {
+    /** The location of the deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. */
+    location?: string;
+    /** Deployment stack resource tags. */
+    tags?: {
+        [propertyName: string]: string;
+    };
+    /** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */
+    error?: ErrorResponse;
+    /** The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. */
+    template?: Record<string, unknown>;
+    /** The URI of the template. Use either the templateLink property or the template property, but not both. */
+    templateLink?: DeploymentStacksTemplateLink;
+    /** Name and value pairs that define the deployment parameters for the template. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. */
+    parameters?: Record<string, unknown>;
+    /** The URI of parameters file. Use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. */
+    parametersLink?: DeploymentStacksParametersLink;
+    /** Defines the behavior of resources that are not managed immediately after the stack is updated. */
+    actionOnUnmanage?: DeploymentStackPropertiesActionOnUnmanage;
+    /** The debug setting of the deployment. */
+    debugSetting?: DeploymentStacksDebugSetting;
+    /** The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). */
+    deploymentScope?: string;
+    /** Deployment stack description. */
+    description?: string;
+    /** Defines how resources deployed by the stack are locked. */
+    denySettings?: DenySettings;
+    /**
+     * State of the deployment stack.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provisioningState?: DeploymentStackProvisioningState;
+    /**
+     * An array of resources that were detached during the most recent update.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly detachedResources?: ResourceReference[];
+    /**
+     * An array of resources that were deleted during the most recent update.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly deletedResources?: ResourceReference[];
+    /**
+     * An array of resources that failed to reach goal state during the most recent update.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly failedResources?: ResourceReferenceExtended[];
+    /**
+     * An array of resources currently managed by the deployment stack.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly resources?: ManagedResourceReference[];
+    /**
+     * The resourceId of the deployment resource created by the deployment stack.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly deploymentId?: string;
+    /**
+     * The outputs of the underlying deployment.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly outputs?: Record<string, unknown>;
+    /**
+     * The duration of the deployment stack update.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly duration?: string;
+}
+
+/** List of deployment stacks. */
+export declare interface DeploymentStackListResult {
+    /** An array of deployment stacks. */
+    value?: DeploymentStack[];
+    /**
+     * The URL to use for getting the next set of results.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly nextLink?: string;
+}
+
+/** Deployment stack properties. */
+export declare interface DeploymentStackProperties extends DeploymentStacksError {
+    /** The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. */
+    template?: Record<string, unknown>;
+    /** The URI of the template. Use either the templateLink property or the template property, but not both. */
+    templateLink?: DeploymentStacksTemplateLink;
+    /** Name and value pairs that define the deployment parameters for the template. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. */
+    parameters?: Record<string, unknown>;
+    /** The URI of parameters file. Use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. */
+    parametersLink?: DeploymentStacksParametersLink;
+    /** Defines the behavior of resources that are not managed immediately after the stack is updated. */
+    actionOnUnmanage: DeploymentStackPropertiesActionOnUnmanage;
+    /** The debug setting of the deployment. */
+    debugSetting?: DeploymentStacksDebugSetting;
+    /** The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). */
+    deploymentScope?: string;
+    /** Deployment stack description. */
+    description?: string;
+    /** Defines how resources deployed by the stack are locked. */
+    denySettings: DenySettings;
+    /**
+     * State of the deployment stack.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provisioningState?: DeploymentStackProvisioningState;
+    /**
+     * An array of resources that were detached during the most recent update.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly detachedResources?: ResourceReference[];
+    /**
+     * An array of resources that were deleted during the most recent update.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly deletedResources?: ResourceReference[];
+    /**
+     * An array of resources that failed to reach goal state during the most recent update.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly failedResources?: ResourceReferenceExtended[];
+    /**
+     * An array of resources currently managed by the deployment stack.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly resources?: ManagedResourceReference[];
+    /**
+     * The resourceId of the deployment resource created by the deployment stack.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly deploymentId?: string;
+    /**
+     * The outputs of the underlying deployment.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly outputs?: Record<string, unknown>;
+    /**
+     * The duration of the deployment stack update.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly duration?: string;
+}
+
+/** Defines the behavior of resources that are not managed immediately after the stack is updated. */
+export declare interface DeploymentStackPropertiesActionOnUnmanage {
+    /** Specifies the action that should be taken on the resource when the deployment stack is deleted. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. */
+    resources: DeploymentStacksDeleteDetachEnum;
+    /** Specifies the action that should be taken on the resource when the deployment stack is deleted. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. */
+    resourceGroups?: DeploymentStacksDeleteDetachEnum;
+    /** Specifies the action that should be taken on the resource when the deployment stack is deleted. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. */
+    managementGroups?: DeploymentStacksDeleteDetachEnum;
+}
+
+/**
+ * Defines values for DeploymentStackProvisioningState. \
+ * {@link KnownDeploymentStackProvisioningState} can be used interchangeably with DeploymentStackProvisioningState,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Creating** \
+ * **Validating** \
+ * **Waiting** \
+ * **Deploying** \
+ * **Canceling** \
+ * **Locking** \
+ * **DeletingResources** \
+ * **Succeeded** \
+ * **Failed** \
+ * **Canceled** \
+ * **Deleting**
+ */
+export declare type DeploymentStackProvisioningState = string;
+
+/** Interface representing a DeploymentStacks. */
+export declare interface DeploymentStacks {
+    /**
+     * Lists all the Deployment Stacks within the specified resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param options The options parameters.
+     */
+    listAtResourceGroup(resourceGroupName: string, options?: DeploymentStacksListAtResourceGroupOptionalParams): PagedAsyncIterableIterator<DeploymentStack>;
+    /**
+     * Lists all the Deployment Stacks within the specified subscription.
+     * @param options The options parameters.
+     */
+    listAtSubscription(options?: DeploymentStacksListAtSubscriptionOptionalParams): PagedAsyncIterableIterator<DeploymentStack>;
+    /**
+     * Lists all the Deployment Stacks within the specified management group.
+     * @param managementGroupId Management Group.
+     * @param options The options parameters.
+     */
+    listAtManagementGroup(managementGroupId: string, options?: DeploymentStacksListAtManagementGroupOptionalParams): PagedAsyncIterableIterator<DeploymentStack>;
+    /**
+     * Creates or updates a Deployment Stack.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param deploymentStackName Name of the deployment stack.
+     * @param deploymentStack Deployment Stack supplied to the operation.
+     * @param options The options parameters.
+     */
+    beginCreateOrUpdateAtResourceGroup(resourceGroupName: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksCreateOrUpdateAtResourceGroupOptionalParams): Promise<SimplePollerLike<OperationState<DeploymentStacksCreateOrUpdateAtResourceGroupResponse>, DeploymentStacksCreateOrUpdateAtResourceGroupResponse>>;
+    /**
+     * Creates or updates a Deployment Stack.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param deploymentStackName Name of the deployment stack.
+     * @param deploymentStack Deployment Stack supplied to the operation.
+     * @param options The options parameters.
+     */
+    beginCreateOrUpdateAtResourceGroupAndWait(resourceGroupName: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksCreateOrUpdateAtResourceGroupOptionalParams): Promise<DeploymentStacksCreateOrUpdateAtResourceGroupResponse>;
+    /**
+     * Gets a Deployment Stack with a given name.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param deploymentStackName Name of the deployment stack.
+     * @param options The options parameters.
+     */
+    getAtResourceGroup(resourceGroupName: string, deploymentStackName: string, options?: DeploymentStacksGetAtResourceGroupOptionalParams): Promise<DeploymentStacksGetAtResourceGroupResponse>;
+    /**
+     * Deletes a Deployment Stack by name. When operation completes, status code 200 returned without
+     * content.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param deploymentStackName Name of the deployment stack.
+     * @param options The options parameters.
+     */
+    beginDeleteAtResourceGroup(resourceGroupName: string, deploymentStackName: string, options?: DeploymentStacksDeleteAtResourceGroupOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
+    /**
+     * Deletes a Deployment Stack by name. When operation completes, status code 200 returned without
+     * content.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param deploymentStackName Name of the deployment stack.
+     * @param options The options parameters.
+     */
+    beginDeleteAtResourceGroupAndWait(resourceGroupName: string, deploymentStackName: string, options?: DeploymentStacksDeleteAtResourceGroupOptionalParams): Promise<void>;
+    /**
+     * Creates or updates a Deployment Stack.
+     * @param deploymentStackName Name of the deployment stack.
+     * @param deploymentStack Deployment Stack supplied to the operation.
+     * @param options The options parameters.
+     */
+    beginCreateOrUpdateAtSubscription(deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksCreateOrUpdateAtSubscriptionOptionalParams): Promise<SimplePollerLike<OperationState<DeploymentStacksCreateOrUpdateAtSubscriptionResponse>, DeploymentStacksCreateOrUpdateAtSubscriptionResponse>>;
+    /**
+     * Creates or updates a Deployment Stack.
+     * @param deploymentStackName Name of the deployment stack.
+     * @param deploymentStack Deployment Stack supplied to the operation.
+     * @param options The options parameters.
+     */
+    beginCreateOrUpdateAtSubscriptionAndWait(deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksCreateOrUpdateAtSubscriptionOptionalParams): Promise<DeploymentStacksCreateOrUpdateAtSubscriptionResponse>;
+    /**
+     * Gets a Deployment Stack with a given name.
+     * @param deploymentStackName Name of the deployment stack.
+     * @param options The options parameters.
+     */
+    getAtSubscription(deploymentStackName: string, options?: DeploymentStacksGetAtSubscriptionOptionalParams): Promise<DeploymentStacksGetAtSubscriptionResponse>;
+    /**
+     * Deletes a Deployment Stack by name. When operation completes, status code 200 returned without
+     * content.
+     * @param deploymentStackName Name of the deployment stack.
+     * @param options The options parameters.
+     */
+    beginDeleteAtSubscription(deploymentStackName: string, options?: DeploymentStacksDeleteAtSubscriptionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
+    /**
+     * Deletes a Deployment Stack by name. When operation completes, status code 200 returned without
+     * content.
+     * @param deploymentStackName Name of the deployment stack.
+     * @param options The options parameters.
+     */
+    beginDeleteAtSubscriptionAndWait(deploymentStackName: string, options?: DeploymentStacksDeleteAtSubscriptionOptionalParams): Promise<void>;
+    /**
+     * Creates or updates a Deployment Stack.
+     * @param managementGroupId Management Group.
+     * @param deploymentStackName Name of the deployment stack.
+     * @param deploymentStack Deployment Stack supplied to the operation.
+     * @param options The options parameters.
+     */
+    beginCreateOrUpdateAtManagementGroup(managementGroupId: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksCreateOrUpdateAtManagementGroupOptionalParams): Promise<SimplePollerLike<OperationState<DeploymentStacksCreateOrUpdateAtManagementGroupResponse>, DeploymentStacksCreateOrUpdateAtManagementGroupResponse>>;
+    /**
+     * Creates or updates a Deployment Stack.
+     * @param managementGroupId Management Group.
+     * @param deploymentStackName Name of the deployment stack.
+     * @param deploymentStack Deployment Stack supplied to the operation.
+     * @param options The options parameters.
+     */
+    beginCreateOrUpdateAtManagementGroupAndWait(managementGroupId: string, deploymentStackName: string, deploymentStack: DeploymentStack, options?: DeploymentStacksCreateOrUpdateAtManagementGroupOptionalParams): Promise<DeploymentStacksCreateOrUpdateAtManagementGroupResponse>;
+    /**
+     * Gets a Deployment Stack with a given name.
+     * @param managementGroupId Management Group.
+     * @param deploymentStackName Name of the deployment stack.
+     * @param options The options parameters.
+     */
+    getAtManagementGroup(managementGroupId: string, deploymentStackName: string, options?: DeploymentStacksGetAtManagementGroupOptionalParams): Promise<DeploymentStacksGetAtManagementGroupResponse>;
+    /**
+     * Deletes a Deployment Stack by name. When operation completes, status code 200 returned without
+     * content.
+     * @param managementGroupId Management Group.
+     * @param deploymentStackName Name of the deployment stack.
+     * @param options The options parameters.
+     */
+    beginDeleteAtManagementGroup(managementGroupId: string, deploymentStackName: string, options?: DeploymentStacksDeleteAtManagementGroupOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
+    /**
+     * Deletes a Deployment Stack by name. When operation completes, status code 200 returned without
+     * content.
+     * @param managementGroupId Management Group.
+     * @param deploymentStackName Name of the deployment stack.
+     * @param options The options parameters.
+     */
+    beginDeleteAtManagementGroupAndWait(managementGroupId: string, deploymentStackName: string, options?: DeploymentStacksDeleteAtManagementGroupOptionalParams): Promise<void>;
+    /**
+     * Exports the template used to create the deployment stack.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param deploymentStackName Name of the deployment stack.
+     * @param options The options parameters.
+     */
+    exportTemplateAtResourceGroup(resourceGroupName: string, deploymentStackName: string, options?: DeploymentStacksExportTemplateAtResourceGroupOptionalParams): Promise<DeploymentStacksExportTemplateAtResourceGroupResponse>;
+    /**
+     * Exports the template used to create the deployment stack.
+     * @param deploymentStackName Name of the deployment stack.
+     * @param options The options parameters.
+     */
+    exportTemplateAtSubscription(deploymentStackName: string, options?: DeploymentStacksExportTemplateAtSubscriptionOptionalParams): Promise<DeploymentStacksExportTemplateAtSubscriptionResponse>;
+    /**
+     * Exports the template used to create the deployment stack.
+     * @param managementGroupId Management Group.
+     * @param deploymentStackName Name of the deployment stack.
+     * @param options The options parameters.
+     */
+    exportTemplateAtManagementGroup(managementGroupId: string, deploymentStackName: string, options?: DeploymentStacksExportTemplateAtManagementGroupOptionalParams): Promise<DeploymentStacksExportTemplateAtManagementGroupResponse>;
+}
+
+export declare class DeploymentStacksClient extends coreClient.ServiceClient {
+    $host: string;
+    subscriptionId?: string;
+    apiVersion: string;
+    /**
+     * Initializes a new instance of the DeploymentStacksClient 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?: DeploymentStacksClientOptionalParams);
+    constructor(credentials: coreAuth.TokenCredential, options?: DeploymentStacksClientOptionalParams);
+    /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+    private addCustomApiVersionPolicy;
+    deploymentStacks: DeploymentStacks;
+}
+
+/** Optional parameters. */
+export declare interface DeploymentStacksClientOptionalParams extends coreClient.ServiceClientOptions {
+    /** server parameter */
+    $host?: string;
+    /** Api Version */
+    apiVersion?: string;
+    /** Overrides client endpoint. */
+    endpoint?: string;
+}
+
+/** Optional parameters. */
+export declare interface DeploymentStacksCreateOrUpdateAtManagementGroupOptionalParams 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 createOrUpdateAtManagementGroup operation. */
+export declare type DeploymentStacksCreateOrUpdateAtManagementGroupResponse = DeploymentStack;
+
+/** Optional parameters. */
+export declare interface DeploymentStacksCreateOrUpdateAtResourceGroupOptionalParams 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 createOrUpdateAtResourceGroup operation. */
+export declare type DeploymentStacksCreateOrUpdateAtResourceGroupResponse = DeploymentStack;
+
+/** Optional parameters. */
+export declare interface DeploymentStacksCreateOrUpdateAtSubscriptionOptionalParams 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 createOrUpdateAtSubscription operation. */
+export declare type DeploymentStacksCreateOrUpdateAtSubscriptionResponse = DeploymentStack;
+
+/** The debug setting. */
+export declare interface DeploymentStacksDebugSetting {
+    /** Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. */
+    detailLevel?: string;
+}
+
+/** Defines headers for DeploymentStacks_deleteAtManagementGroup operation. */
+export declare interface DeploymentStacksDeleteAtManagementGroupHeaders {
+    location?: string;
+}
+
+/** Optional parameters. */
+export declare interface DeploymentStacksDeleteAtManagementGroupOptionalParams extends coreClient.OperationOptions {
+    /** Flag to indicate delete rather than detach for the resources. */
+    unmanageActionResources?: UnmanageActionResourceMode;
+    /** Flag to indicate delete rather than detach for the resource groups. */
+    unmanageActionResourceGroups?: UnmanageActionResourceGroupMode;
+    /** Flag to indicate delete rather than detach for the management groups. */
+    unmanageActionManagementGroups?: UnmanageActionManagementGroupMode;
+    /** 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;
+}
+
+/** Defines headers for DeploymentStacks_deleteAtResourceGroup operation. */
+export declare interface DeploymentStacksDeleteAtResourceGroupHeaders {
+    location?: string;
+}
+
+/** Optional parameters. */
+export declare interface DeploymentStacksDeleteAtResourceGroupOptionalParams extends coreClient.OperationOptions {
+    /** Flag to indicate delete rather than detach for the resources. */
+    unmanageActionResources?: UnmanageActionResourceMode;
+    /** Flag to indicate delete rather than detach for the resource groups. */
+    unmanageActionResourceGroups?: UnmanageActionResourceGroupMode;
+    /** 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;
+}
+
+/** Defines headers for DeploymentStacks_deleteAtSubscription operation. */
+export declare interface DeploymentStacksDeleteAtSubscriptionHeaders {
+    location?: string;
+}
+
+/** Optional parameters. */
+export declare interface DeploymentStacksDeleteAtSubscriptionOptionalParams extends coreClient.OperationOptions {
+    /** Flag to indicate delete rather than detach for the resources. */
+    unmanageActionResources?: UnmanageActionResourceMode;
+    /** Flag to indicate delete rather than detach for the resource groups. */
+    unmanageActionResourceGroups?: UnmanageActionResourceGroupMode;
+    /** 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;
+}
+
+/**
+ * Defines values for DeploymentStacksDeleteDetachEnum. \
+ * {@link KnownDeploymentStacksDeleteDetachEnum} can be used interchangeably with DeploymentStacksDeleteDetachEnum,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **delete** \
+ * **detach**
+ */
+export declare type DeploymentStacksDeleteDetachEnum = string;
+
+/** Deployment Stacks error response. */
+export declare interface DeploymentStacksError {
+    /** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */
+    error?: ErrorResponse;
+}
+
+/** Optional parameters. */
+export declare interface DeploymentStacksExportTemplateAtManagementGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the exportTemplateAtManagementGroup operation. */
+export declare type DeploymentStacksExportTemplateAtManagementGroupResponse = DeploymentStackTemplateDefinition;
+
+/** Optional parameters. */
+export declare interface DeploymentStacksExportTemplateAtResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the exportTemplateAtResourceGroup operation. */
+export declare type DeploymentStacksExportTemplateAtResourceGroupResponse = DeploymentStackTemplateDefinition;
+
+/** Optional parameters. */
+export declare interface DeploymentStacksExportTemplateAtSubscriptionOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the exportTemplateAtSubscription operation. */
+export declare type DeploymentStacksExportTemplateAtSubscriptionResponse = DeploymentStackTemplateDefinition;
+
+/** Optional parameters. */
+export declare interface DeploymentStacksGetAtManagementGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the getAtManagementGroup operation. */
+export declare type DeploymentStacksGetAtManagementGroupResponse = DeploymentStack;
+
+/** Optional parameters. */
+export declare interface DeploymentStacksGetAtResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the getAtResourceGroup operation. */
+export declare type DeploymentStacksGetAtResourceGroupResponse = DeploymentStack;
+
+/** Optional parameters. */
+export declare interface DeploymentStacksGetAtSubscriptionOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the getAtSubscription operation. */
+export declare type DeploymentStacksGetAtSubscriptionResponse = DeploymentStack;
+
+/** Optional parameters. */
+export declare interface DeploymentStacksListAtManagementGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listAtManagementGroupNext operation. */
+export declare type DeploymentStacksListAtManagementGroupNextResponse = DeploymentStackListResult;
+
+/** Optional parameters. */
+export declare interface DeploymentStacksListAtManagementGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listAtManagementGroup operation. */
+export declare type DeploymentStacksListAtManagementGroupResponse = DeploymentStackListResult;
+
+/** Optional parameters. */
+export declare interface DeploymentStacksListAtResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listAtResourceGroupNext operation. */
+export declare type DeploymentStacksListAtResourceGroupNextResponse = DeploymentStackListResult;
+
+/** Optional parameters. */
+export declare interface DeploymentStacksListAtResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listAtResourceGroup operation. */
+export declare type DeploymentStacksListAtResourceGroupResponse = DeploymentStackListResult;
+
+/** Optional parameters. */
+export declare interface DeploymentStacksListAtSubscriptionNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listAtSubscriptionNext operation. */
+export declare type DeploymentStacksListAtSubscriptionNextResponse = DeploymentStackListResult;
+
+/** Optional parameters. */
+export declare interface DeploymentStacksListAtSubscriptionOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listAtSubscription operation. */
+export declare type DeploymentStacksListAtSubscriptionResponse = DeploymentStackListResult;
+
+/** Entity representing the reference to the deployment parameters. */
+export declare interface DeploymentStacksParametersLink {
+    /** The URI of the parameters file. */
+    uri: string;
+    /** If included, must match the ContentVersion in the template. */
+    contentVersion?: string;
+}
+
+/** Entity representing the reference to the template. */
+export declare interface DeploymentStacksTemplateLink {
+    /** The URI of the template to deploy. Use either the uri or id property, but not both. */
+    uri?: string;
+    /** The resource id of a Template Spec. Use either the id or uri property, but not both. */
+    id?: string;
+    /** The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec.  If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs */
+    relativePath?: string;
+    /** The query string (for example, a SAS token) to be used with the templateLink URI. */
+    queryString?: string;
+    /** If included, must match the ContentVersion in the template. */
+    contentVersion?: string;
+}
+
+/** Export Template specific properties of the Stack. */
+export declare interface DeploymentStackTemplateDefinition {
+    /** The template content. Use this element to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. */
+    template?: Record<string, unknown>;
+    /** The URI of the template. Use either the templateLink property or the template property, but not both. */
+    templateLink?: DeploymentStacksTemplateLink;
+}
+
+/** 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;
+
+/** 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 DenySettingsMode} that the service accepts. */
+export declare enum KnownDenySettingsMode {
+    /** Authorized users are able to read and modify the resources, but cannot delete. */
+    DenyDelete = "denyDelete",
+    /** Authorized users can only read from a resource, but cannot modify or delete it. */
+    DenyWriteAndDelete = "denyWriteAndDelete",
+    /** No denyAssignments have been applied. */
+    None = "none"
+}
+
+/** Known values of {@link DenyStatusMode} that the service accepts. */
+export declare enum KnownDenyStatusMode {
+    /** Authorized users are able to read and modify the resources, but cannot delete. */
+    DenyDelete = "denyDelete",
+    /** Resource type does not support denyAssignments. */
+    NotSupported = "notSupported",
+    /** denyAssignments are not supported on resources outside the scope of the deployment stack. */
+    Inapplicable = "inapplicable",
+    /** Authorized users can only read from a resource, but cannot modify or delete it. */
+    DenyWriteAndDelete = "denyWriteAndDelete",
+    /** Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) */
+    RemovedBySystem = "removedBySystem",
+    /** No denyAssignments have been applied. */
+    None = "None"
+}
+
+/** Known values of {@link DeploymentStackProvisioningState} that the service accepts. */
+export declare enum KnownDeploymentStackProvisioningState {
+    /** Creating */
+    Creating = "Creating",
+    /** Validating */
+    Validating = "Validating",
+    /** Waiting */
+    Waiting = "Waiting",
+    /** Deploying */
+    Deploying = "Deploying",
+    /** Canceling */
+    Canceling = "Canceling",
+    /** Locking */
+    Locking = "Locking",
+    /** DeletingResources */
+    DeletingResources = "DeletingResources",
+    /** Succeeded */
+    Succeeded = "Succeeded",
+    /** Failed */
+    Failed = "Failed",
+    /** Canceled */
+    Canceled = "Canceled",
+    /** Deleting */
+    Deleting = "Deleting"
+}
+
+/** Known values of {@link DeploymentStacksDeleteDetachEnum} that the service accepts. */
+export declare enum KnownDeploymentStacksDeleteDetachEnum {
+    /** Delete */
+    Delete = "delete",
+    /** Detach */
+    Detach = "detach"
+}
+
+/** Known values of {@link ResourceStatusMode} that the service accepts. */
+export declare enum KnownResourceStatusMode {
+    /** This resource is managed by the deployment stack. */
+    Managed = "Managed",
+    /** Unable to remove the deny assignment on resource. */
+    RemoveDenyFailed = "removeDenyFailed",
+    /** Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. */
+    DeleteFailed = "deleteFailed",
+    /** No denyAssignments have been applied. */
+    None = "None"
+}
+
+/** Known values of {@link UnmanageActionManagementGroupMode} that the service accepts. */
+export declare enum KnownUnmanageActionManagementGroupMode {
+    /** Delete */
+    Delete = "delete",
+    /** Detach */
+    Detach = "detach"
+}
+
+/** Known values of {@link UnmanageActionResourceGroupMode} that the service accepts. */
+export declare enum KnownUnmanageActionResourceGroupMode {
+    /** Delete */
+    Delete = "delete",
+    /** Detach */
+    Detach = "detach"
+}
+
+/** Known values of {@link UnmanageActionResourceMode} that the service accepts. */
+export declare enum KnownUnmanageActionResourceMode {
+    /** Delete */
+    Delete = "delete",
+    /** Detach */
+    Detach = "detach"
+}
+
+/** The managed resource model. */
+export declare interface ManagedResourceReference extends ResourceReference {
+    /** Current management state of the resource in the deployment stack. */
+    status?: ResourceStatusMode;
+    /** denyAssignment settings applied to the resource. */
+    denyStatus?: DenyStatusMode;
+}
+
+/** The resource Id model. */
+export declare interface ResourceReference {
+    /**
+     * The resourceId of a resource managed by the deployment stack.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly id?: string;
+}
+
+/** The resource Id extended model. */
+export declare interface ResourceReferenceExtended extends ResourceReference, DeploymentStacksError {
+}
+
+/**
+ * Defines values for ResourceStatusMode. \
+ * {@link KnownResourceStatusMode} can be used interchangeably with ResourceStatusMode,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Managed**: This resource is managed by the deployment stack. \
+ * **removeDenyFailed**: Unable to remove the deny assignment on resource. \
+ * **deleteFailed**: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. \
+ * **None**: No denyAssignments have been applied.
+ */
+export declare type ResourceStatusMode = 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;
+}
+
+/**
+ * Defines values for UnmanageActionManagementGroupMode. \
+ * {@link KnownUnmanageActionManagementGroupMode} can be used interchangeably with UnmanageActionManagementGroupMode,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **delete** \
+ * **detach**
+ */
+export declare type UnmanageActionManagementGroupMode = string;
+
+/**
+ * Defines values for UnmanageActionResourceGroupMode. \
+ * {@link KnownUnmanageActionResourceGroupMode} can be used interchangeably with UnmanageActionResourceGroupMode,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **delete** \
+ * **detach**
+ */
+export declare type UnmanageActionResourceGroupMode = string;
+
+/**
+ * Defines values for UnmanageActionResourceMode. \
+ * {@link KnownUnmanageActionResourceMode} can be used interchangeably with UnmanageActionResourceMode,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **delete** \
+ * **detach**
+ */
+export declare type UnmanageActionResourceMode = string;
+
+export { }