Freigeben über


Linker - List

Gibt die Liste der Linker zurück, die eine Verbindung mit der Ressource herstellen. die sowohl die Konfiguration des Anwendungs- als auch des Zieldiensts während der Ressourcenbereitstellung unterstützt.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceUri
path True

string

Der vollqualifizierte Azure Resource Manager-Bezeichner der ressource, die verbunden werden soll.

api-version
query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name Typ Beschreibung
200 OK

ResourceList

Linkerdetails.

Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

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

LinkerList

Beispielanforderung

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/linkers?api-version=2022-11-01-preview

Beispiel für eine Antwort

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/links/linkName",
      "name": "linkName",
      "type": "Microsoft.ServiceLinker/links",
      "properties": {
        "authInfo": {
          "authType": "secret",
          "name": "username"
        },
        "targetService": {
          "type": "AzureResource",
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
        }
      },
      "systemData": {
        "createdAt": "2020-07-12T22:05:09Z"
      }
    }
  ]
}

Definitionen

Name Beschreibung
AccessKeyInfoBase

Der Zugriffsschlüssel direkt über Zielressourceneigenschaften, der Zieldienst azure Resource ist, z. B. Microsoft.Storage

accessKeyPermissions

Berechtigungen des accessKey. Read und Write gelten für Azure Cosmos DB und Azure App Configuration, Listen, Send und Manage für Azure Event Hub und Azure Service Bus.

actionType

Wahlfrei. Gibt die öffentliche Netzwerklösung an. Wenn diese Option aktiviert ist, aktivieren Sie den öffentlichen Netzwerkzugriff des Zieldiensts, und versuchen Sie es am besten. Der Standardwert ist aktiviert. Wenn "optOut" festgelegt ist, deaktivieren Sie die Konfiguration für den Zugriff auf öffentliche Netzwerke.

allowType

Erlauben Sie Azure-Diensten, auf den Zieldienst zuzugreifen, wenn "true".

AuthType

Der Authentifizierungstyp.

AzureKeyVaultProperties

Die Ressourceneigenschaften, wenn der Typ Azure Key Vault ist

AzureResource

Die Azure-Ressourceninformationen, wenn der Zieldiensttyp AzureResource ist

clientType

Der Anwendungsclienttyp

ConfigurationInfo

Die Konfigurationsinformationen, die zum Generieren von Konfigurationen oder zum Speichern in Anwendungen verwendet werden

ConfluentBootstrapServer

Die Diensteigenschaften, wenn der Zieldiensttyp ConfluentBootstrapServer ist

ConfluentSchemaRegistry

Die Diensteigenschaften, wenn der Zieldiensttyp "ConfluentSchemaRegistry" lautet

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

DaprMetadata

Die Dapr-Komponentenmetadaten.

DaprProperties

Gibt einige zusätzliche Eigenschaften für den Dapr-Clienttyp an.

DeleteOrUpdateBehavior

Das Bereinigungsverhalten, das angibt, ob der Bereinigungsvorgang beim Löschen oder Aktualisieren der Ressource angezeigt wird

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetail

Das Fehlerdetails.

ErrorResponse

Fehlerantwort

FirewallRules

Firewallregeln des Zieldiensts. um Verbindungen vom Quelldienst zuzulassen.

KeyVaultSecretReferenceSecretInfo

Die geheimen Informationen, wenn der Typ "keyVaultSecretReference" ist. Dies gilt für Szenarien, in denen der Benutzer einen geheimen Schlüssel bereitstellt, der im Schlüssel des Benutzers gespeichert ist und die Quelle Azure Kubernetes ist. Die Ressourcen-ID des Schlüsseltresors ist mit "secretStore.keyVaultId" verknüpft.

KeyVaultSecretUriSecretInfo

Die geheimen Informationen, wenn der Typ "keyVaultSecretUri" ist. Es ist für szenarios gedacht, dass der Benutzer einen geheimen Schlüssel bereitstellt, der im Keyvault des Benutzers gespeichert ist, und die Quelle ist Web App, Spring Cloud oder Container-App.

LinkerResource

Linker der Quell- und Zielressource

