Configuration Names - List

Serviço:: Service Connector

Versão da API:: 2022-11-01-preview

Lista os nomes de configuração gerados pelo Service Connector para todos os tipos de destino, tipo de cliente e autenticação.

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
$filter	query		string	Opções de filtro OData.
$skipToken	query		string	Opção skipToken OData para paginação.

Respostas

Name	Tipo	Description
200 OK	ConfigurationNameResult	OK. O pedido foi bem-sucedido.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

GetConfigurationNames

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

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

Resposta da amostra

Código de estado:: 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
}

Definições

Name	Description
AuthType	O tipo de autenticação.
clientType	O tipo de cliente do aplicativo
ConfigurationName	Os nomes de configuração.
ConfigurationNameItem
ConfigurationNameResult	Lista de nomes de configuração que será definida com base em diferentes recursos de destino, tipo de cliente, tipo de autenticação.
DaprMetadata	Os metadados do componente dapr.
DaprProperties	Indica algumas propriedades adicionais para o tipo de cliente dapr
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro

AuthType

Enumeração

O tipo de autenticação.

Valor	Description
systemAssignedIdentity
userAssignedIdentity
servicePrincipalSecret
servicePrincipalCertificate
secret
accessKey
userAccount

clientType

Enumeração

O tipo de cliente do aplicativo

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

ConfigurationName

Object

Os nomes de configuração.

Name	Tipo	Description
description	string	Descrição do nome da configuração.
required	boolean	Representar a configuração é necessária ou não
value	string

ConfigurationNameItem

Object

Name	Tipo	Description
properties.authType	AuthType	O tipo de autenticação.
properties.clientType	clientType	O tipo de cliente para nomes de configuração.
properties.daprProperties	DaprProperties	Indica algumas propriedades adicionais para o tipo de cliente dapr
properties.names	ConfigurationName[]	Os nomes de configuração a serem definidos no ambiente de serviço de computação.
properties.targetService	string	O nome do provedor de serviços de destino e o nome do recurso.

ConfigurationNameResult

Object

Lista de nomes de configuração que será definida com base em diferentes recursos de destino, tipo de cliente, tipo de autenticação.

Name	Tipo	Description
nextLink	string	Link para a próxima página de recursos.
value	ConfigurationNameItem[]	Nomes de configuração esperados para cada serviço de destino.

DaprMetadata

Object

Os metadados do componente dapr.

Name	Tipo	Description
name	string	Nome da propriedade Metadata.
secretRef	string	O nome secreto onde dapr poderia obter valor
value	string	Valor da propriedade Metadata.

DaprProperties

Object

Indica algumas propriedades adicionais para o tipo de cliente dapr

Name	Tipo	Description
componentType	string	O tipo de componente dapr
metadata	DaprMetadata[]	Metadados dapr adicionais
scopes	string[]	Os escopos do componente dapr
secretStoreComponent	string	O nome de uma loja secreta dapr para recuperar segredo
version	string	A versão do componente dapr

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

Partilhar via

Configuration Names - List

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

GetConfigurationNames

Pedido de amostra

Resposta da amostra

Definições

AuthType

clientType

ConfigurationName

ConfigurationNameItem

ConfigurationNameResult

DaprMetadata

DaprProperties

ErrorAdditionalInfo

ErrorDetail

ErrorResponse