Configuration Names - List

服务:

Service Connector

API 版本:

2022-11-01-preview

列出服务连接器针对所有目标、客户端类型、身份验证类型生成的配置名称。

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

具有可选参数:

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

URI 参数

名称	在	必需	类型	说明
api-version	query	True	string minLength: 1	用于此操作的 API 版本。
$filter	query		string	OData 筛选器选项。
$skipToken	query		string	用于分页的 OData skipToken 选项。

响应

名称	类型	说明
200 OK	ConfigurationNameResult	还行。 请求已成功。
Other Status Codes	ErrorResponse	描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

GetConfigurationNames

示例请求

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

示例响应

状态代码:

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
}

定义

名称	说明
AuthType	身份验证类型。
clientType	应用程序客户端类型
ConfigurationName	配置名称。
ConfigurationNameItem
ConfigurationNameResult	将基于不同目标资源、客户端类型、身份验证类型设置的配置名称列表。
DaprMetadata	dapr 组件元数据。
DaprProperties	指示 dapr 客户端类型的一些附加属性
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应

AuthType

枚举

身份验证类型。

值	说明
systemAssignedIdentity
userAssignedIdentity
servicePrincipalSecret
servicePrincipalCertificate
secret
accessKey
userAccount

clientType

枚举

应用程序客户端类型

值	说明
none
dotnet
java
python
go
php
ruby
django
nodejs
springBoot
kafka-springBoot
dapr

ConfigurationName

Object

配置名称。

名称	类型	说明
description	string	配置名称的说明。
required	boolean	表示配置是必需的或不需要
value	string

ConfigurationNameItem

Object

名称	类型	说明
properties.authType	AuthType	身份验证类型。
properties.clientType	clientType	配置名称的客户端类型。
properties.daprProperties	DaprProperties	指示 dapr 客户端类型的一些附加属性
properties.names	ConfigurationName[]	要设置在计算服务环境中的配置名称。
properties.targetService	string	目标服务提供程序名称和资源名称。

ConfigurationNameResult

Object

将基于不同目标资源、客户端类型、身份验证类型设置的配置名称列表。

名称	类型	说明
nextLink	string	链接到下一页的资源。
value	ConfigurationNameItem[]	每个目标服务的预期配置名称。

DaprMetadata

Object

dapr 组件元数据。

名称	类型	说明
name	string	元数据属性名称。
secretRef	string	dapr 可以获取值的机密名称
value	string	元数据属性值。

DaprProperties

Object

指示 dapr 客户端类型的一些附加属性

名称	类型	说明
componentType	string	dapr 组件类型
metadata	DaprMetadata[]	其他 dapr 元数据
scopes	string[]	dapr 组件范围
secretStoreComponent	string	要检索机密的机密存储 dapr 的名称
version	string	dapr 组件版本

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。