This README is based on the released stable version (1.11). If you are looking for other releases, see More Information
The Azure Management Libraries for .NET is a higher-level, object-oriented API for managing Azure resources. Libraries are built on the lower-level, request-response style auto generated clients and can run side-by-side with auto generated clients.
- Feature availability and road map
- Code snippets and samples
- Download
- Prerequisites
- Upgrading from older versions
- Help and issues
- Contribute code
- More information
🚩 as of Version 1.11
Service | feature | Available as GA | Available as Preview | Coming soon |
---|---|---|---|
Compute | Virtual machines and VM extensions Virtual machine scale sets Managed disks |
Azure container service (AKS) + registry + instances Availability Zones |
More Availability Zones and MSI features |
Storage | Storage accounts Encryption (deprecated) |
Encryption (Blob) Encryption (File) |
|
SQL Database | Databases Firewalls and virtual network Elastic pools Import, export, recover and restore dbs Failover groups and replication links DNS aliasing and metrics Sync groups Encryption protectors |
More features | |
Networking | Virtual networks Network interfaces IP addresses Routing table Network security groups Load balancers Application gateways DNS Traffic managers |
Network peering Virtual Network Gateway Network watchers Express Route |
VPN More application gateway features |
More services | Resource Manager Key Vault Redis CDN Batch Service bus |
Web apps Function Apps Graph RBAC Cosmos DB Monitor Batch AI Search Event Hub |
Data Lake More Monitor features Logic Apps Event Grid |
Fundamentals | Authentication - core Async methods Managed Service Identity |
Preview features are flagged in documentation comments in libraries. These features are subject to change. They can be modified in any way, or even removed, in the future.
The Azure
class is the simplest entry point for creating and interacting with Azure resources.
IAzure azure = Azure.Authenticate(credFile).WithDefaultSubscription();
To learn more about authentication in the Azure Libraries for .Net, see AUTH.md.
You can create a virtual machine instance by using a Define() … Create()
method chain.
Console.WriteLine("Creating a Windows VM");
var windowsVM = azure.VirtualMachines.Define("myWindowsVM")
.WithRegion(Region.USEast)
.WithNewResourceGroup(rgName)
.WithNewPrimaryNetwork("10.0.0.0/28")
.WithPrimaryPrivateIPAddressDynamic()
.WithNewPrimaryPublicIPAddress("mywindowsvmdns")
.WithPopularWindowsImage(KnownWindowsVirtualMachineImage.WindowsServer2012R2Datacenter)
.WithAdminUsername("tirekicker")
.WithAdminPassword(password)
.WithSize(VirtualMachineSizeTypes.StandardD3V2)
.Create();
Console.WriteLine("Created a Windows VM: " + windowsVM.Id);
You can update a virtual machine instance by using an Update() … Apply()
method chain.
windowsVM.Update()
.WithNewDataDisk(20, lun, CachingTypes.ReadWrite)
.Apply();
You can create a virtual machine scale set instance by using another Define() … Create()
method chain.
var virtualMachineScaleSet = azure.VirtualMachineScaleSets.Define(vmssName)
.WithRegion(Region.USEast)
.WithExistingResourceGroup(rgName)
.WithSku(VirtualMachineScaleSetSkuTypes.StandardD3v2)
.WithExistingPrimaryNetworkSubnet(network, "Front-end")
.WithPrimaryInternetFacingLoadBalancer(loadBalancer1)
.WithPrimaryInternetFacingLoadBalancerBackends(backendPoolName1, backendPoolName2)
.WithPrimaryInternetFacingLoadBalancerInboundNatPools(natPool50XXto22, natPool60XXto23)
.WithoutPrimaryInternalLoadBalancer()
.WithPopularLinuxImage(KnownLinuxVirtualMachineImage.UbuntuServer16_04_Lts)
.WithRootUsername(userName)
.WithSsh(sshKey)
.WithNewDataDisk(100)
.WithNewDataDisk(100, 1, CachingTypes.ReadWrite)
.WithNewDataDisk(100, 2, CachingTypes.ReadWrite, StorageAccountTypes.StandardLRS)
.WithCapacity(3)
.Create();
You can create a virtual network by using a define() … create()
method chain.
var network = networks.Define("mynetwork")
.WithRegion(Region.USEast)
.WithNewResourceGroup()
.WithAddressSpace("10.0.0.0/28")
.WithSubnet("subnet1", "10.0.0.0/29")
.WithSubnet("subnet2", "10.0.0.8/29")
.Create();
You can create a network security group instance by using another Define() … Create()
method chain.
var frontEndNSG = azure.NetworkSecurityGroups.Define(frontEndNSGName)
.WithRegion(Region.USEast)
.WithNewResourceGroup(rgName)
.DefineRule("ALLOW-SSH")
.AllowInbound()
.FromAnyAddress()
.FromAnyPort()
.ToAnyAddress()
.ToPort(22)
.WithProtocol(SecurityRuleProtocol.Tcp)
.WithPriority(100)
.WithDescription("Allow SSH")
.Attach()
.DefineRule("ALLOW-HTTP")
.AllowInbound()
.FromAnyAddress()
.FromAnyPort()
.ToAnyAddress()
.ToPort(80)
.WithProtocol(SecurityRuleProtocol.Tcp)
.WithPriority(101)
.WithDescription("Allow HTTP")
.Attach()
.Create();
You can create a application gateway instance by using another define() … create()
method chain.
var applicationGateway = azure.ApplicationGateways.Define("myFirstAppGateway")
.WithRegion(Region.USEast)
.WithExistingResourceGroup(resourceGroup)
// Request routing rule for HTTP from public 80 to public 8080
.DefineRequestRoutingRule("HTTP-80-to-8080")
.FromPublicFrontend()
.FromFrontendHttpPort(80)
.ToBackendHttpPort(8080)
.ToBackendIPAddress("11.1.1.1")
.ToBackendIPAddress("11.1.1.2")
.ToBackendIPAddress("11.1.1.3")
.ToBackendIPAddress("11.1.1.4")
.Attach()
.WithExistingPublicIPAddress(publicIpAddress)
.Create();
You can create a Web App instance by using another define() … create()
method chain.
var webApp = azure.WebApps.Define(appName)
.WithRegion(Region.USWest)
.WithNewResourceGroup(rgName)
.WithNewWindowsPlan(PricingTier.StandardS1)
.Create();
You can create a Cosmos DB account by using a define() … create()
method chain.
var documentDBAccount = azure.CosmosDBAccounts.Define(cosmosDBName)
.WithRegion(Region.USEast)
.WithNewResourceGroup(rgName)
.WithKind(DatabaseAccountKind.GlobalDocumentDB)
.WithSessionConsistency()
.WithWriteReplication(Region.USWest)
.WithReadReplication(Region.USCentral)
.Create();
You can create a SQL server instance by using another define() … create()
method chain.
var sqlServer = azure.SqlServers.Define(sqlServerName)
.WithRegion(Region.USEast)
.WithNewResourceGroup(rgName)
.WithAdministratorLogin(administratorLogin)
.WithAdministratorPassword(administratorPassword)
.WithNewFirewallRule(firewallRuleIpAddress)
.WithNewFirewallRule(firewallRuleStartIpAddress, firewallRuleEndIpAddress)
.Create();
Then, you can create a SQL database instance by using another define() … create()
method chain.
var database = sqlServer.Databases.Define(databaseName)
.Create();
1.11 release builds are available on NuGet:
- .NET Core
- Azure Service Principal - see how to create authentication info.
If you are migrating your code from 1.10.x to 1.11.x, you can use these release notes for preparing your code for 1.11 from 1.10.
In general, Azure Libraries for .Net follow semantic versioning, so user code should continue working in a compatible fashion between minor versions of the same major version release train, with the following caveats:
-
methods and types that inherit from
IBeta
interface are not considered "generally available" and their design and functionality may change arbitrarily (including removal) in any future minor release of the libraries. To help identify suchIBeta
breaking changes from one minor release to the next and see how to mitigate them, see the above mentioned release notes for each release. -
occasionally the naming and structure of "fluent" interface definitions (i.e. the ones whose names start with
With*
) may change between minor versions, as long as that change does not affect the fluent "flow" (the chaining of the methods in a definition or update chain). -
the
*Inner
types and their methods may occasionally change their naming and structure between minor versions in breaking ways. User code should generally avoid making a reference to those types though, unless their functionality is not yet exposed by the "fluent" API.
If you encounter any bugs with these libraries, please file issues via Issues or checkout StackOverflow for Azure Management Libraries for .NET.
To enable Http message tracing in your code please check this article.
If you would like to become an active contributor to this project please follow the instructions provided in Microsoft Azure Projects Contribution Guidelines.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
- https://azure.microsoft.com/en-us/develop/net/
- If you don't have a Microsoft Azure subscription you can get a FREE trial account here.
Version | SHA1 | Remarks |
---|---|---|
1.11 | 1.11 | Tagged release for 1.11 version of Azure management libraries |
1.10 | 1.10 | Tagged release for 1.10 version of Azure management libraries |
1.9 | 1.9 | Tagged release for 1.9 version of Azure management libraries |
1.8 | 1.8 | Tagged release for 1.8 version of Azure management libraries |
1.7 | 1.7 | Tagged release for 1.7 version of Azure management libraries |
1.6 | 1.6 | Tagged release for 1.6 version of Azure management libraries |
1.4 | 1.4 | Tagged release for 1.4 version of Azure management libraries |
1.3 | 1.3 | Tagged release for 1.3 version of Azure management libraries |
1.2 | 1.2 | Tagged release for 1.2 version of Azure management libraries |
1.1 | 1.1 | Tagged release for 1.1 version of Azure management libraries |
1.0 | 1.0 | Tagged release for 1.0 version of Azure management libraries |
1.0.0-beta5 | 1.0.0-beta5 | Tagged release for 1.0.0-beta5 version of Azure management libraries |
1.0.0-beta4 | 1.0.0-beta4 | Tagged release for 1.0.0-beta4 version of Azure management libraries |
1.0.0-beta3 | 1.0.0-beta3 | Tagged release for 1.0.0-beta3 version of Azure management libraries |
AutoRest | AutoRest | Main branch for AutoRest generated raw clients |
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.