GitHub - Azure/azure-libraries-for-net: Azure libraries for .Net (original) (raw)

This Repository was Deprecated in September 2022

Thank you for the interest in this package.

If you are looking for the latest packages to interact with Azure resources, please use the following libraries:https://aka.ms/azsdk/dotnet/mgmt

Here is all of the latest packages: https://azure.github.io/azure-sdk/releases/latest/mgmt/dotnet.html

You can refer to this https://aka.ms/dotnet/t2/migration for more details about how to migrate your current code to our new SDK.

Azure Management Libraries for .NET

This README is based on the released stable version (1.38.1). 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.

Table of contents

• Feature availability and road map
• Code snippets and samples
  • Virtual machines
  • Networking
  • Application services
  • Databases and storage
  • Others...
• Download
• Prerequisites
• Upgrading from older versions
• Help and issues
• Contribute code
• More information

Feature Availability and Road Map

🚩 as of Version 1.38.1

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.

Code snippets and samples

Azure Authentication

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.

Virtual Machines

Create a Virtual Machine

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);

Update a Virtual Machine

You can update a virtual machine instance by using an Update() … Apply() method chain.

windowsVM.Update() .WithNewDataDisk(20, lun, CachingTypes.ReadWrite) .Apply();

Create a Virtual Machine Scale Set

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();

Ready-to-run code samples for virtual machines

Networking

Create a virtual network

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();

Create a Network Security Group

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();

Create an Application Gateway

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();

Ready-to-run code samples for networking

Application Services

Create a Web App

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();

Ready-to-run code samples for Application Services

Databases and Storage

Create a Cosmos DB with CosmosDB Programming Model

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();

Create a SQL Database

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();

Ready-to-run code samples for databases

Other code samples

Logging

Logging can be enabled by providing an implementation of IServiceClientTracingInterceptor interface.

ServiceClientTracing.AddTracingInterceptor(new LoggingTracer()); ServiceClientTracing.IsEnabled = true;

IAzure azure = Azure.Configure().WithLogLevel(HttpLoggingDelegatingHandler.Level.Basic) .Authenticate(credFile).WithDefaultSubscription();

Download

Latest stable release

1.38.1 release builds are available on NuGet:

Azure Management Library	Package name	Stable
Azure Management Client (wrapper package)	Microsoft.Azure.Management.Fluent
App Service (Web Apps and Functions)	Microsoft.Azure.Management.AppService.Fluent
Batch AI	Microsoft.Azure.Management.BatchAI.Fluent
CDN	Microsoft.Azure.Management.Cdn.Fluent
Virtual Machines, Virtual Machine Scale Sets, Azure Container Services	Microsoft.Azure.Management.Compute.Fluent
Container Instance	Microsoft.Azure.Management.ContainerInstance.Fluent
Container Registry	Microsoft.Azure.Management.ContainerRegistry.Fluent
Container Service	Microsoft.Azure.Management.ContainerService.Fluent
Cosmos DB	Microsoft.Azure.Management.CosmosDB.Fluent
DNS	Microsoft.Azure.Management.Dns.Fluent
EventHub	Microsoft.Azure.Management.EventHub.Fluent
Graph RBAC	Microsoft.Azure.Management.Graph.RBAC.Fluent
Key Vault	Microsoft.Azure.Management.KeyVault.Fluent
Locks	Microsoft.Azure.Management.Locks.Fluent
Monitor	Microsoft.Azure.Management.Monitor.Fluent
Msi	Microsoft.Azure.Management.Msi.Fluent
Networking	Microsoft.Azure.Management.Network.Fluent
Redis Cache	Microsoft.Azure.Management.Redis.Fluent
Resource Manager	Microsoft.Azure.Management.ResourceManager.Fluent
Search	Microsoft.Azure.Management.Search.Fluent
Service Bus	Microsoft.Azure.Management.ServiceBus.Fluent
SQL Database	Microsoft.Azure.Management.Sql.Fluent
Storage	Microsoft.Azure.Management.Storage.Fluent
Traffic Manager	Microsoft.Azure.Management.TrafficManager.Fluent

Prerequisites

• .NET Core
• Azure Service Principal - see how to create authentication info.
• Configure and build locally - see "to build" section here.

Upgrading from older versions

If you are migrating your code from 1.38.0 to 1.38.1, you can use these release notes for preparing your code for 1.38.1 from 1.38.0.

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 such IBeta 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.

Help and Issues

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 logging.

Contribute Code

If you would like to become an active contributor to this project please follow the instructions provided in Microsoft Azure Projects Contribution Guidelines.

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

More Information

• 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.

Previous Releases and Corresponding Repo Branches

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.