Support metric filtering in integration azure GET, PUT APIs (#1880)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit 04fa2a16049b · 2024-07-03T19:44:02.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-07-02 18:50:31.571748",
-            "spec_repo_commit": "fae9d797"
+            "regenerated": "2024-07-03 18:25:11.005515",
+            "spec_repo_commit": "ce846cd6"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-07-02 18:50:31.591802",
-            "spec_repo_commit": "fae9d797"
+            "regenerated": "2024-07-03 18:25:11.023835",
+            "spec_repo_commit": "ce846cd6"
         }
     }
 }
diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml
@@ -840,6 +840,8 @@ components:
             Only hosts that match one of the defined tags are imported into Datadog.'
           example: key:value,filter:example
           type: string
+        metrics_config:
+          $ref: '#/components/schemas/AzureAccountMetricsConfig'
         new_client_id:
           description: Your New Azure web application ID.
           example: new1c7f6-1234-5678-9101-3fcbf464test
@@ -864,6 +866,27 @@ components:
       items:
         $ref: '#/components/schemas/AzureAccount'
       type: array
+    AzureAccountMetricsConfig:
+      description: 'Dictionary containing the key `excluded_resource_providers` which
+        has to be a list of Microsoft Azure Resource Provider names.
+
+        This feature is currently being beta tested.
+
+        In order to enable all resource providers for metric collection, pass:
+
+        `metrics_config: {"excluded_resource_providers": []}` (i.e., an empty list
+        for `excluded_resource_providers`).'
+      properties:
+        excluded_resource_providers:
+          description: List of Microsoft Azure Resource Providers to exclude from
+            metric collection.
+          example:
+          - Microsoft.Sql
+          - Microsoft.Cdn
+          items:
+            type: string
+          type: array
+      type: object
     CancelDowntimesByScopeRequest:
       description: Cancel downtimes according to scope.
       properties:
diff --git a/cassettes/features/v1/azure_integration/Delete-an-Azure-integration-returns-OK-response.frozen b/cassettes/features/v1/azure_integration/Delete-an-Azure-integration-returns-OK-response.frozen
@@ -1 +1 @@
-2024-02-28T20:25:59.931Z
+2024-07-01T18:40:05.567Z
diff --git a/cassettes/features/v1/azure_integration/Delete-an-Azure-integration-returns-OK-response.yml b/cassettes/features/v1/azure_integration/Delete-an-Azure-integration-returns-OK-response.yml
diff --git a/cassettes/features/v1/azure_integration/Update-an-Azure-integration-returns-OK-response.frozen b/cassettes/features/v1/azure_integration/Update-an-Azure-integration-returns-OK-response.frozen
@@ -1 +1 @@
-2024-02-28T20:26:00.368Z
+2024-07-01T18:40:05.942Z
diff --git a/cassettes/features/v1/azure_integration/Update-an-Azure-integration-returns-OK-response.yml b/cassettes/features/v1/azure_integration/Update-an-Azure-integration-returns-OK-response.yml
diff --git a/examples/v1/azure-integration/UpdateAzureHostFilters.rb b/examples/v1/azure-integration/UpdateAzureHostFilters.rb
@@ -15,6 +15,12 @@
     "*",
   ],
   host_filters: "key:value,filter:example",
+  metrics_config: DatadogAPIClient::V1::AzureAccountMetricsConfig.new({
+    excluded_resource_providers: [
+      "Microsoft.Sql",
+      "Microsoft.Cdn",
+    ],
+  }),
   new_client_id: "new1c7f6-1234-5678-9101-3fcbf464test",
   new_tenant_name: "new1c44-1234-5678-9101-cc00736ftest",
   resource_collection_enabled: true,
diff --git a/examples/v1/azure-integration/UpdateAzureIntegration.rb b/examples/v1/azure-integration/UpdateAzureIntegration.rb
@@ -18,6 +18,12 @@
   new_client_id: "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
   new_tenant_name: "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
   resource_collection_enabled: true,
