Workspace Connections - List Secrets
Listet alle Geheimnisse einer Machine Learning-Arbeitsbereichsverbindung auf.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/listsecrets?api-version=2024-04-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
connection
|
path | True |
string |
Anzeigename der Arbeitsbereichsverbindung Regex pattern: |
resource
|
path | True |
string |
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. |
subscription
|
path | True |
string |
Hierbei handelt es sich um die ID des Zielabonnements. |
workspace
|
path | True |
string |
Name des Azure Machine Learning-Arbeitsbereichs. Regex pattern: |
api-version
|
query | True |
string |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Die Anforderung war erfolgreich; die Anforderung war wohlgeformt und wurde ordnungsgemäß empfangen. |
|
Other Status Codes |
Fehler |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
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"
}
}
Definitionen
Name | Beschreibung |
---|---|
AADAuth |
Dieser Verbindungstyp deckt die AAD-Authentifizierung für jeden anwendbaren Azure-Dienst ab. |
Access |
|
Account |
Dieser Verbindungstyp deckt die Kontoschlüsselverbindung für Azure Storage ab. |
Api |
Dieser Verbindungstyp deckt die generischen ApiKey-Authentifizierungsverbindungskategorien ab. Beispiele: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (as type diskriminator) Credentials:= {ApiKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase} CognitiveService: Category:= CognitiveService AuthType:= ApiKey (as type discriminator) Credentials:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion} CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (as type discriminator) Credentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint} Verwenden des Metadateneigenschaftenbehälters für ApiType, ApiVersion, Kind und andere Metadatenfelder |
Connection |
Authentifizierungstyp des Verbindungsziels |
Connection |
Kategorie der Verbindung |
Connection |
Gruppierung nach Verbindungskategorie |
created |
Der Identitätstyp, der die Ressource erstellt hat. |
Custom |
Anmeldeinformationsobjekt für benutzerdefinierte Schlüssel |
Custom |
Category:= CustomKeys AuthType:= CustomKeys (as type discriminator) Credentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Use Metadata property bag for ApiVersion and other metadata fields |
Error |
Zusätzliche Informationen zum Ressourcenverwaltungsfehler. |
Error |
Die Fehlerdetails. |
Error |
Fehlerantwort |
Managed |
|
None |
|
OAuth2Auth |
|
PATAuth |
|
SASAuth |
|
Service |
|
system |
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen. |
Username |
|
Value |
Format für den Arbeitsbereichsverbindungswert |
Workspace |
|
Workspace |
API-Schlüsselobjekt für Anmeldeinformationen für die Arbeitsbereichsverbindung. |
Workspace |
|
Workspace |
ClientId und ClientSecret sind erforderlich. Andere Eigenschaften sind je nach Implementierung jedes OAuth2-Anbieters optional. |
Workspace |
|
Workspace |
|
Workspace |
|
Workspace |
|
Workspace |
AADAuthTypeWorkspaceConnectionProperties
Dieser Verbindungstyp deckt die AAD-Authentifizierung für jeden anwendbaren Azure-Dienst ab.
Name | Typ | Beschreibung |
---|---|---|
authType |
string:
AAD |
Authentifizierungstyp des Verbindungsziels |
category |
Kategorie der Verbindung |
|
createdByWorkspaceArmId |
string |
|
expiryTime |
string |
|
group |
Gruppierung basierend auf der Verbindungskategorie |
|
isSharedToAll |
boolean |
|
metadata |
object |
Speichern von Benutzermetadaten für diese Verbindung |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Wertdetails der Arbeitsbereichsverbindung. |
valueFormat |
Format für den Arbeitsbereichsverbindungswert |
AccessKeyAuthTypeWorkspaceConnectionProperties
Name | Typ | Beschreibung |
---|---|---|
authType |
string:
Access |
Authentifizierungstyp des Verbindungsziels |
category |
Kategorie der Verbindung |
|
createdByWorkspaceArmId |
string |
|
credentials | ||
expiryTime |
string |
|
group |
Gruppierung basierend auf der Verbindungskategorie |
|
isSharedToAll |
boolean |
|
metadata |
object |
Speichern von Benutzermetadaten für diese Verbindung |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Wertdetails der Arbeitsbereichsverbindung. |
valueFormat |
Format für den Arbeitsbereichsverbindungswert |
AccountKeyAuthTypeWorkspaceConnectionProperties
Dieser Verbindungstyp deckt die Kontoschlüsselverbindung für Azure Storage ab.
Name | Typ | Beschreibung |
---|---|---|
authType |
string:
Account |
Authentifizierungstyp des Verbindungsziels |
category |
Kategorie der Verbindung |
|
createdByWorkspaceArmId |
string |
|
credentials | ||
expiryTime |
string |
|
group |
Gruppierung basierend auf der Verbindungskategorie |
|
isSharedToAll |
boolean |
|
metadata |
object |
Speichern von Benutzermetadaten für diese Verbindung |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Wertdetails der Arbeitsbereichsverbindung. |
valueFormat |
Format für den Arbeitsbereichsverbindungswert |
ApiKeyAuthWorkspaceConnectionProperties
Dieser Verbindungstyp deckt die generischen ApiKey-Authentifizierungsverbindungskategorien ab. Beispiele: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (as type diskriminator) Credentials:= {ApiKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase}
CognitiveService: Category:= CognitiveService AuthType:= ApiKey (as type discriminator) Credentials:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion}
CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (as type discriminator) Credentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint}
Verwenden des Metadateneigenschaftenbehälters für ApiType, ApiVersion, Kind und andere Metadatenfelder
Name | Typ | Beschreibung |
---|---|---|
authType |
string:
Api |
Authentifizierungstyp des Verbindungsziels |
category |
Kategorie der Verbindung |
|
createdByWorkspaceArmId |
string |
|
credentials |
API-Schlüsselobjekt für Arbeitsbereichsverbindungsanmeldeinformationen. |
|
expiryTime |
string |
|
group |
Gruppierung basierend auf der Verbindungskategorie |
|
isSharedToAll |
boolean |
|
metadata |
object |
Speichern von Benutzermetadaten für diese Verbindung |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Wertdetails der Arbeitsbereichsverbindung. |
valueFormat |
Format für den Arbeitsbereichsverbindungswert |
ConnectionAuthType
Authentifizierungstyp des Verbindungsziels
Name | Typ | Beschreibung |
---|---|---|
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
Kategorie der Verbindung
Name | Typ | Beschreibung |
---|---|---|
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
Gruppierung nach Verbindungskategorie
Name | Typ | Beschreibung |
---|---|---|
Azure |
string |
|
AzureAI |
string |
|
Database |
string |
|
File |
string |
|
GenericProtocol |
string |
|
NoSQL |
string |
|
ServicesAndApps |
string |
createdByType
Der Identitätstyp, der die Ressource erstellt hat.
Name | Typ | Beschreibung |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
CustomKeys
Anmeldeinformationsobjekt für benutzerdefinierte Schlüssel
Name | Typ | Beschreibung |
---|---|---|
keys |
object |
CustomKeysWorkspaceConnectionProperties
Category:= CustomKeys AuthType:= CustomKeys (as type discriminator) Credentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Use Metadata property bag for ApiVersion and other metadata fields
Name | Typ | Beschreibung |
---|---|---|
authType | string: |
Authentifizierungstyp des Verbindungsziels |
category |
Kategorie der Verbindung |
|
createdByWorkspaceArmId |
string |
|
credentials |
Anmeldeinformationsobjekt für benutzerdefinierte Schlüssel |
|
expiryTime |
string |
|
group |
Gruppierung basierend auf der Verbindungskategorie |
|
isSharedToAll |
boolean |
|
metadata |
object |
Speichern von Benutzermetadaten für diese Verbindung |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Wertdetails der Arbeitsbereichsverbindung. |
valueFormat |
Format für den Arbeitsbereichsverbindungswert |
ErrorAdditionalInfo
Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
Name | Typ | Beschreibung |
---|---|---|
info |
object |
Zusätzliche Informationen. |
type |
string |
Typ der zusätzlichen Informationen. |
ErrorDetail
Die Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Die zusätzlichen Fehlerinformationen. |
|
code |
string |
Der Fehlercode. |
details |
Die Fehlerdetails. |
|
message |
string |
Die Fehlermeldung. |
target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
ManagedIdentityAuthTypeWorkspaceConnectionProperties
Name | Typ | Beschreibung |
---|---|---|
authType |
string:
Managed |
Authentifizierungstyp des Verbindungsziels |
category |
Kategorie der Verbindung |
|
createdByWorkspaceArmId |
string |
|
credentials | ||
expiryTime |
string |
|
group |
Gruppierung basierend auf der Verbindungskategorie |
|
isSharedToAll |
boolean |
|
metadata |
object |
Speichern von Benutzermetadaten für diese Verbindung |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Wertdetails der Arbeitsbereichsverbindung. |
valueFormat |
Format für den Arbeitsbereichsverbindungswert |
NoneAuthTypeWorkspaceConnectionProperties
Name | Typ | Beschreibung |
---|---|---|
authType |
string:
None |
Authentifizierungstyp des Verbindungsziels |
category |
Kategorie der Verbindung |
|
createdByWorkspaceArmId |
string |
|
expiryTime |
string |
|
group |
Gruppierung basierend auf der Verbindungskategorie |
|
isSharedToAll |
boolean |
|
metadata |
object |
Speichern von Benutzermetadaten für diese Verbindung |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Wertdetails der Arbeitsbereichsverbindung. |
valueFormat |
Format für den Arbeitsbereichsverbindungswert |
OAuth2AuthTypeWorkspaceConnectionProperties
Name | Typ | Beschreibung |
---|---|---|
authType |
string:
OAuth2 |
Authentifizierungstyp des Verbindungsziels |
category |
Kategorie der Verbindung |
|
createdByWorkspaceArmId |
string |
|
credentials |
ClientId und ClientSecret sind erforderlich. Andere Eigenschaften sind je nach Implementierung jedes OAuth2-Anbieters optional. |
|
expiryTime |
string |
|
group |
Gruppierung basierend auf der Verbindungskategorie |
|
isSharedToAll |
boolean |
|
metadata |
object |
Speichern von Benutzermetadaten für diese Verbindung |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Wertdetails der Arbeitsbereichsverbindung. |
valueFormat |
Format für den Arbeitsbereichsverbindungswert |
PATAuthTypeWorkspaceConnectionProperties
Name | Typ | Beschreibung |
---|---|---|
authType |
string:
PAT |
Authentifizierungstyp des Verbindungsziels |
category |
Kategorie der Verbindung |
|
createdByWorkspaceArmId |
string |
|
credentials | ||
expiryTime |
string |
|
group |
Gruppierung basierend auf der Verbindungskategorie |
|
isSharedToAll |
boolean |
|
metadata |
object |
Speichern von Benutzermetadaten für diese Verbindung |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Wertdetails der Arbeitsbereichsverbindung. |
valueFormat |
Format für den Arbeitsbereichsverbindungswert |
SASAuthTypeWorkspaceConnectionProperties
Name | Typ | Beschreibung |
---|---|---|
authType |
string:
SAS |
Authentifizierungstyp des Verbindungsziels |
category |
Kategorie der Verbindung |
|
createdByWorkspaceArmId |
string |
|
credentials | ||
expiryTime |
string |
|
group |
Gruppierung basierend auf der Verbindungskategorie |
|
isSharedToAll |
boolean |
|
metadata |
object |
Speichern von Benutzermetadaten für diese Verbindung |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Wertdetails der Arbeitsbereichsverbindung. |
valueFormat |
Format für den Arbeitsbereichsverbindungswert |
ServicePrincipalAuthTypeWorkspaceConnectionProperties
Name | Typ | Beschreibung |
---|---|---|
authType |
string:
Service |
Authentifizierungstyp des Verbindungsziels |
category |
Kategorie der Verbindung |
|
createdByWorkspaceArmId |
string |
|
credentials | ||
expiryTime |
string |
|
group |
Gruppierung nach Verbindungskategorie |
|
isSharedToAll |
boolean |
|
metadata |
object |
Speichern von Benutzermetadaten für diese Verbindung |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Wertdetails der Arbeitsbereichsverbindung. |
valueFormat |
Format für den Arbeitsbereichsverbindungswert |
systemData
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
Name | Typ | Beschreibung |
---|---|---|
createdAt |
string |
Der Zeitstempel der Ressourcenerstellung (UTC). |
createdBy |
string |
Die Identität, die die Ressource erstellt hat. |
createdByType |
Der Identitätstyp, der die Ressource erstellt hat. |
|
lastModifiedAt |
string |
Der Zeitstempel der letzten Änderung der Ressource (UTC) |
lastModifiedBy |
string |
Die Identität, die die Ressource zuletzt geändert hat. |
lastModifiedByType |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |
UsernamePasswordAuthTypeWorkspaceConnectionProperties
Name | Typ | Beschreibung |
---|---|---|
authType |
string:
Username |
Authentifizierungstyp des Verbindungsziels |
category |
Kategorie der Verbindung |
|
createdByWorkspaceArmId |
string |
|
credentials | ||
expiryTime |
string |
|
group |
Gruppierung basierend auf der Verbindungskategorie |
|
isSharedToAll |
boolean |
|
metadata |
object |
Speichern von Benutzermetadaten für diese Verbindung |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Wertdetails der Arbeitsbereichsverbindung. |
valueFormat |
Format für den Arbeitsbereichsverbindungswert |
ValueFormat
Format für den Arbeitsbereichsverbindungswert
Name | Typ | Beschreibung |
---|---|---|
JSON |
string |
WorkspaceConnectionAccessKey
Name | Typ | Beschreibung |
---|---|---|
accessKeyId |
string |
|
secretAccessKey |
string |
WorkspaceConnectionApiKey
API-Schlüsselobjekt für Anmeldeinformationen für die Arbeitsbereichsverbindung.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
WorkspaceConnectionManagedIdentity
Name | Typ | Beschreibung |
---|---|---|
clientId |
string |
|
resourceId |
string |
WorkspaceConnectionOAuth2
ClientId und ClientSecret sind erforderlich. Andere Eigenschaften sind je nach Implementierung jedes OAuth2-Anbieters optional.
Name | Typ | Beschreibung |
---|---|---|
authUrl |
string |
Erforderlich für die Concur-Verbindungskategorie |
clientId |
string |
Client-ID im Format UUID |
clientSecret |
string |
|
developerToken |
string |
Erforderlich für die GoogleAdWords-Verbindungskategorie |
password |
string |
|
refreshToken |
string |
Erforderlich für GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho, wo Der Benutzer RefreshToken offline abrufen muss |
tenantId |
string |
Erforderlich für QuickBooks und Xero-Verbindungskategorien |
username |
string |
Concur, ServiceNow auth server AccessToken grant type is "Password", was UsernamePassword erfordert |
WorkspaceConnectionPersonalAccessToken
Name | Typ | Beschreibung |
---|---|---|
pat |
string |
WorkspaceConnectionPropertiesV2BasicResource
WorkspaceConnectionServicePrincipal
Name | Typ | Beschreibung |
---|---|---|
clientId |
string |
|
clientSecret |
string |
|
tenantId |
string |
WorkspaceConnectionSharedAccessSignature
Name | Typ | Beschreibung |
---|---|---|
sas |
string |
WorkspaceConnectionUsernamePassword
Name | Typ | Beschreibung |
---|---|---|
password |
string |
|
securityToken |
string |
Optional, erforderlich für Verbindungen wie SalesForce für zusätzliche Sicherheit zusätzlich zu UsernamePassword |
username |
string |