Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reusable overview content #45592

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Reusable overview content #45592

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 1 addition & 7 deletions docs/azure/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,4 @@ You can incorporate Azure into your application in different ways depending on y

## Access Azure services from .NET applications

Whether your app is hosted in Azure or on-premises, access to most Azure services is provided through the **Azure SDK for .NET**. The Azure SDK for .NET is provided as a series of NuGet packages and can be used in both .NET Core (2.1 and higher) and .NET Framework (4.6.1 and higher) applications. The Azure SDK for .NET makes incorporating Azure services into your application as easy as installing the correct NuGet package, instantiating a client object and calling the appropriate methods. More information on the Azure SDK for .NET can be found in the [Azure SDK for .NET Overview](./sdk/azure-sdk-for-dotnet.md).

![Diagram showing how .NET applications use the Azure SDK to access Azure services](./media/azure-sdk-for-dotnet-overview.png)

## Next steps

Next, learn about the most [commonly used Azure services](./key-azure-services.md) for .NET development.
[!INCLUDE [azure-sdk-for-dotnet-overview](sdk/includes/azure-sdk-for-dotnet-overview.md)]
22 changes: 2 additions & 20 deletions docs/azure/sdk/azure-sdk-for-dotnet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,11 @@
---
title: Azure SDK for .NET Overview
description: Provides an overview of what the Azure SDK for .NET is and the basic steps to use the SDK in a .NET application
description: Provides an overview of the Azure SDK for .NET and the basic steps to use the SDK in a .NET application.
ms.topic: conceptual
ms.custom: devx-track-dotnet, engagement-fy23
ms.date: 07/26/2024
---

# Azure SDK for .NET overview

## What is the Azure SDK for .NET

The **Azure SDK for .NET** is designed to make it easy to use Azure services from your .NET applications. Whether it's uploading and downloading files to Blob Storage, retrieving application secrets from Azure Key Vault, or processing notifications from Azure Event Hubs, the Azure SDK for .NET provides a consistent and familiar interface to access Azure services.

The Azure SDK for .NET is a collection of NuGet packages that can be used in applications targeting .NET variants that implement [.NET Standard 2.0](/dotnet/standard/net-standard?tabs=net-standard-2-0#select-net-standard-version).

:::image type="content" source="./media/azure-sdk-for-dotnet-overview.png" alt-text="Diagram showing how .NET applications use the Azure SDK to access Azure services.":::

## Use the Azure SDK for .NET in your applications

To use an Azure SDK package in one of your .NET applications, you want to follow these steps.

1. **Locate the appropriate SDK package -** Use the [package list](packages.md) to find the appropriate package for the Azure service you are working with. Be advised that most services have a client package for working with the service and a management package for creating and managing instances of the service. In most cases, you will want the client package. Install this package in your application using NuGet.

2. **Set up authentication for your application -** To access Azure resources, your application will need to have the appropriate credentials and access rights assigned in Azure. Learn how to configure authentication in [Authenticating .NET applications to Azure](authentication/index.md).

3. **Write code using the SDK in your application -** When working with Azure services, your code will first create a client object to work with the service and then call methods on that client object to interact with the service. Both synchronous and asynchronous methods are provided. Examples of using each individual SDK package are provided throughout the Azure documentation.

4. **Configure logging for the SDK (optional) -** If you need to diagnose issues between your application and Azure, you can [enable logging in the Azure SDK for .NET](logging.md).
[!INCLUDE [azure-sdk-for-dotnet-overview](includes/azure-sdk-for-dotnet-overview.md)]
28 changes: 28 additions & 0 deletions docs/azure/sdk/includes/azure-sdk-for-dotnet-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
ms.topic: include
ms.date: 03/11/2025
---

The Azure SDK for .NET enables you to access and consume Azure services from your .NET applications. The SDK provides a consistent and approachable interface to perform various tasks, including:

- **Data storage and management**: Upload, download, and manage files in Azure Blob Storage, or utilize scalable database solutions such as Azure Cosmos DB and Azure SQL.
- **Application hosting**: Deploy and manage web applications, APIs, and serverless functions using Azure App Service, Azure Container Apps, and Azure Functions.
- **Authentication and security**: Securely authenticate users and manage access to Azure resources using Microsoft Entra ID, or manage secrets using services like Azure Key Vault.
- **Event and message processing**: Build event-driven applications with Azure Event Hubs, Azure Service Bus, and Azure Event Grid for real-time data processing and messaging.
- **Provision and manage resources**: Automate the creation, configuration, and management of Azure resources using Azure Resource Manager (ARM) APIs.

The Azure SDK for .NET is a collection of NuGet packages that can be used in applications targeting .NET variants that implement [.NET Standard 2.0](/dotnet/standard/net-standard?tabs=net-standard-2-0#select-net-standard-version).

:::image type="content" source="./media/azure-sdk-for-dotnet-overview.png" alt-text="Diagram showing how .NET applications use the Azure SDK to access Azure services.":::

## Use the Azure SDK for .NET in your app

To use an Azure SDK package in one of your .NET app:

1. **Locate the appropriate SDK package**: Use the [package list](packages.md) to find the appropriate package for the Azure service you are working with. Be aware that most services have a client package for working with the service and a management package for creating and managing instances of the service. In most cases, you will want the client package. Install this package in your application using NuGet.

2. **Set up authentication for your application**: To access Azure resources, your application will need the appropriate credentials and access rights assigned in Azure. Learn how to configure authentication in the [Authenticating .NET applications to Azure](authentication/index.md) and the [Authentication best practices](dotnet/azure/sdk/authentication/best-practices) articles.

3. **Write code using the SDK in your application**: When working with Azure services, your code will first create a client object to work with the service and then call methods on that client object to interact with the service. Both synchronous and asynchronous methods are provided. Examples of using each individual SDK package are available throughout the Azure documentation.

4. **Configure logging for the SDK (optional)**: If you need to diagnose issues between your application and Azure, you can [enable logging in the Azure SDK for .NET](logging.md).
Loading