Aspire Azure Queue Storage-integrationen

Inkluderar:Värdintegrering ingår Värdintegrering &–& integrering ingår integration

Azure Queue Storage är en tjänst för lagring av ett stort antal meddelanden som kan nås var som helst i världen via autentiserade anrop. Med integreringen AspireAzure Queue Storage kan du ansluta till befintliga Azure Queue Storage-instanser eller skapa nya instanser från .NET program.

Integrering av värdtjänster

Lagringshostningsintegration AspireAzure modellerar olika lagringsresurser som följande typer:

• AzureStorageResource: Representerar en Azure lagringsresurs.
• AzureStorageEmulatorResource: Representerar en Azure-lagringsemmulatorresurs (Azurite).
• AzureBlobStorageResource: Representerar en Azure Blob-lagringsresurs.
• AzureQueueStorageResource: Representerar en Azure lagringsresurs för kö.
• AzureTableStorageResource: Representerar en Azure tabelldatalagringsresurs.

Om du vill komma åt dessa typer och API:er för att uttrycka dem lägger du till 📦Aspire. Hosting.Azure. Storage NuGet-paketet i AppHost-projektet .

dotnet add package Aspire.Hosting.Azure.Storage

<PackageReference Include="Aspire.Hosting.Azure.Storage"
                  Version="*" />

För mer information, se dotnet add package eller Hantera paketberoenden i .NET applikationer.

Lägg till Azure lagringsresurs

I ditt AppHost-projekt anropar du AddAzureStorage för att lägga till och returnera en Azure Storage-resursbyggare.

var builder = DistributedApplication.CreateBuilder(args);

var storage = builder.AddAzureStorage("storage");

// An Azure Storage resource is required to add any of the following:
//
// - Azure Blob storage resource.
// - Azure Queue storage resource.
// - Azure Table storage resource.

// After adding all resources, run the app...

När du lägger till en AzureStorageResource i AppHost exponeras andra användbara API:er för att lägga Azure till blob-, kö- och tabelllagringsresurser. Med andra ord måste du lägga till en AzureStorageResource innan du lägger till någon av de andra lagringsresurserna.

Ansluta till ett befintligt Azure Storage-konto

Du kan ha ett befintligt Azure Lagringskonto som du vill ansluta till. Du kan kedja en anropning för att annotera att din AzureStorageResource är en befintlig resurs:

var builder = DistributedApplication.CreateBuilder(args);

var existingStorageName = builder.AddParameter("existingStorageName");
var existingStorageResourceGroup = builder.AddParameter("existingStorageResourceGroup");

var storageaccount = builder.AddAzureStorage("storage")
                    .AsExisting(existingStorageName, existingStorageResourceGroup)
                    .AddBlobs("blobs");

builder.AddProject<Projects.ExampleProject>()
       .WithReference(storageaccount);

// After adding all resources, run the app...

Mer information om hur du behandlar Azure lagringsresurser som befintliga resurser finns i Använda befintliga Azure resurser.

Lägg till Azure Storage-emulator-resurs

Om du vill lägga till en Azure Storage-emulatorresurs kopplar du ett anrop på en IResourceBuilder<AzureStorageResource> till RunAsEmulator API:t.

var builder = DistributedApplication.CreateBuilder(args);

var storage = builder.AddAzureStorage("storage")
                     .RunAsEmulator();

// After adding all resources, run the app...

När du anropar RunAsEmulatorkonfigureras dina lagringsresurser att köras lokalt med hjälp av en emulator. Emulatorn i det här fallet är Azurite. Azurite-emulatorn med öppen källkod ger en kostnadsfri lokal miljö för att testa dina Azure Blob-, Queue Storage- och Table Storage-appar och det är en perfekt följeslagare till AspireAzure värdintegrering. Azurite är inte installerat, utan tillgängligt för Aspire som en container. När du lägger till en container i AppHost, som du ser i föregående exempel med avbildningen mcr.microsoft.com/azure-storage/azurite , skapas och startas containern när AppHost startar. Mer information finns i Livscykel för containerresurser.

Konfigurera Azurite-container

Det finns olika konfigurationer tillgängliga för containerresurser, till exempel kan du konfigurera containerns portar, miljövariabler, det är livslängdmed mera.

