@microsoft/terraform-cdk-constructs 1.0.0 → 1.2.0

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

@@ -1,75 +1,75 @@
-import * as cdktf from "cdktf";
-import { Construct } from "constructs";
+import { Construct } from 'constructs';
+import * as cdktf from 'cdktf';
 export interface DataAzapiResourceActionConfig extends cdktf.TerraformMetaArguments {
     /**
-     * The name of the resource action. It's also possible to make HTTP requests towards the resource ID if leave this field empty.
-     *
-     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource_action#action DataAzapiResourceAction#action}
-     */
+    * The name of the resource action. It's also possible to make HTTP requests towards the resource ID if leave this field empty.
+    *
+    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource_action#action DataAzapiResourceAction#action}
+    */
     readonly action?: string;
     /**
-     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource_action#body DataAzapiResourceAction#body}
-     */
+    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource_action#body DataAzapiResourceAction#body}
+    */
     readonly body?: {
         [key: string]: any;
     };
     /**
-     * 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_action#headers DataAzapiResourceAction#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_action#headers DataAzapiResourceAction#headers}
+    */
     readonly headers?: {
         [key: string]: string;
     };
     /**
-     * The HTTP method to use when performing the action. Must be one of `POST`, `GET`. Defaults to `POST`.
-     *
-     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource_action#method DataAzapiResourceAction#method}
-     */
+    * The HTTP method to use when performing the action. Must be one of `POST`, `GET`. Defaults to `POST`.
+    *
+    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource_action#method DataAzapiResourceAction#method}
+    */
     readonly method?: 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_action#query_parameters DataAzapiResourceAction#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_action#query_parameters DataAzapiResourceAction#query_parameters}
+    */
     readonly queryParameters?: {
         [key: string]: string[];
     } | cdktf.IResolvable;
     /**
-     * The ID of the Azure resource to perform the action on.
-     *
-     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource_action#resource_id DataAzapiResourceAction#resource_id}
-     */
+    * The ID of the Azure resource to perform the action on.
+    *
+    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource_action#resource_id DataAzapiResourceAction#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_action#response_export_values DataAzapiResourceAction#response_export_values}
     */
@@ -77,40 +77,40 @@ export interface DataAzapiResourceActionConfig extends cdktf.TerraformMetaArgume
         [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_action#retry DataAzapiResourceAction#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_action#retry DataAzapiResourceAction#retry}
+    */
     readonly retry?: DataAzapiResourceActionRetry;
     /**
     * 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 sensitive_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 sensitive_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 sensitive_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 sensitive_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_action#sensitive_response_export_values DataAzapiResourceAction#sensitive_response_export_values}
     */
@@ -118,58 +118,59 @@ export interface DataAzapiResourceActionConfig extends cdktf.TerraformMetaArgume
         [key: string]: any;
     };
     /**
-     * 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_action#type DataAzapiResourceAction#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_action#type DataAzapiResourceAction#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_action#timeouts DataAzapiResourceAction#timeouts}
-     */
+    * timeouts block
+    *
+    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource_action#timeouts DataAzapiResourceAction#timeouts}
+    */
     readonly timeouts?: DataAzapiResourceActionTimeouts;
 }
 export interface DataAzapiResourceActionRetry {
     /**
-     * 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_action#error_message_regex DataAzapiResourceAction#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_action#error_message_regex DataAzapiResourceAction#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_action#interval_seconds DataAzapiResourceAction#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_action#interval_seconds DataAzapiResourceAction#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_action#max_interval_seconds DataAzapiResourceAction#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_action#max_interval_seconds DataAzapiResourceAction#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_action#multiplier DataAzapiResourceAction#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_action#multiplier DataAzapiResourceAction#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_action#randomization_factor DataAzapiResourceAction#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_action#randomization_factor DataAzapiResourceAction#randomization_factor}
+    */
     readonly randomizationFactor?: number;
 }
 export declare function dataAzapiResourceActionRetryToTerraform(struct?: DataAzapiResourceActionRetry | cdktf.IResolvable): any;
+export declare function dataAzapiResourceActionRetryToHclTerraform(struct?: DataAzapiResourceActionRetry | cdktf.IResolvable): any;
 export declare class DataAzapiResourceActionRetryOutputReference 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(): DataAzapiResourceActionRetry | cdktf.IResolvable | undefined;
     set internalValue(value: DataAzapiResourceActionRetry | cdktf.IResolvable | undefined);
@@ -200,20 +201,21 @@ export declare class DataAzapiResourceActionRetryOutputReference extends cdktf.C
 }
 export interface DataAzapiResourceActionTimeouts {
     /**
-     * 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_action#read DataAzapiResourceAction#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_action#read DataAzapiResourceAction#read}
+    */
     readonly read?: string;
 }
 export declare function dataAzapiResourceActionTimeoutsToTerraform(struct?: DataAzapiResourceActionTimeouts | cdktf.IResolvable): any;
+export declare function dataAzapiResourceActionTimeoutsToHclTerraform(struct?: DataAzapiResourceActionTimeouts | cdktf.IResolvable): any;
 export declare class DataAzapiResourceActionTimeoutsOutputReference 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(): DataAzapiResourceActionTimeouts | cdktf.IResolvable | undefined;
     set internalValue(value: DataAzapiResourceActionTimeouts | cdktf.IResolvable | undefined);
@@ -224,17 +226,25 @@ export declare class DataAzapiResourceActionTimeoutsOutputReference extends cdkt
     get readInput(): string | undefined;
 }
 /**
- * Represents a {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource_action azapi_resource_action}
- */
+* Represents a {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource_action azapi_resource_action}
+*/
 export declare class DataAzapiResourceAction extends cdktf.TerraformDataSource {
     static readonly tfResourceType = "azapi_resource_action";
     /**
-     * Create a new {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource_action azapi_resource_action} 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 DataAzapiResourceActionConfig
-     */
+    * Generates CDKTF code for importing a DataAzapiResourceAction 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 DataAzapiResourceAction to import
+    * @param importFromId The id of the existing DataAzapiResourceAction that should be imported. Refer to the {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/data-sources/resource_action#import import section} in the documentation of this resource for the id to use
+    * @param provider? Optional instance of the provider where the DataAzapiResourceAction 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_action azapi_resource_action} 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 DataAzapiResourceActionConfig
+    */
     constructor(scope: Construct, id: string, config: DataAzapiResourceActionConfig);
     private _action?;
     get action(): string;
@@ -328,4 +338,7 @@ export declare class DataAzapiResourceAction extends cdktf.TerraformDataSource {
     protected synthesizeAttributes(): {
         [name: string]: any;
     };
+    protected synthesizeHclAttributes(): {
+        [name: string]: any;
+    };
 }