@microsoft/terraform-cdk-constructs 1.0.0 → 1.3.0

package/lib/core-azure/lib/azapi/providers-azapi/data-azapi-resource/index.d.ts

@@ -1,85 +1,85 @@
-import * as cdktf from "cdktf";
-import { Construct } from "constructs";
+import { Construct } from 'constructs';
+import * as cdktf from 'cdktf';
 export interface DataAzapiResourceConfig extends cdktf.TerraformMetaArguments {
     /**
-     * A map of headers to include in the request
-     *
-     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#headers DataAzapiResource#headers}
-     */
+    * A map of headers to include in the request
+    *
+    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#headers DataAzapiResource#headers}
+    */
     readonly headers?: {
         [key: string]: string;
     };
     /**
-     * If set to `true`, the data source will not fail when the specified resource is not found (HTTP 404). Identifier attributes (`id`, `name`, `parent_id`, `resource_id`) will still be populated based on inputs; other computed attributes (`output`, `location`, `identity`, `tags`) will be null/empty. Defaults to `false`.
-     *
-     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#ignore_not_found DataAzapiResource#ignore_not_found}
-     */
+    * If set to `true`, the data source will not fail when the specified resource is not found (HTTP 404). Identifier attributes (`id`, `name`, `parent_id`, `resource_id`) will still be populated based on inputs; other computed attributes (`output`, `location`, `identity`, `tags`) will be null/empty. Defaults to `false`.
+    *
+    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#ignore_not_found DataAzapiResource#ignore_not_found}
+    */
     readonly ignoreNotFound?: boolean | cdktf.IResolvable;
     /**
-     * Specifies the name of the Azure resource. Exactly one of the arguments `name` or `resource_id` must be set. It could be omitted if the `type` is `Microsoft.Resources/subscriptions`.
-     *
-     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#name DataAzapiResource#name}
-     */
+    * Specifies the name of the Azure resource. Exactly one of the arguments `name` or `resource_id` must be set. It could be omitted if the `type` is `Microsoft.Resources/subscriptions`.
+    *
+    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#name DataAzapiResource#name}
+    */
     readonly name?: string;
     /**
     * The ID of the azure resource in which this resource is created. It supports different kinds of deployment scope for **top level** resources:
-  
-    - resource group scope: `parent_id` should be the ID of a resource group, it's recommended to manage a resource group by azurerm_resource_group.
-      - management group scope: `parent_id` should be the ID of a management group, it's recommended to manage a management group by azurerm_management_group.
-      - extension scope: `parent_id` should be the ID of the resource you're adding the extension to.
-      - subscription scope: `parent_id` should be like \x60/subscriptions/00000000-0000-0000-0000-000000000000\x60
-      - tenant scope: `parent_id` should be /
-  
-    For child level resources, the `parent_id` should be the ID of its parent resource, for example, subnet resource's `parent_id` is the ID of the vnet.
-  
-    For type `Microsoft.Resources/resourceGroups`, the `parent_id` could be omitted, it defaults to subscription ID specified in provider or the default subscription (You could check the default subscription by azure cli command: `az account show`).
+    *
+    *   - resource group scope: `parent_id` should be the ID of a resource group, it's recommended to manage a resource group by azurerm_resource_group.
+    * 	- management group scope: `parent_id` should be the ID of a management group, it's recommended to manage a management group by azurerm_management_group.
+    * 	- extension scope: `parent_id` should be the ID of the resource you're adding the extension to.
+    * 	- subscription scope: `parent_id` should be like \x60/subscriptions/00000000-0000-0000-0000-000000000000\x60
+    * 	- tenant scope: `parent_id` should be /
+    *
+    *   For child level resources, the `parent_id` should be the ID of its parent resource, for example, subnet resource's `parent_id` is the ID of the vnet.
+    *
+    *   For type `Microsoft.Resources/resourceGroups`, the `parent_id` could be omitted, it defaults to subscription ID specified in provider or the default subscription (You could check the default subscription by azure cli command: `az account show`).
     *
     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#parent_id DataAzapiResource#parent_id}
     */
     readonly parentId?: string;
     /**
-     * A map of query parameters to include in the request
-     *
-     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#query_parameters DataAzapiResource#query_parameters}
-     */
+    * A map of query parameters to include in the request
+    *
+    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#query_parameters DataAzapiResource#query_parameters}
+    */
     readonly queryParameters?: {
         [key: string]: string[];
     } | cdktf.IResolvable;
     /**
-     * The ID of the Azure resource to retrieve. Exactly one of the arguments `name` or `resource_id` must be set. It could be omitted if the `type` is `Microsoft.Resources/subscriptions`.
-     *
-     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#resource_id DataAzapiResource#resource_id}
-     */
+    * The ID of the Azure resource to retrieve. Exactly one of the arguments `name` or `resource_id` must be set. It could be omitted if the `type` is `Microsoft.Resources/subscriptions`.
+    *
+    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#resource_id DataAzapiResource#resource_id}
+    */
     readonly resourceId?: string;
     /**
     * The attribute can accept either a list or a map.
-  
-  - **List**: A list of paths that need to be exported from the response body. Setting it to `["*"]` will export the full response body. Here's an example. If it sets to `["properties.loginServer", "properties.policies.quarantinePolicy.status"]`, it will set the following HCL object to the computed property output.
-  
-      ```text
-      {
-          properties = {
-              loginServer = "registry1.azurecr.io"
-              policies = {
-                  quarantinePolicy = {
-                      status = "disabled"
-                  }
-              }
-          }
-      }
-      ```
-  
-  - **Map**: A map where the key is the name for the result and the value is a JMESPath query string to filter the response. Here's an example. If it sets to `{"login_server": "properties.loginServer", "quarantine_status": "properties.policies.quarantinePolicy.status"}`, it will set the following HCL object to the computed property output.
-  
-      ```text
-      {
-          "login_server" = "registry1.azurecr.io"
-          "quarantine_status" = "disabled"
-      }
-      ```
-  
-  To learn more about JMESPath, visit [JMESPath](https://jmespath.org/).
-  
+    *
+    * - **List**: A list of paths that need to be exported from the response body. Setting it to `["*"]` will export the full response body. Here's an example. If it sets to `["properties.loginServer", "properties.policies.quarantinePolicy.status"]`, it will set the following HCL object to the computed property output.
+    *
+    * 	```text
+    * 	{
+    * 		properties = {
+    * 			loginServer = "registry1.azurecr.io"
+    * 			policies = {
+    * 				quarantinePolicy = {
+    * 					status = "disabled"
+    * 				}
+    * 			}
+    * 		}
+    * 	}
+    * 	```
+    *
+    * - **Map**: A map where the key is the name for the result and the value is a JMESPath query string to filter the response. Here's an example. If it sets to `{"login_server": "properties.loginServer", "quarantine_status": "properties.policies.quarantinePolicy.status"}`, it will set the following HCL object to the computed property output.
+    *
+    * 	```text
+    * 	{
+    * 		"login_server" = "registry1.azurecr.io"
+    * 		"quarantine_status" = "disabled"
+    * 	}
+    * 	```
+    *
+    * To learn more about JMESPath, visit [JMESPath](https://jmespath.org/).
+    *
     *
     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#response_export_values DataAzapiResource#response_export_values}
     */
@@ -87,35 +87,36 @@ export interface DataAzapiResourceConfig extends cdktf.TerraformMetaArguments {
         [key: string]: any;
     };
     /**
-     * The retry object supports the following attributes:
-     *
-     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#retry DataAzapiResource#retry}
-     */
+    * The retry object supports the following attributes:
+    *
+    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#retry DataAzapiResource#retry}
+    */
     readonly retry?: DataAzapiResourceRetry;
     /**
-     * In a format like `<resource-type>@<api-version>`. `<resource-type>` is the Azure resource type, for example, `Microsoft.Storage/storageAccounts`. `<api-version>` is version of the API used to manage this azure resource.
-     *
-     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#type DataAzapiResource#type}
-     */
+    * In a format like `<resource-type>@<api-version>`. `<resource-type>` is the Azure resource type, for example, `Microsoft.Storage/storageAccounts`. `<api-version>` is version of the API used to manage this azure resource.
+    *
+    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#type DataAzapiResource#type}
+    */
     readonly type: string;
     /**
-     * timeouts block
-     *
-     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#timeouts DataAzapiResource#timeouts}
-     */
+    * timeouts block
+    *
+    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#timeouts DataAzapiResource#timeouts}
+    */
     readonly timeouts?: DataAzapiResourceTimeouts;
 }
 export interface DataAzapiResourceIdentity {
 }
 export declare function dataAzapiResourceIdentityToTerraform(struct?: DataAzapiResourceIdentity): any;
