Workspace Connections - List Secrets

Ссылка

Служба:: Machine Learning

Версия API:: 2024-10-01

Список всех секретов подключений рабочих областей машинного обучения.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/listsecrets?api-version=2024-10-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
connectionName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Понятное имя подключения к рабочей области
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Имя рабочей области Машинного обучения Azure.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	WorkspaceConnectionPropertiesV2BasicResource	Запрос выполнен успешно; запрос был хорошо сформирован и получен должным образом.
Other Status Codes	ErrorResponse	Ошибка

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

GetWorkspaceConnection

Образец запроса

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/connections/connection-1/listsecrets?api-version=2024-10-01

Пример ответа

Код состояния:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/connections/connection-1",
  "name": "connection-1",
  "type": "Microsoft.MachineLearningServices/workspaces/connections",
  "properties": {
    "authType": "AccessKey",
    "credentials": {
      "accessKeyId": "some_string",
      "secretAccessKey": "some_string"
    },
    "category": "CustomKeys",
    "expiryTime": "2020-01-01T00:00:00Z",
    "target": "some_string",
    "metadata": {}
  },
  "systemData": {
    "createdAt": "2020-01-01T00:00:00Z",
    "createdBy": "some_string",
    "createdByType": "ManagedIdentity",
    "lastModifiedAt": "2020-01-01T00:00:00Z",
    "lastModifiedBy": "some_string",
    "lastModifiedByType": "User"
  }
}

Определения

Имя	Описание
AADAuthTypeWorkspaceConnectionProperties	Этот тип подключения охватывает проверку подлинности AAD для любой применимой службы Azure.
AccessKeyAuthTypeWorkspaceConnectionProperties
AccountKeyAuthTypeWorkspaceConnectionProperties	Этот тип подключения охватывает подключение к ключу учетной записи для хранилища Azure
ApiKeyAuthWorkspaceConnectionProperties	Этот тип подключения охватывает универсальные категории подключений apiKey, например AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (как тип дискриминационных) Учетные данные:= {ApiKey} как Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase} CognitiveService: Category:= CognitiveService AuthType:= ApiKey (как тип дискриминационный) Credentials:= {SubscriptionKey} как Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion} CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (как тип дискриминационный) Credentials:= {Key} как Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint} Использование контейнера свойств метаданных для ApiType, ApiVersion, Kind и других полей метаданных
ConnectionAuthType	Тип проверки подлинности целевого объекта подключения
ConnectionCategory	Категория подключения
ConnectionGroup	Группа на основе категории подключения
createdByType	Тип удостоверения, создавшего ресурс.
CustomKeys	Объект учетных данных пользовательских ключей
CustomKeysWorkspaceConnectionProperties	Категория:= CustomKeys AuthType:= CustomKeys (как тип дискриминационные) Credentials:= {CustomKeys} в качестве Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Использовать контейнер свойств метаданных для ApiVersion и других полей метаданных
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
ManagedIdentityAuthTypeWorkspaceConnectionProperties
NoneAuthTypeWorkspaceConnectionProperties
OAuth2AuthTypeWorkspaceConnectionProperties
PATAuthTypeWorkspaceConnectionProperties
SASAuthTypeWorkspaceConnectionProperties
ServicePrincipalAuthTypeWorkspaceConnectionProperties
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
UsernamePasswordAuthTypeWorkspaceConnectionProperties
ValueFormat	Формат значения подключения к рабочей области
WorkspaceConnectionAccessKey
WorkspaceConnectionAccountKey
WorkspaceConnectionApiKey	Объект ключа API для учетных данных подключения к рабочей области.
WorkspaceConnectionManagedIdentity
WorkspaceConnectionOAuth2	Требуется ClientId и ClientSecret. Другие свойства являются необязательными в зависимости от реализации каждого поставщика OAuth2.
WorkspaceConnectionPersonalAccessToken
WorkspaceConnectionPropertiesV2BasicResource
WorkspaceConnectionServicePrincipal
WorkspaceConnectionSharedAccessSignature
WorkspaceConnectionUsernamePassword

AADAuthTypeWorkspaceConnectionProperties

Object

Этот тип подключения охватывает проверку подлинности AAD для любой применимой службы Azure.

Имя	Тип	Описание
authType	string: AAD	Тип проверки подлинности целевого объекта подключения
category	ConnectionCategory	Категория подключения
createdByWorkspaceArmId	string (arm-id)
expiryTime	string (date-time)
group	ConnectionGroup	Группа на основе категории подключения
isSharedToAll	boolean
metadata	object	Хранение метаданных пользователя для этого подключения
sharedUserList	string[]
target	string
value	string	Сведения о значении подключения к рабочей области.
valueFormat	ValueFormat	Формат значения подключения к рабочей области