PublicNetworkSolution

Gibt an, dass die öffentliche Netzwerklösung Firewallregeln enthält

ResourceList

Die Liste der Linker.

SecretAuthInfo

Die Authentifizierungsinformationen, wenn authType geheim ist

SecretStore

Eine Option zum Speichern eines geheimen Werts an einem sicheren Ort

SecretType

Der geheime Typ.

SelfHostedServer

Die Diensteigenschaften, wenn der Zieldiensttyp SelfHostedServer ist

ServicePrincipalCertificateAuthInfo

Die Authentifizierungsinformationen, wenn authType "servicePrincipal"-Zertifikat ist

ServicePrincipalSecretAuthInfo

Die Authentifizierungsinformationen, wenn authType "servicePrincipal" ist

SystemAssignedIdentityAuthInfo

Die Authentifizierungsinformationen, wenn authType systemAssignedIdentity ist

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

UserAccountAuthInfo

Die Authentifizierungsinformationen, wenn authType ein Benutzerkonto ist

UserAssignedIdentityAuthInfo

Die Authentifizierungsinformationen, wenn "authType" "userAssignedIdentity" ist

ValueSecretInfo

Die geheimen Informationen, wenn der Typ "rawValue" ist. Dies ist für Szenarien gedacht, in denen der Benutzer den geheimen Schlüssel eingibt.

VNetSolution

Die VNet-Lösung für Linker

vNetSolutionType

Typ der VNet-Lösung.

AccessKeyInfoBase

Der Zugriffsschlüssel direkt über Zielressourceneigenschaften, der Zieldienst azure Resource ist, z. B. Microsoft.Storage

Name Typ Beschreibung
authType string:

accessKey

Der Authentifizierungstyp.

permissions

accessKeyPermissions[]

Berechtigungen des accessKey. Read und Write gelten für Azure Cosmos DB und Azure App Configuration, Listen, Send und Manage für Azure Event Hub und Azure Service Bus.

accessKeyPermissions

Berechtigungen des accessKey. Read und Write gelten für Azure Cosmos DB und Azure App Configuration, Listen, Send und Manage für Azure Event Hub und Azure Service Bus.

Wert Beschreibung
Listen
Manage
Read
Send
Write

actionType

Wahlfrei. Gibt die öffentliche Netzwerklösung an. Wenn diese Option aktiviert ist, aktivieren Sie den öffentlichen Netzwerkzugriff des Zieldiensts, und versuchen Sie es am besten. Der Standardwert ist aktiviert. Wenn "optOut" festgelegt ist, deaktivieren Sie die Konfiguration für den Zugriff auf öffentliche Netzwerke.

Wert Beschreibung
enable
optOut

allowType

Erlauben Sie Azure-Diensten, auf den Zieldienst zuzugreifen, wenn "true".

Wert Beschreibung
false
true

AuthType

Der Authentifizierungstyp.

Wert Beschreibung
accessKey
secret
servicePrincipalCertificate
servicePrincipalSecret
systemAssignedIdentity
userAccount
userAssignedIdentity

AzureKeyVaultProperties

Die Ressourceneigenschaften, wenn der Typ Azure Key Vault ist

Name Typ Beschreibung
connectAsKubernetesCsiDriver

boolean

True, wenn die Verbindung über Kubernetes CSI-Treiber hergestellt wird.

type string:

KeyVault

Der Azure-Ressourcentyp.

AzureResource

Die Azure-Ressourceninformationen, wenn der Zieldiensttyp AzureResource ist

Name Typ Beschreibung
id

string

Die ID der Azure-Ressource.

resourceProperties AzureResourcePropertiesBase:

AzureKeyVaultProperties

Die azure-Ressourcenverbindungseigenschaften.

type string:

AzureResource

Der Zieldiensttyp.

clientType

Der Anwendungsclienttyp

Wert Beschreibung
dapr
django
dotnet
go
java
kafka-springBoot
nodejs
none
php
python
ruby
springBoot

ConfigurationInfo

Die Konfigurationsinformationen, die zum Generieren von Konfigurationen oder zum Speichern in Anwendungen verwendet werden

Name Typ Beschreibung
action