Konfigurera Azurite-containerportar

Som standard exponerar Azurite-containern när den konfigureras av Aspireföljande slutpunkter:

Porten som de lyssnar på är dynamisk som standard. När containern startar mappas portarna till en slumpmässig port på värddatorn. För att konfigurera slutpunktsportarna kedjar du anrop på containerresursverktyget som tillhandahålls av metoden RunAsEmulator enligt följande exempel:

var builder = DistributedApplication.CreateBuilder(args);

var storage = builder.AddAzureStorage("storage").RunAsEmulator(
                     azurite =>
                     {
                         azurite.WithBlobPort(27000)
                                .WithQueuePort(27001)
                                .WithTablePort(27002);
                     });

// After adding all resources, run the app...

Föregående kod konfigurerar Azurite-containerns befintliga blob, queueoch table slutpunkter för att lyssna på portar 27000, 27001respektive 27002. Azurite-containerns portar mappas till värdportarna enligt följande tabell:

Konfigurera Azurite-container med beständig livslängd

Om du vill konfigurera Azurite-containern med en beständig livslängd anropar du metoden WithLifetime på Azurite-containerresursen och skickar ContainerLifetime.Persistent:

var builder = DistributedApplication.CreateBuilder(args);

var storage = builder.AddAzureStorage("storage").RunAsEmulator(
                     azurite =>
                     {
                         azurite.WithLifetime(ContainerLifetime.Persistent);
                     });

// After adding all resources, run the app...

Mer information finns i Containerresursens livslängd.

Konfigurera Azurite-container med datavolym

Om du vill lägga till en datavolym i Azure Storage-emulatorresursen anropar du metoden WithDataVolume på Azure Storage-emulatorresursen:

var builder = DistributedApplication.CreateBuilder(args);

var storage = builder.AddAzureStorage("storage").RunAsEmulator(
                     azurite =>
                     {
                         azurite.WithDataVolume();
                     });

// After adding all resources, run the app...

Datavolymen används för att bevara Azurite-data utanför containerns livscykel. Datavolymen monteras på sökvägen /data i containern Azurite, och när parameter name inte tillhandahålls formateras namnet som .azurite/{resource name}. Mer om datavolymer och varför de föredras framför bind mountsfinns i Docker dokument: Volymer.

Konfigurera Azurite-container med databindningspunkt

Om du vill lägga till en databindningsmontering till Azure Storage-emulatorresursen anropar du metoden WithDataBindMount:

var builder = DistributedApplication.CreateBuilder(args);

var storage = builder.AddAzureStorage("storage").RunAsEmulator(
                     azurite =>
                     {
                         azurite.WithDataBindMount("../Azurite/Data");
                     });

// After adding all resources, run the app...

Databindningar förlitar sig på värdmaskinens filsystem för att bevara Azurite-data mellan omstarter av containrar. Databindningsmonteringen ../Azurite/Data monteras på sökvägen på värddatorn i förhållande till AppHost-katalogen (IDistributedApplicationBuilder.AppHostDirectory) i Azurite-containern. Mer information om bindningsmonteringar finns i Docker dokumentationen: Bindningsmonteringar.

Ansluta till lagringsresurser

Aspire När AppHost körs kan lagringsresurserna nås av externa verktyg, till exempel Azure Storage Explorer. Om lagringsresursen körs lokalt med Azurite hämtas den automatiskt av Azure Storage Explorer.

Följ dessa steg för att ansluta till lagringsresursen från Azure Storage Explorer:

1. Aspire Kör AppHost.

2. Öppna Azure Storage Explorer.

3. Visa fönstret Explorer.

4. Klicka på länken Uppdatera alla för att uppdatera lagringskontolistan.

5. Expandera noden Emulator & Ansluten.

6. Expandera noden Lagringskonton.

7. Du bör se ett lagringskonto med resursens namn som prefix:

   

Du kan utforska lagringskontot och dess innehåll med hjälp av Azure Storage Explorer. Mer information om hur du använder Azure Storage Explorer finns i Komma igång med Storage Explorer.

Lägg till Azure Queue Storage-resurs

