fixing param description. updating readmes

tony-box · May 22, 2024 · f50115d · f50115d
1 parent 2f3dd47
commit f50115d
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 6 deletions.
diff --git a/avm/res/api-management/service/README.md b/avm/res/api-management/service/README.md
@@ -643,8 +643,14 @@ module service 'br/public:avm/res/api-management/service:<version>' = {
     location: '<location>'
     loggers: [
       {
-        loggerType: 'azureMonitor'
+        credentials: {
+          instrumentationKey: '<instrumentationKey>'
+        }
+        description: 'Logger to Azure Application Insights'
+        isBuffered: false
+        loggerType: 'applicationInsights'
         name: 'logger'
+        resourceId: '<resourceId>'
       }
     ]
     minApiVersion: '2021-08-01'
@@ -843,8 +849,14 @@ module service 'br/public:avm/res/api-management/service:<version>' = {
     "loggers": {
       "value": [
         {
-          "loggerType": "azureMonitor",
-          "name": "logger"
+          "credentials": {
+            "instrumentationKey": "<instrumentationKey>"
+          },
+          "description": "Logger to Azure Application Insights",
+          "isBuffered": false,
+          "loggerType": "applicationInsights",
+          "name": "logger",
+          "resourceId": "<resourceId>"
         }
       ]
     },

diff --git a/avm/res/api-management/service/loggers/README.md b/avm/res/api-management/service/loggers/README.md
@@ -23,7 +23,7 @@ This module deploys an API Management Service Logger.
 | Parameter | Type | Description |
 | :-- | :-- | :-- |
 | [`loggerType`](#parameter-loggertype) | string | Logger type. |
-| [`name`](#parameter-name) | string | Resource Name |
+| [`name`](#parameter-name) | string | Resource Name. |
 
 **Conditional parameters**
 
@@ -57,7 +57,7 @@ Logger type.
 
 ### Parameter: `name`
 
-Resource Name
+Resource Name.
 
 - Required: Yes
 - Type: string

diff --git a/avm/res/api-management/service/loggers/main.bicep b/avm/res/api-management/service/loggers/main.bicep
@@ -5,7 +5,7 @@ metadata owner = 'Azure/module-maintainers'
 @description('Conditional. The name of the parent API Management service. Required if the template is used in a standalone deployment.')
 param apiManagementServiceName string
 
-@description('Required. Resource Name')
+@description('Required. Resource Name.')
 param name string
 
 @description('Optional. Logger description.')