Azure Management Libraries for .NET for Azure Cosmos DB

  • Code Sample
Browse code

The Azure Management Libraries for .NET for Azure Cosmos DB is a object-oriented API for managing Azure Cosmos DB resources via it's Resource Provider. The library is auto-generated against the Swagger spec for the Cosmos DB Resource Provider.

Contents

Outline the file contents of the repository. It helps users navigate the codebase, build configuration and any related assets.

File/folder Description
cosmos-management-generated Cosmos DB generated management samples.

Prerequisites

None

Setup

To get started you will need to generate a service principal in Azure. Add the required information needed in appSettings.json, or authenticate using MSI with the proper RBAC on the Cosmos resources to manage and modify the authentication in the samples.

To generate the service principal with the correct permissions, use this sample azure cli script below. You can define the scope for this service principal at the subscription or resource group level.

let "randomIdentifier=$RANDOM*$RANDOM"  
servicePrincipalName="cosmos-mgt-sp-$randomIdentifier"
roleName="Contributor"
subscriptionID=$(az account show --query id -o tsv)
# Verify the ID of the active subscription if not use `az account set -s [subscriptionId}]`
echo "Using subscription ID $subscriptionID"
resourceGroup="myResourceGroup"

echo "Creating SP for RBAC with name $servicePrincipalName, with role $roleName and in scopes /subscriptions/$subscriptionID/resourceGroups/$resourceGroup"

az ad sp create-for-rbac --name $servicePrincipalName --role $roleName --scopes /subscriptions/$subscriptionID/resourceGroups/$resourceGroup

Save the output in a secure location.

Running the sample

Set the start up project, ensure you have your service principal credentials as outlined above. To learn more see, Authentication in Azure Management Libraries for .NET. Please note these instructions are out of date. Example above is latest guidance.

Key concepts

These samples demonstrate how to manage Cosmos DB resources through it's Control Plane (Resource Provider). You cannot do any database CRUD operations using these samples

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. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.