I ditt AppHost-projekt registrerar du integreringen Azure av queue storage genom att länka ett anrop till AddQueues på den instans som IResourceBuilder<IAzureStorageResource> returneras av AddAzureStorage. I följande exempel visas hur du lägger till en Azure Queue Storage-resurs med namnet storage och en köresurs med namnet queues:

var builder = DistributedApplication.CreateBuilder(args);

var storage = builder.AddAzureStorage("storage")
                    .AddQueue("jobs");

builder.AddProject<Projects.ExampleProject>()
       .WithReference(storage);

// After adding all resources, run the app...

Föregående kod:

• Lägger till en Azure Storage-resurs med namnet storage.
• Lägger till en kö med namnet jobs till lagringsresursen.
• Lägger till den storage resursen i ExampleProject och väntar på att den ska vara klar innan projektet startas.

Konfigurationsgenererad Bicep

Om du är ny på Bicepär det ett domänspecifikt språk för att definiera Azure-resurser. Med Aspirebehöver du inte skriva Bicep för hand, i stället genererar etablerings-API:erna Bicep åt dig. När du publicerar din app genereras den skapade Bicep-filen tillsammans med manifestfilen. När du lägger till en Azure lagringsresurs genereras följande Bicep:

@description('The location for the resource(s) to be deployed.')
param location string = resourceGroup().location

resource storage 'Microsoft.Storage/storageAccounts@2024-01-01' = {
  name: take('storage${uniqueString(resourceGroup().id)}', 24)
  kind: 'StorageV2'
  location: location
  sku: {
    name: 'Standard_GRS'
  }
  properties: {
    accessTier: 'Hot'
    allowSharedKeyAccess: false
    minimumTlsVersion: 'TLS1_2'
    networkAcls: {
      defaultAction: 'Allow'
    }
  }
  tags: {
    'aspire-resource-name': 'storage'
  }
}

output blobEndpoint string = storage.properties.primaryEndpoints.blob

output queueEndpoint string = storage.properties.primaryEndpoints.queue

output tableEndpoint string = storage.properties.primaryEndpoints.table

output name string = storage.name

Föregående Bicep är en modul som etablerar ett Azure Storage-konto med följande standardvärden:

• kind: Typen av lagringskonto. Standardvärdet är StorageV2.
• sku: SKU:n för lagringskontot. Standardvärdet är Standard_GRS.
• properties: Egenskaperna för lagringskontot:
  • accessTier: Åtkomstnivån för lagringskontot. Standardvärdet är Hot.
  • allowSharedKeyAccess: Ett booleskt värde som anger om lagringskontot tillåter att begäranden auktoriseras med kontoåtkomstnyckeln. Standardvärdet är false.
  • minimumTlsVersion: Den lägsta TLS-version som stöds för lagringskontot. Standardvärdet är TLS1_2.
  • networkAcls: Nätverks-ACL:er för lagringskontot. Standardvärdet är { defaultAction: 'Allow' }.

Förutom lagringskontot skapar det även en blobcontainer.

Följande rolltilldelningar läggs till i lagringskontot för att ge ditt program åtkomst. Mer information finns i inbyggda roller för Azure rollbaserad åtkomstkontroll (Azure RBAC):

Dessutom skapas rolltilldelningar för resursen Azure i en separat modul:

@description('The location for the resource(s) to be deployed.')
param location string = resourceGroup().location

param storage_outputs_name string

param principalType string

param principalId string

resource storage 'Microsoft.Storage/storageAccounts@2024-01-01' existing = {
  name: storage_outputs_name
}

resource storage_StorageBlobDataContributor 'Microsoft.Authorization/roleAssignments@2022-04-01' = {
  name: guid(storage.id, principalId, subscriptionResourceId('Microsoft.Authorization/roleDefinitions', 'ba92f5b4-2d11-453d-a403-e96b0029c9fe'))
  properties: {
    principalId: principalId
    roleDefinitionId: subscriptionResourceId('Microsoft.Authorization/roleDefinitions', 'ba92f5b4-2d11-453d-a403-e96b0029c9fe')
    principalType: principalType
  }
  scope: storage
}

