From 077d3bfc05ded216364c2477974bfe73967de42a Mon Sep 17 00:00:00 2001 From: Elham Saber Date: Tue, 8 Apr 2025 10:58:58 -0700 Subject: [PATCH 1/4] docs: Add cognitive-services-accounts.md --- .../providers/cognitive-services-accounts.md | 37 +++++++++++++++++++ mkdocs.yml | 2 + 2 files changed, 39 insertions(+) create mode 100644 docs/scraping/providers/cognitive-services-accounts.md diff --git a/docs/scraping/providers/cognitive-services-accounts.md b/docs/scraping/providers/cognitive-services-accounts.md new file mode 100644 index 0000000..84c570c --- /dev/null +++ b/docs/scraping/providers/cognitive-services-accounts.md @@ -0,0 +1,37 @@ +--- +tags: + - Scraper + - Resource Discovery + - Cognitive Services Accounts +--- + +# Cognitive Services + +![Availability Badge](https://img.shields.io/badge/Available%20Starting-v2.12-green.svg)![Resource Discovery Support Badge](https://img.shields.io/badge/Support%20for%20Resource%20Discovery-Yes-green.svg) + +You can scrape an Cognitive Service Accounts via the `CognitiveServicesAccounts` +resource type. + +When using declared resources, the following fields need to be provided: + +- `cognitiveServicesAccountsName` - The name of the Cognitive Services Accounts. + +All supported metrics are documented in the official [Azure Monitor documentation](https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/microsoft-cognitiveservices-accounts-metrics). + +## Example + +Here is an example configuration: + +```yaml +name: cognitive_services_rate_limit +description: The current ratelimit of the ratelimit key. +resourceType: CognitiveServicesAccounts +azureMetricConfiguration: + metricName: Ratelimit + aggregation: + type: Count + dimension: + name: Status +resourceDiscoveryGroups: + - name: cognitive-services-accounts +``` diff --git a/mkdocs.yml b/mkdocs.yml index ee4090c..dcb3fcd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -155,6 +155,7 @@ nav: - Azure Blob Storage: scraping/providers/blob-storage.md - Azure Cache for Redis: scraping/providers/redis-cache.md - Azure Cache for Redis Enterprise: scraping/providers/redis-enterprise-cache.md + - Azure Cognitive Services Accounts: scraping/providers/cognitive-services-accounts.md - Azure Content Delivery Network (CDN): scraping/providers/cdn.md - Azure Container Instances: scraping/providers/container-instances.md - Azure Container Registry: scraping/providers/container-registry.md @@ -211,6 +212,7 @@ nav: - Azure Automation account: scraping/providers/automation-account.md - Azure Cache for Redis: scraping/providers/redis-cache.md - Azure Cache for Redis Enterprise: scraping/providers/redis-enterprise-cache.md + - Azure Cognitive Services Accounts: scraping/providers/cognitive-services-accounts.md - Azure Content Delivery Network (CDN): scraping/providers/cdn.md - Azure Container Instances: scraping/providers/container-instances.md - Azure Container Registry: scraping/providers/container-registry.md From b712d3937881d48a4e84a9254172b2eeaccd56f6 Mon Sep 17 00:00:00 2001 From: Elham Saber Date: Tue, 8 Apr 2025 10:59:19 -0700 Subject: [PATCH 2/4] PR feedbacks --- ...ces-accounts.md => cognitive-services-account.md} | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) rename docs/scraping/providers/{cognitive-services-accounts.md => cognitive-services-account.md} (70%) diff --git a/docs/scraping/providers/cognitive-services-accounts.md b/docs/scraping/providers/cognitive-services-account.md similarity index 70% rename from docs/scraping/providers/cognitive-services-accounts.md rename to docs/scraping/providers/cognitive-services-account.md index 84c570c..436de3d 100644 --- a/docs/scraping/providers/cognitive-services-accounts.md +++ b/docs/scraping/providers/cognitive-services-account.md @@ -2,19 +2,19 @@ tags: - Scraper - Resource Discovery - - Cognitive Services Accounts + - Cognitive Services Account --- # Cognitive Services -![Availability Badge](https://img.shields.io/badge/Available%20Starting-v2.12-green.svg)![Resource Discovery Support Badge](https://img.shields.io/badge/Support%20for%20Resource%20Discovery-Yes-green.svg) +![Availability Badge](https://img.shields.io/badge/Available%20Starting-v2.14-green.svg)![Resource Discovery Support Badge](https://img.shields.io/badge/Support%20for%20Resource%20Discovery-Yes-green.svg) -You can scrape an Cognitive Service Accounts via the `CognitiveServicesAccounts` +You can scrape an Cognitive Service Account via the `CognitiveServicesAccount` resource type. When using declared resources, the following fields need to be provided: -- `cognitiveServicesAccountsName` - The name of the Cognitive Services Accounts. +- `cognitiveServicesAccountName` - The name of the Cognitive Services Account. All supported metrics are documented in the official [Azure Monitor documentation](https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/microsoft-cognitiveservices-accounts-metrics). @@ -25,7 +25,7 @@ Here is an example configuration: ```yaml name: cognitive_services_rate_limit description: The current ratelimit of the ratelimit key. -resourceType: CognitiveServicesAccounts +resourceType: CognitiveServicesAccount azureMetricConfiguration: metricName: Ratelimit aggregation: @@ -33,5 +33,5 @@ azureMetricConfiguration: dimension: name: Status resourceDiscoveryGroups: - - name: cognitive-services-accounts + - name: cognitive-services-account ``` From 4d775c44ebb01d073cc4c19b8bda05f07dfd253c Mon Sep 17 00:00:00 2001 From: Elham Saber Date: Mon, 7 Apr 2025 22:05:56 -0700 Subject: [PATCH 3/4] Update mkdocs.yml Co-authored-by: Tom Kerkhove Signed-off-by: Elham Saber --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index dcb3fcd..e2288c1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -155,7 +155,7 @@ nav: - Azure Blob Storage: scraping/providers/blob-storage.md - Azure Cache for Redis: scraping/providers/redis-cache.md - Azure Cache for Redis Enterprise: scraping/providers/redis-enterprise-cache.md - - Azure Cognitive Services Accounts: scraping/providers/cognitive-services-accounts.md + - Azure Cognitive Services Account: scraping/providers/cognitive-services-account.md - Azure Content Delivery Network (CDN): scraping/providers/cdn.md - Azure Container Instances: scraping/providers/container-instances.md - Azure Container Registry: scraping/providers/container-registry.md From d177e43b56a240f2b869d8f7e210d17949c4d4fb Mon Sep 17 00:00:00 2001 From: Elham Saber Date: Mon, 7 Apr 2025 22:06:04 -0700 Subject: [PATCH 4/4] Update mkdocs.yml Co-authored-by: Tom Kerkhove Signed-off-by: Elham Saber --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index e2288c1..e5ffc28 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -212,7 +212,7 @@ nav: - Azure Automation account: scraping/providers/automation-account.md - Azure Cache for Redis: scraping/providers/redis-cache.md - Azure Cache for Redis Enterprise: scraping/providers/redis-enterprise-cache.md - - Azure Cognitive Services Accounts: scraping/providers/cognitive-services-accounts.md + - Azure Cognitive Services Account: scraping/providers/cognitive-services-account.md - Azure Content Delivery Network (CDN): scraping/providers/cdn.md - Azure Container Instances: scraping/providers/container-instances.md - Azure Container Registry: scraping/providers/container-registry.md