Integratie van AspireAzure Queue Storage

Inclusief: —&— Client integratie

Azure Queue Storage- is een service voor het opslaan van grote aantallen berichten die overal ter wereld toegankelijk zijn via geverifieerde aanroepen. Met de integratie van AspireAzure Queue Storage kunt u verbinding maken met bestaande Azure Queue Storage-exemplaren of nieuwe exemplaren maken vanuit .NET toepassingen.

Hostingintegratie

De AspireAzure opslag-hostingintegratie modelleert de verschillende opslagbronnen als de volgende typen:

• AzureStorageResource: vertegenwoordigt een Azure Storage-resource.
• AzureStorageEmulatorResource: vertegenwoordigt een Azure Storage Emulator-resource (Azurite).
• AzureBlobStorageResource: vertegenwoordigt een Azure Blob Storage-resource.
• AzureQueueStorageResource: vertegenwoordigt een Azure Queue Storage-resource.
• AzureTableStorageResource: vertegenwoordigt een Azure Table storage-bron.

Als u toegang wilt krijgen tot deze typen en API's om ze uit te drukken, voegt u de 📦Aspire. Hosting.Azure. Storage NuGet-pakket in het AppHost-project .

dotnet add package Aspire.Hosting.Azure.Storage

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

Zie dotnet pakket toevoegen of Pakketafhankelijkheden beheren in .NET toepassingenvoor meer informatie.

Azure Storage-resource toevoegen

Roep in uw AppHost-project AddAzureStorage aan om een Azure opbouwfunctie voor opslagresources toe te voegen en te retourneren.

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

Wanneer u een app AzureStorageResource toevoegt aan de AppHost, worden er andere nuttige API's weergegeven om blob-, wachtrij- en tableopslagresources toe te voegen Azure . Met andere woorden, u moet een AzureStorageResource toevoegen voordat u een van de andere opslagbronnen toevoegt.

Verbinding maken met een bestaand Azure Storage-account

Mogelijk hebt u een bestaand Azure Storage-account waarmee u verbinding wilt maken. U kunt een aanroep aaneenschakelen om aan te geven dat uw AzureStorageResource een bestaande resource is.

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

Zie Azure voor meer informatie om opslagresources Azure als Azure te behandelen.

Resource voor Azure Storage-emulator toevoegen

Als u een Azure Storage-emulatorresource wilt toevoegen, koppelt u een aanroep op een IResourceBuilder<AzureStorageResource> aan de RunAsEmulator-API:

var builder = DistributedApplication.CreateBuilder(args);

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

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

Wanneer u RunAsEmulatoraanroept, worden uw opslagbronnen geconfigureerd voor lokaal uitvoeren met behulp van een emulator. De emulator in dit geval is Azurite. De opensource-emulator Van Azurite biedt een gratis lokale omgeving voor het testen van uw Azure Blob-, Queue Storage- en Table Storage-apps en het is een perfecte aanvulling op de AspireAzure hostingintegratie. Azurite is niet geïnstalleerd, in plaats daarvan is het toegankelijk voor Aspire als container. Wanneer u een container aan de AppHost toevoegt, zoals wordt weergegeven in het vorige voorbeeld met de mcr.microsoft.com/azure-storage/azurite installatiekopieën, wordt de container gemaakt en gestart wanneer de AppHost wordt gestart. Zie levenscyclus van containerresourcesvoor meer informatie.

Azurite-container configureren

Er zijn verschillende configuraties beschikbaar voor containerresources. U kunt bijvoorbeeld de poorten van de container, omgevingsvariabelen, de levensduuren meer configureren.

Azurite-containerpoorten configureren

Standaard stelt de Azurite-container, wanneer geconfigureerd door Aspire, de volgende eindpunten bloot:

De poort waarop ze luisteren, is standaard dynamisch. Wanneer de container wordt gestart, worden de poorten toegewezen aan een willekeurige poort op de hostcomputer. Als u de eindpuntpoorten wilt configureren, maakt u kettingaanroepen op de containerresourcebouwer die wordt geleverd door de RunAsEmulator Methode, zoals in het volgende voorbeeld:

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