AccessKeyAuthTypeWorkspaceConnectionProperties

Object

Имя	Тип	Описание
authType	string: AccessKey	Тип проверки подлинности целевого объекта подключения
category	ConnectionCategory	Категория подключения
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionAccessKey
expiryTime	string (date-time)
group	ConnectionGroup	Группа на основе категории подключения
isSharedToAll	boolean
metadata	object	Хранение метаданных пользователя для этого подключения
sharedUserList	string[]
target	string
value	string	Сведения о значении подключения к рабочей области.
valueFormat	ValueFormat	Формат значения подключения к рабочей области

AccountKeyAuthTypeWorkspaceConnectionProperties

Object

Этот тип подключения охватывает подключение к ключу учетной записи для хранилища Azure

Имя	Тип	Описание
authType	string: AccountKey	Тип проверки подлинности целевого объекта подключения
category	ConnectionCategory	Категория подключения
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionAccountKey
expiryTime	string (date-time)
group	ConnectionGroup	Группа на основе категории подключения
isSharedToAll	boolean
metadata	object	Хранение метаданных пользователя для этого подключения
sharedUserList	string[]
target	string
value	string	Сведения о значении подключения к рабочей области.
valueFormat	ValueFormat	Формат значения подключения к рабочей области

ApiKeyAuthWorkspaceConnectionProperties

Object

Этот тип подключения охватывает универсальные категории подключений apiKey, например AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (как тип дискриминационных) Учетные данные:= {ApiKey} как Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase}

CognitiveService: Category:= CognitiveService AuthType:= ApiKey (как тип дискриминационный) Credentials:= {SubscriptionKey} как Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion}

CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (как тип дискриминационный) Credentials:= {Key} как Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint}

Использование контейнера свойств метаданных для ApiType, ApiVersion, Kind и других полей метаданных

Имя	Тип	Описание
authType	string: ApiKey	Тип проверки подлинности целевого объекта подключения
category	ConnectionCategory	Категория подключения
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionApiKey	Объект ключа API для учетных данных подключения к рабочей области.
expiryTime	string (date-time)
group	ConnectionGroup	Группа на основе категории подключения
isSharedToAll	boolean
metadata	object	Хранение метаданных пользователя для этого подключения
sharedUserList	string[]
target	string
value	string	Сведения о значении подключения к рабочей области.
valueFormat	ValueFormat	Формат значения подключения к рабочей области

ConnectionAuthType

Перечисление

Тип проверки подлинности целевого объекта подключения

Значение	Описание
AAD
AccessKey
AccountKey
ApiKey
CustomKeys
ManagedIdentity
None
OAuth2
PAT
SAS
ServicePrincipal
UsernamePassword

ConnectionCategory

Перечисление

Категория подключения

Значение	Описание
ADLSGen2
AIServices
AmazonMws
AmazonRdsForOracle
AmazonRdsForSqlServer
AmazonRedshift
AmazonS3Compatible
ApiKey
AzureBlob
AzureDataExplorer
AzureDatabricksDeltaLake
AzureMariaDb
AzureMySqlDb
AzureOneLake
AzureOpenAI
AzurePostgresDb
AzureSqlDb
AzureSqlMi
AzureSynapseAnalytics
AzureTableStorage
BingLLMSearch
Cassandra
CognitiveSearch
CognitiveService
Concur
ContainerRegistry
CosmosDb
CosmosDbMongoDbApi
Couchbase
CustomKeys
Db2
Drill
Dynamics
DynamicsAx
DynamicsCrm
Elasticsearch
Eloqua
FileServer
FtpServer
GenericContainerRegistry
GenericHttp
GenericRest
Git
GoogleAdWords
GoogleBigQuery
GoogleCloudStorage
Greenplum
Hbase
Hdfs
Hive
Hubspot
Impala
Informix
Jira
Magento
ManagedOnlineEndpoint
MariaDb
Marketo
MicrosoftAccess
MongoDbAtlas
MongoDbV2
MySql
Netezza
ODataRest
Odbc
Office365
OpenAI
Oracle
OracleCloudStorage
OracleServiceCloud
PayPal
Phoenix
Pinecone
PostgreSql
Presto
PythonFeed
QuickBooks
Redis
Responsys
S3
Salesforce
SalesforceMarketingCloud
SalesforceServiceCloud
SapBw
SapCloudForCustomer
SapEcc
SapHana
SapOpenHub
SapTable
Serp
Serverless
ServiceNow
Sftp
SharePointOnlineList
Shopify
Snowflake
Spark
SqlServer
Square
Sybase
Teradata
Vertica
WebTable
Xero
Zoho

