@microsoft/terraform-cdk-constructs 1.0.0 → 1.2.0

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

@@ -1,86 +1,86 @@
-import * as cdktf from "cdktf";
-import { Construct } from "constructs";
+import { Construct } from 'constructs';
+import * as cdktf from 'cdktf';
 export interface DataAzapiResourceListConfig 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_list#headers DataAzapiResourceList#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_list#headers DataAzapiResourceList#headers}
+    */
     readonly headers?: {
         [key: string]: 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_list#parent_id DataAzapiResourceList#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_list#query_parameters DataAzapiResourceList#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_list#query_parameters DataAzapiResourceList#query_parameters}
+    */
     readonly queryParameters?: {
         [key: string]: string[];
     } | cdktf.IResolvable;
     /**
     * 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 `["value"]`, it will set the following HCL object to the computed property output.
-  
-      ```text
-      {
-        "value" = [
-          {
-            "id" = "/subscriptions/000000/resourceGroups/demo-rg/providers/Microsoft.Automation/automationAccounts/example"
-            "location" = "eastus2"
-            "name" = "example"
-            "properties" = {
-              "creationTime" = "2024-10-11T08:18:38.737+00:00"
-              "disableLocalAuth" = false
-              "lastModifiedTime" = "2024-10-11T08:18:38.737+00:00"
-              "publicNetworkAccess" = true
-            }
-            "tags" = {}
-            "type" = "Microsoft.Automation/AutomationAccounts"
-          }
-        ]
-      }
-      ```
-  
-  - **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 `{"values": "value[].{name: name, publicNetworkAccess: properties.publicNetworkAccess}", "names": "value[].name"}`, it will set the following HCL object to the computed property output.
-  
-      ```text
-      {
-          "names" = [
-              "example",
-              "fredaccount01",
-          ]
-          "values" = [
-              {
-                "name" = "example"
-                "publicNetworkAccess" = true
-              },
-              {
-                "name" = "fredaccount01"
-                "publicNetworkAccess" = null
-              },
-          ]
-      }
-      ```
-  
-  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 `["value"]`, it will set the following HCL object to the computed property output.
+    *
+    * 	```text
+    * 	{
+    * 	  "value" = [
+    * 		{
+    * 		  "id" = "/subscriptions/000000/resourceGroups/demo-rg/providers/Microsoft.Automation/automationAccounts/example"
+    * 		  "location" = "eastus2"
+    * 		  "name" = "example"
+    * 		  "properties" = {
+    * 			"creationTime" = "2024-10-11T08:18:38.737+00:00"
+    * 			"disableLocalAuth" = false
+    * 			"lastModifiedTime" = "2024-10-11T08:18:38.737+00:00"
+    * 			"publicNetworkAccess" = true
+    * 		  }
+    * 		  "tags" = {}
+    * 		  "type" = "Microsoft.Automation/AutomationAccounts"
+    * 		}
+    * 	  ]
+    * 	}
+    * 	```
+    *
+    * - **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 `{"values": "value[].{name: name, publicNetworkAccess: properties.publicNetworkAccess}", "names": "value[].name"}`, it will set the following HCL object to the computed property output.
+    *
+    * 	```text
+    * 	{
+    * 		"names" = [
+    * 			"example",
+    * 			"fredaccount01",
+    * 		]
+    * 		"values" = [
+    * 			{
+    * 			  "name" = "example"
+    * 			  "publicNetworkAccess" = true
+    * 			},
+    * 			{
+    * 			  "name" = "fredaccount01"
+    * 			  "publicNetworkAccess" = null
+    * 			},
+    * 		]
+    * 	}
+    * 	```
+    *
+    * 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_list#response_export_values DataAzapiResourceList#response_export_values}
     */
@@ -88,64 +88,65 @@ export interface DataAzapiResourceListConfig extends cdktf.TerraformMetaArgument
         [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_list#retry DataAzapiResourceList#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_list#retry DataAzapiResourceList#retry}
+    */
     readonly retry?: DataAzapiResourceListRetry;
     /**
-     * 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_list#type DataAzapiResourceList#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_list#type DataAzapiResourceList#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_list#timeouts DataAzapiResourceList#timeouts}
-     */
+    * timeouts block
+    *
+    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource_list#timeouts DataAzapiResourceList#timeouts}
+    */
     readonly timeouts?: DataAzapiResourceListTimeouts;
 }
 export interface DataAzapiResourceListRetry {
     /**
-     * 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_list#error_message_regex DataAzapiResourceList#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_list#error_message_regex DataAzapiResourceList#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_list#interval_seconds DataAzapiResourceList#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_list#interval_seconds DataAzapiResourceList#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_list#max_interval_seconds DataAzapiResourceList#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_list#max_interval_seconds DataAzapiResourceList#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_list#multiplier DataAzapiResourceList#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_list#multiplier DataAzapiResourceList#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_list#randomization_factor DataAzapiResourceList#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_list#randomization_factor DataAzapiResourceList#randomization_factor}
+    */
     readonly randomizationFactor?: number;
 }
 export declare function dataAzapiResourceListRetryToTerraform(struct?: DataAzapiResourceListRetry | cdktf.IResolvable): any;
+export declare function dataAzapiResourceListRetryToHclTerraform(struct?: DataAzapiResourceListRetry | cdktf.IResolvable): any;
 export declare class DataAzapiResourceListRetryOutputReference 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(): DataAzapiResourceListRetry | cdktf.IResolvable | undefined;
     set internalValue(value: DataAzapiResourceListRetry | cdktf.IResolvable | undefined);
@@ -176,20 +177,21 @@ export declare class DataAzapiResourceListRetryOutputReference extends cdktf.Com
 }
 export interface DataAzapiResourceListTimeouts {
     /**
-     * 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_list#read DataAzapiResourceList#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_list#read DataAzapiResourceList#read}
+    */
     readonly read?: string;
 }
 export declare function dataAzapiResourceListTimeoutsToTerraform(struct?: DataAzapiResourceListTimeouts | cdktf.IResolvable): any;