De voorgaande code configureert de bestaande blob, queueen table eindpunten van de Azurite-container om respectievelijk te luisteren op poorten 27000, 27001en 27002. De poorten van de Azurite-container worden toegewezen aan de hostpoorten, zoals wordt weergegeven in de volgende tabel:

Azurite-container configureren met een permanente levensduur

Als u de Azurite-container met een permanente levensduur wilt configureren, roept u de methode WithLifetime op de Resource van de Azurite-container aan en geeft u ContainerLifetime.Persistentdoor:

var builder = DistributedApplication.CreateBuilder(args);

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

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

Zie Levensduur van containerresourcesvoor meer informatie.

Azurite-container configureren met gegevensvolume

Als u een gegevensvolume wilt toevoegen aan de resource van de Azure Storage-emulator, roept u de WithDataVolume methode aan op de resource van de Azure Storage-emulator:

var builder = DistributedApplication.CreateBuilder(args);

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

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

Het gegevensvolume wordt gebruikt om de Azurite-gegevens buiten de levenscyclus van de container te behouden. Het gegevensvolume wordt gekoppeld aan het /data pad in de Azure-container en wanneer er geen name parameter wordt opgegeven, wordt de naam opgemaakt als .azurite/{resource name}. Voor meer informatie over gegevensvolumes en waarom deze de voorkeur hebben boven bind mounts, zie Docker docs: Volumes.

De Azurite-container configureren met een databind-mount

Als u een koppeling voor gegevensbinding wilt toevoegen aan de resource van de Azure Storage-emulator, roept u de WithDataBindMount methode aan:

var builder = DistributedApplication.CreateBuilder(args);

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

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

Gegevensbindkoppelingen zijn afhankelijk van het bestandssysteem van de hostcomputer om de Azurite-gegevens bij herstarts van de container te behouden. De koppeling van de gegevensbinding wordt gekoppeld aan het ../Azurite/Data pad op de hostcomputer ten opzichte van de AppHost-map (IDistributedApplicationBuilder.AppHostDirectory) in de Azure-container. Zie Docker docs: Bind mounts voor meer informatie over bind mounts voor gegevens.

Verbinding maken met opslagbronnen

Wanneer de Aspire AppHost wordt uitgevoerd, kunnen de opslagbronnen worden geopend door externe hulpprogramma's, zoals StorageAzure Explorer. Als uw opslagresource lokaal wordt uitgevoerd met behulp van Azurite, wordt deze automatisch opgehaald door de Azure Storage Explorer.

Voer de volgende stappen uit om vanuit Azure Storage Explorer verbinding te maken met de opslagresource:

1. Voer de Aspire AppHost uit.

2. Open de Azure Opslagverkenner.

3. Bekijk het deelvenster Explorer.

4. Selecteer de link Vernieuw alles om de lijst met opslagaccounts te vernieuwen.

5. Vouw het knooppunt Emulator & Attached uit.

6. Vouw het Opslagaccounts knooppunt uit.

7. U zou een opslagaccount met de naam van uw resource als voorvoegsel moeten zien.

   

U kunt het opslagaccount en de inhoud ervan verkennen met behulp van de Azure Storage Explorer. Zie Azurevoor meer informatie over het gebruik van de Storage Explorer.

De Azure Queue Storage-resource toevoegen

Registreer in uw AppHost-project de Azure integratie van Queue Storage door een aanroep te koppelen aan AddQueues het IResourceBuilder<IAzureStorageResource> exemplaar dat wordt geretourneerd door AddAzureStorage. In het volgende voorbeeld ziet u hoe u een Azure Queue Storage-resource met de naam storage en een wachtrijresource met de naam queuestoevoegt:

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

De voorgaande code:

• Hiermee wordt een Azure Storage-resource met de naam storagetoegevoegd.
• Hiermee voegt u een wachtrij met de naam jobs toe aan de opslagresource.
• Voegt de storage resource toe aan de ExampleProject en wacht tot deze gereed is voordat het project wordt gestart.