+export declare function dataAzapiResourceIdentityToHclTerraform(struct?: DataAzapiResourceIdentity): any;
 export declare class DataAzapiResourceIdentityOutputReference extends cdktf.ComplexObject {
     private isEmptyObject;
     /**
-     * @param terraformResource The parent resource
-     * @param terraformAttribute The attribute on the parent resource this class is referencing
-     * @param complexObjectIndex the index of this item in the list
-     * @param complexObjectIsFromSet whether the list is wrapping a set (will add tolist() to be able to access an item via an index)
-     */
+    * @param terraformResource The parent resource
+    * @param terraformAttribute The attribute on the parent resource this class is referencing
+    * @param complexObjectIndex the index of this item in the list
+    * @param complexObjectIsFromSet whether the list is wrapping a set (will add tolist() to be able to access an item via an index)
+    */
     constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean);
     get internalValue(): DataAzapiResourceIdentity | undefined;
     set internalValue(value: DataAzapiResourceIdentity | undefined);
@@ -129,56 +130,57 @@ export declare class DataAzapiResourceIdentityList extends cdktf.ComplexList {
     protected terraformAttribute: string;
     protected wrapsSet: boolean;
     /**
-     * @param terraformResource The parent resource
-     * @param terraformAttribute The attribute on the parent resource this class is referencing
-     * @param wrapsSet whether the list is wrapping a set (will add tolist() to be able to access an item via an index)
-     */
+    * @param terraformResource The parent resource
+    * @param terraformAttribute The attribute on the parent resource this class is referencing
+    * @param wrapsSet whether the list is wrapping a set (will add tolist() to be able to access an item via an index)
+    */
     constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean);
     /**
-     * @param index the index of the item to return
-     */
+    * @param index the index of the item to return
+    */
     get(index: number): DataAzapiResourceIdentityOutputReference;
 }
 export interface DataAzapiResourceRetry {
     /**
-     * A list of regular expressions to match against error messages. If any of the regular expressions match, the request will be retried.
-     *
-     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#error_message_regex DataAzapiResource#error_message_regex}
-     */
+    * A list of regular expressions to match against error messages. If any of the regular expressions match, the request will be retried.
+    *
+    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#error_message_regex DataAzapiResource#error_message_regex}
+    */
     readonly errorMessageRegex: string[];
     /**
-     * The base number of seconds to wait between retries. Default is `10`.
-     *
-     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#interval_seconds DataAzapiResource#interval_seconds}
-     */
+    * The base number of seconds to wait between retries. Default is `10`.
+    *
+    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#interval_seconds DataAzapiResource#interval_seconds}
+    */
     readonly intervalSeconds?: number;
     /**
-     * The maximum number of seconds to wait between retries. Default is `180`.
-     *
-     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#max_interval_seconds DataAzapiResource#max_interval_seconds}
-     */
+    * The maximum number of seconds to wait between retries. Default is `180`.
+    *
+    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#max_interval_seconds DataAzapiResource#max_interval_seconds}
+    */
     readonly maxIntervalSeconds?: number;
     /**
-     * The multiplier to apply to the interval between retries. Default is `1.5`.
-     *
-     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#multiplier DataAzapiResource#multiplier}
-     */
+    * The multiplier to apply to the interval between retries. Default is `1.5`.
+    *
+    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#multiplier DataAzapiResource#multiplier}
+    */
     readonly multiplier?: number;
     /**
-     * The randomization factor to apply to the interval between retries. The formula for the randomized interval is: `RetryInterval * (random value in range [1 - RandomizationFactor, 1 + RandomizationFactor])`. Therefore set to zero `0.0` for no randomization. Default is `0.5`.
-     *
-     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#randomization_factor DataAzapiResource#randomization_factor}
-     */
+    * The randomization factor to apply to the interval between retries. The formula for the randomized interval is: `RetryInterval * (random value in range [1 - RandomizationFactor, 1 + RandomizationFactor])`. Therefore set to zero `0.0` for no randomization. Default is `0.5`.
+    *
+    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#randomization_factor DataAzapiResource#randomization_factor}
+    */
     readonly randomizationFactor?: number;
 }
 export declare function dataAzapiResourceRetryToTerraform(struct?: DataAzapiResourceRetry | cdktf.IResolvable): any;