resource storage_StorageTableDataContributor 'Microsoft.Authorization/roleAssignments@2022-04-01' = {
  name: guid(storage.id, principalId, subscriptionResourceId('Microsoft.Authorization/roleDefinitions', '0a9a7e1f-b9d0-4cc4-a60d-0319b160aaa3'))
  properties: {
    principalId: principalId
    roleDefinitionId: subscriptionResourceId('Microsoft.Authorization/roleDefinitions', '0a9a7e1f-b9d0-4cc4-a60d-0319b160aaa3')
    principalType: principalType
  }
  scope: storage
}

resource storage_StorageQueueDataContributor 'Microsoft.Authorization/roleAssignments@2022-04-01' = {
  name: guid(storage.id, principalId, subscriptionResourceId('Microsoft.Authorization/roleDefinitions', '974c5e8b-45b9-4653-ba55-5f855dd0fb88'))
  properties: {
    principalId: principalId
    roleDefinitionId: subscriptionResourceId('Microsoft.Authorization/roleDefinitions', '974c5e8b-45b9-4653-ba55-5f855dd0fb88')
    principalType: principalType
  }
  scope: storage
}

Den genererade Bicep är en startpunkt och påverkas av ändringar i tillhandahållandeinfrastrukturen i C#. Anpassningar till Bicep-filen skrivs över direkt, så gör ändringar via C#-etablerings-API:erna för att säkerställa att de återspeglas i de genererade filerna.

Anpassa tillhandahållandeinfrastruktur

Alla AspireAzure resurser är underklasser av den AzureProvisioningResource typen. Den här typen möjliggör anpassning av den genererade Bicep genom att tillhandahålla en flytande API för att konfigurera Azure-resurser med hjälp av ConfigureInfrastructure<T>(IResourceBuilder<T>, Action<AzureResourceInfrastructure>)-API:et. Du kan till exempel konfigurera kind, sku, propertiesoch mycket mer. I följande exempel visas hur du anpassar Azure Storage-resursen:

builder.AddAzureStorage("storage")
    .ConfigureInfrastructure(infra =>
    {
        var storageAccount = infra.GetProvisionableResources()
                                  .OfType<StorageAccount>()
                                  .Single();

        storageAccount.AccessTier = StorageAccountAccessTier.Cool;
        storageAccount.Sku = new StorageSku { Name = StorageSkuName.PremiumZrs };
        storageAccount.Tags.Add("ExampleKey", "Example value");
    });

Föregående kod:

• Kedjar ett anrop till ConfigureInfrastructure-API:et:
  • Parametern infra är en instans av den AzureResourceInfrastructure typen.
  • De tillgängliga resurserna hämtas genom att anropa metoden GetProvisionableResources().
  • Den enda StorageAccount hämtas.
  • StorageAccount.AccessTier tilldelas till StorageAccountAccessTier.Cool.
  • StorageAccount.Sku tilldelas till en ny StorageSku med en Name av PremiumZrs.
  • En tagg läggs till i lagringskontot med nyckeln ExampleKey och värdet Example value.

Det finns många fler konfigurationsalternativ för att anpassa Azure Storage-resursen. Mer information finns i Azure.Provisioning.Storage.

Lägg till Azure Storage-emulator-resurs

Om du vill lägga till en Azure Storage-emulatorresurs kopplar du ett anrop på en IResourceBuilder<AzureStorageResource> till RunAsEmulator API:t.

var builder = DistributedApplication.CreateBuilder(args);

var storage = builder.AddAzureStorage("storage")
                     .RunAsEmulator();

// After adding all resources, run the app...

När du anropar RunAsEmulatorkonfigureras dina lagringsresurser att köras lokalt med hjälp av en emulator. Emulatorn i det här fallet är Azurite. Azurite-emulatorn med öppen källkod ger en kostnadsfri lokal miljö för att testa dina Azure Blob-, Queue Storage- och Table Storage-appar och det är en perfekt följeslagare till AspireAzure värdintegrering. Azurite är inte installerat. I stället är den tillgänglig som Aspire en container. När du lägger till en container i AppHost, som du ser i föregående exempel med avbildningen mcr.microsoft.com/azure-storage/azurite , skapas och startas containern när AppHost startar. Mer information finns i Livscykel för containerresurser.

Konfigurera Azurite-container

Det finns olika konfigurationer tillgängliga för containerresurser, till exempel kan du konfigurera containerns portar, miljövariabler, livslängd med mera.