actionType

Optional, gibt an, ob Konfigurationen auf die Quellanwendung angewendet werden sollen. Wenn diese Option aktiviert ist, generieren Sie Konfigurationen, und wenden Sie sie auf die Quellanwendung an. Der Standardwert ist aktiviert. Wenn "optOut" aktiviert ist, wird keine Konfigurationsänderung an der Quelle vorgenommen.

additionalConfigurations

object

Ein Wörterbuch mit zusätzlichen Konfigurationen, die hinzugefügt werden sollen. Der Dienst generiert automatisch eine Reihe von grundlegenden Konfigurationen, und diese Eigenschaft besteht darin, mehr angepasste Konfigurationen vollständig auszufüllen.

customizedKeys

object

Wahlfrei. Ein Wörterbuch mit Standardschlüsselnamen und angepasster Schlüsselnamenzuordnung. Wenn nicht angegeben, wird der Standardschlüsselname für die Generierung von Konfigurationen verwendet.

daprProperties

DaprProperties

Gibt einige zusätzliche Eigenschaften für den Dapr-Clienttyp an.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Gibt an, ob der vorherige Vorgang beim Aktualisieren oder Löschen von Linker bereinigt werden soll.

ConfluentBootstrapServer

Die Diensteigenschaften, wenn der Zieldiensttyp ConfluentBootstrapServer ist

Name Typ Beschreibung
endpoint

string

Der Endpunkt des Diensts.

type string:

ConfluentBootstrapServer

Der Zieldiensttyp.

ConfluentSchemaRegistry

Die Diensteigenschaften, wenn der Zieldiensttyp "ConfluentSchemaRegistry" lautet

Name Typ Beschreibung
endpoint

string

Der Endpunkt des Diensts.

type string:

ConfluentSchemaRegistry

Der Zieldiensttyp.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Wert Beschreibung
Application
Key
ManagedIdentity
User

DaprMetadata

Die Dapr-Komponentenmetadaten.

Name Typ Beschreibung
name

string

Name der Metadateneigenschaft.

secretRef

string

Der geheime Name, unter dem "dapr" den Wert abrufen konnte

value

string

Metadateneigenschaftswert.

DaprProperties

Gibt einige zusätzliche Eigenschaften für den Dapr-Clienttyp an.

Name Typ Beschreibung
componentType

string

Der Dapr-Komponententyp

metadata

DaprMetadata[]

Zusätzliche Dapr-Metadaten

scopes

string[]

Die Dapr-Komponentenbereiche

secretStoreComponent

string

Der Name eines geheimen Informationsspeichers zum Abrufen eines geheimen Schlüssels

version

string

Die Dapr-Komponentenversion

DeleteOrUpdateBehavior

Das Bereinigungsverhalten, das angibt, ob der Bereinigungsvorgang beim Löschen oder Aktualisieren der Ressource angezeigt wird

Wert Beschreibung
Default
ForcedCleanup

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.

FirewallRules

Firewallregeln des Zieldiensts. um Verbindungen vom Quelldienst zuzulassen.

Name Typ Beschreibung
azureServices

allowType

Erlauben Sie Azure-Diensten, auf den Zieldienst zuzugreifen, wenn "true".

callerClientIP

allowType

Allow caller client IP to access the target service if true. die Eigenschaft wird verwendet, wenn eine lokale Anwendung mit dem Zieldienst verbunden wird.

ipRanges

string[]

Dieser Wert gibt den Satz von IP-Adressen oder IP-Adressbereichen im CIDR-Formular an, der als zulässige Liste der Client-IPs für ein bestimmtes Datenbankkonto eingeschlossen werden soll.

KeyVaultSecretReferenceSecretInfo

Die geheimen Informationen, wenn der Typ "keyVaultSecretReference" ist. Dies gilt für Szenarien, in denen der Benutzer einen geheimen Schlüssel bereitstellt, der im Schlüssel des Benutzers gespeichert ist und die Quelle Azure Kubernetes ist. Die Ressourcen-ID des Schlüsseltresors ist mit "secretStore.keyVaultId" verknüpft.

Name Typ Beschreibung
name