+  metrics_config: DatadogAPIClient::V1::AzureAccountMetricsConfig.new({
+    excluded_resource_providers: [
+      "Microsoft.Sql",
+      "Microsoft.Cdn",
+    ],
+  }),
   tenant_name: "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
 })
 p api_instance.update_azure_integration(body)
diff --git a/features/v1/azure_integration.feature b/features/v1/azure_integration.feature
@@ -12,7 +12,7 @@ Feature: Azure Integration
   @generated @skip @team:DataDog/azure-integrations
   Scenario: Create an Azure integration returns "Bad Request" response
     Given new "CreateAzureIntegration" request
-    And body with value {"app_service_plan_filters": "key:value,filter:example", "automute": true, "client_id": "testc7f6-1234-5678-9101-3fcbf464test", "client_secret": "testingx./Sw*g/Y33t..R1cH+hScMDt", "container_app_filters": "key:value,filter:example", "cspm_enabled": true, "custom_metrics_enabled": true, "errors": ["*"], "host_filters": "key:value,filter:example", "new_client_id": "new1c7f6-1234-5678-9101-3fcbf464test", "new_tenant_name": "new1c44-1234-5678-9101-cc00736ftest", "resource_collection_enabled": true, "tenant_name": "testc44-1234-5678-9101-cc00736ftest"}
+    And body with value {"app_service_plan_filters": "key:value,filter:example", "automute": true, "client_id": "testc7f6-1234-5678-9101-3fcbf464test", "client_secret": "testingx./Sw*g/Y33t..R1cH+hScMDt", "container_app_filters": "key:value,filter:example", "cspm_enabled": true, "custom_metrics_enabled": true, "errors": ["*"], "host_filters": "key:value,filter:example", "metrics_config": {"excluded_resource_providers": ["Microsoft.Sql", "Microsoft.Cdn"]}, "new_client_id": "new1c7f6-1234-5678-9101-3fcbf464test", "new_tenant_name": "new1c44-1234-5678-9101-cc00736ftest", "resource_collection_enabled": true, "tenant_name": "testc44-1234-5678-9101-cc00736ftest"}
     When the request is sent
     Then the response status is 400 Bad Request
 
@@ -26,7 +26,7 @@ Feature: Azure Integration
   @generated @skip @team:DataDog/azure-integrations
   Scenario: Delete an Azure integration returns "Bad Request" response
     Given new "DeleteAzureIntegration" request
-    And body with value {"app_service_plan_filters": "key:value,filter:example", "automute": true, "client_id": "testc7f6-1234-5678-9101-3fcbf464test", "client_secret": "testingx./Sw*g/Y33t..R1cH+hScMDt", "container_app_filters": "key:value,filter:example", "cspm_enabled": true, "custom_metrics_enabled": true, "errors": ["*"], "host_filters": "key:value,filter:example", "new_client_id": "new1c7f6-1234-5678-9101-3fcbf464test", "new_tenant_name": "new1c44-1234-5678-9101-cc00736ftest", "resource_collection_enabled": true, "tenant_name": "testc44-1234-5678-9101-cc00736ftest"}
+    And body with value {"app_service_plan_filters": "key:value,filter:example", "automute": true, "client_id": "testc7f6-1234-5678-9101-3fcbf464test", "client_secret": "testingx./Sw*g/Y33t..R1cH+hScMDt", "container_app_filters": "key:value,filter:example", "cspm_enabled": true, "custom_metrics_enabled": true, "errors": ["*"], "host_filters": "key:value,filter:example", "metrics_config": {"excluded_resource_providers": ["Microsoft.Sql", "Microsoft.Cdn"]}, "new_client_id": "new1c7f6-1234-5678-9101-3fcbf464test", "new_tenant_name": "new1c44-1234-5678-9101-cc00736ftest", "resource_collection_enabled": true, "tenant_name": "testc44-1234-5678-9101-cc00736ftest"}
     When the request is sent
     Then the response status is 400 Bad Request
 
@@ -53,28 +53,28 @@ Feature: Azure Integration
   @generated @skip @team:DataDog/azure-integrations
   Scenario: Update Azure integration host filters returns "Bad Request" response
     Given new "UpdateAzureHostFilters" request
