Configuration Names - List

Služba:

Service Connector

Verze rozhraní API:

2022-11-01-preview

Zobrazí seznam názvů konfigurací vygenerovaných konektorem služby pro všechny cílové typy klientů, typy ověřování.

GET https://management.azure.com/providers/Microsoft.ServiceLinker/configurationNames?api-version=2022-11-01-preview

S volitelnými parametry:

GET https://management.azure.com/providers/Microsoft.ServiceLinker/configurationNames?api-version=2022-11-01-preview&$filter={$filter}&$skipToken={$skipToken}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
$filter	query		string	Možnosti filtru OData.
$skipToken	query		string	Možnost OData skipToken pro stránkování

Odpovědi

Name	Typ	Description
200 OK	ConfigurationNameResult	OK. Požadavek byl úspěšný.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

GetConfigurationNames

Ukázkový požadavek

HTTP

GET https://management.azure.com/providers/Microsoft.ServiceLinker/configurationNames?api-version=2022-11-01-preview

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.servicelinker import ServiceLinkerManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-servicelinker
# USAGE
    python configuration_names_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ServiceLinkerManagementClient(
        credential=DefaultAzureCredential(),
    )

    response = client.configuration_names.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2022-11-01-preview/examples/ConfigurationNamesList.json
if __name__ == "__main__":
    main()

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

Ukázková odpověď

Stavový kód:

200

{
  "value": [
    {
      "properties": {
        "targetService": "MICROSOFT.APPCONFIGURATION/CONFIGURATIONSTORES",
        "clientType": "none",
        "authType": "systemAssignedIdentity",
        "names": [
          {
            "value": "AZURE_APPCONFIGURATION_ENDPOINT",
            "description": "App configuration endpoint"
          },
          {
            "value": "AZURE_APPCONFIGURATION_SCOPE",
            "description": "The scopes required for the token."
          }
        ]
      }
    },
    {
      "properties": {
        "targetService": "MICROSOFT.APPCONFIGURATION/CONFIGURATIONSTORES",
        "clientType": "none",
        "authType": "userAssignedIdentity",
        "names": [
          {
            "value": "AZURE_APPCONFIGURATION_ENDPOINT",
            "description": "App configuration endpoint"
          },
          {
            "value": "AZURE_APPCONFIGURATION_CLIENTID",
            "description": "The client(application) ID of the user identity."
          },
          {
            "value": "AZURE_APPCONFIGURATION_SCOPE",
            "description": "The scopes required for getting token."
          }
        ]
      }
    }
  ],
  "nextLink": null
}

Definice

Name	Description
AuthType	Typ ověřování.
clientType	Typ klienta aplikace
ConfigurationName	Názvy konfigurací.
ConfigurationNameItem
ConfigurationNameResult	Seznam názvů konfigurace, který se nastaví na základě jiného cílového prostředku, typu klienta, typu ověřování.
DaprMetadata	Metadata komponenty dapr.
DaprProperties	Označuje některé další vlastnosti pro typ klienta dapr.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď

AuthType

Výčet

Typ ověřování.

Hodnota	Description
systemAssignedIdentity
userAssignedIdentity
servicePrincipalSecret
servicePrincipalCertificate
secret
accessKey
userAccount

clientType

Výčet

Typ klienta aplikace

Hodnota	Description
none
dotnet
java
python
go
php
ruby
django
nodejs
springBoot
kafka-springBoot
dapr

ConfigurationName

Objekt

Názvy konfigurací.

Name	Typ	Description
description	string	Popis názvu konfigurace
required	boolean	Reprezentace konfigurace je povinná nebo nikoli.
value	string

ConfigurationNameItem

Objekt

Name	Typ	Description
properties.authType	AuthType	Typ ověřování.
properties.clientType	clientType	Typ klienta pro názvy konfigurace.
properties.daprProperties	DaprProperties	Označuje některé další vlastnosti pro typ klienta dapr.
properties.names	ConfigurationName[]	Názvy konfigurace, které se mají nastavit v prostředí výpočetní služby.
properties.targetService	string	Název cílového poskytovatele služby a název prostředku.

ConfigurationNameResult

Objekt

Seznam názvů konfigurace, který se nastaví na základě jiného cílového prostředku, typu klienta, typu ověřování.

Name	Typ	Description
nextLink	string	Odkaz na další stránku prostředků
value	ConfigurationNameItem[]	Očekávané názvy konfigurace pro každou cílovou službu

DaprMetadata

Objekt

Metadata komponenty dapr.

Name	Typ	Description
name	string	Název vlastnosti metadat.
secretRef	string	Název tajného kódu, ve kterém může dapr získat hodnotu
value	string	Hodnota vlastnosti metadat.

DaprProperties

Objekt

Označuje některé další vlastnosti pro typ klienta dapr.

Name	Typ	Description
componentType	string	Typ komponenty dapr
metadata	DaprMetadata[]	Další metadata dapr
scopes	string[]	Obory komponent dapr
secretStoreComponent	string	Název dapr úložiště tajných kódů pro načtení tajného kódu
version	string	Verze komponenty dapr

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.