Workspace Connections - List Secrets
Wyświetl listę wszystkich wpisów tajnych połączeń obszarów roboczych uczenia maszynowego.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/listsecrets?api-version=2024-04-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
connection
|
path | True |
string |
Przyjazna nazwa połączenia obszaru roboczego Regex pattern: |
resource
|
path | True |
string |
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter. |
subscription
|
path | True |
string |
Identyfikator subskrypcji docelowej. |
workspace
|
path | True |
string |
Nazwa obszaru roboczego usługi Azure Machine Learning. Regex pattern: |
api-version
|
query | True |
string |
Wersja interfejsu API do użycia dla tej operacji. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Żądanie zakończyło się pomyślnie; żądanie zostało prawidłowo sformułowane i odebrane prawidłowo. |
|
Other Status Codes |
Błąd |
Zabezpieczenia
azure_auth
Przepływ OAuth2 usługi Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nazwa | Opis |
---|---|
user_impersonation | personifikacja konta użytkownika |
Przykłady
GetWorkspaceConnection
Sample Request
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-04-01
Sample Response
{
"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"
}
}
Definicje
Nazwa | Opis |
---|---|
AADAuth |
Ten typ połączenia obejmuje uwierzytelnianie usługi AAD dla dowolnej odpowiedniej usługi platformy Azure |
Access |
|
Account |
Ten typ połączenia obejmuje połączenie klucza konta dla usługi Azure Storage |
Api |
Ten typ połączenia obejmuje ogólne kategorie połączeń uwierzytelniania ApiKey, na przykład: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (jako dyskryminujące typy) Credentials:= {ApiKey} jako Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase} CognitiveService: Category:= CognitiveService AuthType:= ApiKey (jako typ dyskryminujący) Poświadczenia:= {SubscriptionKey} jako Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion} CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (jako dyskryminujące typy) Credentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint} Używanie torby właściwości metadanych dla pól ApiType, ApiVersion, Kind i innych metadanych |
Connection |
Typ uwierzytelniania docelowego połączenia |
Connection |
Kategoria połączenia |
Connection |
Grupuj na podstawie kategorii połączeń |
created |
Typ tożsamości, która utworzyła zasób. |
Custom |
Obiekt poświadczeń kluczy niestandardowych |
Custom |
Category:= CustomKeys AuthType:= CustomKeys (jako dyskryminujące typy) Credentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Użyj torby właściwości metadanych dla apiVersion i innych pól metadanych |
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
Error |
Szczegóły błędu. |
Error |
Odpowiedź na błąd |
Managed |
|
None |
|
OAuth2Auth |
|
PATAuth |
|
SASAuth |
|
Service |
|
system |
Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu. |
Username |
|
Value |
format wartości połączenia obszaru roboczego |
Workspace |
|
Workspace |
Obiekt klucza interfejsu API dla poświadczeń połączenia obszaru roboczego. |
Workspace |
|
Workspace |
Wymagane są identyfikatory ClientId i ClientSecret. Inne właściwości są opcjonalne w zależności od implementacji każdego dostawcy OAuth2. |
Workspace |
|
Workspace |
|
Workspace |
|
Workspace |
|
Workspace |
AADAuthTypeWorkspaceConnectionProperties
Ten typ połączenia obejmuje uwierzytelnianie usługi AAD dla dowolnej odpowiedniej usługi platformy Azure
Nazwa | Typ | Opis |
---|---|---|
authType |
string:
AAD |
Typ uwierzytelniania docelowego połączenia |
category |
Kategoria połączenia |
|
createdByWorkspaceArmId |
string |
|
expiryTime |
string |
|
group |
Grupuj na podstawie kategorii połączeń |
|
isSharedToAll |
boolean |
|
metadata |
object |
Przechowywanie metadanych użytkownika dla tego połączenia |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Szczegóły wartości połączenia obszaru roboczego. |
valueFormat |
format wartości połączenia obszaru roboczego |
AccessKeyAuthTypeWorkspaceConnectionProperties
Nazwa | Typ | Opis |
---|---|---|
authType |
string:
Access |
Typ uwierzytelniania docelowego połączenia |
category |
Kategoria połączenia |
|
createdByWorkspaceArmId |
string |
|
credentials | ||
expiryTime |
string |
|
group |
Grupuj na podstawie kategorii połączeń |
|
isSharedToAll |
boolean |
|
metadata |
object |
Przechowywanie metadanych użytkownika dla tego połączenia |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Szczegóły wartości połączenia obszaru roboczego. |
valueFormat |
format wartości połączenia obszaru roboczego |
AccountKeyAuthTypeWorkspaceConnectionProperties
Ten typ połączenia obejmuje połączenie klucza konta dla usługi Azure Storage
Nazwa | Typ | Opis |
---|---|---|
authType |
string:
Account |
Typ uwierzytelniania docelowego połączenia |
category |
Kategoria połączenia |
|
createdByWorkspaceArmId |
string |
|
credentials | ||
expiryTime |
string |
|
group |
Grupuj na podstawie kategorii połączeń |
|
isSharedToAll |
boolean |
|
metadata |
object |
Przechowywanie metadanych użytkownika dla tego połączenia |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Szczegóły wartości połączenia obszaru roboczego. |
valueFormat |
format wartości połączenia obszaru roboczego |
ApiKeyAuthWorkspaceConnectionProperties
Ten typ połączenia obejmuje ogólne kategorie połączeń uwierzytelniania ApiKey, na przykład: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (jako dyskryminujące typy) Credentials:= {ApiKey} jako Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase}
CognitiveService: Category:= CognitiveService AuthType:= ApiKey (jako typ dyskryminujący) Poświadczenia:= {SubscriptionKey} jako Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion}
CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (jako dyskryminujące typy) Credentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint}
Używanie torby właściwości metadanych dla pól ApiType, ApiVersion, Kind i innych metadanych
Nazwa | Typ | Opis |
---|---|---|
authType |
string:
Api |
Typ uwierzytelniania docelowego połączenia |
category |
Kategoria połączenia |
|
createdByWorkspaceArmId |
string |
|
credentials |
Obiekt klucza interfejsu API dla poświadczeń połączenia obszaru roboczego. |
|
expiryTime |
string |
|
group |
Grupuj na podstawie kategorii połączeń |
|
isSharedToAll |
boolean |
|
metadata |
object |
Przechowywanie metadanych użytkownika dla tego połączenia |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Szczegóły wartości połączenia obszaru roboczego. |
valueFormat |
format wartości połączenia obszaru roboczego |
ConnectionAuthType
Typ uwierzytelniania docelowego połączenia
Nazwa | Typ | Opis |
---|---|---|
AAD |
string |
|
AccessKey |
string |
|
AccountKey |
string |
|
ApiKey |
string |
|
CustomKeys |
string |
|
ManagedIdentity |
string |
|
None |
string |
|
OAuth2 |
string |
|
PAT |
string |
|
SAS |
string |
|
ServicePrincipal |
string |
|
UsernamePassword |
string |
ConnectionCategory
Kategoria połączenia
Nazwa | Typ | Opis |
---|---|---|
ADLSGen2 |
string |
|
AIServices |
string |
|
AmazonMws |
string |
|
AmazonRdsForOracle |
string |
|
AmazonRdsForSqlServer |
string |
|
AmazonRedshift |
string |
|
AmazonS3Compatible |
string |
|
ApiKey |
string |
|
AzureBlob |
string |
|
AzureDataExplorer |
string |
|
AzureDatabricksDeltaLake |
string |
|
AzureMariaDb |
string |
|
AzureMySqlDb |
string |
|
AzureOneLake |
string |
|
AzureOpenAI |
string |
|
AzurePostgresDb |
string |
|
AzureSqlDb |
string |
|
AzureSqlMi |
string |
|
AzureSynapseAnalytics |
string |
|
AzureTableStorage |
string |
|
BingLLMSearch |
string |
|
Cassandra |
string |
|
CognitiveSearch |
string |
|
CognitiveService |
string |
|
Concur |
string |
|
ContainerRegistry |
string |
|
CosmosDb |
string |
|
CosmosDbMongoDbApi |
string |
|
Couchbase |
string |
|
CustomKeys |
string |
|
Db2 |
string |
|
Drill |
string |
|
Dynamics |
string |
|
DynamicsAx |
string |
|
DynamicsCrm |
string |
|
Eloqua |
string |
|
FileServer |
string |
|
FtpServer |
string |
|
GenericContainerRegistry |
string |
|
GenericHttp |
string |
|
GenericRest |
string |
|
Git |
string |
|
GoogleAdWords |
string |
|
GoogleBigQuery |
string |
|
GoogleCloudStorage |
string |
|
Greenplum |
string |
|
Hbase |
string |
|
Hdfs |
string |
|
Hive |
string |
|
Hubspot |
string |
|
Impala |
string |
|
Informix |
string |
|
Jira |
string |
|
Magento |
string |
|
MariaDb |
string |
|
Marketo |
string |
|
MicrosoftAccess |
string |
|
MongoDbAtlas |
string |
|
MongoDbV2 |
string |
|
MySql |
string |
|
Netezza |
string |
|
ODataRest |
string |
|
Odbc |
string |
|
Office365 |
string |
|
OpenAI |
string |
|
Oracle |
string |
|
OracleCloudStorage |
string |
|
OracleServiceCloud |
string |
|
PayPal |
string |
|
Phoenix |
string |
|
PostgreSql |
string |
|
Presto |
string |
|
PythonFeed |
string |
|
QuickBooks |
string |
|
Redis |
string |
|
Responsys |
string |
|
S3 |
string |
|
Salesforce |
string |
|
SalesforceMarketingCloud |
string |
|
SalesforceServiceCloud |
string |
|
SapBw |
string |
|
SapCloudForCustomer |
string |
|
SapEcc |
string |
|
SapHana |
string |
|
SapOpenHub |
string |
|
SapTable |
string |
|
Serp |
string |
|
Serverless |
string |
|
ServiceNow |
string |
|
Sftp |
string |
|
SharePointOnlineList |
string |
|
Shopify |
string |
|
Snowflake |
string |
|
Spark |
string |
|
SqlServer |
string |
|
Square |
string |
|
Sybase |
string |
|
Teradata |
string |
|
Vertica |
string |
|
WebTable |
string |
|
Xero |
string |
|
Zoho |
string |
ConnectionGroup
Grupuj na podstawie kategorii połączeń
Nazwa | Typ | Opis |
---|---|---|
Azure |
string |
|
AzureAI |
string |
|
Database |
string |
|
File |
string |
|
GenericProtocol |
string |
|
NoSQL |
string |
|
ServicesAndApps |
string |
createdByType
Typ tożsamości, która utworzyła zasób.
Nazwa | Typ | Opis |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
CustomKeys
Obiekt poświadczeń kluczy niestandardowych
Nazwa | Typ | Opis |
---|---|---|
keys |
object |
CustomKeysWorkspaceConnectionProperties
Category:= CustomKeys AuthType:= CustomKeys (jako dyskryminujące typy) Credentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Użyj torby właściwości metadanych dla apiVersion i innych pól metadanych
Nazwa | Typ | Opis |
---|---|---|
authType | string: |
Typ uwierzytelniania docelowego połączenia |
category |
Kategoria połączenia |
|
createdByWorkspaceArmId |
string |
|
credentials |
Obiekt poświadczeń kluczy niestandardowych |
|
expiryTime |
string |
|
group |
Grupuj na podstawie kategorii połączeń |
|
isSharedToAll |
boolean |
|
metadata |
object |
Przechowywanie metadanych użytkownika dla tego połączenia |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Szczegóły wartości połączenia obszaru roboczego. |
valueFormat |
format wartości połączenia obszaru roboczego |
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
Nazwa | Typ | Opis |
---|---|---|
info |
object |
Dodatkowe informacje. |
type |
string |
Dodatkowy typ informacji. |
ErrorDetail
Szczegóły błędu.
Nazwa | Typ | Opis |
---|---|---|
additionalInfo |
Dodatkowe informacje o błędzie. |
|
code |
string |
Kod błędu. |
details |
Szczegóły błędu. |
|
message |
string |
Komunikat o błędzie. |
target |
string |
Element docelowy błędu. |
ErrorResponse
Odpowiedź na błąd
Nazwa | Typ | Opis |
---|---|---|
error |
Obiekt błędu. |
ManagedIdentityAuthTypeWorkspaceConnectionProperties
Nazwa | Typ | Opis |
---|---|---|
authType |
string:
Managed |
Typ uwierzytelniania docelowego połączenia |
category |
Kategoria połączenia |
|
createdByWorkspaceArmId |
string |
|
credentials | ||
expiryTime |
string |
|
group |
Grupuj na podstawie kategorii połączeń |
|
isSharedToAll |
boolean |
|
metadata |
object |
Przechowywanie metadanych użytkownika dla tego połączenia |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Szczegóły wartości połączenia obszaru roboczego. |
valueFormat |
format wartości połączenia obszaru roboczego |
NoneAuthTypeWorkspaceConnectionProperties
Nazwa | Typ | Opis |
---|---|---|
authType |
string:
None |
Typ uwierzytelniania docelowego połączenia |
category |
Kategoria połączenia |
|
createdByWorkspaceArmId |
string |
|
expiryTime |
string |
|
group |
Grupuj na podstawie kategorii połączeń |
|
isSharedToAll |
boolean |
|
metadata |
object |
Przechowywanie metadanych użytkownika dla tego połączenia |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Szczegóły wartości połączenia obszaru roboczego. |
valueFormat |
format wartości połączenia obszaru roboczego |
OAuth2AuthTypeWorkspaceConnectionProperties
Nazwa | Typ | Opis |
---|---|---|
authType |
string:
OAuth2 |
Typ uwierzytelniania docelowego połączenia |
category |
Kategoria połączenia |
|
createdByWorkspaceArmId |
string |
|
credentials |
Wymagane są identyfikatory ClientId i ClientSecret. Inne właściwości są opcjonalne w zależności od implementacji każdego dostawcy OAuth2. |
|
expiryTime |
string |
|
group |
Grupuj na podstawie kategorii połączeń |
|
isSharedToAll |
boolean |
|
metadata |
object |
Przechowywanie metadanych użytkownika dla tego połączenia |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Szczegóły wartości połączenia obszaru roboczego. |
valueFormat |
format wartości połączenia obszaru roboczego |
PATAuthTypeWorkspaceConnectionProperties
Nazwa | Typ | Opis |
---|---|---|
authType |
string:
PAT |
Typ uwierzytelniania docelowego połączenia |
category |
Kategoria połączenia |
|
createdByWorkspaceArmId |
string |
|
credentials | ||
expiryTime |
string |
|
group |
Grupuj na podstawie kategorii połączeń |
|
isSharedToAll |
boolean |
|
metadata |
object |
Przechowywanie metadanych użytkownika dla tego połączenia |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Szczegóły wartości połączenia obszaru roboczego. |
valueFormat |
format wartości połączenia obszaru roboczego |
SASAuthTypeWorkspaceConnectionProperties
Nazwa | Typ | Opis |
---|---|---|
authType |
string:
SAS |
Typ uwierzytelniania docelowego połączenia |
category |
Kategoria połączenia |
|
createdByWorkspaceArmId |
string |
|
credentials | ||
expiryTime |
string |
|
group |
Grupuj na podstawie kategorii połączeń |
|
isSharedToAll |
boolean |
|
metadata |
object |
Przechowywanie metadanych użytkownika dla tego połączenia |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Szczegóły wartości połączenia obszaru roboczego. |
valueFormat |
format wartości połączenia obszaru roboczego |
ServicePrincipalAuthTypeWorkspaceConnectionProperties
Nazwa | Typ | Opis |
---|---|---|
authType |
string:
Service |
Typ uwierzytelniania docelowego połączenia |
category |
Kategoria połączenia |
|
createdByWorkspaceArmId |
string |
|
credentials | ||
expiryTime |
string |
|
group |
Grupuj na podstawie kategorii połączeń |
|
isSharedToAll |
boolean |
|
metadata |
object |
Przechowywanie metadanych użytkownika dla tego połączenia |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Szczegóły wartości połączenia obszaru roboczego. |
valueFormat |
format wartości połączenia obszaru roboczego |
systemData
Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
Nazwa | Typ | Opis |
---|---|---|
createdAt |
string |
Sygnatura czasowa tworzenia zasobu (UTC). |
createdBy |
string |
Tożsamość, która utworzyła zasób. |
createdByType |
Typ tożsamości, która utworzyła zasób. |
|
lastModifiedAt |
string |
Sygnatura czasowa ostatniej modyfikacji zasobu (UTC) |
lastModifiedBy |
string |
Tożsamość, która ostatnio zmodyfikowała zasób. |
lastModifiedByType |
Typ tożsamości, która ostatnio zmodyfikowała zasób. |
UsernamePasswordAuthTypeWorkspaceConnectionProperties
Nazwa | Typ | Opis |
---|---|---|
authType |
string:
Username |
Typ uwierzytelniania docelowego połączenia |
category |
Kategoria połączenia |
|
createdByWorkspaceArmId |
string |
|
credentials | ||
expiryTime |
string |
|
group |
Grupuj na podstawie kategorii połączeń |
|
isSharedToAll |
boolean |
|
metadata |
object |
Przechowywanie metadanych użytkownika dla tego połączenia |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Szczegóły wartości połączenia obszaru roboczego. |
valueFormat |
format wartości połączenia obszaru roboczego |
ValueFormat
format wartości połączenia obszaru roboczego
Nazwa | Typ | Opis |
---|---|---|
JSON |
string |
WorkspaceConnectionAccessKey
Nazwa | Typ | Opis |
---|---|---|
accessKeyId |
string |
|
secretAccessKey |
string |
WorkspaceConnectionApiKey
Obiekt klucza interfejsu API dla poświadczeń połączenia obszaru roboczego.
Nazwa | Typ | Opis |
---|---|---|
key |
string |
WorkspaceConnectionManagedIdentity
Nazwa | Typ | Opis |
---|---|---|
clientId |
string |
|
resourceId |
string |
WorkspaceConnectionOAuth2
Wymagane są identyfikatory ClientId i ClientSecret. Inne właściwości są opcjonalne w zależności od implementacji każdego dostawcy OAuth2.
Nazwa | Typ | Opis |
---|---|---|
authUrl |
string |
Wymagane przez kategorię połączenia Concur |
clientId |
string |
Identyfikator klienta w formacie UUID |
clientSecret |
string |
|
developerToken |
string |
Wymagane przez kategorię połączenia GoogleAdWords |
password |
string |
|
refreshToken |
string |
Wymagane przez GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho, gdzie użytkownik musi uzyskać polecenie RefreshToken w trybie offline |
tenantId |
string |
Wymagane przez kategorie połączeń QuickBooks i Xero |
username |
string |
Concur, ServiceNow auth server AccessToken grant type to "Password", który wymaga UsernamePassword |
WorkspaceConnectionPersonalAccessToken
Nazwa | Typ | Opis |
---|---|---|
pat |
string |
WorkspaceConnectionPropertiesV2BasicResource
WorkspaceConnectionServicePrincipal
Nazwa | Typ | Opis |
---|---|---|
clientId |
string |
|
clientSecret |
string |
|
tenantId |
string |
WorkspaceConnectionSharedAccessSignature
Nazwa | Typ | Opis |
---|---|---|
sas |
string |
WorkspaceConnectionUsernamePassword
Nazwa | Typ | Opis |
---|---|---|
password |
string |
|
securityToken |
string |
Opcjonalnie, wymagane przez połączenia, takie jak SalesForce, w celu zapewnienia dodatkowych zabezpieczeń oprócz elementu UsernamePassword |
username |
string |