Konfigurera Azurite-containerportar

Som standard exponerar Azurite-containern, när den konfigureras av Aspire, följande slutpunkter:

Porten som de lyssnar på är dynamisk som standard. När containern startar mappas portarna till en slumpmässig port på värddatorn. För att konfigurera slutpunktsportarna kedjar du anrop på containerresursverktyget som tillhandahålls av metoden RunAsEmulator enligt följande exempel:

var builder = DistributedApplication.CreateBuilder(args);

var storage = builder.AddAzureStorage("storage").RunAsEmulator(
                     azurite =>
                     {
                         azurite.WithBlobPort(27000)
                                .WithQueuePort(27001)
                                .WithTablePort(27002);
                     });

// After adding all resources, run the app...

Föregående kod konfigurerar Azurite-containerns befintliga blob, queueoch table slutpunkter för att lyssna på portar 27000, 27001respektive 27002. Azurite-containerns portar mappas till värdportarna enligt följande tabell:

Konfigurera Azurite-container med beständig livslängd

Om du vill konfigurera Azurite-containern med en beständig livslängd anropar du metoden WithLifetime på Azurite-containerresursen och skickar ContainerLifetime.Persistent:

var builder = DistributedApplication.CreateBuilder(args);

var storage = builder.AddAzureStorage("storage").RunAsEmulator(
                     azurite =>
                     {
                         azurite.WithLifetime(ContainerLifetime.Persistent);
                     });

// After adding all resources, run the app...

Mer information finns i Containerresursens livslängd.

Konfigurera Azurite-container med datavolym

Om du vill lägga till en datavolym i Azure Storage-emulatorresursen anropar du metoden WithDataVolume på Azure Storage-emulatorresursen:

var builder = DistributedApplication.CreateBuilder(args);

var storage = builder.AddAzureStorage("storage").RunAsEmulator(
                     azurite =>
                     {
                         azurite.WithDataVolume();
                     });

// After adding all resources, run the app...

Datavolymen används för att bevara Azurite-data utanför containerns livscykel. Datavolymen monteras på sökvägen /data i containern Azurite, och när parameter name inte tillhandahålls formateras namnet som .azurite/{resource name}. Mer om datavolymer och varför de föredras framför bind mountsfinns i Docker dokument: Volymer.

Konfigurera Azurite-container med databindningspunkt

Om du vill lägga till en databindningsmontering till Azure Storage-emulatorresursen anropar du metoden WithDataBindMount:

var builder = DistributedApplication.CreateBuilder(args);

var storage = builder.AddAzureStorage("storage").RunAsEmulator(
                     azurite =>
                     {
                         azurite.WithDataBindMount("../Azurite/Data");
                     });

// After adding all resources, run the app...

Databindningar förlitar sig på värdmaskinens filsystem för att bevara Azurite-data mellan omstarter av containrar. Databindningsmonteringen ../Azurite/Data monteras på sökvägen på värddatorn i förhållande till AppHost-katalogen (IDistributedApplicationBuilder.AppHostDirectory) i Azurite-containern. Mer information om bindningsmonteringar finns i Docker dokumentationen: Bindningsmonteringar.

Ansluta till ett befintligt Azure Storage-konto

Du kan ha ett befintligt Azure Lagringskonto som du vill ansluta till. I stället för att representera en ny Azure Lagringsresurs kan du lägga till en anslutningssträng i AppHost. Om du vill lägga till en anslutning till ett befintligt Azure Storage-konto anropar du metoden AddConnectionString:

var builder = DistributedApplication.CreateBuilder(args);

var blobs = builder.AddConnectionString("blobs");

builder.AddProject<Projects.WebApplication>("web")
       .WithReference(blobs);

// After adding all resources, run the app...

Anslutningssträngen konfigureras i AppHost-konfigurationen, vanligtvis under Användarhemligheter, under avsnittet ConnectionStrings . AppHost matar in den här anslutningssträngen som en miljövariabel i alla beroende resurser, till exempel:

{
    "ConnectionStrings": {
        "blobs": "https://{account_name}.blob.core.windows.net/"
    }
}