Provisioning-gegenereerde Bicep

Als je nieuw bent met Bicep, is dit een domeinspecifieke taal voor het definiëren van Azure-bronnen. Met Aspire hoeft u Bicep niet handmatig te schrijven, omdat de voorzienings-API's Bicep voor u genereren. Wanneer u uw app publiceert, wordt de gegenereerde Bicep uitgegeven naast het manifestbestand. Wanneer u een Azure Storage-resource toevoegt, wordt de volgende Bicep gegenereerd:

@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

De voorgaande Bicep is een module die een Azure Storage-account in richt met de volgende standaardwaarden:

• kind: het type opslagaccount. De standaardwaarde is StorageV2.
• sku: de SKU van het opslagaccount. De standaardwaarde is Standard_GRS.
• properties: de eigenschappen van het opslagaccount:
  • accessTier: de toegangslaag van het opslagaccount. De standaardwaarde is Hot.
  • allowSharedKeyAccess: een Booleaanse waarde die aangeeft of het opslagaccount toestaat dat aanvragen worden geautoriseerd met de toegangssleutel voor het account. De standaardwaarde is false.
  • minimumTlsVersion: de minimaal ondersteunde TLS-versie voor het opslagaccount. De standaardwaarde is TLS1_2.
  • networkAcls: de netwerk-ACL's voor het opslagaccount. De standaardwaarde is { defaultAction: 'Allow' }.

Naast het opslagaccount wordt ook een blobcontainer geleverd.

De volgende roltoewijzingen worden toegevoegd aan het opslagaccount om uw toepassing toegang te verlenen. Zie de Azure voor meer informatie.

Daarnaast worden roltoewijzingen gemaakt voor de Azure resource in een afzonderlijke module:

@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
}

De gegenereerde Bicep is een beginpunt en wordt beïnvloed door wijzigingen aan de voorzieningsinfrastructuur in C#. Aanpassingen aan het Bicep-bestand zullen direct overschreven worden, dus breng wijzigingen aan via de C#-inrichtings-API's zodat ze weerspiegeld worden in de gegenereerde bestanden.

Voorzieninginfrastructuur aanpassen

Alle AspireAzure resources zijn subklassen van het AzureProvisioningResource type. Met dit type kunt u de gegenereerde Bicep aanpassen door een vloeiende API te bieden waarmee u de Azure-resources kunt configureren, met behulp van de ConfigureInfrastructure<T>(IResourceBuilder<T>, Action<AzureResourceInfrastructure>)-API. U kunt bijvoorbeeld de kind, sku, propertiesen meer configureren. In het volgende voorbeeld ziet u hoe u de Azure Storage-resource aanpast:

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

De voorgaande code:

• Koppelt een aanroep naar de ConfigureInfrastructure-API:
  • De parameter infra is een exemplaar van het AzureResourceInfrastructure type.
  • De voorziende middelen worden opgehaald door de GetProvisionableResources() methode aan te roepen.
  • De enkele StorageAccount wordt opgehaald.
  • De StorageAccount.AccessTier is toegewezen aan StorageAccountAccessTier.Cool.
  • De StorageAccount.Sku wordt toegewezen aan een nieuw StorageSku met als NamePremiumZrs.
  • Er wordt een tag toegevoegd aan het opslagaccount met een sleutel van ExampleKey en een waarde van Example value.

Er zijn nog veel meer configuratieopties beschikbaar om de Azure Storage-resource aan te passen. Zie Azure.Provisioning.Storagevoor meer informatie.

Resource voor Azure Storage-emulator toevoegen

Als u een Azure Storage-emulatorresource wilt toevoegen, koppelt u een aanroep op een IResourceBuilder<AzureStorageResource> aan de RunAsEmulator-API:

var builder = DistributedApplication.CreateBuilder(args);

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

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

