Terraform Provider Azapi Versions Save

ENHANCEMENTS:

• azapi provider: Support enable_hcl_output_for_data_source field, which is used to enable the HCL output for the data source, the default value is false. This could resolve the following breaking changes in the previous release:

  • azapi_resource data source: The output field changes from JSON string to HCL object. Users can use access the fields in the output as an HCL object. Please remove the jsondecode function when using the output field.
  • azapi_resource_list data source: The output field changes from JSON string to HCL object. Users can use access the fields in the output as an HCL object. Please remove the jsondecode function when using the output field.

  Please notice if you already upgraded to v1.13.0 and removed jsondecode function for the output of data sources, when upgrade to the v1.13.1 release, you need to set enable_hcl_output_for_data_source = true in the azapi provider block to enable the HCL output for data sources.

BUG FIXES:

• Fix a bug when upgrading from previous provider azapi_resource resource will set tags and location for resources that don't have tags or location in the configuration.
• Fix a bug that azapi_resource resource cannot handle tags with unknown values.
• Fix a bug that null string value can't pass the schema validation.
• Fix a bug that required fields which have null value can't pass the schema validation.
• Fix a bug that schema validation fails to validate the float number in the body.
• Fix a bug that client certificate authentication doesn't work.
• Fix a bug that auxiliary tenant ids are not passed to the client.
• Fix a bug that azapi_resource_action resource shows the plan diff when upgrading from the previous provider.

BREAKING CHANGES:

1. Provider field default_naming_prefix and default_naming_suffix are deprecated. It will not work in this release and will be removed in the next major release. Please specify the naming prefix and suffix in the resource's name field instead.
2. The azapi_resource's removing_special_chars field is deprecated. It will not work in this release and will be removed in the next major release. Please specify the name field and remove the special characters in the name field instead.
3. Defining the identity inside the body field is not recommended. In this release, it will not sync the identity inside the body field to identity block. Please define the identity block instead.
4. azapi_resource data source, azapi_resource_listdata source: Theoutput` field changes from JSON string to HCL object. Users can use access the fields in the output as an HCL object. Please follow the instructions to migrate:
   1. Please remove the jsondecode function when using the output field from these data sources.

   data "azapi_resource" "test" {
     type                   = "Microsoft.Automation/automationAccounts@2023-11-01"
     resource_id            = azapi_resource.auto.id
     response_export_values = ["properties"]
   }
   
   output "o1" {
     // change jsondecode(data.azapi_resource.test.output).properties.automationHybridServiceUrl to
     value = data.azapi_resource.test.output.properties.automationHybridServiceUrl
   }
   

   2. Run terraform plan to preview the changes.

   No changes. Your infrastructure matches the configuration.
   

ENHANCEMENTS:

• azapi_resource resource, azapi_update_resource resource, azapi_resource_action resource, azapi_data_plane_resource resource, azapi_resource_action data source: The body field supports the dynamic schema and allows user to use the HCL object to specify the body.
• azapi_resource resource, azapi_update_resource resource, azapi_resource_action resource, azapi_data_plane_resource resource, azapi_resource_action data source, azapi_resource data source, azapi_resource_list data source: The output field supports the dynamic schema and allows user to read the output as an HCL object.
• azapi provider: Support client_id_file_pathand client_secret_file_path fields, which are used to specify the file path of the client id and client secret.
• azapi_data_plane_resource resource: Support Microsoft.Synapse/workspaces/databases type.
• azapi_resource resource, azapi_update_resource resource: Ignore the order of the elements in a list if the element has a name field as identifier.
• Update bicep types to https://github.com/ms-henglu/bicep-types-az/commit/48ce933ad85391b60ee02cf83e17c9b28d31a7b1

BUG FIXES:

• Fix a bug that azapi_resource_action doesn't support 204 status code as a success response.

BUG FIXES:

• Fix a bug that azapi_resource removes some required fields in the body when using ignore_body_changes feature.

v1.12.0

ENHANCEMENTS:

• Update bicep types to https://github.com/ms-henglu/bicep-types-az/commit/4abd79ba2baa05ba3c8364919b670ab43a9bf69c

BUG FIXES:

• Fix a bug that ignore_body_changes incorrectly removes tags.

NOTICE:

• Provider field default_naming_prefix and default_naming_suffix are deprecated. It will not work in the next minor release and will be removed in the next major release. Please specify the naming prefix and suffix in the resource's name field instead.
• The azapi_resource's removing_special_chars field is deprecated. It will not work in the next minor release and will be removed in the next major release. Please specify the name field and remove the special characters in the name field instead.
• Defining the identity inside the body field is not recommended. In the next minor release, it will not sync the identity inside the body field to identity block. Please define the identity block instead.

ENHANCEMENTS:

• azapi_resource_action resource: Support HEAD method.
• azapi_resource_action resource: Support when field, which is used to control when to execute the action.
• Update bicep types to https://github.com/ms-henglu/bicep-types-az/commit/fcfe2a66a04575f204767182fc575612c82eebc1

ENHANCEMENTS:

• azapi_resource data source: When creating Microsoft.Resources/subscriptions, resource_id is optional and defaults to the ID of the default subscription.
• Add a new logger to record the traffic in a structured way.
• azapi: Support endpoint block, which is used to configure the endpoints of the Azure Clouds.
• azapi_resource_action resource: Support GET method.
• Update bicep types to https://github.com/ms-henglu/bicep-types-az/commit/505b813ce50368156e3da1b86f07977b5a913be9

BUG FIXES:

• Fix a bug that body is not set when import with an unrecognized api-version.
• Fix a bug that deploy time constants are not removed from the request body when using azapi_update_resource resource.

FEATURES:

• New Data Source: azapi_resource_list
• New Data Source: azapi_resource_id

ENHANCEMENTS:

• azapi_resource resource/data source: When creating Microsoft.Resources/resourceGroups, parent_id is optional and defaults to the ID of the default subscription.
• azapi_resource resource: Support ignore_body_changes field, which is used to ignore some properties when comparing the resource with its current state.
• azapi_update_resource resource: Support ignore_body_changes field, which is used to ignore some properties when comparing the resource with its current state.
• Update bicep types to https://github.com/ms-henglu/bicep-types-az/commit/1d8fec8184258cdf967b1288b156e01f7cbc8ca9

BUG FIXES:

• Fix a bug that azapi_resource resource doesn't store the id in the state when error happens during the creation.
• Fix a bug that errors from the polling API which don't follow the ARM LRO guidelines are not handled properly.

FEATURES:

ENHANCEMENTS:

• azapi_resource_action: Support provider action.
• Update bicep types to https://ms-henglu/bicep-types-az/commit/c616eb1ad4980f63c0d6b436a63701e175a62224

BUG FIXES:

• Fix a bug that resource id for type Microsoft.Resources/providers is not parsed correctly.
• Fix a bug that resource id for type Microsoft.Resources/tenants is not parsed correctly.

FEATURES:

• New Resource: azapi_data_plane_resource
• azapi: Support use_msi and use_cli features.
• azapi: Support auxiliary_tenant_ids field, which is required for multi-tenancy and cross-tenant scenarios.
• azapi: Support custom_correlation_request_id field, which is used to specify the correlation request id.

ENHANCEMENTS:

• Update bicep types to https://github.com/ms-henglu/bicep-types-az/commit/0536b68e779fba100b9fbe32737c38d75396e2cf

BUG FIXES:

• Fix a bug that provider crashes when loading azure schema.

FEATURES:

ENHANCEMENTS:

• Update bicep types to https://github.com/ms-henglu/bicep-types-az/commit/da15d0376faa02a6e891dee315910535cef2a13f

BUG FIXES:

• Fix the bug that the headers are not stored in the log.