From a986b0317338c0a5a97204ab8f45b210f9635cf9 Mon Sep 17 00:00:00 2001 From: Ahmad Abdalla <28486158+ahmadabdalla@users.noreply.github.com> Date: Thu, 12 Oct 2023 22:01:27 +1100 Subject: [PATCH 1/4] containers --- .../container-group/README.md | 290 ++++++++--------- modules/container-registry/registry/README.md | 74 ++--- .../managed-cluster/README.md | 294 +++++++++--------- 3 files changed, 333 insertions(+), 325 deletions(-) diff --git a/modules/container-instance/container-group/README.md b/modules/container-instance/container-group/README.md index 3e31dd66c8..2e9d0bbfcd 100644 --- a/modules/container-instance/container-group/README.md +++ b/modules/container-instance/container-group/README.md @@ -9,10 +9,7 @@ This module deploys a Container Instance Container Group. - [Outputs](#Outputs) - [Cross-referenced modules](#Cross-referenced-modules) - [Deployment examples](#Deployment-examples) - -### Container groups in Azure Container Instances - -The top-level resource in Azure Container Instances is the container group. A container group is a collection of containers that get scheduled on the same host machine. The containers in a container group share a lifecycle, resources, local network, and storage volumes. It's similar in concept to a pod in Kubernetes. +- [Notes](#Notes) ## Resource types @@ -64,43 +61,6 @@ The top-level resource in Azure Container Instances is the container group. A co | `volumes` | array | `[]` | | Specify if volumes (emptyDir, AzureFileShare or GitRepo) shall be attached to your containergroup. | -### Parameter Usage: `imageRegistryCredentials` - -The image registry credentials by which the container group is created from. - -
- -Parameter JSON format - -```json -"imageRegistryCredentials": { - "value": [ - { - "server": "sxxazacrx001.azurecr.io", - "username": "sxxazacrx001" - } - ] -} -``` - -
- -
- -Bicep format - -```bicep -imageRegistryCredentials: [ - { - server: 'sxxazacrx001.azurecr.io' - username: 'sxxazacrx001' - } -] -``` - -
-

- ### Parameter Usage: `tags` Tag names and tag values can be provided as needed. A tag can be left without a value. @@ -142,110 +102,6 @@ tags: {

-### Parameter Usage: `autoGeneratedDomainNameLabelScope` - -DNS name reuse is convenient for DevOps within any modern company. The idea of redeploying an application by reusing the DNS name fulfills an on-demand philosophy that secures cloud development. Therefore, it's important to note that DNS names that are available to anyone become a problem when one customer releases a name only to have that same name taken by another customer. This is called subdomain takeover. A customer releases a resource using a particular name, and another customer creates a new resource with that same DNS name. If there were any records pointing to the old resource, they now also point to the new resource. - -This field can only be used when the `ipAddressType` is set to `Public`. - -Allowed values are: -| Policy name | Policy definition | | | | -|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---| -| unsecure | Hash will be generated based on only the DNS name. Avoiding subdomain takeover is not guaranteed if another customer uses the same DNS name. | | | | -| tenantReuse | Default Hash will be generated based on the DNS name and the tenant ID. Object's domain name label can be reused within the same tenant. | | | | -| subscriptionReuse | Hash will be generated based on the DNS name and the tenant ID and subscription ID. Object's domain name label can be reused within the same subscription. | | | | -| resourceGroupReuse | Hash will be generated based on the DNS name and the tenant ID, subscription ID, and resource group name. Object's domain name label can be reused within the same resource group. | | | | -| noReuse | Hash will not be generated. Object's domain label can't be reused within resource group, subscription, or tenant. | | | | - -

- -Parameter JSON format - -```json -"autoGeneratedDomainNameLabelScope": { - "value": "Unsecure" - }, -``` - -
- -
- -Bicep format - -```bicep -autoGeneratedDomainNameLabelScope: 'Unsecure' -``` - -
-

- -### Parameter Usage: `volumes` - -By default, Azure Container Instances are stateless. If the container is restarted, crashes, or stops, all of its state is lost. To persist state beyond the lifetime of the container, you must mount a volume from an external store. Currently, Azure volume mounting is only supported on a linux based image. - -You can mount: - -- an Azure File Share (make sure the storage account has a service endpoint when running the container in private mode!) -- a secret -- a GitHub Repository -- an empty local directory - -

- -Parameter JSON format - -```json -"volumes": [ - { - "azureFile": { - "readOnly": "bool", - "shareName": "string", - "storageAccountKey": "string", - "storageAccountName": "string" - }, - "emptyDir": {}, - "gitRepo": { - "directory": "string", - "repository": "string", - "revision": "string" - }, - "name": "string", - "secret": {} - } - ] -``` - -
- -
- -Bicep format - -```bicep -volumes: [ - { - azureFile: { - readOnly: bool - shareName: 'string' - storageAccountKey: 'string' - storageAccountName: 'string' - } - emptyDir: any() - gitRepo: { - directory: 'string' - repository: 'string' - revision: 'string' - } - name: 'string' - secret: {} - } - ] -``` - -
-

- ### Parameter Usage: `userAssignedIdentities` You can specify multiple user assigned identities to a resource by providing additional resource IDs using the following format: @@ -1022,3 +878,147 @@ module containerGroup './container-instance/container-group/main.bicep' = {

+ + +## Notes + +### Parameter Usage: `imageRegistryCredentials` + +The image registry credentials by which the container group is created from. + +

+ +Parameter JSON format + +```json +"imageRegistryCredentials": { + "value": [ + { + "server": "sxxazacrx001.azurecr.io", + "username": "sxxazacrx001" + } + ] +} +``` + +
+ +
+ +Bicep format + +```bicep +imageRegistryCredentials: [ + { + server: 'sxxazacrx001.azurecr.io' + username: 'sxxazacrx001' + } +] +``` + +
+

+ +### Parameter Usage: `autoGeneratedDomainNameLabelScope` + +DNS name reuse is convenient for DevOps within any modern company. The idea of redeploying an application by reusing the DNS name fulfills an on-demand philosophy that secures cloud development. Therefore, it's important to note that DNS names that are available to anyone become a problem when one customer releases a name only to have that same name taken by another customer. This is called subdomain takeover. A customer releases a resource using a particular name, and another customer creates a new resource with that same DNS name. If there were any records pointing to the old resource, they now also point to the new resource. + +This field can only be used when the `ipAddressType` is set to `Public`. + +Allowed values are: +| Policy name | Policy definition | | | | +|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---| +| unsecure | Hash will be generated based on only the DNS name. Avoiding subdomain takeover is not guaranteed if another customer uses the same DNS name. | | | | +| tenantReuse | Default Hash will be generated based on the DNS name and the tenant ID. Object's domain name label can be reused within the same tenant. | | | | +| subscriptionReuse | Hash will be generated based on the DNS name and the tenant ID and subscription ID. Object's domain name label can be reused within the same subscription. | | | | +| resourceGroupReuse | Hash will be generated based on the DNS name and the tenant ID, subscription ID, and resource group name. Object's domain name label can be reused within the same resource group. | | | | +| noReuse | Hash will not be generated. Object's domain label can't be reused within resource group, subscription, or tenant. | | | | + +

+ +Parameter JSON format + +```json +"autoGeneratedDomainNameLabelScope": { + "value": "Unsecure" + }, +``` + +
+ +
+ +Bicep format + +```bicep +autoGeneratedDomainNameLabelScope: 'Unsecure' +``` + +
+

+ +### Parameter Usage: `volumes` + +By default, Azure Container Instances are stateless. If the container is restarted, crashes, or stops, all of its state is lost. To persist state beyond the lifetime of the container, you must mount a volume from an external store. Currently, Azure volume mounting is only supported on a linux based image. + +You can mount: + +- an Azure File Share (make sure the storage account has a service endpoint when running the container in private mode!) +- a secret +- a GitHub Repository +- an empty local directory + +

+ +Parameter JSON format + +```json +"volumes": [ + { + "azureFile": { + "readOnly": "bool", + "shareName": "string", + "storageAccountKey": "string", + "storageAccountName": "string" + }, + "emptyDir": {}, + "gitRepo": { + "directory": "string", + "repository": "string", + "revision": "string" + }, + "name": "string", + "secret": {} + } + ] +``` + +
+ +
+ +Bicep format + +```bicep +volumes: [ + { + azureFile: { + readOnly: bool + shareName: 'string' + storageAccountKey: 'string' + storageAccountName: 'string' + } + emptyDir: any() + gitRepo: { + directory: 'string' + repository: 'string' + revision: 'string' + } + name: 'string' + secret: {} + } + ] +``` + +
+

diff --git a/modules/container-registry/registry/README.md b/modules/container-registry/registry/README.md index 39286f8f94..47197bd3ff 100644 --- a/modules/container-registry/registry/README.md +++ b/modules/container-registry/registry/README.md @@ -9,6 +9,7 @@ This module deploys an Azure Container Registry (ACR). - [Outputs](#Outputs) - [Cross-referenced modules](#Cross-referenced-modules) - [Deployment examples](#Deployment-examples) +- [Notes](#Notes) ## Resource types @@ -141,41 +142,6 @@ roleAssignments: [

-### Parameter Usage: `imageRegistryCredentials` - -The image registry credentials by which the container group is created from. - -

- -Parameter JSON format - -```json -"acrName": { - "value": { - "server": "acrx001", - } -}, -"acrAdminUserEnabled": { - "value": false -} -``` - -
- -
- -Bicep format - -```bicep -acrName: { - server: 'acrx001' -} -acrAdminUserEnabled: false -``` - -
-

- ### Parameter Usage: `privateEndpoints` To use Private Endpoint the following dependencies must be deployed: @@ -839,3 +805,41 @@ module registry './container-registry/registry/main.bicep' = {

+ + +## Notes + +### Parameter Usage: `imageRegistryCredentials` + +The image registry credentials by which the container group is created from. + +

+ +Parameter JSON format + +```json +"acrName": { + "value": { + "server": "acrx001", + } +}, +"acrAdminUserEnabled": { + "value": false +} +``` + +
+ +
+ +Bicep format + +```bicep +acrName: { + server: 'acrx001' +} +acrAdminUserEnabled: false +``` + +
+

diff --git a/modules/container-service/managed-cluster/README.md b/modules/container-service/managed-cluster/README.md index 402d82e6fb..84750942fc 100644 --- a/modules/container-service/managed-cluster/README.md +++ b/modules/container-service/managed-cluster/README.md @@ -9,6 +9,7 @@ This module deploys an Azure Kubernetes Service (AKS) Managed Cluster. - [Outputs](#Outputs) - [Cross-referenced modules](#Cross-referenced-modules) - [Deployment examples](#Deployment-examples) +- [Notes](#Notes) ## Resource types @@ -239,100 +240,6 @@ tags: {

-### Parameter Usage: `primaryAgentPoolProfile` - -Provide values for primary agent pool as needed. -For available properties check - -

- -Parameter JSON format - -```json -"primaryAgentPoolProfile": { - "value": [ - { - "name": "poolname", - "vmSize": "Standard_DS3_v2", - "osDiskSizeGB": 128, - "count": 2, - "osType": "Linux", - "maxCount": 5, - "minCount": 1, - "enableAutoScaling": true, - "scaleSetPriority": "Regular", - "scaleSetEvictionPolicy": "Delete", - "nodeLabels": {}, - "nodeTaints": [ - "CriticalAddonsOnly=true:NoSchedule" - ], - "type": "VirtualMachineScaleSets", - "availabilityZones": [ - "1", - "2", - "3" - ], - "maxPods": 30, - "storageProfile": "ManagedDisks", - "mode": "System", - "vnetSubnetID": "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet", - "tags": { - "Owner": "test.user@testcompany.com", - "BusinessUnit": "IaCs", - "Environment": "PROD", - "Region": "USEast" - } - } - ] -} -``` - -
- -
- -Bicep format - -```bicep -primaryAgentPoolProfile: [ - { - name: 'poolname' - vmSize: 'Standard_DS3_v2' - osDiskSizeGB: 128 - count: 2 - osType: 'Linux' - maxCount: 5 - minCount: 1 - enableAutoScaling: true - scaleSetPriority: 'Regular' - scaleSetEvictionPolicy: 'Delete' - nodeLabels: {} - nodeTaints: [ - 'CriticalAddonsOnly=true:NoSchedule' - ] - type: 'VirtualMachineScaleSets' - availabilityZones: [ - '1' - '2' - '3' - ] - maxPods: 30 - storageProfile: 'ManagedDisks' - mode: 'System' - vnetSubnetID: '/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet' - tags: { - Owner: 'test.user@testcompany.com' - BusinessUnit: 'IaCs' - Environment: 'PROD' - Region: 'USEast' - } - } -] -``` - -
-

- ### Parameter Usage: `userAssignedIdentities` You can specify multiple user assigned identities to a resource by providing additional resource IDs using the following format: @@ -366,57 +273,6 @@ userAssignedIdentities: {

-### Parameter Usage: `httpProxyConfig` - -Configurations for provisioning the cluster with HTTP proxy servers. You can specify in the following format: - -

- -Parameter JSON format - -```json -"httpProxyConfig": { - "value": { - "httpProxy": "http://proxy.contoso.com:8080/", - "httpsProxy": "http://proxy.contoso.com:8080/", - "noProxy": [ - "10.0.0.0/8", - "127.0.0.1", - "168.63.129.16", - "169.254.169.254", - "azurecr.io", - "konnectivity", - "localhost" - ] - } -} -``` - -
- -
- -Bicep format - -```bicep -httpProxyConfig: { - httpProxy: 'http://proxy.contoso.com:8080/' - httpsProxy: 'http://proxy.contoso.com:8080/' - noProxy: [ - '10.0.0.0/8' - '127.0.0.1' - '168.63.129.16' - '169.254.169.254' - 'azurecr.io' - 'konnectivity' - 'localhost' - ] -} -``` - -
-

- ## Outputs | Output Name | Type | Description | @@ -1469,3 +1325,151 @@ module managedCluster './container-service/managed-cluster/main.bicep' = {

+ + +## Notes + +### Parameter Usage: `primaryAgentPoolProfile` + +Provide values for primary agent pool as needed. +For available properties check + +

+ +Parameter JSON format + +```json +"primaryAgentPoolProfile": { + "value": [ + { + "name": "poolname", + "vmSize": "Standard_DS3_v2", + "osDiskSizeGB": 128, + "count": 2, + "osType": "Linux", + "maxCount": 5, + "minCount": 1, + "enableAutoScaling": true, + "scaleSetPriority": "Regular", + "scaleSetEvictionPolicy": "Delete", + "nodeLabels": {}, + "nodeTaints": [ + "CriticalAddonsOnly=true:NoSchedule" + ], + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "maxPods": 30, + "storageProfile": "ManagedDisks", + "mode": "System", + "vnetSubnetID": "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet", + "tags": { + "Owner": "test.user@testcompany.com", + "BusinessUnit": "IaCs", + "Environment": "PROD", + "Region": "USEast" + } + } + ] +} +``` + +
+ +
+ +Bicep format + +```bicep +primaryAgentPoolProfile: [ + { + name: 'poolname' + vmSize: 'Standard_DS3_v2' + osDiskSizeGB: 128 + count: 2 + osType: 'Linux' + maxCount: 5 + minCount: 1 + enableAutoScaling: true + scaleSetPriority: 'Regular' + scaleSetEvictionPolicy: 'Delete' + nodeLabels: {} + nodeTaints: [ + 'CriticalAddonsOnly=true:NoSchedule' + ] + type: 'VirtualMachineScaleSets' + availabilityZones: [ + '1' + '2' + '3' + ] + maxPods: 30 + storageProfile: 'ManagedDisks' + mode: 'System' + vnetSubnetID: '/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet' + tags: { + Owner: 'test.user@testcompany.com' + BusinessUnit: 'IaCs' + Environment: 'PROD' + Region: 'USEast' + } + } +] +``` + +
+

+ +### Parameter Usage: `httpProxyConfig` + +Configurations for provisioning the cluster with HTTP proxy servers. You can specify in the following format: + +

+ +Parameter JSON format + +```json +"httpProxyConfig": { + "value": { + "httpProxy": "http://proxy.contoso.com:8080/", + "httpsProxy": "http://proxy.contoso.com:8080/", + "noProxy": [ + "10.0.0.0/8", + "127.0.0.1", + "168.63.129.16", + "169.254.169.254", + "azurecr.io", + "konnectivity", + "localhost" + ] + } +} +``` + +
+ +
+ +Bicep format + +```bicep +httpProxyConfig: { + httpProxy: 'http://proxy.contoso.com:8080/' + httpsProxy: 'http://proxy.contoso.com:8080/' + noProxy: [ + '10.0.0.0/8' + '127.0.0.1' + '168.63.129.16' + '169.254.169.254' + 'azurecr.io' + 'konnectivity' + 'localhost' + ] +} +``` + +
+

From 73a9d5e5b15b2a5ec9abe8abea83b46ed8f50759 Mon Sep 17 00:00:00 2001 From: Ahmad Abdalla <28486158+ahmadabdalla@users.noreply.github.com> Date: Thu, 12 Oct 2023 22:09:30 +1100 Subject: [PATCH 2/4] until databricks --- modules/data-factory/factory/README.md | 103 +++--- .../factory/integration-runtime/README.md | 29 +- .../factory/managed-virtual-network/README.md | 27 +- .../data-protection/backup-vault/README.md | 298 +++++++++--------- .../backup-vault/backup-policy/README.md | 27 +- modules/databricks/workspace/README.md | 134 ++++---- 6 files changed, 320 insertions(+), 298 deletions(-) diff --git a/modules/data-factory/factory/README.md b/modules/data-factory/factory/README.md index e6f1df293c..a1c42758cf 100644 --- a/modules/data-factory/factory/README.md +++ b/modules/data-factory/factory/README.md @@ -9,6 +9,7 @@ This module deploys a Data Factory. - [Outputs](#Outputs) - [Cross-referenced modules](#Cross-referenced-modules) - [Deployment examples](#Deployment-examples) +- [Notes](#Notes) ## Resource types @@ -309,56 +310,7 @@ privateEndpoints: [

-### Parameter Usage: `managedPrivateEndpoints` - -To use Managed Private Endpoints the following dependencies must be deployed: - -- The `managedVirtualNetworkName` property must be set to allow provisioning of a managed virtual network in Azure Data Factory. -- Destination private link resource must be created before and permissions allow requesting a private link connection to that resource. - -

- -Parameter JSON format - -```json -"managedPrivateEndpoints": { - "value": [ - { - "name": "mystorageaccount-managed-privateEndpoint", // Required: The managed private endpoint resource name - "groupId": "blob", // Required: The groupId to which the managed private endpoint is created - "fqdns": [ - "mystorageaccount.blob.core.windows.net" // Required: Fully qualified domain names - ], - "privateLinkResourceId": "/subscriptions/[[subscriptionId]]/resourceGroups/validation-rg/providers/Microsoft.Storage/storageAccounts/mystorageaccount" - // Required: The ARM resource ID of the resource to which the managed private endpoint is created. - } - ] -} -``` - -
- -
- -Bicep format - -```bicep -managedPrivateEndpoints: [ - // Example showing all available fields - { - name: 'mystorageaccount-managed-privateEndpoint' // Required: The managed private endpoint resource name - groupId: 'blob' // Required: The groupId to which the managed private endpoint is created - fqdns: [ - 'mystorageaccount.blob.core.windows.net' // Required: Fully qualified domain names - ] - privateLinkResourceId: '/subscriptions/[[subscriptionId]]/resourceGroups/validation-rg/providers/Microsoft.Storage/storageAccounts/mystorageaccount' - } // Required: The ARM resource ID of the resource to which the managed private endpoint is created. -] -``` - -

- ## Outputs | Output Name | Type | Description | @@ -659,3 +611,56 @@ module factory './data-factory/factory/main.bicep' = {

+ + +## Notes + +### Parameter Usage: `managedPrivateEndpoints` + +To use Managed Private Endpoints the following dependencies must be deployed: + +- The `managedVirtualNetworkName` property must be set to allow provisioning of a managed virtual network in Azure Data Factory. +- Destination private link resource must be created before and permissions allow requesting a private link connection to that resource. + +

+ +Parameter JSON format + +```json +"managedPrivateEndpoints": { + "value": [ + { + "name": "mystorageaccount-managed-privateEndpoint", // Required: The managed private endpoint resource name + "groupId": "blob", // Required: The groupId to which the managed private endpoint is created + "fqdns": [ + "mystorageaccount.blob.core.windows.net" // Required: Fully qualified domain names + ], + "privateLinkResourceId": "/subscriptions/[[subscriptionId]]/resourceGroups/validation-rg/providers/Microsoft.Storage/storageAccounts/mystorageaccount" + // Required: The ARM resource ID of the resource to which the managed private endpoint is created. + } + ] +} +``` + +
+ +
+ +Bicep format + +```bicep +managedPrivateEndpoints: [ + // Example showing all available fields + { + name: 'mystorageaccount-managed-privateEndpoint' // Required: The managed private endpoint resource name + groupId: 'blob' // Required: The groupId to which the managed private endpoint is created + fqdns: [ + 'mystorageaccount.blob.core.windows.net' // Required: Fully qualified domain names + ] + privateLinkResourceId: '/subscriptions/[[subscriptionId]]/resourceGroups/validation-rg/providers/Microsoft.Storage/storageAccounts/mystorageaccount' + } // Required: The ARM resource ID of the resource to which the managed private endpoint is created. +] +``` + +
+

diff --git a/modules/data-factory/factory/integration-runtime/README.md b/modules/data-factory/factory/integration-runtime/README.md index 8d15a01a4e..420d090782 100644 --- a/modules/data-factory/factory/integration-runtime/README.md +++ b/modules/data-factory/factory/integration-runtime/README.md @@ -8,6 +8,7 @@ This module deploys a Data Factory Managed or Self-Hosted Integration Runtime. - [Parameters](#Parameters) - [Outputs](#Outputs) - [Cross-referenced modules](#Cross-referenced-modules) +- [Notes](#Notes) ## Resource types @@ -39,7 +40,21 @@ This module deploys a Data Factory Managed or Self-Hosted Integration Runtime. | `typeProperties` | object | `{object}` | Integration Runtime type properties. Required if type is "Managed". | -### Parameter Usage: [`typeProperties`](https://learn.microsoft.com/en-us/azure/templates/microsoft.datafactory/factories/integrationruntimes?tabs=bicep#integrationruntime-objects) +## Outputs + +| Output Name | Type | Description | +| :-- | :-- | :-- | +| `name` | string | The name of the Integration Runtime. | +| `resourceGroupName` | string | The name of the Resource Group the Integration Runtime was created in. | +| `resourceId` | string | The resource ID of the Integration Runtime. | + +## Cross-referenced modules + +_None_ + +## Notes + +### Parameter Usage: `typeProperties`

@@ -69,15 +84,3 @@ typeProperties: {

- -## Outputs - -| Output Name | Type | Description | -| :-- | :-- | :-- | -| `name` | string | The name of the Integration Runtime. | -| `resourceGroupName` | string | The name of the Resource Group the Integration Runtime was created in. | -| `resourceId` | string | The resource ID of the Integration Runtime. | - -## Cross-referenced modules - -_None_ diff --git a/modules/data-factory/factory/managed-virtual-network/README.md b/modules/data-factory/factory/managed-virtual-network/README.md index d1da00c980..cda18555b9 100644 --- a/modules/data-factory/factory/managed-virtual-network/README.md +++ b/modules/data-factory/factory/managed-virtual-network/README.md @@ -8,6 +8,7 @@ This module deploys a Data Factory Managed Virtual Network. - [Parameters](#Parameters) - [Outputs](#Outputs) - [Cross-referenced modules](#Cross-referenced-modules) +- [Notes](#Notes) ## Resource types @@ -38,6 +39,20 @@ This module deploys a Data Factory Managed Virtual Network. | `managedPrivateEndpoints` | array | `[]` | An array of managed private endpoints objects created in the Data Factory managed virtual network. | +## Outputs + +| Output Name | Type | Description | +| :-- | :-- | :-- | +| `name` | string | The name of the Managed Virtual Network. | +| `resourceGroupName` | string | The name of the Resource Group the Managed Virtual Network was created in. | +| `resourceId` | string | The resource ID of the Managed Virtual Network. | + +## Cross-referenced modules + +_None_ + +## Notes + ### Parameter Usage: `managedPrivateEndpoints` To use Managed Private Endpoints the following dependencies must be deployed: @@ -86,15 +101,3 @@ managedPrivateEndpoints: [

- -## Outputs - -| Output Name | Type | Description | -| :-- | :-- | :-- | -| `name` | string | The name of the Managed Virtual Network. | -| `resourceGroupName` | string | The name of the Resource Group the Managed Virtual Network was created in. | -| `resourceId` | string | The resource ID of the Managed Virtual Network. | - -## Cross-referenced modules - -_None_ diff --git a/modules/data-protection/backup-vault/README.md b/modules/data-protection/backup-vault/README.md index e25728aafc..e12e916acc 100644 --- a/modules/data-protection/backup-vault/README.md +++ b/modules/data-protection/backup-vault/README.md @@ -9,6 +9,7 @@ This module deploys a Data Protection Backup Vault. - [Outputs](#Outputs) - [Cross-referenced modules](#Cross-referenced-modules) - [Deployment examples](#Deployment-examples) +- [Notes](#Notes) ## Resource Types @@ -45,153 +46,6 @@ This module deploys a Data Protection Backup Vault. | `type` | string | `'GeoRedundant'` | `[GeoRedundant, LocallyRedundant, ZoneRedundant]` | The vault redundancy level to use. | -### Parameter Usage: `backupPolicies` - -Create backup policies in the backupvault. - -

- -Parameter JSON format -```json - "backupPolicies": { - "value": [ - { - "name": "DefaultPolicy", - "properties": { - "policyRules": [ - { - "backupParameters": { - "backupType": "Incremental", - "objectType": "AzureBackupParams" - }, - "trigger": { - "schedule": { - "repeatingTimeIntervals": [ - "R/2022-05-31T23:30:00+01:00/P1D" - ], - "timeZone": "W. Europe Standard Time" - }, - "taggingCriteria": [ - { - "tagInfo": { - "tagName": "Default", - "id": "Default_" - }, - "taggingPriority": 99, - "isDefault": true - } - ], - "objectType": "ScheduleBasedTriggerContext" - }, - "dataStore": { - "dataStoreType": "OperationalStore", - "objectType": "DataStoreInfoBase" - }, - "name": "BackupDaily", - "objectType": "AzureBackupRule" - }, - { - "lifecycles": [ - { - "deleteAfter": { - "objectType": "AbsoluteDeleteOption", - "duration": "P7D" - }, - "targetDataStoreCopySettings": [], - "sourceDataStore": { - "dataStoreType": "OperationalStore", - "objectType": "DataStoreInfoBase" - } - } - ], - "isDefault": true, - "name": "Default", - "objectType": "AzureRetentionRule" - } - ], - "datasourceTypes": [ - "Microsoft.Compute/disks" - ], - "objectType": "BackupPolicy" - } - } - ] -} -``` - -
- -
- -Bicep format - -```bicep -backupPolicies: [ - { - name: 'DefaultPolicy' - properties: { - policyRules: [ - { - backupParameters: { - backupType: 'Incremental' - objectType: 'AzureBackupParams' - } - trigger: { - schedule: { - repeatingTimeIntervals: [ - 'R/2022-05-31T23:30:00+01:00/P1D' - ] - timeZone: 'W. Europe Standard Time' - } - taggingCriteria: [ - { - tagInfo: { - tagName: 'Default' - id: 'Default_' - } - taggingPriority: 99 - isDefault: true - } - ] - objectType: 'ScheduleBasedTriggerContext' - } - dataStore: { - dataStoreType: 'OperationalStore' - objectType: 'DataStoreInfoBase' - } - name: 'BackupDaily' - objectType: 'AzureBackupRule' - } - { - lifecycles: [ - { - deleteAfter: { - objectType: 'AbsoluteDeleteOption' - duration: 'P7D' - } - targetDataStoreCopySettings: [] - sourceDataStore: { - dataStoreType: 'OperationalStore' - objectType: 'DataStoreInfoBase' - } - } - ] - isDefault: true - name: 'Default' - objectType: 'AzureRetentionRule' - } - ] - datasourceTypes: [ - 'Microsoft.Compute/disks' - ] - objectType: 'BackupPolicy' - } - } -] -``` - -
- ### Parameter Usage: `roleAssignments` Create a role assignment for the given resource. If you want to assign a service principal / managed identity that is created in the same deployment, make sure to also specify the `'principalType'` parameter and set it to `'ServicePrincipal'`. This will ensure the role assignment waits for the principal's propagation in Azure. @@ -605,3 +459,153 @@ module backupVault './data-protection/backup-vault/main.bicep' = {

+ + +## Notes + +### Parameter Usage: `backupPolicies` + +Create backup policies in the backupvault. + +

+ +Parameter JSON format +```json + "backupPolicies": { + "value": [ + { + "name": "DefaultPolicy", + "properties": { + "policyRules": [ + { + "backupParameters": { + "backupType": "Incremental", + "objectType": "AzureBackupParams" + }, + "trigger": { + "schedule": { + "repeatingTimeIntervals": [ + "R/2022-05-31T23:30:00+01:00/P1D" + ], + "timeZone": "W. Europe Standard Time" + }, + "taggingCriteria": [ + { + "tagInfo": { + "tagName": "Default", + "id": "Default_" + }, + "taggingPriority": 99, + "isDefault": true + } + ], + "objectType": "ScheduleBasedTriggerContext" + }, + "dataStore": { + "dataStoreType": "OperationalStore", + "objectType": "DataStoreInfoBase" + }, + "name": "BackupDaily", + "objectType": "AzureBackupRule" + }, + { + "lifecycles": [ + { + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P7D" + }, + "targetDataStoreCopySettings": [], + "sourceDataStore": { + "dataStoreType": "OperationalStore", + "objectType": "DataStoreInfoBase" + } + } + ], + "isDefault": true, + "name": "Default", + "objectType": "AzureRetentionRule" + } + ], + "datasourceTypes": [ + "Microsoft.Compute/disks" + ], + "objectType": "BackupPolicy" + } + } + ] +} +``` + +
+ +
+ +Bicep format + +```bicep +backupPolicies: [ + { + name: 'DefaultPolicy' + properties: { + policyRules: [ + { + backupParameters: { + backupType: 'Incremental' + objectType: 'AzureBackupParams' + } + trigger: { + schedule: { + repeatingTimeIntervals: [ + 'R/2022-05-31T23:30:00+01:00/P1D' + ] + timeZone: 'W. Europe Standard Time' + } + taggingCriteria: [ + { + tagInfo: { + tagName: 'Default' + id: 'Default_' + } + taggingPriority: 99 + isDefault: true + } + ] + objectType: 'ScheduleBasedTriggerContext' + } + dataStore: { + dataStoreType: 'OperationalStore' + objectType: 'DataStoreInfoBase' + } + name: 'BackupDaily' + objectType: 'AzureBackupRule' + } + { + lifecycles: [ + { + deleteAfter: { + objectType: 'AbsoluteDeleteOption' + duration: 'P7D' + } + targetDataStoreCopySettings: [] + sourceDataStore: { + dataStoreType: 'OperationalStore' + objectType: 'DataStoreInfoBase' + } + } + ] + isDefault: true + name: 'Default' + objectType: 'AzureRetentionRule' + } + ] + datasourceTypes: [ + 'Microsoft.Compute/disks' + ] + objectType: 'BackupPolicy' + } + } +] +``` + +
diff --git a/modules/data-protection/backup-vault/backup-policy/README.md b/modules/data-protection/backup-vault/backup-policy/README.md index 619bef79af..dea9657139 100644 --- a/modules/data-protection/backup-vault/backup-policy/README.md +++ b/modules/data-protection/backup-vault/backup-policy/README.md @@ -8,6 +8,7 @@ This module deploys a Data Protection Backup Vault Backup Policy. - [Parameters](#Parameters) - [Outputs](#Outputs) - [Cross-referenced modules](#Cross-referenced-modules) +- [Notes](#Notes) ## Resource Types @@ -32,6 +33,20 @@ This module deploys a Data Protection Backup Vault Backup Policy. | `properties` | object | `{object}` | The properties of the backup policy. | +## Outputs + +| Output Name | Type | Description | +| :-- | :-- | :-- | +| `name` | string | The name of the backup policy. | +| `resourceGroupName` | string | The name of the resource group the backup policy was created in. | +| `resourceId` | string | The resource ID of the backup policy. | + +## Cross-referenced modules + +_None_ + +## Notes + ### Parameter Usage: `properties` Create a backup policy. @@ -169,15 +184,3 @@ properties: { ``` - -## Outputs - -| Output Name | Type | Description | -| :-- | :-- | :-- | -| `name` | string | The name of the backup policy. | -| `resourceGroupName` | string | The name of the resource group the backup policy was created in. | -| `resourceId` | string | The resource ID of the backup policy. | - -## Cross-referenced modules - -_None_ diff --git a/modules/databricks/workspace/README.md b/modules/databricks/workspace/README.md index 5f1ba4b232..13d48b4502 100644 --- a/modules/databricks/workspace/README.md +++ b/modules/databricks/workspace/README.md @@ -9,6 +9,7 @@ This module deploys an Azure Databricks Workspace. - [Outputs](#Outputs) - [Cross-referenced modules](#Cross-referenced-modules) - [Deployment examples](#Deployment-examples) +- [Notes](#Notes) ## Resource types @@ -136,71 +137,6 @@ roleAssignments: [

-### Parameter Usage: `customPublicSubnetName` and `customPrivateSubnetName` - -- Require Network Security Groups attached to the subnets (Note: Rule don't have to be set, they are set through the deployment) - -- The two subnets also need the delegation to service `Microsoft.Databricks/workspaces` - -### Parameter Usage: `parameters` - -- Include only those elements (e.g. amlWorkspaceId) as object if specified, otherwise remove it - -

- -Parameter JSON format - -```json -"parameters": { - "value": { - "amlWorkspaceId": { - "value": "/subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.MachineLearningServices/workspaces/xxx" - }, - "customVirtualNetworkId": { - "value": "/subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.Network/virtualNetworks/xxx" - }, - "customPublicSubnetName": { - "value": "xxx" - }, - "customPrivateSubnetName": { - "value": "xxx" - }, - "enableNoPublicIp": { - "value": true - } - } -} -``` - -
- -
- -Bicep format - -```bicep -parameters: { - amlWorkspaceId: { - value: '/subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.MachineLearningServices/workspaces/xxx' - } - customVirtualNetworkId: { - value: '/subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.Network/virtualNetworks/xxx' - } - customPublicSubnetName: { - value: 'xxx' - } - customPrivateSubnetName: { - value: 'xxx' - } - enableNoPublicIp: { - value: true - } -} -``` - -
-

- ### Parameter Usage: `tags` Tag names and tag values can be provided as needed. A tag can be left without a value. @@ -649,3 +585,71 @@ module workspace './databricks/workspace/main.bicep' = {

+ + +## Notes + +### Parameter Usage: `customPublicSubnetName` and `customPrivateSubnetName` + +- Require Network Security Groups attached to the subnets (Note: Rule don't have to be set, they are set through the deployment) + +- The two subnets also need the delegation to service `Microsoft.Databricks/workspaces` + +### Parameter Usage: `parameters` + +- Include only those elements (e.g. amlWorkspaceId) as object if specified, otherwise remove it. + +

+ +Parameter JSON format + +```json +"parameters": { + "value": { + "amlWorkspaceId": { + "value": "/subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.MachineLearningServices/workspaces/xxx" + }, + "customVirtualNetworkId": { + "value": "/subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.Network/virtualNetworks/xxx" + }, + "customPublicSubnetName": { + "value": "xxx" + }, + "customPrivateSubnetName": { + "value": "xxx" + }, + "enableNoPublicIp": { + "value": true + } + } +} +``` + +
+ +
+ +Bicep format + +```bicep +parameters: { + amlWorkspaceId: { + value: '/subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.MachineLearningServices/workspaces/xxx' + } + customVirtualNetworkId: { + value: '/subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.Network/virtualNetworks/xxx' + } + customPublicSubnetName: { + value: 'xxx' + } + customPrivateSubnetName: { + value: 'xxx' + } + enableNoPublicIp: { + value: true + } +} +``` + +
+

From a8595977c861f89a7fc7551c7039292ddce244de Mon Sep 17 00:00:00 2001 From: Ahmad Abdalla <28486158+ahmadabdalla@users.noreply.github.com> Date: Thu, 12 Oct 2023 22:13:23 +1100 Subject: [PATCH 3/4] updated posgtresql --- .../flexible-server/README.md | 290 +++++++++--------- 1 file changed, 147 insertions(+), 143 deletions(-) diff --git a/modules/db-for-postgre-sql/flexible-server/README.md b/modules/db-for-postgre-sql/flexible-server/README.md index 6215497fed..6e2318ca72 100644 --- a/modules/db-for-postgre-sql/flexible-server/README.md +++ b/modules/db-for-postgre-sql/flexible-server/README.md @@ -9,6 +9,7 @@ This module deploys a DBforPostgreSQL Flexible Server. - [Outputs](#Outputs) - [Cross-referenced modules](#Cross-referenced-modules) - [Deployment examples](#Deployment-examples) +- [Notes](#Notes) ## Resource Types @@ -182,149 +183,6 @@ tags: {

-### Parameter Usage: `firewallRules` - -To enable firewall rules on the PostgreSQL flexible server: - -- Used when the desired connectivity mode is "Public Access" only. - -

- -Parameter JSON format - -```json -"firewallRules": { - // Example showing all available fields - "value": [ - { - "name": "AllowAllWindowsAzureIps", //Use this rule to allow Trusted Azure services to access the server - "endIpAddress": "0.0.0.0", - "startIpAddress": "0.0.0.0" - }, - { - "name": "test-rule1", - "startIpAddress": "10.10.10.1", //Start IP address for the firewall rule. Must be IPv4 format - "endIpAddress": "10.10.10.10" //End IP address for the firewall rule. Must be IPv4 format - } - ] -} -``` - -
- -
- -Bicep format - -```bicep -firewallRules: [ - // Example showing all available fields - { - name: 'AllowAllWindowsAzureIps', //Use this rule to allow Trusted Azure services to access the server - endIpAddress: '0.0.0.0' - startIpAddress: '0.0.0.0' - } - { - name: "test-rule1", - startIpAddress: '10.10.10.1' //Start IP address for the firewall rule. Must be IPv4 format - endIpAddress: '10.10.10.10' //End IP address for the firewall rule. Must be IPv4 format - } -] -``` - -
-

- -### Parameter Usage: `configurations` - -To override default server configurations on the PostgreSQL flexible server: - -- Use the following documentation as guidance for the available configurations: [PostgreSQL Server Configurations](https://learn.microsoft.com/en-us/azure/postgresql/single-server/how-to-configure-server-parameters-using-cli). - -

- -Parameter JSON format - -```json -"configurations": { - // Example showing all available fields - "value": [ - { - "name": "log_min_messages", // Name of the configuration - "source": "user-override", // user-override, dynamic, system-default - "value": "INFO" // Value of the configuration - } - ] -} -``` - -
- -
- -Bicep format - -```bicep -configurations: [ - // Example showing all available fields - { - name: 'log_min_messages' // Name of the configuration - source: 'user-override' // user-override, dynamic, system-default - value: 'INFO' // Value of the configuration - } -] -``` - -
-

- -### Parameter Usage: `databases` - -To create databases on the PostgreSQL flexible server: - -

- -Parameter JSON format - -```json -"databases": { - // Example showing all available fields - "value": [ - { - "name": "testdb1", // Name of the database - "collation": "en_US.utf8", // Collation of the database - "charset": "UTF8" // Character set of the database - }, - { - "name": "testdb2" // Name of the database only which implements the default collation and charset - } - ] -} -``` - -
- -
- -Bicep format - -```bicep -databases: [ - // Example showing all available fields - { - name: 'testdb1' // Name of the database - collation: 'en_US.utf8' // Collation of the database - charset: 'UTF8' // Character set of the database - } - { - name: 'testdb2' // Name of the database only which implements the default collation and charset - } -] -``` - -
-

- ### Parameter Usage: `userAssignedIdentities` You can specify multiple user assigned identities to a resource by providing additional resource IDs using the following format: @@ -806,3 +664,149 @@ module flexibleServer './db-for-postgre-sql/flexible-server/main.bicep' = {

+ + +## Notes + +### Parameter Usage: `firewallRules` + +To enable firewall rules on the PostgreSQL flexible server: + +- Used when the desired connectivity mode is "Public Access" only. + +

+ +Parameter JSON format + +```json +"firewallRules": { + // Example showing all available fields + "value": [ + { + "name": "AllowAllWindowsAzureIps", //Use this rule to allow Trusted Azure services to access the server + "endIpAddress": "0.0.0.0", + "startIpAddress": "0.0.0.0" + }, + { + "name": "test-rule1", + "startIpAddress": "10.10.10.1", //Start IP address for the firewall rule. Must be IPv4 format + "endIpAddress": "10.10.10.10" //End IP address for the firewall rule. Must be IPv4 format + } + ] +} +``` + +
+ +
+ +Bicep format + +```bicep +firewallRules: [ + // Example showing all available fields + { + name: 'AllowAllWindowsAzureIps', //Use this rule to allow Trusted Azure services to access the server + endIpAddress: '0.0.0.0' + startIpAddress: '0.0.0.0' + } + { + name: "test-rule1", + startIpAddress: '10.10.10.1' //Start IP address for the firewall rule. Must be IPv4 format + endIpAddress: '10.10.10.10' //End IP address for the firewall rule. Must be IPv4 format + } +] +``` + +
+

+ +### Parameter Usage: `configurations` + +To override default server configurations on the PostgreSQL flexible server: + +- Use the following documentation as guidance for the available configurations: [PostgreSQL Server Configurations](https://learn.microsoft.com/en-us/azure/postgresql/single-server/how-to-configure-server-parameters-using-cli). + +

+ +Parameter JSON format + +```json +"configurations": { + // Example showing all available fields + "value": [ + { + "name": "log_min_messages", // Name of the configuration + "source": "user-override", // user-override, dynamic, system-default + "value": "INFO" // Value of the configuration + } + ] +} +``` + +
+ +
+ +Bicep format + +```bicep +configurations: [ + // Example showing all available fields + { + name: 'log_min_messages' // Name of the configuration + source: 'user-override' // user-override, dynamic, system-default + value: 'INFO' // Value of the configuration + } +] +``` + +
+

+ +### Parameter Usage: `databases` + +To create databases on the PostgreSQL flexible server: + +

+ +Parameter JSON format + +```json +"databases": { + // Example showing all available fields + "value": [ + { + "name": "testdb1", // Name of the database + "collation": "en_US.utf8", // Collation of the database + "charset": "UTF8" // Character set of the database + }, + { + "name": "testdb2" // Name of the database only which implements the default collation and charset + } + ] +} +``` + +
+ +
+ +Bicep format + +```bicep +databases: [ + // Example showing all available fields + { + name: 'testdb1' // Name of the database + collation: 'en_US.utf8' // Collation of the database + charset: 'UTF8' // Character set of the database + } + { + name: 'testdb2' // Name of the database only which implements the default collation and charset + } +] +``` + +
+

From c494586376a8488b04ee7da5eb0fad2d940d8862 Mon Sep 17 00:00:00 2001 From: Ahmad Abdalla <28486158+ahmadabdalla@users.noreply.github.com> Date: Fri, 13 Oct 2023 12:48:56 +1100 Subject: [PATCH 4/4] Updated based on feedback --- modules/container-registry/registry/README.md | 39 ----- .../managed-cluster/README.md | 94 ----------- .../.test/public/main.test.bicep | 4 - .../flexible-server/README.md | 147 ------------------ 4 files changed, 284 deletions(-) diff --git a/modules/container-registry/registry/README.md b/modules/container-registry/registry/README.md index 47197bd3ff..e18522cf96 100644 --- a/modules/container-registry/registry/README.md +++ b/modules/container-registry/registry/README.md @@ -9,7 +9,6 @@ This module deploys an Azure Container Registry (ACR). - [Outputs](#Outputs) - [Cross-referenced modules](#Cross-referenced-modules) - [Deployment examples](#Deployment-examples) -- [Notes](#Notes) ## Resource types @@ -805,41 +804,3 @@ module registry './container-registry/registry/main.bicep' = {

- - -## Notes - -### Parameter Usage: `imageRegistryCredentials` - -The image registry credentials by which the container group is created from. - -

- -Parameter JSON format - -```json -"acrName": { - "value": { - "server": "acrx001", - } -}, -"acrAdminUserEnabled": { - "value": false -} -``` - -
- -
- -Bicep format - -```bicep -acrName: { - server: 'acrx001' -} -acrAdminUserEnabled: false -``` - -
-

diff --git a/modules/container-service/managed-cluster/README.md b/modules/container-service/managed-cluster/README.md index 84750942fc..1e231622d5 100644 --- a/modules/container-service/managed-cluster/README.md +++ b/modules/container-service/managed-cluster/README.md @@ -1329,100 +1329,6 @@ module managedCluster './container-service/managed-cluster/main.bicep' = { ## Notes -### Parameter Usage: `primaryAgentPoolProfile` - -Provide values for primary agent pool as needed. -For available properties check - -

- -Parameter JSON format - -```json -"primaryAgentPoolProfile": { - "value": [ - { - "name": "poolname", - "vmSize": "Standard_DS3_v2", - "osDiskSizeGB": 128, - "count": 2, - "osType": "Linux", - "maxCount": 5, - "minCount": 1, - "enableAutoScaling": true, - "scaleSetPriority": "Regular", - "scaleSetEvictionPolicy": "Delete", - "nodeLabels": {}, - "nodeTaints": [ - "CriticalAddonsOnly=true:NoSchedule" - ], - "type": "VirtualMachineScaleSets", - "availabilityZones": [ - "1", - "2", - "3" - ], - "maxPods": 30, - "storageProfile": "ManagedDisks", - "mode": "System", - "vnetSubnetID": "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet", - "tags": { - "Owner": "test.user@testcompany.com", - "BusinessUnit": "IaCs", - "Environment": "PROD", - "Region": "USEast" - } - } - ] -} -``` - -
- -
- -Bicep format - -```bicep -primaryAgentPoolProfile: [ - { - name: 'poolname' - vmSize: 'Standard_DS3_v2' - osDiskSizeGB: 128 - count: 2 - osType: 'Linux' - maxCount: 5 - minCount: 1 - enableAutoScaling: true - scaleSetPriority: 'Regular' - scaleSetEvictionPolicy: 'Delete' - nodeLabels: {} - nodeTaints: [ - 'CriticalAddonsOnly=true:NoSchedule' - ] - type: 'VirtualMachineScaleSets' - availabilityZones: [ - '1' - '2' - '3' - ] - maxPods: 30 - storageProfile: 'ManagedDisks' - mode: 'System' - vnetSubnetID: '/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet' - tags: { - Owner: 'test.user@testcompany.com' - BusinessUnit: 'IaCs' - Environment: 'PROD' - Region: 'USEast' - } - } -] -``` - -
-

- ### Parameter Usage: `httpProxyConfig` Configurations for provisioning the cluster with HTTP proxy servers. You can specify in the following format: diff --git a/modules/db-for-postgre-sql/flexible-server/.test/public/main.test.bicep b/modules/db-for-postgre-sql/flexible-server/.test/public/main.test.bicep index 5fd5a4da99..93fdbb9416 100644 --- a/modules/db-for-postgre-sql/flexible-server/.test/public/main.test.bicep +++ b/modules/db-for-postgre-sql/flexible-server/.test/public/main.test.bicep @@ -14,10 +14,6 @@ param location string = deployment().location @description('Optional. A short identifier for the kind of deployment. Should be kept short to not run into resource-name length-constraints.') param serviceShort string = 'dfpsfsp' -@description('Optional. The password to leverage for the login.') -@secure() -param password string = newGuid() - @description('Generated. Used as a basis for unique resource names.') param baseTime string = utcNow('u') diff --git a/modules/db-for-postgre-sql/flexible-server/README.md b/modules/db-for-postgre-sql/flexible-server/README.md index 6e2318ca72..e4d2eb18d5 100644 --- a/modules/db-for-postgre-sql/flexible-server/README.md +++ b/modules/db-for-postgre-sql/flexible-server/README.md @@ -9,7 +9,6 @@ This module deploys a DBforPostgreSQL Flexible Server. - [Outputs](#Outputs) - [Cross-referenced modules](#Cross-referenced-modules) - [Deployment examples](#Deployment-examples) -- [Notes](#Notes) ## Resource Types @@ -664,149 +663,3 @@ module flexibleServer './db-for-postgre-sql/flexible-server/main.bicep' = {

- - -## Notes - -### Parameter Usage: `firewallRules` - -To enable firewall rules on the PostgreSQL flexible server: - -- Used when the desired connectivity mode is "Public Access" only. - -

- -Parameter JSON format - -```json -"firewallRules": { - // Example showing all available fields - "value": [ - { - "name": "AllowAllWindowsAzureIps", //Use this rule to allow Trusted Azure services to access the server - "endIpAddress": "0.0.0.0", - "startIpAddress": "0.0.0.0" - }, - { - "name": "test-rule1", - "startIpAddress": "10.10.10.1", //Start IP address for the firewall rule. Must be IPv4 format - "endIpAddress": "10.10.10.10" //End IP address for the firewall rule. Must be IPv4 format - } - ] -} -``` - -
- -
- -Bicep format - -```bicep -firewallRules: [ - // Example showing all available fields - { - name: 'AllowAllWindowsAzureIps', //Use this rule to allow Trusted Azure services to access the server - endIpAddress: '0.0.0.0' - startIpAddress: '0.0.0.0' - } - { - name: "test-rule1", - startIpAddress: '10.10.10.1' //Start IP address for the firewall rule. Must be IPv4 format - endIpAddress: '10.10.10.10' //End IP address for the firewall rule. Must be IPv4 format - } -] -``` - -
-

- -### Parameter Usage: `configurations` - -To override default server configurations on the PostgreSQL flexible server: - -- Use the following documentation as guidance for the available configurations: [PostgreSQL Server Configurations](https://learn.microsoft.com/en-us/azure/postgresql/single-server/how-to-configure-server-parameters-using-cli). - -

- -Parameter JSON format - -```json -"configurations": { - // Example showing all available fields - "value": [ - { - "name": "log_min_messages", // Name of the configuration - "source": "user-override", // user-override, dynamic, system-default - "value": "INFO" // Value of the configuration - } - ] -} -``` - -
- -
- -Bicep format - -```bicep -configurations: [ - // Example showing all available fields - { - name: 'log_min_messages' // Name of the configuration - source: 'user-override' // user-override, dynamic, system-default - value: 'INFO' // Value of the configuration - } -] -``` - -
-

- -### Parameter Usage: `databases` - -To create databases on the PostgreSQL flexible server: - -

- -Parameter JSON format - -```json -"databases": { - // Example showing all available fields - "value": [ - { - "name": "testdb1", // Name of the database - "collation": "en_US.utf8", // Collation of the database - "charset": "UTF8" // Character set of the database - }, - { - "name": "testdb2" // Name of the database only which implements the default collation and charset - } - ] -} -``` - -
- -
- -Bicep format - -```bicep -databases: [ - // Example showing all available fields - { - name: 'testdb1' // Name of the database - collation: 'en_US.utf8' // Collation of the database - charset: 'UTF8' // Character set of the database - } - { - name: 'testdb2' // Name of the database only which implements the default collation and charset - } -] -``` - -
-