Connected Environments - List By Subscription

Odwołanie

Service:: Azure Container Apps

API Version:: 2023-04-01-preview

Pobierz wszystkie połączoneŚrodowisko dla subskrypcji.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.App/connectedEnvironments?api-version=2023-04-01-preview

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
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	ConnectedEnvironmentCollection	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

List connected environments by subscription

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

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;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ConnectedEnvironments_ListBySubscription.json
// this example is just showing the usage of "ConnectedEnvironments_ListBySubscription" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "8efdecc5-919e-44eb-b179-915dca89ebf9";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (ContainerAppConnectedEnvironmentResource item in subscriptionResource.GetContainerAppConnectedEnvironmentsAsync())
{
    // the variable item 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
    ContainerAppConnectedEnvironmentData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

{
  "value": [
    {
      "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/sample1",
      "name": "sample1",
      "type": "Microsoft.App/connectedEnvironments",
      "location": "North Central US",
      "tags": {},
      "properties": {
        "provisioningState": "Succeeded",
        "deploymentErrors": null,
        "defaultDomain": "sample1.k4apps.io",
        "staticIp": "20.42.33.145",
        "customDomainConfiguration": {
          "customDomainVerificationId": "custom domain verification id",
          "dnsSuffix": "www.my-name.com",
          "subjectName": "CN=www.my-name.com",
          "expirationDate": "2022-11-06T04:00:00Z",
          "thumbprint": "CERTIFICATE_THUMBPRINT"
        }
      }
    },
    {
      "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/DemoRG/providers/Microsoft.App/connectedEnvironments/sample2",
      "name": "sample2",
      "type": "Microsoft.App/connectedEnvironments",
      "location": "North Central US",
      "tags": {},
      "properties": {
        "provisioningState": "Succeeded",
        "deploymentErrors": null,
        "defaultDomain": "sample2.k4apps.io",
        "staticIp": "52.142.21.61",
        "customDomainConfiguration": {
          "customDomainVerificationId": "custom domain verification id",
          "dnsSuffix": "www.my-name2.com",
          "subjectName": "CN=www.my-name2.com",
          "expirationDate": "2022-11-06T04:00:00Z",
          "thumbprint": "CERTIFICATE_THUMBPRINT"
        }
      }
    }
  ]
}

Definicje

Nazwa	Opis
ConnectedEnvironment	Środowisko klastra Kubernetes wyspecjalizowane w przypadku obciążeń internetowych przez Azure App Service
ConnectedEnvironmentCollection	Kolekcja połączonychśrodowień
ConnectedEnvironmentProvisioningState	Stan aprowizacji środowiska Kubernetes.
createdByType	Typ tożsamości, która utworzyła zasób.
CustomDomainConfiguration	Właściwości konfiguracji dla domeny niestandardowej środowiska aplikacji
DefaultErrorResponse	App Service odpowiedź na błąd.
Details	Szczegóły lub błąd
Error	Model błędu.
ExtendedLocation	Typ złożony lokalizacji rozszerzonej.
ExtendedLocationTypes	Typ lokalizacji rozszerzonej.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

ConnectedEnvironment

Środowisko klastra Kubernetes wyspecjalizowane w przypadku obciążeń internetowych przez Azure App Service

Nazwa	Typ	Opis
extendedLocation	ExtendedLocation	Typ złożony lokalizacji rozszerzonej.
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Lokalizacja geograficzna, w której znajduje się zasób
name	string	Nazwa zasobu
properties.customDomainConfiguration	CustomDomainConfiguration	Konfiguracja domeny niestandardowej dla środowiska
properties.daprAIConnectionString	string	Parametry połączenia usługi Application Insights używane przez narzędzie Dapr do eksportowania danych telemetrycznych komunikacji usługi do usługi
properties.defaultDomain	string	Domyślna nazwa domeny klastra
properties.deploymentErrors	string	Wszelkie błędy, które wystąpiły podczas wdrażania lub walidacji wdrożenia
properties.provisioningState	ConnectedEnvironmentProvisioningState	Stan aprowizacji środowiska Kubernetes.
properties.staticIp	string	Statyczny adres IP połączonegośrodowisko
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

ConnectedEnvironmentCollection

Kolekcja połączonychśrodowień

Nazwa	Typ	Opis
nextLink	string	Łącze do następnej strony zasobów.
value	ConnectedEnvironment[]	Kolekcja zasobów.

ConnectedEnvironmentProvisioningState

Stan aprowizacji środowiska Kubernetes.

Nazwa	Typ	Opis
Canceled	string
Failed	string
InfrastructureSetupComplete	string
InfrastructureSetupInProgress	string
InitializationInProgress	string
ScheduledForDelete	string
Succeeded	string
Waiting	string

createdByType

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

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

CustomDomainConfiguration

Właściwości konfiguracji dla domeny niestandardowej środowiska aplikacji

Nazwa	Typ	Opis
certificatePassword	string	Hasło certyfikatu
certificateValue	string	Obiekt blob PFX lub PEM
customDomainVerificationId	string	Identyfikator używany do weryfikowania własności nazwy domeny
dnsSuffix	string	Sufiks DNS dla domeny środowiska
expirationDate	string	Data wygaśnięcia certyfikatu.
subjectName	string	Nazwa podmiotu certyfikatu.
thumbprint	string	Odcisk palca certyfikatu.

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.

ExtendedLocation

Typ złożony lokalizacji rozszerzonej.

Nazwa	Typ	Opis
name	string	Nazwa lokalizacji rozszerzonej.
type	ExtendedLocationTypes	Typ lokalizacji rozszerzonej.

ExtendedLocationTypes

Typ lokalizacji rozszerzonej.

Nazwa	Typ	Opis
CustomLocation	string

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.