+export declare function dataAzapiResourceListTimeoutsToHclTerraform(struct?: DataAzapiResourceListTimeouts | cdktf.IResolvable): any;
 export declare class DataAzapiResourceListTimeoutsOutputReference 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(): DataAzapiResourceListTimeouts | cdktf.IResolvable | undefined;
     set internalValue(value: DataAzapiResourceListTimeouts | cdktf.IResolvable | undefined);
@@ -200,17 +202,25 @@ export declare class DataAzapiResourceListTimeoutsOutputReference extends cdktf.
     get readInput(): string | undefined;
 }
 /**
- * Represents a {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource_list azapi_resource_list}
- */
+* Represents a {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource_list azapi_resource_list}
+*/
 export declare class DataAzapiResourceList extends cdktf.TerraformDataSource {
     static readonly tfResourceType = "azapi_resource_list";
     /**
-     * Create a new {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource_list azapi_resource_list} 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 DataAzapiResourceListConfig
-     */
+    * Generates CDKTF code for importing a DataAzapiResourceList 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 DataAzapiResourceList to import
+    * @param importFromId The id of the existing DataAzapiResourceList that should be imported. Refer to the {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource_list#import import section} in the documentation of this resource for the id to use
+    * @param provider? Optional instance of the provider where the DataAzapiResourceList 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_list azapi_resource_list} 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 DataAzapiResourceListConfig
+    */
     constructor(scope: Construct, id: string, config: DataAzapiResourceListConfig);
     private _headers?;
     get headers(): {
@@ -269,4 +279,7 @@ export declare class DataAzapiResourceList extends cdktf.TerraformDataSource {
     protected synthesizeAttributes(): {
         [name: string]: any;
     };
+    protected synthesizeHclAttributes(): {
+        [name: string]: any;
+    };
 }