+export declare function dataAzapiResourceRetryToHclTerraform(struct?: DataAzapiResourceRetry | cdktf.IResolvable): any;
 export declare class DataAzapiResourceRetryOutputReference extends cdktf.ComplexObject {
     private isEmptyObject;
     private resolvableValue?;
     /**
-     * @param terraformResource The parent resource
-     * @param terraformAttribute The attribute on the parent resource this class is referencing
-     */
+    * @param terraformResource The parent resource
+    * @param terraformAttribute The attribute on the parent resource this class is referencing
+    */
     constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string);
     get internalValue(): DataAzapiResourceRetry | cdktf.IResolvable | undefined;
     set internalValue(value: DataAzapiResourceRetry | cdktf.IResolvable | undefined);
@@ -209,20 +211,21 @@ export declare class DataAzapiResourceRetryOutputReference extends cdktf.Complex
 }
 export interface DataAzapiResourceTimeouts {
     /**
-     * A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
-     *
-     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#read DataAzapiResource#read}
-     */
+    * A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
+    *
+    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#read DataAzapiResource#read}
+    */
     readonly read?: string;
 }
 export declare function dataAzapiResourceTimeoutsToTerraform(struct?: DataAzapiResourceTimeouts | cdktf.IResolvable): any;
+export declare function dataAzapiResourceTimeoutsToHclTerraform(struct?: DataAzapiResourceTimeouts | cdktf.IResolvable): any;
 export declare class DataAzapiResourceTimeoutsOutputReference extends cdktf.ComplexObject {
     private isEmptyObject;
     private resolvableValue?;
     /**
-     * @param terraformResource The parent resource
-     * @param terraformAttribute The attribute on the parent resource this class is referencing
-     */
+    * @param terraformResource The parent resource
+    * @param terraformAttribute The attribute on the parent resource this class is referencing
+    */
     constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string);
     get internalValue(): DataAzapiResourceTimeouts | cdktf.IResolvable | undefined;
     set internalValue(value: DataAzapiResourceTimeouts | cdktf.IResolvable | undefined);