string

Name des Schlüsseltresorschlüssels.

secretType string:

keyVaultSecretReference

Der geheime Typ.

version

string

Version des Schlüsseltresorschlüssels.

KeyVaultSecretUriSecretInfo

Die geheimen Informationen, wenn der Typ "keyVaultSecretUri" ist. Es ist für szenarios gedacht, dass der Benutzer einen geheimen Schlüssel bereitstellt, der im Keyvault des Benutzers gespeichert ist, und die Quelle ist Web App, Spring Cloud oder Container-App.

Name Typ Beschreibung
secretType string:

keyVaultSecretUri

Der geheime Typ.

value

string

URI für den Schlüsselschlüsselschlüssel

LinkerResource

Linker der Quell- und Zielressource

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.authInfo AuthInfoBase:

Der Authentifizierungstyp.

properties.clientType

clientType

Der Anwendungsclienttyp

properties.configurationInfo

ConfigurationInfo

Die von Anwendungen genutzten Verbindungsinformationen, einschließlich geheimer Schlüssel, Verbindungszeichenfolgen.

properties.provisioningState

string

Der Bereitstellungsstatus.

properties.publicNetworkSolution

PublicNetworkSolution

Die Netzwerklösung.

properties.scope

string

Verbindungsbereich im Quelldienst.

properties.secretStore

SecretStore

Eine Option zum Speichern eines geheimen Werts an einem sicheren Ort

properties.targetService TargetServiceBase:

Die Zieldiensteigenschaften

properties.vNetSolution

VNetSolution

Die VNet-Lösung.

systemData

systemData

Die Systemdaten.

type

string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PublicNetworkSolution

Gibt an, dass die öffentliche Netzwerklösung Firewallregeln enthält

Name Typ Beschreibung
action

actionType

Wahlfrei. Gibt die öffentliche Netzwerklösung an. Wenn diese Option aktiviert ist, aktivieren Sie den öffentlichen Netzwerkzugriff des Zieldiensts, und versuchen Sie es am besten. Der Standardwert ist aktiviert. Wenn "optOut" festgelegt ist, deaktivieren Sie die Konfiguration für den Zugriff auf öffentliche Netzwerke.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Gibt an, ob vorheriger Vorgang (z. B. Firewallregeln) beim Aktualisieren oder Löschen von Linker bereinigt werden soll.

firewallRules

FirewallRules

Beschreiben Sie Firewallregeln des Zieldiensts, um sicherzustellen, dass die Quellanwendung eine Verbindung mit dem Ziel herstellen kann.

ResourceList

Die Liste der Linker.

Name Typ Beschreibung
nextLink

string

Der Linker, der zum Abrufen der nächsten Seite der Linker-Liste verwendet wurde.

value

LinkerResource[]

Die Liste der Linker.

SecretAuthInfo

Die Authentifizierungsinformationen, wenn authType geheim ist

Name Typ Beschreibung
authType string:

secret

Der Authentifizierungstyp.

name

string

Benutzername oder Kontoname für die geheime Authentifizierung.

secretInfo SecretInfoBase:

Kennwort- oder Schlüsseltresorschlüssel für die geheime Authentifizierung.

SecretStore

Eine Option zum Speichern eines geheimen Werts an einem sicheren Ort

Name Typ Beschreibung
keyVaultId

string

Die Schlüsseltresor-ID zum Speichern des geheimen Schlüssels

keyVaultSecretName

string

Der Schlüsseltresorschlüsselname zum Speichern des geheimen Schlüssels, nur gültig beim Speichern eines geheimen Schlüssels

SecretType

Der geheime Typ.

Wert Beschreibung
keyVaultSecretReference
keyVaultSecretUri
rawValue

SelfHostedServer

Die Diensteigenschaften, wenn der Zieldiensttyp SelfHostedServer ist

Name Typ Beschreibung
endpoint

string

Der Endpunkt des Diensts.

type string:

SelfHostedServer

Der Zieldiensttyp.

ServicePrincipalCertificateAuthInfo

Die Authentifizierungsinformationen, wenn authType "servicePrincipal"-Zertifikat ist

Name Typ Beschreibung
authType string:

servicePrincipalCertificate

Der Authentifizierungstyp.

certificate

string

ServicePrincipal-Zertifikat für servicePrincipal-Authentifizierung.

clientId

string

Application clientId for servicePrincipal auth.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Gibt an, ob der vorherige Vorgang beim Aktualisieren oder Löschen von Linker bereinigt werden soll.

principalId

string

Prinzipal-ID für servicePrincipal-Authentifizierung.

roles

string[]

Optional gibt dieser Wert die Azure-Rollen an, die zugewiesen werden sollen. Automatisch

ServicePrincipalSecretAuthInfo

Die Authentifizierungsinformationen, wenn authType "servicePrincipal" ist

Name Typ Beschreibung
authType string:

servicePrincipalSecret

Der Authentifizierungstyp.

clientId

string

ServicePrincipal application clientId for servicePrincipal auth.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Gibt an, ob der vorherige Vorgang beim Aktualisieren oder Löschen von Linker bereinigt werden soll.

principalId

string

Prinzipal-ID für servicePrincipal-Authentifizierung.

roles

string[]

Optional gibt dieser Wert die Azure-Rollen an, die zugewiesen werden sollen. Automatisch

secret

string

Secret for servicePrincipal auth.

userName

string

Der in der Datenbank erstellte Benutzername, der einem Benutzer in AAD zugeordnet ist.

SystemAssignedIdentityAuthInfo

Die Authentifizierungsinformationen, wenn authType systemAssignedIdentity ist

Name Typ Beschreibung
authType string:

systemAssignedIdentity

Der Authentifizierungstyp.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Gibt an, ob der vorherige Vorgang beim Aktualisieren oder Löschen von Linker bereinigt werden soll.

roles

string[]

Optional, dieser Wert gibt die Azure-Rolle an, die zugewiesen werden soll.

userName

string

Der in der Datenbank erstellte Benutzername, der einem Benutzer in AAD zugeordnet ist.

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name Typ Beschreibung
createdAt

string (date-time)

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 (date-time)

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.

UserAccountAuthInfo

Die Authentifizierungsinformationen, wenn authType ein Benutzerkonto ist

Name Typ Beschreibung
authType string:

userAccount

Der Authentifizierungstyp.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Gibt an, ob der vorherige Vorgang beim Aktualisieren oder Löschen von Linker bereinigt werden soll.

principalId

string

Prinzipal-ID für benutzerkonto.

roles

string[]

Optional gibt dieser Wert die Azure-Rollen an, die zugewiesen werden sollen. Automatisch

userName

string

Der in der Datenbank erstellte Benutzername, der einem Benutzer in AAD zugeordnet ist.

UserAssignedIdentityAuthInfo

Die Authentifizierungsinformationen, wenn "authType" "userAssignedIdentity" ist

Name Typ Beschreibung
authType string:

userAssignedIdentity

Der Authentifizierungstyp.

clientId

string

Client-ID für userAssignedIdentity.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Gibt an, ob der vorherige Vorgang beim Aktualisieren oder Löschen von Linker bereinigt werden soll.

roles

string[]

Optional, dieser Wert gibt die Azure-Rolle an, die zugewiesen werden soll.

subscriptionId

string

Abonnement-ID für userAssignedIdentity.

userName

string

Der in der Datenbank erstellte Benutzername, der einem Benutzer in AAD zugeordnet ist.

ValueSecretInfo

Die geheimen Informationen, wenn der Typ "rawValue" ist. Dies ist für Szenarien gedacht, in denen der Benutzer den geheimen Schlüssel eingibt.

Name Typ Beschreibung
secretType string:

rawValue

Der geheime Typ.

value

string

Der tatsächliche Wert des geheimen Schlüssels.

VNetSolution

Die VNet-Lösung für Linker

Name Typ Beschreibung
deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Gibt an, ob der vorherige Vorgang beim Aktualisieren oder Löschen von Linker bereinigt werden soll.

type

vNetSolutionType

Typ der VNet-Lösung.

vNetSolutionType

Typ der VNet-Lösung.

Wert Beschreibung
privateLink
serviceEndpoint