Workspace Connections - List Secrets

Referenz

Dienst:: Machine Learning

API-Version:: 2024-10-01

Auflisten aller Geheimnisse einer Maschinellen Lernarbeitsbereichsverbindungen.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
connectionName	path	True	string	Anzeigename der Arbeitsbereichverbindung RegEx-Muster: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Die ID des Zielabonnements.
workspaceName	path	True	string	Name des Azure Machine Learning-Arbeitsbereichs. RegEx-Muster: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	WorkspaceConnectionPropertiesV2BasicResource	Die Anforderung war erfolgreich; die Anforderung war wohlgeformt und richtig empfangen.
Other Status Codes	ErrorResponse	Fehler

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

GetWorkspaceConnection

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 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"
  }
}

Definitionen

Name	Beschreibung
AADAuthTypeWorkspaceConnectionProperties	Dieser Verbindungstyp deckt die AAD-Authentifizierung für alle anwendbaren Azure-Dienste ab.
AccessKeyAuthTypeWorkspaceConnectionProperties
AccountKeyAuthTypeWorkspaceConnectionProperties	Dieser Verbindungstyp deckt die Kontoschlüsselverbindung für Azure Storage ab.
ApiKeyAuthWorkspaceConnectionProperties	Dieser Verbindungstyp deckt die generischen ApiKey-Authentifizierungsverbindungskategorien ab, z. B. 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 diskriminator) Credentials:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion} CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (as type diskriminator) Credentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint} Verwenden des Eigenschaftenbehälters "Metadaten" für ApiType, ApiVersion, Kind und andere Metadatenfelder
ConnectionAuthType	Authentifizierungstyp des Verbindungsziels
ConnectionCategory	Kategorie der Verbindung
ConnectionGroup	Gruppe basierend auf der Verbindungskategorie
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
CustomKeys	Benutzerdefinierte Schlüssel-Anmeldeinformationsobjekt
CustomKeysWorkspaceConnectionProperties	Category:= CustomKeys AuthType:= CustomKeys (as type diskriminator) Credentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Use Metadata property bag for ApiVersion and other metadata fields
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
ManagedIdentityAuthTypeWorkspaceConnectionProperties
NoneAuthTypeWorkspaceConnectionProperties
OAuth2AuthTypeWorkspaceConnectionProperties
PATAuthTypeWorkspaceConnectionProperties
SASAuthTypeWorkspaceConnectionProperties
ServicePrincipalAuthTypeWorkspaceConnectionProperties
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
UsernamePasswordAuthTypeWorkspaceConnectionProperties
ValueFormat	Format für den Arbeitsbereich-Verbindungswert
WorkspaceConnectionAccessKey
WorkspaceConnectionAccountKey
WorkspaceConnectionApiKey	API-Schlüsselobjekt für Arbeitsbereichsverbindungsanmeldeinformationen.
WorkspaceConnectionManagedIdentity
WorkspaceConnectionOAuth2	ClientId und ClientSecret sind erforderlich. Andere Eigenschaften sind je nach Implementierung jedes OAuth2-Anbieters optional.
WorkspaceConnectionPersonalAccessToken
WorkspaceConnectionPropertiesV2BasicResource
WorkspaceConnectionServicePrincipal
WorkspaceConnectionSharedAccessSignature
WorkspaceConnectionUsernamePassword

AADAuthTypeWorkspaceConnectionProperties

Dieser Verbindungstyp deckt die AAD-Authentifizierung für alle anwendbaren Azure-Dienste ab.

Name	Typ	Beschreibung
authType	string: AAD	Authentifizierungstyp des Verbindungsziels
category	ConnectionCategory	Kategorie der Verbindung
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	Gruppe 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	ValueFormat	Format für den Arbeitsbereich-Verbindungswert

AccessKeyAuthTypeWorkspaceConnectionProperties

Name	Typ	Beschreibung
authType	string: AccessKey	Authentifizierungstyp des Verbindungsziels
category	ConnectionCategory	Kategorie der Verbindung
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionAccessKey
expiryTime	string
group	ConnectionGroup	Gruppe 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	ValueFormat	Format für den Arbeitsbereich-Verbindungswert

AccountKeyAuthTypeWorkspaceConnectionProperties

Dieser Verbindungstyp deckt die Kontoschlüsselverbindung für Azure Storage ab.

Name	Typ	Beschreibung
authType	string: AccountKey	Authentifizierungstyp des Verbindungsziels
category	ConnectionCategory	Kategorie der Verbindung
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionAccountKey
expiryTime	string
group	ConnectionGroup	Gruppe 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	ValueFormat	Format für den Arbeitsbereich-Verbindungswert

ApiKeyAuthWorkspaceConnectionProperties

Dieser Verbindungstyp deckt die generischen ApiKey-Authentifizierungsverbindungskategorien ab, z. B. 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 diskriminator) Credentials:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion}

CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (as type diskriminator) Credentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint}

Verwenden des Eigenschaftenbehälters "Metadaten" für ApiType, ApiVersion, Kind und andere Metadatenfelder

Name	Typ	Beschreibung
authType	string: ApiKey	Authentifizierungstyp des Verbindungsziels
category	ConnectionCategory	Kategorie der Verbindung
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionApiKey	API-Schlüsselobjekt für Arbeitsbereichsverbindungsanmeldeinformationen.
expiryTime	string
group	ConnectionGroup	Gruppe 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	ValueFormat	Format für den Arbeitsbereich-Verbindungswert

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
Elasticsearch	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
ManagedOnlineEndpoint	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
Pinecone	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