@@ -233,17 +236,25 @@ export declare class DataAzapiResourceTimeoutsOutputReference extends cdktf.Comp
     get readInput(): string | undefined;
 }
 /**
- * Represents a {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource azapi_resource}
- */
+* Represents a {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource azapi_resource}
+*/
 export declare class DataAzapiResource extends cdktf.TerraformDataSource {
     static readonly tfResourceType = "azapi_resource";
     /**
-     * Create a new {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource azapi_resource} Data Source
-     *
-     * @param scope The scope in which to define this construct
-     * @param id The scoped construct ID. Must be unique amongst siblings in the same scope
-     * @param options DataAzapiResourceConfig
-     */
+    * Generates CDKTF code for importing a DataAzapiResource resource upon running "cdktf plan <stack-name>"
+    * @param scope The scope in which to define this construct
+    * @param importToId The construct id used in the generated config for the DataAzapiResource to import
+    * @param importFromId The id of the existing DataAzapiResource that should be imported. Refer to the {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource#import import section} in the documentation of this resource for the id to use
+    * @param provider? Optional instance of the provider where the DataAzapiResource to import is found
+    */
+    static generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: cdktf.TerraformProvider): cdktf.ImportableResource;
+    /**
+    * Create a new {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource azapi_resource} Data Source
+    *
+    * @param scope The scope in which to define this construct
+    * @param id The scoped construct ID. Must be unique amongst siblings in the same scope
+    * @param options DataAzapiResourceConfig
+    */
     constructor(scope: Construct, id: string, config: DataAzapiResourceConfig);
     get exists(): cdktf.IResolvable;
     private _headers?;
@@ -324,4 +335,7 @@ export declare class DataAzapiResource extends cdktf.TerraformDataSource {
     protected synthesizeAttributes(): {
         [name: string]: any;
     };
+    protected synthesizeHclAttributes(): {
+        [name: string]: any;
+    };
 }