Den beroende resursen kan komma åt den inmatade anslutningssträngen genom att anropa metoden GetConnectionString och skicka anslutningsnamnet som parameter, i det här fallet "blobs". API:et GetConnectionString är en förkortning för IConfiguration.GetSection("ConnectionStrings")[name].

Ansluta till lagringsresurser

Aspire När AppHost körs kan lagringsresurserna nås av externa verktyg, till exempel Azure Storage Explorer. Om lagringsresursen körs lokalt med Azurite hämtas den automatiskt av Azure Storage Explorer.

Följ dessa steg för att ansluta till lagringsresursen från Azure Storage Explorer:

1. Aspire Kör AppHost.

2. Öppna Azure Storage Explorer.

3. Visa fönstret Explorer.

4. Klicka på länken Uppdatera alla för att uppdatera lagringskontolistan.

5. Expandera noden Emulator & Ansluten.

6. Expandera noden Lagringskonton.

7. Du bör se ett lagringskonto med resursens namn som prefix:

   

Du kan utforska lagringskontot och dess innehåll med hjälp av Azure Storage Explorer. Mer information om hur du använder Azure Storage Explorer finns i Komma igång med Storage Explorer.

Värdskap av hälsokontroller för integration

Azure-lagringsvärdintegration skapar automatiskt en hälsokontroll för lagringsresursen. Den läggs bara till när den körs som en emulator och verifierar att Azurite-containern körs och att en anslutning kan upprättas till den. Integrationen av hosting förlitar sig på 📦 AspNetCore.HealthChecks.Azure.Storage.Blobs NuGet-paketet.

Client integrering

Kom igång med klientintegrering av AspireAzure Queue Storage genom att installera 📦Aspire.Azure. Storage.Queues NuGet-paket i det klientkrävande projektet, dvs. projektet för det program som använder Azure Queue Storage-klienten. Klientintegrering Azure Queue Storage registrerar en QueueServiceClient instans som du kan använda för att interagera med Azure Queue Storage.

dotnet add package Aspire.Azure.Storage.Queues

<PackageReference Include="Aspire.Azure.Storage.Queues"
                  Version="*" />

Lägg till Azure Queue Storage-klient

I Program.cs-filen för ditt klientförbrukande projekt, anropar du AddAzureQueueClient-tilläggsmetoden på valfri IHostApplicationBuilder för att registrera en QueueServiceClient för användning via beroendeinjektionscontainern. Metoden tar en parameter för anslutningsnamn.

builder.AddAzureQueueClient("queue");

Du kan sedan hämta QueueServiceClient-instansen med hjälp av beroendeinjektion. Om du till exempel vill hämta klienten från en tjänst:

public class ExampleService(QueueServiceClient client)
{
    // Use client...
}

Configuration

Integreringen AspireAzure Queue Storage innehåller flera alternativ för att konfigurera QueueServiceClient baserat på kraven och konventionerna i projektet.

Använda en anslutningssträng

När du använder en anslutningssträng från ConnectionStrings konfigurationsavsnittet kan du ange namnet på anslutningssträngen när du anropar AddAzureQueueClient:

builder.AddAzureQueueClient("queue");

Sedan hämtas anslutningssträngen från avsnittet ConnectionStrings konfiguration och två anslutningsformat stöds:

Tjänst-URI

Den rekommenderade metoden är att använda en ServiceUri, som fungerar med egenskapen AzureStorageQueuesSettings.Credential för att upprätta en anslutning. Om inga autentiseringsuppgifter har konfigurerats används Azure.Identity.DefaultAzureCredential.

{
  "ConnectionStrings": {
    "queue": "https://{account_name}.queue.core.windows.net/"
  }
}

Anslutningssträng

Du kan också använda en Azure Storage-anslutningssträng.

{
  "ConnectionStrings": {
    "queue": "AccountName=myaccount;AccountKey=myaccountkey"
  }
}

För mer information, se Konfigurera lagringsanslutningssträngar Azure.

Använda konfigurationsprovidrar

Integreringen AspireAzure Queue Storage stöder Microsoft.Extensions.Configuration. Den läser in AzureStorageQueuesSettings och QueueClientOptions från konfigurationen med hjälp av Aspire:Azure:Storage:Queues-nyckeln. Följande kodfragment är ett exempel på en appsettings.json fil som konfigurerar några av alternativen:

{
  "Aspire": {
    "Azure": {
      "Storage": {
        "Queues": {
          "DisableHealthChecks": true,
          "DisableTracing": false,
          "ClientOptions": {
            "Diagnostics": {
              "ApplicationId": "myapp"
            }
          }
        }
      }
    }
  }
}

Det fullständiga Azure Storage Queues klientintegreringsschemat JSON finns i Aspire.Azure. Data.Queues/ConfigurationSchema.json.

Använda namngiven konfiguration

Queue Storage-integreringen AspireAzure stöder namngiven konfiguration, vilket gör att du kan konfigurera flera instanser av samma resurstyp med olika inställningar. Den namngivna konfigurationen använder anslutningsnamnet som en nyckel under huvudkonfigurationsavsnittet.

{
  "Aspire": {
    "Azure": {
      "Storage": {
        "Queues": {
          "queue1": {
            "DisableHealthChecks": true,
            "ClientOptions": {
              "Diagnostics": {
                "ApplicationId": "myapp1"
              }
            }
          },
          "queue2": {
            "DisableTracing": true,
            "ClientOptions": {
              "Diagnostics": {
                "ApplicationId": "myapp2"
              }
            }
          }
        }
      }
    }
  }
}

I det här exemplet kan anslutningsnamnen queue1 och queue2 användas när du anropar AddAzureQueueClient:

builder.AddAzureQueueClient("queue1");
builder.AddAzureQueueClient("queue2");

Den namngivna konfigurationen har företräde framför konfigurationen på den översta nivån. Om båda anges åsidosätter inställningarna från den namngivna konfigurationen inställningarna på den översta nivån.

Använd inline-delegater

Du kan också överföra delegering Action<AzureStorageQueuesSettings> configureSettings för att sätta upp vissa eller alla alternativ direkt, till exempel för att konfigurera hälsokontroller.

builder.AddAzureQueueClient(
    "queue",
    settings => settings.DisableHealthChecks = true);

Du kan också konfigurera QueueClientOptions med hjälp av Action<IAzureClientBuilder<QueueServiceClient, QueueClientOptions>> configureClientBuilder delegat, den andra parametern i metoden AddAzureQueueClient. Om du till exempel vill ställa in den första delen av användaragenthuvudena för alla begäranden som görs av den här klienten:

builder.AddAzureQueueClient(
    "queue",
    configureClientBuilder: clientBuilder =>
        clientBuilder.ConfigureOptions(
            options => options.Diagnostics.ApplicationId = "myapp"));

Client hälsokontroller för integrering

Integreringar aktiverar som standard Aspirehälsokontroller för alla tjänster. Mer information finns i Aspire översikten över integreringar.

Integrering av AspireAzure Queue Storage:

• Lägger till hälsokontrollen när AzureStorageQueuesSettings.DisableHealthChecks är false, som försöker ansluta till Azure Queue Storage.
• Integrerar med /health HTTP-slutpunkt, som specificerar att alla registrerade hälsokontroller måste passera för att appen ska anses vara redo att ta emot trafik.

Observerbarhet och telemetri

Aspire integreringar konfigurerar automatiskt konfigurationer för loggning, spårning och mått, som ibland kallas grundpelarna för observerbarhet. Mer information om integreringsobservabilitet och telemetri finns i Aspire översikten över integreringar. Beroende på säkerhetskopieringstjänsten kanske vissa integreringar bara stöder vissa av dessa funktioner. Vissa integreringar stöder till exempel loggning och spårning, men inte mått. Telemetrifunktioner kan också inaktiveras med hjälp av de tekniker som visas i avsnittet Configuration.

Logging

Integreringen AspireAzure Queue Storage använder följande loggkategorier:

• Azure.Core
• Azure.Identity

Tracing

Integreringen AspireAzure Queue Storage genererar följande spårningsaktiviteter med hjälp av OpenTelemetry:

• Azure.Storage.Queues.QueueClient

Metrics

Integreringen av AspireAzure Queue Storage stöder för närvarande inte mått som standard på grund av begränsningar med Azure SDK.

Se även

• Azure Queue Storage-dokument
• Aspire Integrationer
• Aspire GitHub Repo