-    And body with value {"app_service_plan_filters": "key:value,filter:example", "automute": true, "client_id": "testc7f6-1234-5678-9101-3fcbf464test", "client_secret": "testingx./Sw*g/Y33t..R1cH+hScMDt", "container_app_filters": "key:value,filter:example", "cspm_enabled": true, "custom_metrics_enabled": true, "errors": ["*"], "host_filters": "key:value,filter:example", "new_client_id": "new1c7f6-1234-5678-9101-3fcbf464test", "new_tenant_name": "new1c44-1234-5678-9101-cc00736ftest", "resource_collection_enabled": true, "tenant_name": "testc44-1234-5678-9101-cc00736ftest"}
+    And body with value {"app_service_plan_filters": "key:value,filter:example", "automute": true, "client_id": "testc7f6-1234-5678-9101-3fcbf464test", "client_secret": "testingx./Sw*g/Y33t..R1cH+hScMDt", "container_app_filters": "key:value,filter:example", "cspm_enabled": true, "custom_metrics_enabled": true, "errors": ["*"], "host_filters": "key:value,filter:example", "metrics_config": {"excluded_resource_providers": ["Microsoft.Sql", "Microsoft.Cdn"]}, "new_client_id": "new1c7f6-1234-5678-9101-3fcbf464test", "new_tenant_name": "new1c44-1234-5678-9101-cc00736ftest", "resource_collection_enabled": true, "tenant_name": "testc44-1234-5678-9101-cc00736ftest"}
     When the request is sent
     Then the response status is 400 Bad Request
 
   @generated @skip @team:DataDog/azure-integrations
   Scenario: Update Azure integration host filters returns "OK" response
     Given new "UpdateAzureHostFilters" request
-    And body with value {"app_service_plan_filters": "key:value,filter:example", "automute": true, "client_id": "testc7f6-1234-5678-9101-3fcbf464test", "client_secret": "testingx./Sw*g/Y33t..R1cH+hScMDt", "container_app_filters": "key:value,filter:example", "cspm_enabled": true, "custom_metrics_enabled": true, "errors": ["*"], "host_filters": "key:value,filter:example", "new_client_id": "new1c7f6-1234-5678-9101-3fcbf464test", "new_tenant_name": "new1c44-1234-5678-9101-cc00736ftest", "resource_collection_enabled": true, "tenant_name": "testc44-1234-5678-9101-cc00736ftest"}
+    And body with value {"app_service_plan_filters": "key:value,filter:example", "automute": true, "client_id": "testc7f6-1234-5678-9101-3fcbf464test", "client_secret": "testingx./Sw*g/Y33t..R1cH+hScMDt", "container_app_filters": "key:value,filter:example", "cspm_enabled": true, "custom_metrics_enabled": true, "errors": ["*"], "host_filters": "key:value,filter:example", "metrics_config": {"excluded_resource_providers": ["Microsoft.Sql", "Microsoft.Cdn"]}, "new_client_id": "new1c7f6-1234-5678-9101-3fcbf464test", "new_tenant_name": "new1c44-1234-5678-9101-cc00736ftest", "resource_collection_enabled": true, "tenant_name": "testc44-1234-5678-9101-cc00736ftest"}
     When the request is sent
     Then the response status is 200 OK
 
   @generated @skip @team:DataDog/azure-integrations
   Scenario: Update an Azure integration returns "Bad Request" response
     Given new "UpdateAzureIntegration" request