ConnectionGroup

Перечисление

Группа на основе категории подключения

Значение	Описание
Azure
AzureAI
Database
File
GenericProtocol
NoSQL
ServicesAndApps

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
Application
Key
ManagedIdentity
User

CustomKeys

Object

Объект учетных данных пользовательских ключей

Имя	Тип	Описание
keys	object

CustomKeysWorkspaceConnectionProperties

Object

Категория:= CustomKeys AuthType:= CustomKeys (как тип дискриминационные) Credentials:= {CustomKeys} в качестве Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Использовать контейнер свойств метаданных для ApiVersion и других полей метаданных

Имя	Тип	Описание
authType	string: CustomKeys	Тип проверки подлинности целевого объекта подключения
category	ConnectionCategory	Категория подключения
createdByWorkspaceArmId	string (arm-id)
credentials	CustomKeys	Объект учетных данных пользовательских ключей
expiryTime	string (date-time)
group	ConnectionGroup	Группа на основе категории подключения
isSharedToAll	boolean
metadata	object	Хранение метаданных пользователя для этого подключения
sharedUserList	string[]
target	string
value	string	Сведения о значении подключения к рабочей области.
valueFormat	ValueFormat	Формат значения подключения к рабочей области

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Object

Имя	Тип	Описание
authType	string: ManagedIdentity	Тип проверки подлинности целевого объекта подключения
category	ConnectionCategory	Категория подключения
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionManagedIdentity
expiryTime	string (date-time)
group	ConnectionGroup	Группа на основе категории подключения
isSharedToAll	boolean
metadata	object	Хранение метаданных пользователя для этого подключения
sharedUserList	string[]
target	string
value	string	Сведения о значении подключения к рабочей области.
valueFormat	ValueFormat	Формат значения подключения к рабочей области

NoneAuthTypeWorkspaceConnectionProperties

Object

Имя	Тип	Описание
authType	string: None	Тип проверки подлинности целевого объекта подключения
category	ConnectionCategory	Категория подключения
createdByWorkspaceArmId	string (arm-id)
expiryTime	string (date-time)
group	ConnectionGroup	Группа на основе категории подключения
isSharedToAll	boolean
metadata	object	Хранение метаданных пользователя для этого подключения
sharedUserList	string[]
target	string
value	string	Сведения о значении подключения к рабочей области.
valueFormat	ValueFormat	Формат значения подключения к рабочей области

OAuth2AuthTypeWorkspaceConnectionProperties

Object

Имя	Тип	Описание
authType	string: OAuth2	Тип проверки подлинности целевого объекта подключения
category	ConnectionCategory	Категория подключения
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionOAuth2	Требуется ClientId и ClientSecret. Другие свойства являются необязательными в зависимости от реализации каждого поставщика OAuth2.
expiryTime	string (date-time)
group	ConnectionGroup	Группа на основе категории подключения
isSharedToAll	boolean
metadata	object	Хранение метаданных пользователя для этого подключения
sharedUserList	string[]
target	string
value	string	Сведения о значении подключения к рабочей области.
valueFormat	ValueFormat	Формат значения подключения к рабочей области

PATAuthTypeWorkspaceConnectionProperties

Object

Имя	Тип	Описание
authType	string: PAT	Тип проверки подлинности целевого объекта подключения
category	ConnectionCategory	Категория подключения
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionPersonalAccessToken
expiryTime	string (date-time)
group	ConnectionGroup	Группа на основе категории подключения
isSharedToAll	boolean
metadata	object	Хранение метаданных пользователя для этого подключения
sharedUserList	string[]
target	string
value	string	Сведения о значении подключения к рабочей области.
valueFormat	ValueFormat	Формат значения подключения к рабочей области

SASAuthTypeWorkspaceConnectionProperties

Object

Имя	Тип	Описание
authType	string: SAS	Тип проверки подлинности целевого объекта подключения
category	ConnectionCategory	Категория подключения
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionSharedAccessSignature
expiryTime	string (date-time)
group	ConnectionGroup	Группа на основе категории подключения
isSharedToAll	boolean
metadata	object	Хранение метаданных пользователя для этого подключения
sharedUserList	string[]
target	string
value	string	Сведения о значении подключения к рабочей области.
valueFormat	ValueFormat	Формат значения подключения к рабочей области

ServicePrincipalAuthTypeWorkspaceConnectionProperties

Object

Имя	Тип	Описание
authType	string: ServicePrincipal	Тип проверки подлинности целевого объекта подключения
category	ConnectionCategory	Категория подключения
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionServicePrincipal
expiryTime	string (date-time)
group	ConnectionGroup	Группа на основе категории подключения
isSharedToAll	boolean
metadata	object	Хранение метаданных пользователя для этого подключения
sharedUserList	string[]
target	string
value	string	Сведения о значении подключения к рабочей области.
valueFormat	ValueFormat	Формат значения подключения к рабочей области

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

