Configuration Names - List

Service:

Service Connector

Version d'API:

2022-11-01-preview

Répertorie les noms de configuration générés par Service Connector pour tous les types cibles, clients, authentification.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
$filter	query		string	Options de filtre OData.
$skipToken	query		string	Option OData skipToken pour la pagination.

Réponses

Nom	Type	Description
200 OK	ConfigurationNameResult	D’ACCORD. La demande a réussi.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

GetConfigurationNames

Exemple de requête

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

Exemple de réponse

Code d’état:

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
}

Définitions

Nom	Description
AuthType	Type d’authentification.
clientType	Type de client d’application
ConfigurationName	Noms de configuration.
ConfigurationNameItem
ConfigurationNameResult	Liste de noms de configuration qui sera définie en fonction de différentes ressources cibles, type de client, type d’authentification.
DaprMetadata	Métadonnées du composant dapr.
DaprProperties	Indique certaines propriétés supplémentaires pour le type de client dapr
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur

AuthType

Énumération

Type d’authentification.

Valeur	Description
systemAssignedIdentity
userAssignedIdentity
servicePrincipalSecret
servicePrincipalCertificate
secret
accessKey
userAccount

clientType

Énumération

Type de client d’application

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

ConfigurationName

Object

Noms de configuration.

Nom	Type	Description
description	string	Description du nom de configuration.
required	boolean	Représenter la configuration est requise ou non
value	string

ConfigurationNameItem

Object

Nom	Type	Description
properties.authType	AuthType	Type d’authentification.
properties.clientType	clientType	Type de client pour les noms de configuration.
properties.daprProperties	DaprProperties	Indique certaines propriétés supplémentaires pour le type de client dapr
properties.names	ConfigurationName[]	Noms de configuration à définir dans l’environnement de service de calcul.
properties.targetService	string	Nom du fournisseur de services cible et nom de ressource.

ConfigurationNameResult

Object

Liste de noms de configuration qui sera définie en fonction de différentes ressources cibles, type de client, type d’authentification.

Nom	Type	Description
nextLink	string	Lien vers la page suivante des ressources.
value	ConfigurationNameItem[]	Noms de configuration attendus pour chaque service cible.

DaprMetadata

Object

Métadonnées du composant dapr.

Nom	Type	Description
name	string	Nom de la propriété de métadonnées.
secretRef	string	Nom du secret où dapr peut obtenir la valeur
value	string	Valeur de propriété de métadonnées.

DaprProperties

Object

Indique certaines propriétés supplémentaires pour le type de client dapr

Nom	Type	Description
componentType	string	Type de composant dapr
metadata	DaprMetadata[]	Métadonnées dapr supplémentaires
scopes	string[]	Étendues des composants dapr
secretStoreComponent	string	Nom d’un dapr de magasin de secrets pour récupérer le secret
version	string	Version du composant dapr

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.