-    And body with value {"app_service_plan_filters": "key:value,filter:example", "automute": true, "client_id": "testc7f6-1234-5678-9101-3fcbf464test", "client_secret": "testingx./Sw*g/Y33t..R1cH+hScMDt", "container_app_filters": "key:value,filter:example", "cspm_enabled": true, "custom_metrics_enabled": true, "errors": ["*"], "host_filters": "key:value,filter:example", "new_client_id": "new1c7f6-1234-5678-9101-3fcbf464test", "new_tenant_name": "new1c44-1234-5678-9101-cc00736ftest", "resource_collection_enabled": true, "tenant_name": "testc44-1234-5678-9101-cc00736ftest"}
+    And body with value {"app_service_plan_filters": "key:value,filter:example", "automute": true, "client_id": "testc7f6-1234-5678-9101-3fcbf464test", "client_secret": "testingx./Sw*g/Y33t..R1cH+hScMDt", "container_app_filters": "key:value,filter:example", "cspm_enabled": true, "custom_metrics_enabled": true, "errors": ["*"], "host_filters": "key:value,filter:example", "metrics_config": {"excluded_resource_providers": ["Microsoft.Sql", "Microsoft.Cdn"]}, "new_client_id": "new1c7f6-1234-5678-9101-3fcbf464test", "new_tenant_name": "new1c44-1234-5678-9101-cc00736ftest", "resource_collection_enabled": true, "tenant_name": "testc44-1234-5678-9101-cc00736ftest"}
     When the request is sent
     Then the response status is 400 Bad Request
 
   @team:DataDog/azure-integrations
   Scenario: Update an Azure integration returns "OK" response
     Given there is a valid "azure_account" in the system
     And new "UpdateAzureIntegration" request
-    And body with value {"app_service_plan_filters": "key:value,filter:example", "automute": true, "client_id": "{{ uuid }}", "client_secret": "testingx./Sw*g/Y33t..R1cH+hScMDt", "container_app_filters": "key:value,filter:example", "cspm_enabled": true, "custom_metrics_enabled": true, "errors": ["*"], "host_filters": "key:value,filter:example", "new_client_id": "{{ uuid }}", "new_tenant_name": "{{ uuid }}", "resource_collection_enabled": true, "tenant_name": "{{ uuid }}"}
+    And body with value {"app_service_plan_filters": "key:value,filter:example", "automute": true, "client_id": "{{ uuid }}", "client_secret": "testingx./Sw*g/Y33t..R1cH+hScMDt", "container_app_filters": "key:value,filter:example", "cspm_enabled": true, "custom_metrics_enabled": true, "errors": ["*"], "host_filters": "key:value,filter:example", "new_client_id": "{{ uuid }}", "new_tenant_name": "{{ uuid }}", "resource_collection_enabled": true, "metrics_config": {"excluded_resource_providers": ["Microsoft.Sql", "Microsoft.Cdn"]}, "tenant_name": "{{ uuid }}"}
     When the request is sent
     Then the response status is 200 OK
diff --git a/features/v1/given.json b/features/v1/given.json
@@ -117,7 +117,7 @@
       {
         "name": "body",
         "origin": "request",
-        "value": "{\n  \"app_service_plan_filters\": \"key:value,filter:example\",\n  \"automute\": true,\n  \"client_id\": \"{{ uuid }}\",\n  \"client_secret\": \"testingx./Sw*g/Y33t..R1cH+hScMDt\",\n  \"container_app_filters\": \"key:value,filter:example\",\n  \"cspm_enabled\": true,\n  \"custom_metrics_enabled\": true,\n  \"errors\": [\"*\"],\n  \"host_filters\": \"key:value,filter:example\",\n  \"new_client_id\": \"{{ uuid }}\",\n  \"new_tenant_name\": \"{{ uuid }}\",\n  \"resource_collection_enabled\": true,\n  \"tenant_name\": \"{{ uuid }}\"\n}"
+        "value": "{\n  \"app_service_plan_filters\": \"key:value,filter:example\",\n  \"automute\": true,\n  \"client_id\": \"{{ uuid }}\",\n  \"client_secret\": \"testingx./Sw*g/Y33t..R1cH+hScMDt\",\n  \"container_app_filters\": \"key:value,filter:example\",\n  \"cspm_enabled\": true,\n  \"custom_metrics_enabled\": true,\n  \"errors\": [\"*\"],\n  \"host_filters\": \"key:value,filter:example\",\n  \"new_client_id\": \"{{ uuid }}\",\n  \"new_tenant_name\": \"{{ uuid }}\",\n  \"resource_collection_enabled\": true,\n  \"metrics_config\": {\n    \"excluded_resource_providers\": [\"Microsoft.Sql\", \"Microsoft.Cdn\"]\n  },\n  \"tenant_name\": \"{{ uuid }}\"\n}"
       }
     ],
     "step": "there is a valid \"azure_account\" in the system",
