# osdu-bicep

**Repository Path**: mirrors_Azure/osdu-bicep

## Basic Information

- **Project Name**: osdu-bicep
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-10-24
- **Last Updated**: 2026-03-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OSDU Bicep

This project is used to host Bicep infrastructure that can be used in deploying OSDU on Azure.

## Project Principals

The guiding principal we have with this project is to focus on the the _downstream use_ of the project (see [releases](https://github.com/azure/osdu-bicep/releases)) The goal is to work on infrastructure in a manner that other components can consume infrastructure as code. As such, these are our specific practices.

1. Deploy all components through a single, modular, idempotent bicep template Converge on a single bicep template, which can easily be consumed
2. Provide best-practice defaults, then use parameters for flagging on additional options.
3. Minimize "manual" steps for ease of automation
4. Maintain quality through validation & CI/CD pipelines

## Modules

Below is a table containing all published modules. Each version badge shows the latest version of the corresponding module.

<!-- Begin Module Table -->

| Module                         |                                                                                                                                                           Version |                                                                                                                                                                                                                              Docs |
| :----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| `public/app-configuration`     |     <a href="https://github.com/azure/osdu-bicep/releases/tag/public/app-configuration/1.0.4"><image src="https://img.shields.io/badge/osdubicep-1.0.4-blue"></a> |         [🦾 Code](https://github.com/azure/osdu-bicep/blob/main/bicep/modules/public/app-configuration/main.bicep) ｜ [📃 Readme](https://github.com/azure/osdu-bicep/blob/main/bicep/modules/public/app-configuration/README.md) |
| `public/azure-keyvault`        |        <a href="https://github.com/azure/osdu-bicep/releases/tag/public/azure-keyvault/1.0.6"><image src="https://img.shields.io/badge/osdubicep-1.0.6-blue"></a> |               [🦾 Code](https://github.com/azure/osdu-bicep/blob/main/bicep/modules/public/azure-keyvault/main.bicep) ｜ [📃 Readme](https://github.com/azure/osdu-bicep/blob/main/bicep/modules/public/azure-keyvault/README.md) |
| `public/container-registry`    |    <a href="https://github.com/azure/osdu-bicep/releases/tag/public/container-registry/1.0.5"><image src="https://img.shields.io/badge/osdubicep-1.0.5-blue"></a> |       [🦾 Code](https://github.com/azure/osdu-bicep/blob/main/bicep/modules/public/container-registry/main.bicep) ｜ [📃 Readme](https://github.com/azure/osdu-bicep/blob/main/bicep/modules/public/container-registry/README.md) |
| `public/cosmos-db`             |           <a href="https://github.com/azure/osdu-bicep/releases/tag/public/cosmos-db/1.0.18"><image src="https://img.shields.io/badge/osdubicep-1.0.18-blue"></a> |                         [🦾 Code](https://github.com/azure/osdu-bicep/blob/main/bicep/modules/public/cosmos-db/main.bicep) ｜ [📃 Readme](https://github.com/azure/osdu-bicep/blob/main/bicep/modules/public/cosmos-db/README.md) |
| `public/log-analytics`         |         <a href="https://github.com/azure/osdu-bicep/releases/tag/public/log-analytics/1.0.4"><image src="https://img.shields.io/badge/osdubicep-1.0.4-blue"></a> |                 [🦾 Code](https://github.com/azure/osdu-bicep/blob/main/bicep/modules/public/log-analytics/main.bicep) ｜ [📃 Readme](https://github.com/azure/osdu-bicep/blob/main/bicep/modules/public/log-analytics/README.md) |
| `public/private-endpoint`      |      <a href="https://github.com/azure/osdu-bicep/releases/tag/public/private-endpoint/1.0.4"><image src="https://img.shields.io/badge/osdubicep-1.0.4-blue"></a> |           [🦾 Code](https://github.com/azure/osdu-bicep/blob/main/bicep/modules/public/private-endpoint/main.bicep) ｜ [📃 Readme](https://github.com/azure/osdu-bicep/blob/main/bicep/modules/public/private-endpoint/README.md) |
| `public/service-bus`           |           <a href="https://github.com/azure/osdu-bicep/releases/tag/public/service-bus/1.0.1"><image src="https://img.shields.io/badge/osdubicep-1.0.1-blue"></a> |                     [🦾 Code](https://github.com/azure/osdu-bicep/blob/main/bicep/modules/public/service-bus/main.bicep) ｜ [📃 Readme](https://github.com/azure/osdu-bicep/blob/main/bicep/modules/public/service-bus/README.md) |
| `public/storage-account`       |       <a href="https://github.com/azure/osdu-bicep/releases/tag/public/storage-account/1.0.8"><image src="https://img.shields.io/badge/osdubicep-1.0.8-blue"></a> |             [🦾 Code](https://github.com/azure/osdu-bicep/blob/main/bicep/modules/public/storage-account/main.bicep) ｜ [📃 Readme](https://github.com/azure/osdu-bicep/blob/main/bicep/modules/public/storage-account/README.md) |
| `public/user-managed-identity` | <a href="https://github.com/azure/osdu-bicep/releases/tag/public/user-managed-identity/1.0.2"><image src="https://img.shields.io/badge/osdubicep-1.0.2-blue"></a> | [🦾 Code](https://github.com/azure/osdu-bicep/blob/main/bicep/modules/public/user-managed-identity/main.bicep) ｜ [📃 Readme](https://github.com/azure/osdu-bicep/blob/main/bicep/modules/public/user-managed-identity/README.md) |
| `public/virtual-network`       |       <a href="https://github.com/azure/osdu-bicep/releases/tag/public/virtual-network/1.0.9"><image src="https://img.shields.io/badge/osdubicep-1.0.9-blue"></a> |             [🦾 Code](https://github.com/azure/osdu-bicep/blob/main/bicep/modules/public/virtual-network/main.bicep) ｜ [📃 Readme](https://github.com/azure/osdu-bicep/blob/main/bicep/modules/public/virtual-network/README.md) |

<!-- End Module Table -->

## Solution

This is a sample module showing the usage of the modules and how a solution can be configured.

### Features

Register the AzureServiceMeshPreview feature flag by using the az feature register command:

```bash
az feature register --namespace "Microsoft.ContainerService" --name "AzureServiceMeshPreview"
```

It takes a few minutes for the feature to register. Verify the registration status by using the az feature show command:

```bash
az feature show --namespace "Microsoft.ContainerService" --name "AzureServiceMeshPreview"
```

When the status reflects Registered, refresh the registration of the Microsoft.ContainerService resource provider by using the az provider register command:

```bash
az provider register --namespace Microsoft.ContainerService
```

### Setup

**Login**

Log into the Azure CLI from a command line and set the subscription.

```bash
az login
azd auth login  # (Optional) --use-device-code
az account set --subscription <your_subscription_id>
```

**Environment Variables**

An environment must be created using the following environment variables.

| Variable              | Purpose                                 |
| :-------------------- | :-------------------------------------- |
| AZURE_SUBSCRIPTION_ID | The Azure Subscription _(GUID)_         |
| AZURE_LOCATION        | The Azure Region                        |
| AZURE_CLIENT_ID       | Azure AD Application Client Id _(GUID)_ |
| ENABLE_PRIVATE_ACCESS | Feature Flag - Private Access           |

```bash
APP_NAME=                                          # <-- <your_ad_application_name>
AZURE_LOCATION=eastus

azd init -e dev
azd env set AZURE_SUBSCRIPTION_ID $(az account show --query id -otsv)
azd env set AZURE_LOCATION $AZURE_LOCATION
azd env set AZURE_CLIENT_ID $(az ad app list --display-name $APP_NAME --query "[].appId" -otsv)

# Solution Uses Resource Group Scoped deployments
azd config set alpha.resourceGroupDeployments on   # Enable Alpha Feature

# Feature Switches
azd env set ENABLE_BASTION false                   # Enable Bastion Host  (Beta)

azd env set ENABLE_VPN_GATEWAY false                  # Enable Site to Site VPN  (Alpha)
azd env set VPN_SHARED_KEY  <your_shared_key>         # if ENABLE_VPN_GATEWAY then Shared Secret
azd env set REMOTE_VPN_PREFIX                         # if ENABLE_VPN_GATEWAY then Remote IP CIDR

azd env set ENABLE_PRIVATE_LINK false              # Enable Private Link Services  (Alpha)
```

### Workspace

The workspace is brought online using the azure developer cli

| Action | Command                    |
| :----- | :------------------------- |
| Start  | `azd up`                   |
| Stop   | `azd down --purge --force` |


## Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

## Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
trademarks or logos is subject to and must follow
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
Any use of third-party trademarks or logos are subject to those third-party's policies.