Dapr Components - Get

Service:

Azure Container Apps

API Version:

2023-04-01-preview

Pobieranie składnika dapr.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents/{componentName}?api-version=2023-04-01-preview

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
componentName	path	True	string	Nazwa składnika Dapr.
environmentName	path	True	string	Nazwa środowiska zarządzanego.
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DaprComponent	OK
Other Status Codes	DefaultErrorResponse	Typowa odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Get Dapr Component with secret store component

Get Dapr Component with secrets

Get Dapr Component with secret store component

Sample Request

HTTP

GET https://management.azure.com/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprComponents/reddog?api-version=2023-04-01-preview

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.AppContainers;
using Azure.ResourceManager.AppContainers.Models;

// Generated from example definition: specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/DaprComponents_Get_SecretStoreComponent.json
// this example is just showing the usage of "DaprComponents_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ContainerAppManagedEnvironmentDaprComponentResource created on azure
// for more information of creating ContainerAppManagedEnvironmentDaprComponentResource, please refer to the document of ContainerAppManagedEnvironmentDaprComponentResource
string subscriptionId = "8efdecc5-919e-44eb-b179-915dca89ebf9";
string resourceGroupName = "examplerg";
string environmentName = "myenvironment";
string componentName = "reddog";
ResourceIdentifier containerAppManagedEnvironmentDaprComponentResourceId = ContainerAppManagedEnvironmentDaprComponentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, environmentName, componentName);
ContainerAppManagedEnvironmentDaprComponentResource containerAppManagedEnvironmentDaprComponent = client.GetContainerAppManagedEnvironmentDaprComponentResource(containerAppManagedEnvironmentDaprComponentResourceId);

// invoke the operation
ContainerAppManagedEnvironmentDaprComponentResource result = await containerAppManagedEnvironmentDaprComponent.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ContainerAppDaprComponentData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1/daprcomponents/reddog",
  "name": "reddog",
  "type": "Microsoft.App/managedEnvironments/daprcomponents",
  "properties": {
    "componentType": "state.azure.cosmosdb",
    "version": "v1",
    "ignoreErrors": false,
    "initTimeout": "50s",
    "secretStoreComponent": "my-secret-store",
    "metadata": [
      {
        "name": "url",
        "value": "<COSMOS-URL>"
      },
      {
        "name": "database",
        "value": "itemsDB"
      },
      {
        "name": "collection",
        "value": "items"
      },
      {
        "name": "masterkey",
        "secretRef": "masterkey"
      }
    ],
    "scopes": [
      "container-app-1",
      "container-app-2"
    ]
  }
}

Get Dapr Component with secrets

Sample Request

HTTP

GET https://management.azure.com/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprComponents/reddog?api-version=2023-04-01-preview

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.AppContainers;
using Azure.ResourceManager.AppContainers.Models;

// Generated from example definition: specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/DaprComponents_Get_Secrets.json
// this example is just showing the usage of "DaprComponents_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ContainerAppManagedEnvironmentDaprComponentResource created on azure
// for more information of creating ContainerAppManagedEnvironmentDaprComponentResource, please refer to the document of ContainerAppManagedEnvironmentDaprComponentResource
string subscriptionId = "8efdecc5-919e-44eb-b179-915dca89ebf9";
string resourceGroupName = "examplerg";
string environmentName = "myenvironment";
string componentName = "reddog";
ResourceIdentifier containerAppManagedEnvironmentDaprComponentResourceId = ContainerAppManagedEnvironmentDaprComponentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, environmentName, componentName);
ContainerAppManagedEnvironmentDaprComponentResource containerAppManagedEnvironmentDaprComponent = client.GetContainerAppManagedEnvironmentDaprComponentResource(containerAppManagedEnvironmentDaprComponentResourceId);

// invoke the operation
ContainerAppManagedEnvironmentDaprComponentResource result = await containerAppManagedEnvironmentDaprComponent.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ContainerAppDaprComponentData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1/daprcomponents/reddog",
  "name": "reddog",
  "type": "Microsoft.App/managedEnvironments/daprcomponents",
  "properties": {
    "componentType": "state.azure.cosmosdb",
    "version": "v1",
    "ignoreErrors": false,
    "initTimeout": "50s",
    "secrets": [
      {
        "name": "masterkey"
      }
    ],
    "metadata": [
      {
        "name": "url",
        "value": "<COSMOS-URL>"
      },
      {
        "name": "database",
        "value": "itemsDB"
      },
      {
        "name": "collection",
        "value": "items"
      },
      {
        "name": "masterkey",
        "secretRef": "masterkey"
      }
    ],
    "scopes": [
      "container-app-1",
      "container-app-2"
    ]
  }
}

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
DaprComponent	Dapr, składnik.
DaprMetadata	Metadane składnika języka Dapr.
DefaultErrorResponse	App Service odpowiedź na błąd.
Details	Szczegóły lub błąd
Error	Model błędu.
Secret	Definicja wpisu tajnego.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

DaprComponent

Dapr, składnik.

Nazwa	Typ	Wartość domyślna	Opis
id	string		W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Nazwa zasobu
properties.componentType	string		Typ składnika
properties.ignoreErrors	boolean	False	Wartość logiczna opisująca, czy błędy składnika są ignorowane
properties.initTimeout	string		Limit czasu inicjowania
properties.metadata	DaprMetadata[]		Metadane składników
properties.scopes	string[]		Nazwy aplikacji kontenera, które mogą używać tego składnika Dapr
properties.secretStoreComponent	string		Nazwa składnika Dapr do pobierania wpisów tajnych składników z
properties.secrets	Secret[]		Zbieranie wpisów tajnych używanych przez składnik Języka Dapr
properties.version	string		Wersja składnika
systemData	systemData		Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string		Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

DaprMetadata

Metadane składnika języka Dapr.

Nazwa	Typ	Opis
name	string	Nazwa właściwości metadanych.
secretRef	string	Nazwa wpisu tajnego składnika dapr, z którego ma być pobierana wartość właściwości metadanych.
value	string	Wartość właściwości metadanych.

DefaultErrorResponse

App Service odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Model błędu.

Details

Szczegóły lub błąd

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg w celu programowego identyfikowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

Error

Model błędu.

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg w celu programowego identyfikowania błędu.
details	Details[]	Szczegóły lub błąd
innererror	string	Więcej informacji na temat debugowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

Secret

Definicja wpisu tajnego.

Nazwa	Typ	Opis
identity	string	Identyfikator zasobu tożsamości zarządzanej do uwierzytelniania za pomocą usługi Azure Key Vault lub system do używania tożsamości przypisanej przez system.
keyVaultUrl	string	Adres URL usługi Azure Key Vault wskazujący wpis tajny przywołyny przez aplikację kontenera.
name	string	Nazwa wpisu tajnego.
value	string	Wartość wpisu tajnego.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobów (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.