diff --git a/lib/datadog_api_client/inflector.rb b/lib/datadog_api_client/inflector.rb
@@ -53,6 +53,7 @@ def overrides
           "v1.aws_tag_filter_delete_request" => "AWSTagFilterDeleteRequest",
           "v1.aws_tag_filter_list_response" => "AWSTagFilterListResponse",
           "v1.azure_account" => "AzureAccount",
+          "v1.azure_account_metrics_config" => "AzureAccountMetricsConfig",
           "v1.cancel_downtimes_by_scope_request" => "CancelDowntimesByScopeRequest",
           "v1.canceled_downtimes_ids" => "CanceledDowntimesIds",
           "v1.change_widget_definition" => "ChangeWidgetDefinition",
diff --git a/lib/datadog_api_client/v1/models/azure_account.rb b/lib/datadog_api_client/v1/models/azure_account.rb
diff --git a/lib/datadog_api_client/v1/models/azure_account_metrics_config.rb b/lib/datadog_api_client/v1/models/azure_account_metrics_config.rb

Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,13 @@`
`4`	`4`	`"spec_versions": {`
`5`	`5`	`"v1": {`
`6`	`6`	`"apigentools_version": "1.6.6",`
`7`		`- "regenerated": "2024-07-02 18:50:31.571748",`
`8`		`- "spec_repo_commit": "fae9d797"`
	`7`	`+ "regenerated": "2024-07-03 18:25:11.005515",`
	`8`	`+ "spec_repo_commit": "ce846cd6"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.6",`
`12`		`- "regenerated": "2024-07-02 18:50:31.591802",`
`13`		`- "spec_repo_commit": "fae9d797"`
	`12`	`+ "regenerated": "2024-07-03 18:25:11.023835",`
	`13`	`+ "spec_repo_commit": "ce846cd6"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-2024-02-28T20:25:59.931Z`
	`1`	`+2024-07-01T18:40:05.567Z`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-2024-02-28T20:26:00.368Z`
	`1`	`+2024-07-01T18:40:05.942Z`
Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,7 @@`
`117`	`117`	`{`
`118`	`118`	`"name": "body",`
`119`	`119`	`"origin": "request",`
`120`		- "value": "{\n \"app_service_plan_filters\": \"key:value,filter:example\",\n \"automute\": true,\n \"client_id\": \"{{ uuid }}\",\n \"client_secret\": \"testingx./Swg/Y33t..R1cH+hScMDt\",\n \"container_app_filters\": \"key:value,filter:example\",\n \"cspm_enabled\": true,\n \"custom_metrics_enabled\": true,\n \"errors\": [\"\"],\n \"host_filters\": \"key:value,filter:example\",\n \"new_client_id\": \"{{ uuid }}\",\n \"new_tenant_name\": \"{{ uuid }}\",\n \"resource_collection_enabled\": true,\n \"tenant_name\": \"{{ uuid }}\"\n}"
	`120`	+ "value": "{\n \"app_service_plan_filters\": \"key:value,filter:example\",\n \"automute\": true,\n \"client_id\": \"{{ uuid }}\",\n \"client_secret\": \"testingx./Swg/Y33t..R1cH+hScMDt\",\n \"container_app_filters\": \"key:value,filter:example\",\n \"cspm_enabled\": true,\n \"custom_metrics_enabled\": true,\n \"errors\": [\"\"],\n \"host_filters\": \"key:value,filter:example\",\n \"new_client_id\": \"{{ uuid }}\",\n \"new_tenant_name\": \"{{ uuid }}\",\n \"resource_collection_enabled\": true,\n \"metrics_config\": {\n \"excluded_resource_providers\": [\"Microsoft.Sql\", \"Microsoft.Cdn\"]\n },\n \"tenant_name\": \"{{ uuid }}\"\n}"
`121`	`121`	`}`
`122`	`122`	`],`
`123`	`123`	`"step": "there is a valid \"azure_account\" in the system",`