Skip to content

Commit

Permalink
feat: create examples in documentation (#2314)
Browse files Browse the repository at this point in the history 
## Description

Examples from metadata examples are now rendered to the documentation.

Fixes #1280 

## Pipeline Reference

<!-- Insert your Pipeline Status Badge below -->

| Pipeline |
| -------- |
|          |

[![avm.ptn.authorization.policy-assignment](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.ptn.authorization.policy-assignment.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.ptn.authorization.policy-assignment.yml)

[![avm.ptn.authorization.resource-role-assignment](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.ptn.authorization.resource-role-assignment.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.ptn.authorization.resource-role-assignment.yml)

[![avm.ptn.authorization.role-assignment](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.ptn.authorization.role-assignment.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.ptn.authorization.role-assignment.yml)

[![avm.ptn.deployment-script.import-image-to-acr](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.ptn.deployment-script.import-image-to-acr.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.ptn.deployment-script.import-image-to-acr.yml)

[![avm.ptn.finops-toolkit.finops-hub](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.ptn.finops-toolkit.finops-hub.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.ptn.finops-toolkit.finops-hub.yml)

[![avm.ptn.lz.sub-vending](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.ptn.lz.sub-vending.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.ptn.lz.sub-vending.yml)

[![avm.ptn.policy-insights.remediation](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.ptn.policy-insights.remediation.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.ptn.policy-insights.remediation.yml)

[![avm.ptn.security.security-center](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.ptn.security.security-center.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.ptn.security.security-center.yml)

[![avm.res.aad.domain-service](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.aad.domain-service.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.aad.domain-service.yml)

[![avm.res.alerts-management.action-rule](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.alerts-management.action-rule.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.alerts-management.action-rule.yml)

[![avm.res.analysis-services.server](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.analysis-services.server.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.analysis-services.server.yml)

[![avm.res.api-management.service](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.api-management.service.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.api-management.service.yml)

[![avm.res.app-configuration.configuration-store](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.app-configuration.configuration-store.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.app-configuration.configuration-store.yml)

[![avm.res.app.container-app](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.app.container-app.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.app.container-app.yml)

[![avm.res.app.job](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.app.job.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.app.job.yml)

[![avm.res.app.managed-environment](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.app.managed-environment.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.app.managed-environment.yml)

[![avm.res.automation.automation-account](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.automation.automation-account.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.automation.automation-account.yml)

[![avm.res.batch.batch-account](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.batch.batch-account.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.batch.batch-account.yml)

[![avm.res.cache.redis](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.cache.redis.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.cache.redis.yml)

[![avm.res.cdn.profile](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.cdn.profile.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.cdn.profile.yml)

[![avm.res.cognitive-services.account](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.cognitive-services.account.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.cognitive-services.account.yml)

[![avm.res.communication.communication-service](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.communication.communication-service.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.communication.communication-service.yml)

[![avm.res.communication.email-service](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.communication.email-service.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.communication.email-service.yml)

[![avm.res.compute.availability-set](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.compute.availability-set.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.compute.availability-set.yml)

[![avm.res.compute.disk-encryption-set](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.compute.disk-encryption-set.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.compute.disk-encryption-set.yml)

[![avm.res.compute.disk](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.compute.disk.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.compute.disk.yml)

[![avm.res.compute.gallery](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.compute.gallery.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.compute.gallery.yml)

[![avm.res.compute.image](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.compute.image.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.compute.image.yml)

[![avm.res.compute.proximity-placement-group](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.compute.proximity-placement-group.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.compute.proximity-placement-group.yml)

[![avm.res.compute.ssh-public-key](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.compute.ssh-public-key.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.compute.ssh-public-key.yml)

[![avm.res.compute.virtual-machine-scale-set](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.compute.virtual-machine-scale-set.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.compute.virtual-machine-scale-set.yml)

[![avm.res.compute.virtual-machine](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.compute.virtual-machine.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.compute.virtual-machine.yml)

[![avm.res.consumption.budget](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.consumption.budget.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.consumption.budget.yml)

[![avm.res.container-instance.container-group](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.container-instance.container-group.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.container-instance.container-group.yml)

[![avm.res.container-registry.registry](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.container-registry.registry.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.container-registry.registry.yml)

[![avm.res.container-service.managed-cluster](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.container-service.managed-cluster.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.container-service.managed-cluster.yml)

[![avm.res.data-factory.factory](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.data-factory.factory.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.data-factory.factory.yml)

[![avm.res.data-protection.backup-vault](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.data-protection.backup-vault.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.data-protection.backup-vault.yml)

[![avm.res.databricks.access-connector](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.databricks.access-connector.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.databricks.access-connector.yml)

[![avm.res.databricks.workspace](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.databricks.workspace.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.databricks.workspace.yml)

[![avm.res.db-for-my-sql.flexible-server](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.db-for-my-sql.flexible-server.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.db-for-my-sql.flexible-server.yml)

[![avm.res.db-for-postgre-sql.flexible-server](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.db-for-postgre-sql.flexible-server.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.db-for-postgre-sql.flexible-server.yml)

[![avm.res.desktop-virtualization.application-group](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.desktop-virtualization.application-group.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.desktop-virtualization.application-group.yml)

[![avm.res.desktop-virtualization.host-pool](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.desktop-virtualization.host-pool.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.desktop-virtualization.host-pool.yml)

[![avm.res.desktop-virtualization.scaling-plan](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.desktop-virtualization.scaling-plan.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.desktop-virtualization.scaling-plan.yml)

[![avm.res.desktop-virtualization.workspace](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.desktop-virtualization.workspace.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.desktop-virtualization.workspace.yml)

[![avm.res.dev-test-lab.lab](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.dev-test-lab.lab.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.dev-test-lab.lab.yml)

[![avm.res.digital-twins.digital-twins-instance](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.digital-twins.digital-twins-instance.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.digital-twins.digital-twins-instance.yml)

[![avm.res.document-db.database-account](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.document-db.database-account.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.document-db.database-account.yml)

[![avm.res.event-grid.domain](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.event-grid.domain.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.event-grid.domain.yml)

[![avm.res.event-grid.namespace](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.event-grid.namespace.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.event-grid.namespace.yml)

[![avm.res.event-grid.system-topic](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.event-grid.system-topic.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.event-grid.system-topic.yml)

[![avm.res.event-grid.topic](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.event-grid.topic.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.event-grid.topic.yml)

[![avm.res.event-hub.namespace](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.event-hub.namespace.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.event-hub.namespace.yml)

[![avm.res.health-bot.health-bot](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.health-bot.health-bot.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.health-bot.health-bot.yml)

[![avm.res.healthcare-apis.workspace](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.healthcare-apis.workspace.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.healthcare-apis.workspace.yml)

[![avm.res.insights.action-group](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.insights.action-group.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.insights.action-group.yml)

[![avm.res.insights.activity-log-alert](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.insights.activity-log-alert.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.insights.activity-log-alert.yml)

[![avm.res.insights.component](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.insights.component.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.insights.component.yml)

[![avm.res.insights.data-collection-endpoint](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.insights.data-collection-endpoint.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.insights.data-collection-endpoint.yml)

[![avm.res.insights.data-collection-rule](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.insights.data-collection-rule.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.insights.data-collection-rule.yml)

[![avm.res.insights.diagnostic-setting](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.insights.diagnostic-setting.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.insights.diagnostic-setting.yml)

[![avm.res.insights.metric-alert](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.insights.metric-alert.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.insights.metric-alert.yml)

[![avm.res.insights.private-link-scope](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.insights.private-link-scope.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.insights.private-link-scope.yml)

[![avm.res.insights.scheduled-query-rule](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.insights.scheduled-query-rule.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.insights.scheduled-query-rule.yml)

[![avm.res.insights.webtest](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.insights.webtest.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.insights.webtest.yml)

[![avm.res.key-vault.vault](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.key-vault.vault.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.key-vault.vault.yml)

[![avm.res.kubernetes-configuration.extension](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.kubernetes-configuration.extension.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.kubernetes-configuration.extension.yml)

[![avm.res.kubernetes-configuration.flux-configuration](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.kubernetes-configuration.flux-configuration.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.kubernetes-configuration.flux-configuration.yml)

[![avm.res.load-test-service.load-test](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.load-test-service.load-test.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.load-test-service.load-test.yml)

[![avm.res.logic.workflow](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.logic.workflow.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.logic.workflow.yml)

[![avm.res.machine-learning-services.workspace](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.machine-learning-services.workspace.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.machine-learning-services.workspace.yml)

[![avm.res.maintenance.maintenance-configuration](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.maintenance.maintenance-configuration.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.maintenance.maintenance-configuration.yml)

[![avm.res.managed-identity.user-assigned-identity](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.managed-identity.user-assigned-identity.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.managed-identity.user-assigned-identity.yml)

[![avm.res.managed-services.registration-definition](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.managed-services.registration-definition.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.managed-services.registration-definition.yml)

[![avm.res.management.management-group](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.management.management-group.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.management.management-group.yml)

[![avm.res.net-app.net-app-account](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.net-app.net-app-account.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.net-app.net-app-account.yml)

[![avm.res.network.application-gateway-web-application-firewall-policy](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.application-gateway-web-application-firewall-policy.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.application-gateway-web-application-firewall-policy.yml)

[![avm.res.network.application-gateway](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.application-gateway.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.application-gateway.yml)

[![avm.res.network.application-security-group](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.application-security-group.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.application-security-group.yml)

[![avm.res.network.azure-firewall](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.azure-firewall.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.azure-firewall.yml)

[![avm.res.network.bastion-host](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.bastion-host.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.bastion-host.yml)

[![avm.res.network.connection](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.connection.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.connection.yml)

[![avm.res.network.ddos-protection-plan](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.ddos-protection-plan.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.ddos-protection-plan.yml)

[![avm.res.network.dns-forwarding-ruleset](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.dns-forwarding-ruleset.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.dns-forwarding-ruleset.yml)

[![avm.res.network.dns-resolver](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.dns-resolver.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.dns-resolver.yml)

[![avm.res.network.dns-zone](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.dns-zone.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.dns-zone.yml)

[![avm.res.network.express-route-circuit](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.express-route-circuit.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.express-route-circuit.yml)

[![avm.res.network.express-route-gateway](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.express-route-gateway.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.express-route-gateway.yml)

[![avm.res.network.firewall-policy](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.firewall-policy.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.firewall-policy.yml)

[![avm.res.network.front-door-web-application-firewall-policy](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.front-door-web-application-firewall-policy.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.front-door-web-application-firewall-policy.yml)

[![avm.res.network.front-door](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.front-door.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.front-door.yml)

[![avm.res.network.ip-group](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.ip-group.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.ip-group.yml)

[![avm.res.network.load-balancer](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.load-balancer.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.load-balancer.yml)

[![avm.res.network.local-network-gateway](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.local-network-gateway.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.local-network-gateway.yml)

[![avm.res.network.nat-gateway](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.nat-gateway.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.nat-gateway.yml)

[![avm.res.network.network-interface](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.network-interface.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.network-interface.yml)

[![avm.res.network.network-manager](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.network-manager.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.network-manager.yml)

[![avm.res.network.network-security-group](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.network-security-group.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.network-security-group.yml)

[![avm.res.network.network-watcher](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.network-watcher.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.network-watcher.yml)

[![avm.res.network.private-dns-zone](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.private-dns-zone.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.private-dns-zone.yml)

[![avm.res.network.private-endpoint](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.private-endpoint.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.private-endpoint.yml)

[![avm.res.network.private-link-service](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.private-link-service.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.private-link-service.yml)

[![avm.res.network.public-ip-address](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.public-ip-address.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.public-ip-address.yml)

[![avm.res.network.public-ip-prefix](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.public-ip-prefix.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.public-ip-prefix.yml)

[![avm.res.network.route-table](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.route-table.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.route-table.yml)

[![avm.res.network.service-endpoint-policy](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.service-endpoint-policy.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.service-endpoint-policy.yml)

[![avm.res.network.trafficmanagerprofile](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.trafficmanagerprofile.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.trafficmanagerprofile.yml)

[![avm.res.network.virtual-hub](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.virtual-hub.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.virtual-hub.yml)

[![avm.res.network.virtual-network-gateway](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.virtual-network-gateway.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.virtual-network-gateway.yml)

[![avm.res.network.virtual-network](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.virtual-network.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.virtual-network.yml)

[![avm.res.network.virtual-wan](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.virtual-wan.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.virtual-wan.yml)

[![avm.res.network.vpn-gateway](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.vpn-gateway.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.vpn-gateway.yml)

[![avm.res.network.vpn-site](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.vpn-site.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.network.vpn-site.yml)

[![avm.res.operational-insights.workspace](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.operational-insights.workspace.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.operational-insights.workspace.yml)

[![avm.res.operations-management.solution](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.operations-management.solution.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.operations-management.solution.yml)

[![avm.res.power-bi-dedicated.capacity](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.power-bi-dedicated.capacity.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.power-bi-dedicated.capacity.yml)

[![avm.res.purview.account](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.purview.account.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.purview.account.yml)

[![avm.res.recovery-services.vault](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.recovery-services.vault.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.recovery-services.vault.yml)

[![avm.res.relay.namespace](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.relay.namespace.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.relay.namespace.yml)

[![avm.res.resource-graph.query](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.resource-graph.query.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.resource-graph.query.yml)

[![avm.res.resources.deployment-script](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.resources.deployment-script.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.resources.deployment-script.yml)

[![avm.res.resources.resource-group](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.resources.resource-group.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.resources.resource-group.yml)

[![avm.res.search.search-service](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.search.search-service.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.search.search-service.yml)

[![avm.res.service-bus.namespace](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.service-bus.namespace.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.service-bus.namespace.yml)

[![avm.res.service-fabric.cluster](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.service-fabric.cluster.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.service-fabric.cluster.yml)

[![avm.res.signal-r-service.signal-r](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.signal-r-service.signal-r.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.signal-r-service.signal-r.yml)

[![avm.res.signal-r-service.web-pub-sub](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.signal-r-service.web-pub-sub.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.signal-r-service.web-pub-sub.yml)

[![avm.res.sql.instance-pool](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.sql.instance-pool.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.sql.instance-pool.yml)

[![avm.res.sql.managed-instance](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.sql.managed-instance.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.sql.managed-instance.yml)

[![avm.res.sql.server](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.sql.server.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.sql.server.yml)

[![avm.res.storage.storage-account](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.storage.storage-account.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.storage.storage-account.yml)

[![avm.res.synapse.private-link-hub](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.synapse.private-link-hub.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.synapse.private-link-hub.yml)

[![avm.res.synapse.workspace](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.synapse.workspace.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.synapse.workspace.yml)

[![avm.res.virtual-machine-images.image-template](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.virtual-machine-images.image-template.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.virtual-machine-images.image-template.yml)

[![avm.res.web.connection](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.web.connection.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.web.connection.yml)

[![avm.res.web.hosting-environment](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.web.hosting-environment.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.web.hosting-environment.yml)

[![avm.res.web.serverfarm](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.web.serverfarm.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.web.serverfarm.yml)

[![avm.res.web.site](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.web.site.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.web.site.yml)

[![avm.res.web.static-site](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.web.static-site.yml/badge.svg?branch=examples-in-documentation&event=workflow_dispatch)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.web.static-site.yml)

Some actions are expected to fail, as <del>this PR addes output to the
readme.md files (the examples definied in the bicep files). Or
</del>they are not yet WAF complient and therefore complaining.

## Type of Change

- [x] Update to CI Environment or utilities (Non-module affecting
changes)
- [ ] Azure Verified Module updates:
- [ ] Bugfix containing backwards-compatible bug fixes, and I have NOT
bumped the MAJOR or MINOR version in `version.json`:
- [ ] Someone has opened a bug report issue, and I have included "Closes
#{bug_report_issue_number}" in the PR description.
- [ ] The bug was found by the module author, and no one has opened an
issue to report it yet.
- [ ] Feature update backwards compatible feature updates, and I have
bumped the MINOR version in `version.json`.
- [ ] Breaking changes and I have bumped the MAJOR version in
`version.json`.
  - [x] Update to documentation

## Checklist

- [x] I'm sure there are no other open Pull Requests for the same
update/change
- [x] I have run `Set-AVMModule` locally to generate the supporting
module files.
- [x] My corresponding pipelines / checks run clean and green without
any errors or warnings

---------

Co-authored-by: Erika Gressi <[email protected]>
  • Loading branch information
@ReneHezser @eriqua
ReneHezser and eriqua authored Jun 21, 2024
1 parent 33eb4d1 commit b9e998a
Show file tree
Hide file tree
Showing 4 changed files with 192 additions and 1 deletion.
18 changes: 18 additions & 0 deletions avm/res/aad/domain-service/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,11 @@ The domain name specific to the Azure ADDS service.

- Required: Yes
- Type: string
- Example:
```Bicep
- 'contoso.onmicrosoft.com'
- 'aaddscontoso.com'
```

### Parameter: `pfxCertificate`

Expand All @@ -260,6 +265,11 @@ The email recipient value to receive alerts.
- Required: No
- Type: array
- Default: `[]`
- Example:
```Bicep
- ['[email protected]']
- ['[email protected]','[email protected]']
```

### Parameter: `diagnosticSettings`

Expand Down Expand Up @@ -629,6 +639,7 @@ The id of the subnet that Domain Services will be deployed on. The subnet has so

- Required: Yes
- Type: string
- Example: `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/<resourceGroup>/providers/Microsoft.Network/virtualNetworks/<vnetName>/subnets/<subnetName>`

### Parameter: `roleAssignments`

Expand Down Expand Up @@ -771,6 +782,13 @@ Tags of the resource.

- Required: No
- Type: object
- Example:
```Bicep
{
"key1": "value1",
"key2": "value2"
}
```

### Parameter: `tlsV1`

Expand Down
141 changes: 141 additions & 0 deletions avm/res/app/job/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -943,13 +943,24 @@ The CPU limit of the container in cores.

- Required: Yes
- Type: string
- Example:
```Bicep
'0.25'
'1'
```

### Parameter: `containers.resources.memory`

The required memory.

- Required: Yes
- Type: string
- Example:
```Bicep
'250Mb'
'1.5Gi'
'1500Mi'
```

### Parameter: `containers.volumeMounts`

Expand Down Expand Up @@ -1084,6 +1095,24 @@ Scaling rules for the job.

- Required: Yes
- Type: array
- Example:
```Bicep
[
// for type azure-queue
{
name: 'myrule'
type: 'azure-queue'
metadata: {
queueName: 'default'
storageAccountResourceId: '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount'
}
auth: {
secretRef: 'mysecret'
triggerParameter: 'queueName'
}
}
]
```

**Required parameters**

Expand Down Expand Up @@ -1140,13 +1169,29 @@ Metadata properties to describe the scale rule.

- Required: Yes
- Type: object
- Example:
```Bicep
{
"// for type azure-queue
{
queueName: 'default'
storageAccountResourceId: '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount'
}"
}
```

### Parameter: `eventTriggerConfig.scale.rules.type`

The type of the rule.

- Required: Yes
- Type: string
- Example:
```Bicep
"azure-servicebus"
"azure-queue"
"redis"
```

### Parameter: `eventTriggerConfig.parallelism`

Expand Down Expand Up @@ -1216,6 +1261,11 @@ Cron formatted repeating schedule ("* * * * *") of a Cron Job. It supports the s

- Required: Yes
- Type: string
- Example:
```Bicep
'* * * * *' // Every minute, every hour, every day
'0 0 * * *' // at 00:00 UTC every day
```

### Parameter: `scheduleTriggerConfig.parallelism`

Expand Down Expand Up @@ -1302,13 +1352,24 @@ The CPU limit of the container in cores.

- Required: Yes
- Type: string
- Example:
```Bicep
'0.25'
'1'
```

### Parameter: `initContainers.resources.memory`

The required memory.

- Required: Yes
- Type: string
- Example:
```Bicep
'250Mb'
'1.5Gi'
'1500Mi'
```

### Parameter: `initContainers.args`

Expand All @@ -1330,6 +1391,19 @@ The environment variables to set in the container.

- Required: No
- Type: array
- Example:
```Bicep
[
{
name: 'AZURE_STORAGE_QUEUE_NAME'
value: '<storage-queue-name>'
}
{
name: 'AZURE_STORAGE_CONNECTION_STRING'
secretRef: 'connection-string'
}
]
```

**Required parameters**

Expand Down Expand Up @@ -1456,6 +1530,18 @@ The managed identity definition for this resource.

- Required: No
- Type: object
- Example:
```Bicep
{
systemAssigned: true,
userAssignedResourceIds: [
'/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myManagedIdentity'
]
}
{
systemAssigned: true
}
```

**Optional parameters**

Expand Down Expand Up @@ -1484,6 +1570,24 @@ Collection of private container registry credentials for containers used by the

- Required: No
- Type: array
- Example:
```Bicep
[
{
server: 'myregistry.azurecr.io'
identity: '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myManagedIdentity'
}
{
server: 'myregistry2.azurecr.io'
identity: 'system'
}
{
server: 'myregistry3.azurecr.io'
username: 'myusername'
passwordSecretRef: 'secret-name'
}
]
```

**Required parameters**

Expand All @@ -1510,6 +1614,7 @@ The FQDN name of the container registry.

- Required: Yes
- Type: string
- Example: `myregistry.azurecr.io`

### Parameter: `registries.passwordSecretRef`

Expand All @@ -1524,6 +1629,11 @@ The resource ID of the (user) managed identity, which is used to access the Azur

- Required: No
- Type: string
- Example:
```Bicep
user-assigned identity: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myManagedIdentity
system-assigned identity: system
```

### Parameter: `registries.username`

Expand Down Expand Up @@ -1643,6 +1753,29 @@ The secrets of the Container App.

- Required: No
- Type: array
- Example:
```Bicep
[
{
name: 'mysecret'
identity: '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myManagedIdentity'
keyVaultUrl: 'https://myvault${environment().suffixes.keyvaultDns}/secrets/mysecret'
}
{
name: 'mysecret'
identity: 'system'
keyVaultUrl: 'https://myvault${environment().suffixes.keyvaultDns}/secrets/mysecret'
}
{
name: 'mysecret'
value: 'mysecretvalue'
}
{
name: 'connection-string'
value: listKeys('/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount', '2023-04-01').keys[0].value
}
]
```

**Conditional parameters**

Expand All @@ -1664,6 +1797,7 @@ Azure Key Vault URL pointing to the secret referenced by the Container App Job.

- Required: No
- Type: string
- Example: `https://myvault${environment().suffixes.keyvaultDns}/secrets/mysecret`

### Parameter: `secrets.value`

Expand Down Expand Up @@ -1692,6 +1826,13 @@ Tags of the resource.

- Required: No
- Type: object
- Example:
```Bicep
{
key1: 'value1'
key2: 'value2'
}
```

### Parameter: `volumes`

Expand Down
7 changes: 7 additions & 0 deletions avm/res/web/serverfarm/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -417,6 +417,13 @@ The name of the SKU will Determine the tier, size, family of the App Service Pla

- Required: Yes
- Type: string
- Example:
```Bicep
'F1'
'B1'
'P1v3'
'I1v2'
```

### Parameter: `reserved`

Expand Down
27 changes: 26 additions & 1 deletion avm/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -330,6 +330,7 @@ function Set-DefinitionSection {

$isRequired = (Get-IsParameterRequired -TemplateFileContent $TemplateFileContent -Parameter $parameter) ? 'Yes' : 'No'
$description = $parameter.ContainsKey('metadata') ? $parameter['metadata']['description'].substring("$category. ".Length).Replace("`n- ", '<li>').Replace("`r`n", '<p>').Replace("`n", '<p>') : $null
$example = ($parameter.ContainsKey('metadata') -and $parameter['metadata'].ContainsKey('example')) ? $parameter['metadata']['example'] : $null

#####################
# Table content #
Expand Down Expand Up @@ -412,6 +413,29 @@ function Set-DefinitionSection {
$formattedAllowedValues = $null
}

# Format example
# ==============
if (-not [String]::IsNullOrEmpty($example)) {
# allign content to the left by removing trailing whitespaces
$leadingSpacesToTrim = ($example -match '^(\s+).+') ? $matches[1].Length : 0
$exampleLines = $example -split '\n'
# Removing excess leading spaces
$example = ($exampleLines | Where-Object { -not [String]::IsNullOrEmpty($_) } | ForEach-Object { " $_" -replace "^\s{$leadingSpacesToTrim}" } | Out-String).TrimEnd()

if ($exampleLines.count -eq 1) {
$formattedExample = '- Example: `{0}`' -f $example.TrimStart()
} else {
$formattedExample = @(
'- Example:',
' ```Bicep',
$example,
' ```'
)
}
} else {
$formattedExample = $null
}

# Build list item
# ===============
$listSectionContent += @(
Expand All @@ -422,7 +446,8 @@ function Set-DefinitionSection {
('- Required: {0}' -f $isRequired),
('- Type: {0}' -f $type),
((-not [String]::IsNullOrEmpty($formattedDefaultValue)) ? $formattedDefaultValue : $null),
((-not [String]::IsNullOrEmpty($formattedAllowedValues)) ? $formattedAllowedValues : $null)
((-not [String]::IsNullOrEmpty($formattedAllowedValues)) ? $formattedAllowedValues : $null),
((-not [String]::IsNullOrEmpty($formattedExample)) ? $formattedExample : $null)
''
) | Where-Object { $null -ne $_ }

Expand Down

0 comments on commit b9e998a

Please sign in to comment.