Wanneer u RunAsEmulatoraanroept, worden uw opslagbronnen geconfigureerd voor lokaal uitvoeren met behulp van een emulator. De emulator in dit geval is Azurite. De opensource-emulator Van Azurite biedt een gratis lokale omgeving voor het testen van uw Azure Blob-, Queue Storage- en Table Storage-apps en het is een perfecte aanvulling op de AspireAzure hostingintegratie. Azurite is niet geïnstalleerd; In plaats daarvan is het toegankelijk voor Aspire als een container. Wanneer u een container aan de AppHost toevoegt, zoals wordt weergegeven in het vorige voorbeeld met de mcr.microsoft.com/azure-storage/azurite installatiekopieën, wordt de container gemaakt en gestart wanneer de AppHost wordt gestart. Zie levenscyclus van containerresourcesvoor meer informatie.

Azurite-container configureren

Er zijn verschillende configuraties beschikbaar voor containerresources, bijvoorbeeld: u kunt de poorten van de container, omgevingsvariabelen, levensduur en meer configureren.

Azurite-containerpoorten configureren

Standaard worden in de Azure-container, wanneer deze is geconfigureerd door Aspire, de volgende eindpunten weergegeven:

De poort waarop ze luisteren, is standaard dynamisch. Wanneer de container wordt gestart, worden de poorten toegewezen aan een willekeurige poort op de hostcomputer. Als u de eindpuntpoorten wilt configureren, maakt u kettingaanroepen op de containerresourcebouwer die wordt geleverd door de RunAsEmulator Methode, zoals in het volgende voorbeeld:

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

De voorgaande code configureert de bestaande blob, queueen table eindpunten van de Azurite-container om respectievelijk te luisteren op poorten 27000, 27001en 27002. De poorten van de Azurite-container worden toegewezen aan de hostpoorten, zoals wordt weergegeven in de volgende tabel:

Azurite-container configureren met een permanente levensduur

Als u de Azurite-container met een permanente levensduur wilt configureren, roept u de methode WithLifetime op de Resource van de Azurite-container aan en geeft u ContainerLifetime.Persistentdoor:

var builder = DistributedApplication.CreateBuilder(args);

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

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

Zie Levensduur van containerresourcesvoor meer informatie.

Azurite-container configureren met gegevensvolume

Als u een gegevensvolume wilt toevoegen aan de resource van de Azure Storage-emulator, roept u de WithDataVolume methode aan op de resource van de Azure Storage-emulator:

var builder = DistributedApplication.CreateBuilder(args);

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

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

Het gegevensvolume wordt gebruikt om de Azurite-gegevens buiten de levenscyclus van de container te behouden. Het gegevensvolume wordt gekoppeld aan het /data pad in de Azure-container en wanneer er geen name parameter wordt opgegeven, wordt de naam opgemaakt als .azurite/{resource name}. Voor meer informatie over gegevensvolumes en waarom deze de voorkeur hebben boven bind mounts, zie Docker docs: Volumes.

De Azurite-container configureren met een databind-mount

Als u een koppeling voor gegevensbinding wilt toevoegen aan de resource van de Azure Storage-emulator, roept u de WithDataBindMount methode aan:

var builder = DistributedApplication.CreateBuilder(args);

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

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

Gegevensbindkoppelingen zijn afhankelijk van het bestandssysteem van de hostcomputer om de Azurite-gegevens bij herstarts van de container te behouden. De koppeling van de gegevensbinding wordt gekoppeld aan het ../Azurite/Data pad op de hostcomputer ten opzichte van de AppHost-map (IDistributedApplicationBuilder.AppHostDirectory) in de Azure-container. Zie Docker docs: Bind mounts voor meer informatie over bind mounts voor gegevens.

Verbinding maken met een bestaand Azure Storage-account

Mogelijk hebt u een bestaand Azure Storage-account waarmee u verbinding wilt maken. In plaats van een nieuwe Azure opslagresource weer te geven, kunt u een verbindingsreeks toevoegen aan de AppHost. Als u een verbinding wilt toevoegen aan een bestaand Azure Storage-account, roept u de methode AddConnectionString aan:

var builder = DistributedApplication.CreateBuilder(args);

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

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

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