Gruppe basierend auf der 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

Benutzerdefinierte Schlüssel-Anmeldeinformationsobjekt

Name	Typ	Beschreibung
keys	object

CustomKeysWorkspaceConnectionProperties

Category:= CustomKeys AuthType:= CustomKeys (as type diskriminator) 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: CustomKeys	Authentifizierungstyp des Verbindungsziels
category	ConnectionCategory	Kategorie der Verbindung
createdByWorkspaceArmId	string
credentials	CustomKeys	Benutzerdefinierte Schlüssel-Anmeldeinformationsobjekt
expiryTime	string
group	ConnectionGroup	Gruppe 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	ValueFormat	Format für den Arbeitsbereich-Verbindungswert

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Name	Typ	Beschreibung
authType	string: ManagedIdentity	Authentifizierungstyp des Verbindungsziels
category	ConnectionCategory	Kategorie der Verbindung
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionManagedIdentity
expiryTime	string
group	ConnectionGroup	Gruppe 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	ValueFormat	Format für den Arbeitsbereich-Verbindungswert

NoneAuthTypeWorkspaceConnectionProperties

Name	Typ	Beschreibung
authType	string: None	Authentifizierungstyp des Verbindungsziels
category	ConnectionCategory	Kategorie der Verbindung
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	Gruppe 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	ValueFormat	Format für den Arbeitsbereich-Verbindungswert

OAuth2AuthTypeWorkspaceConnectionProperties

Name	Typ	Beschreibung
authType	string: OAuth2	Authentifizierungstyp des Verbindungsziels
category	ConnectionCategory	Kategorie der Verbindung
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionOAuth2	ClientId und ClientSecret sind erforderlich. Andere Eigenschaften sind je nach Implementierung jedes OAuth2-Anbieters optional.
expiryTime	string
group	ConnectionGroup	Gruppe 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	ValueFormat	Format für den Arbeitsbereich-Verbindungswert

PATAuthTypeWorkspaceConnectionProperties

Name	Typ	Beschreibung
authType	string: PAT	Authentifizierungstyp des Verbindungsziels
category	ConnectionCategory	Kategorie der Verbindung
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionPersonalAccessToken
expiryTime	string
group	ConnectionGroup	Gruppe 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	ValueFormat	Format für den Arbeitsbereich-Verbindungswert

SASAuthTypeWorkspaceConnectionProperties

Name	Typ	Beschreibung
authType	string: SAS	Authentifizierungstyp des Verbindungsziels
category	ConnectionCategory	Kategorie der Verbindung
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionSharedAccessSignature
expiryTime	string
group	ConnectionGroup	Gruppe 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	ValueFormat	Format für den Arbeitsbereich-Verbindungswert

ServicePrincipalAuthTypeWorkspaceConnectionProperties

Name	Typ	Beschreibung
authType	string: ServicePrincipal	Authentifizierungstyp des Verbindungsziels
category	ConnectionCategory	Kategorie der Verbindung
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionServicePrincipal
expiryTime	string
group	ConnectionGroup	Gruppe 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	ValueFormat	Format für den Arbeitsbereich-Verbindungswert

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	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	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

UsernamePasswordAuthTypeWorkspaceConnectionProperties

Name	Typ	Beschreibung
authType	string: UsernamePassword	Authentifizierungstyp des Verbindungsziels
category	ConnectionCategory	Kategorie der Verbindung
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionUsernamePassword
expiryTime	string
group	ConnectionGroup	Gruppe 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	ValueFormat	Format für den Arbeitsbereich-Verbindungswert

ValueFormat

Format für den Arbeitsbereich-Verbindungswert

Name	Typ	Beschreibung
JSON	string

WorkspaceConnectionAccessKey

Name	Typ	Beschreibung
accessKeyId	string
secretAccessKey	string

WorkspaceConnectionAccountKey

Name	Typ	Beschreibung
key	string

WorkspaceConnectionApiKey

API-Schlüsselobjekt für Arbeitsbereichsverbindungsanmeldeinformationen.

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 Kategorie "Concur"-Verbindung
clientId	string	Client-ID im Format von UUID
clientSecret	string
developerToken	string	Erforderlich für die GoogleAdWords-Verbindungskategorie
password	string
refreshToken	string	Erforderlich von GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho, wo der Benutzer RefreshToken offline erhalten muss
tenantId	string	Erforderlich für QuickBooks und Xero-Verbindungskategorien
username	string	Concur, ServiceNow auth Server AccessToken Grant Type ist "Password", die UsernamePassword erfordert

WorkspaceConnectionPersonalAccessToken

Name	Typ	Beschreibung
pat	string

WorkspaceConnectionPropertiesV2BasicResource

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties	WorkspaceConnectionPropertiesV2: AADAuthTypeWorkspaceConnectionProperties AccessKeyAuthTypeWorkspaceConnectionProperties AccountKeyAuthTypeWorkspaceConnectionProperties ApiKeyAuthWorkspaceConnectionProperties CustomKeysWorkspaceConnectionProperties ManagedIdentityAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties OAuth2AuthTypeWorkspaceConnectionProperties PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties ServicePrincipalAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

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

Freigeben über