UsernamePasswordAuthTypeWorkspaceConnectionProperties

Object

Имя	Тип	Описание
authType	string: UsernamePassword	Тип проверки подлинности целевого объекта подключения
category	ConnectionCategory	Категория подключения
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionUsernamePassword
expiryTime	string (date-time)
group	ConnectionGroup	Группа на основе категории подключения
isSharedToAll	boolean
metadata	object	Хранение метаданных пользователя для этого подключения
sharedUserList	string[]
target	string
value	string	Сведения о значении подключения к рабочей области.
valueFormat	ValueFormat	Формат значения подключения к рабочей области

ValueFormat

Перечисление

Формат значения подключения к рабочей области

Значение	Описание
JSON

WorkspaceConnectionAccessKey

Object

Имя	Тип	Описание
accessKeyId	string
secretAccessKey	string

WorkspaceConnectionAccountKey

Object

Имя	Тип	Описание
key	string

WorkspaceConnectionApiKey

Object

Объект ключа API для учетных данных подключения к рабочей области.

Имя	Тип	Описание
key	string

WorkspaceConnectionManagedIdentity

Object

Имя	Тип	Описание
clientId	string
resourceId	string

WorkspaceConnectionOAuth2

Object

Требуется ClientId и ClientSecret. Другие свойства являются необязательными в зависимости от реализации каждого поставщика OAuth2.

Имя	Тип	Описание
authUrl	string (url)	Требуется для категории подключения Concur
clientId	string (uuid)	Идентификатор клиента в формате UUID
clientSecret	string
developerToken	string	Требуется для категории подключения GoogleAdWords
password	string
refreshToken	string	Требуется GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho, где пользователь должен получить RefreshToken в автономном режиме
tenantId	string	Требуется для категорий подключений QuickBooks и Xero
username	string	Concur, serviceNow auth server AccessToken grant type is Password, который требует имени пользователяPassword

WorkspaceConnectionPersonalAccessToken

Object

Имя	Тип	Описание
pat	string

WorkspaceConnectionPropertiesV2BasicResource

Object

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties	WorkspaceConnectionPropertiesV2: AADAuthTypeWorkspaceConnectionProperties AccessKeyAuthTypeWorkspaceConnectionProperties AccountKeyAuthTypeWorkspaceConnectionProperties ApiKeyAuthWorkspaceConnectionProperties CustomKeysWorkspaceConnectionProperties ManagedIdentityAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties OAuth2AuthTypeWorkspaceConnectionProperties PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties ServicePrincipalAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

WorkspaceConnectionServicePrincipal

Object

Имя	Тип	Описание
clientId	string
clientSecret	string
tenantId	string

WorkspaceConnectionSharedAccessSignature

Object

Имя	Тип	Описание
sas	string

WorkspaceConnectionUsernamePassword

Object

Имя	Тип	Описание
password	string
securityToken	string	Необязательный, необходимый для подключений, таких как SalesForce для дополнительной безопасности, в дополнение к Имени пользователяPassword
username	string

Поделиться через

Workspace Connections - List Secrets

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

GetWorkspaceConnection

Образец запроса

Пример ответа

Определения

AADAuthTypeWorkspaceConnectionProperties

AccessKeyAuthTypeWorkspaceConnectionProperties

AccountKeyAuthTypeWorkspaceConnectionProperties

ApiKeyAuthWorkspaceConnectionProperties

ConnectionAuthType

ConnectionCategory

ConnectionGroup

createdByType

CustomKeys

CustomKeysWorkspaceConnectionProperties

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedIdentityAuthTypeWorkspaceConnectionProperties

NoneAuthTypeWorkspaceConnectionProperties

OAuth2AuthTypeWorkspaceConnectionProperties

PATAuthTypeWorkspaceConnectionProperties

SASAuthTypeWorkspaceConnectionProperties

ServicePrincipalAuthTypeWorkspaceConnectionProperties

systemData

UsernamePasswordAuthTypeWorkspaceConnectionProperties

ValueFormat

WorkspaceConnectionAccessKey

WorkspaceConnectionAccountKey

WorkspaceConnectionApiKey

WorkspaceConnectionManagedIdentity

WorkspaceConnectionOAuth2

WorkspaceConnectionPersonalAccessToken

WorkspaceConnectionPropertiesV2BasicResource

WorkspaceConnectionServicePrincipal

WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionUsernamePassword

Дополнительные ресурсы