De verbindingsreeks wordt geconfigureerd in de configuratie van AppHost, meestal onder Gebruikersgeheimen, onder de ConnectionStrings sectie. De AppHost injecteert deze verbindingsreeks als een omgevingsvariabele in alle afhankelijke resources, bijvoorbeeld:

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

De afhankelijke resource heeft toegang tot de geïnjecteerde verbindingsreeks door de methode GetConnectionString aan te roepen en de verbindingsnaam door te geven als de parameter, in dit geval "blobs". De GetConnectionString-API is een afkorting voor IConfiguration.GetSection("ConnectionStrings")[name].

Verbinding maken met opslagbronnen

Wanneer de Aspire AppHost wordt uitgevoerd, kunnen de opslagbronnen worden geopend door externe hulpprogramma's, zoals StorageAzure Explorer. Als uw opslagresource lokaal wordt uitgevoerd met behulp van Azurite, wordt deze automatisch opgehaald door de Azure Storage Explorer.

Voer de volgende stappen uit om vanuit Azure Storage Explorer verbinding te maken met de opslagresource:

1. Voer de Aspire AppHost uit.

2. Open de Azure Opslagverkenner.

3. Bekijk het deelvenster Explorer.

4. Selecteer de link Vernieuw alles om de lijst met opslagaccounts te vernieuwen.

5. Vouw het knooppunt Emulator & Attached uit.

6. Vouw het Opslagaccounts knooppunt uit.

7. U zou een opslagaccount met de naam van uw resource als voorvoegsel moeten zien.

   

U kunt het opslagaccount en de inhoud ervan verkennen met behulp van de Azure Storage Explorer. Zie Azurevoor meer informatie over het gebruik van de Storage Explorer.

Gezondheidscontroles voor hostingintegratie

De integratie van Azure Storage-hosting voegt automatisch een statuscontrole toe voor de opslagresource. Het wordt alleen toegevoegd bij uitvoering als emulator en controleert of de Azurite-container draait en of er een verbinding tot stand kan worden gebracht. De hostingintegratie is afhankelijk van de 📦 AspNetCore.HealthChecks.Azure. Storage.Blobs NuGet-pakket.

integratie Client

Om te beginnen met de AspireAzure Queue Storage-clientintegratie, installeer het 📦Aspire.Azure.Storage.Queues NuGet-pakket in het project dat de Azure Queue Storage-client gebruikt. De Azure Queue Storage-clientintegratie registreert een QueueServiceClient exemplaar dat u kunt gebruiken om te communiceren met Azure Queue Storage.

dotnet add package Aspire.Azure.Storage.Queues

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

Azure Queue Storage-client toevoegen

Roep in het Program.cs bestand van het clientgebruikte project de AddAzureQueueClient-extensiemethode aan op een IHostApplicationBuilder om een QueueServiceClient te registreren voor gebruik via de container voor afhankelijkheidsinjectie. De methode gebruikt een verbindingsnaamparameter.

builder.AddAzureQueueClient("queue");

Vervolgens kunt u het QueueServiceClient exemplaar ophalen met behulp van afhankelijkheidsinjectie. Bijvoorbeeld om de client op te halen uit een service:

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

Configuration

De integratie van AspireAzure Queue Storage biedt meerdere opties voor het configureren van de QueueServiceClient op basis van de vereisten en conventies van uw project.

Een verbindingsreeks gebruiken

Wanneer u een verbindingsreeks uit de sectie ConnectionStrings configuratie gebruikt, kunt u de naam van de verbindingsreeks opgeven bij het aanroepen van AddAzureQueueClient:

builder.AddAzureQueueClient("queue");

Vervolgens wordt de verbindingsreeks opgehaald uit de ConnectionStrings configuratiesectie en worden twee verbindingsindelingen ondersteund:

Service-URI

De aanbevolen methode is om een ServiceUrite gebruiken, die werkt met de eigenschap AzureStorageQueuesSettings.Credential om een verbinding tot stand te brengen. Als er geen referentiegegevens zijn geconfigureerd, wordt de Azure.Identity.DefaultAzureCredential gebruikt.

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

verbindingsstring

U kunt ook een Azure Storage-verbindingsreeks gebruiken.

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

Zie Azure Storage-verbindingsreeksen configurerenvoor meer informatie.

Configuratieproviders gebruiken

De integratie van AspireAzure Queue Storage ondersteunt Microsoft.Extensions.Configuration. Hiermee worden de AzureStorageQueuesSettings en QueueClientOptions vanuit de configuratie geladen met behulp van de Aspire:Azure:Storage:Queues-sleutel. Het volgende codefragment is een voorbeeld van een appsettings.json-bestand waarmee een aantal van de opties wordt geconfigureerd:

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

Zie Azure Storage Queuesvoor het volledige JSON client-integratieschema Aspire.Azure. Data.Queues/ConfigurationSchema.json.

Benoemde configuratie gebruiken

De AspireAzure Queue Storage-integratie ondersteunt benoemde configuratie, waarmee u meerdere exemplaren van hetzelfde resourcetype met verschillende instellingen kunt configureren. De benoemde configuratie maakt gebruik van de verbindingsnaam als een sleutel in het hoofdgedeelte van de configuratie.

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

In dit voorbeeld kunnen de queue1 en queue2 verbindingsnamen worden gebruikt wanneer AddAzureQueueClient wordt aangeroepen:

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

Benoemde configuratie heeft voorrang op de configuratie op het hoogste niveau. Als beide zijn opgegeven, overschrijven de instellingen van de benoemde configuratie de instellingen op het hoogste niveau.

Inline delegeringen gebruiken

U kunt ook de Action<AzureStorageQueuesSettings> configureSettings gedelegeerde doorgeven om enkele of alle opties inline in te stellen, bijvoorbeeld om gezondheidscontroles te configureren.

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

U kunt de QueueClientOptions ook instellen via de Action<IAzureClientBuilder<QueueServiceClient, QueueClientOptions>> configureClientBuilder delegeer, de tweede parameter van de AddAzureQueueClient methode. Als u bijvoorbeeld het eerste deel van de user-agent header wilt instellen voor alle verzoeken verzonden door deze client.

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

statuscontroles voor Client integratie

Aspire Standaard schakelen integraties statuscontroles in voor alle services. Zie Aspire het overzicht van integraties voor meer informatie.

De integratie van AspireAzure Queue Storage:

• Hiermee wordt de gezondheidscontrole toegevoegd wanneer AzureStorageQueuesSettings.DisableHealthChecksfalseis, waarmee geprobeerd wordt verbinding te maken met de Azure Queue Storage.
• Kan worden geïntegreerd met het /health HTTP-eindpunt, waarmee is vastgesteld dat alle geregistreerde gezondheidscontroles moeten slagen voordat de app als gereed wordt beschouwd om verkeer te accepteren.

Waarneembaarheid en telemetrie

Aspire Integraties stellen automatisch configuraties voor logboekregistratie, tracering en metrische gegevens in, die ook wel de pijlers van waarneembaarheid worden genoemd. Zie het overzicht van integratieobserveerbaarheid en telemetrie voor meer informatie over integratieobserveerbaarheid en telemetrieAspire. Afhankelijk van de back-upservice ondersteunen sommige integraties mogelijk slechts enkele van deze functies. Sommige integraties ondersteunen bijvoorbeeld logboekregistratie en tracering, maar geen metrische gegevens. Telemetriefuncties kunnen ook worden uitgeschakeld met behulp van de technieken die worden weergegeven in de sectie Configuratie.

Logging

De integratie van AspireAzure Queue Storage maakt gebruik van de volgende logboekcategorieën:

• Azure.Core
• Azure.Identity

Tracing

De integratie van AspireAzure Queue Storage verzendt de volgende traceringsactiviteiten met behulp van OpenTelemetry:

• Azure.Storage.Queues.QueueClient

Metrics

De integratie van AspireAzure Queue Storage biedt momenteel geen ondersteuning voor metriek door beperkingen van de Azure SDK.

Zie ook

• Azure Queue Storage-documenten
• Aspire Integraties
• Aspire GitHub Repo