Megosztás a következőn keresztül:


Connector - Create Or Update

Összekötő-erőforrás létrehozása vagy frissítése.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName}?api-version=2022-11-01-preview

URI-paraméterek

Name In Kötelező Típus Description
connectorName
path True

string

Az erőforrás neve.

location
path True

string

minLength: 1

Az Azure-régió neve.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

subscriptionId
path True

string

minLength: 1

A cél-előfizetés azonosítója.

api-version
query True

string

minLength: 1

A művelethez használni kívánt API-verzió.

Kérelem törzse

Name Típus Description
properties.authInfo AuthInfoBase:

A hitelesítési típus.

properties.clientType

clientType

Az alkalmazásügyfél típusa

properties.configurationInfo

ConfigurationInfo

Az alkalmazások által felhasznált kapcsolati információk, beleértve a titkos kulcsokat és a kapcsolati sztringeket.

properties.publicNetworkSolution

PublicNetworkSolution

A hálózati megoldás.

properties.scope

string

kapcsolat hatóköre a forrásszolgáltatásban.

properties.secretStore

SecretStore

A titkos kód értékének biztonságos helyen való tárolásának lehetősége

properties.targetService TargetServiceBase:

A célszolgáltatás tulajdonságai

properties.vNetSolution

VNetSolution

A VNet-megoldás.

Válaszok

Name Típus Description
200 OK

LinkerResource

Sikeres.

201 Created

LinkerResource

Hosszú ideig futó művelet.

Other Status Codes

ErrorResponse

Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation a felhasználói fiók megszemélyesítése

Példák

PutConnector

Mintakérelem

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ServiceLinker/locations/westus/connectors/connectorName?api-version=2022-11-01-preview

{
  "properties": {
    "targetService": {
      "type": "AzureResource",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
    },
    "authInfo": {
      "authType": "secret"
    },
    "secretStore": {
      "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv"
    }
  }
}

Mintaválasz

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName",
  "type": "Microsoft.ServiceLinker/links",
  "name": "linkName",
  "properties": {
    "authInfo": {
      "authType": "secret"
    },
    "secretStore": {
      "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv"
    },
    "targetService": {
      "type": "AzureResource",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
    }
  }
}
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName",
  "type": "Microsoft.ServiceLinker/links",
  "name": "linkName",
  "properties": {
    "authInfo": {
      "authType": "secret"
    },
    "secretStore": {
      "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv"
    },
    "targetService": {
      "type": "AzureResource",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
    }
  }
}

Definíciók

Name Description
AccessKeyInfoBase

A hozzáférési kulcs közvetlenül a célerőforrás-tulajdonságokból származik, amely célszolgáltatás az Azure-erőforrás, például a Microsoft.Storage

accessKeyPermissions

Az accessKey engedélyei. Read és Write az Azure Cosmos DB-hez és az Azure App Configurationhoz, Listen, Send és Manage az Azure Event Hubhoz és az Azure Service Bushoz.

actionType

Opcionális. Nyilvános hálózati megoldást jelez. Ha engedélyezve van, a legjobb megoldásként engedélyezze a célszolgáltatás nyilvános hálózati elérését. Az alapértelmezett beállítás engedélyezve van. Ha leiratkozhat, tiltsa le a nyilvános hálózati hozzáférés konfigurációját.

allowType

Ha igaz, engedélyezze az Azure-szolgáltatások számára a célszolgáltatás elérését.

AuthType

A hitelesítési típus.

AzureKeyVaultProperties

Az erőforrás tulajdonságai, ha a típus az Azure Key Vault

AzureResource

Az Azure-erőforrás adatai, ha a célszolgáltatás típusa az AzureResource

clientType

Az alkalmazásügyfél típusa

ConfigurationInfo

A konfigurációk létrehozásához vagy alkalmazásokba való mentéshez használt konfigurációs információk

ConfluentBootstrapServer

A szolgáltatás tulajdonságai, ha a célszolgáltatás típusa ConfluentBootstrapServer

ConfluentSchemaRegistry

A szolgáltatás tulajdonságai, ha a célszolgáltatás típusa ConfluentSchemaRegistry

createdByType

Az erőforrást létrehozó identitás típusa.

DaprMetadata

A dapr összetevő metaadatai.

DaprProperties

További tulajdonságokat jelez a dapr-ügyféltípushoz

DeleteOrUpdateBehavior

A törlési viselkedés jelzi, hogy az erőforrás törlésekor vagy frissítésekor végzett tisztítási művelet

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

ErrorDetail

A hiba részletei.

ErrorResponse

Hibaválasz

FirewallRules

A célszolgáltatás tűzfalszabályai. a forrásszolgáltatásból származó kapcsolatok engedélyezéséhez.

KeyVaultSecretReferenceSecretInfo

A titkos információ, ha a típus keyVaultSecretReference. A felhasználó a felhasználó kulcstartójában tárolt titkos kulcsot biztosít, a forrás pedig az Azure Kubernetes. A key Vault erőforrás-azonosítója a secretStore.keyVaultId azonosítóhoz van csatolva.

KeyVaultSecretUriSecretInfo

A titkos információ, ha a típus keyVaultSecretUri. Ez az a forgatókönyv, amely szerint a felhasználó a felhasználó kulcstartójában tárolt titkos kulcsot biztosít, és a forrás a Web App, a Spring Cloud vagy a Container App.

LinkerResource

Forrás- és célerőforrás csatolása

PublicNetworkSolution

Nyilvános hálózati megoldást jelez, tűzfalszabályokat is tartalmaz

SecretAuthInfo

A hitelesítési adatok, ha az authType titkos

SecretStore

A titkos kód értékének biztonságos helyen való tárolásának lehetősége

SecretType

A titkos kód típusa.

SelfHostedServer

A szolgáltatás tulajdonságai, ha a célszolgáltatás típusa SelfHostedServer

ServicePrincipalCertificateAuthInfo

A hitelesítési adatok, amikor az authType servicePrincipal tanúsítvány

ServicePrincipalSecretAuthInfo

A hitelesítési adatok, ha az authType servicePrincipal titkos kód

SystemAssignedIdentityAuthInfo

A hitelesítési adatok, ha az authType systemAssignedIdentity

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

UserAccountAuthInfo

A hitelesítési adatok, ha az authType felhasználói fiók

UserAssignedIdentityAuthInfo

A hitelesítési adatok, amikor az authType userAssignedIdentity

ValueSecretInfo

A titkos információ, ha a típus rawValue. Olyan forgatókönyvek esetében, amelyekben a felhasználó beírja a titkos kulcsot.

VNetSolution

A linker virtuális hálózati megoldása

vNetSolutionType

A VNet-megoldás típusa.

AccessKeyInfoBase

A hozzáférési kulcs közvetlenül a célerőforrás-tulajdonságokból származik, amely célszolgáltatás az Azure-erőforrás, például a Microsoft.Storage

Name Típus Description
authType string:

accessKey

A hitelesítési típus.

permissions

accessKeyPermissions[]

Az accessKey engedélyei. Read és Write az Azure Cosmos DB-hez és az Azure App Configurationhoz, Listen, Send és Manage az Azure Event Hubhoz és az Azure Service Bushoz.

accessKeyPermissions

Az accessKey engedélyei. Read és Write az Azure Cosmos DB-hez és az Azure App Configurationhoz, Listen, Send és Manage az Azure Event Hubhoz és az Azure Service Bushoz.

Érték Description
Listen
Manage
Read
Send
Write

actionType

Opcionális. Nyilvános hálózati megoldást jelez. Ha engedélyezve van, a legjobb megoldásként engedélyezze a célszolgáltatás nyilvános hálózati elérését. Az alapértelmezett beállítás engedélyezve van. Ha leiratkozhat, tiltsa le a nyilvános hálózati hozzáférés konfigurációját.

Érték Description
enable
optOut

allowType

Ha igaz, engedélyezze az Azure-szolgáltatások számára a célszolgáltatás elérését.

Érték Description
false
true

AuthType

A hitelesítési típus.

Érték Description
accessKey
secret
servicePrincipalCertificate
servicePrincipalSecret
systemAssignedIdentity
userAccount
userAssignedIdentity

AzureKeyVaultProperties

Az erőforrás tulajdonságai, ha a típus az Azure Key Vault

Name Típus Description
connectAsKubernetesCsiDriver

boolean

Igaz, ha Kubernetes CSI-illesztőprogramon keresztül csatlakozik.

type string:

KeyVault

Az Azure-erőforrás típusa.

AzureResource

Az Azure-erőforrás adatai, ha a célszolgáltatás típusa az AzureResource

Name Típus Description
id

string

Az Azure-erőforrás azonosítója.

resourceProperties AzureResourcePropertiesBase:

AzureKeyVaultProperties

Az Azure-erőforrás-kapcsolattal kapcsolatos tulajdonságok.

type string:

AzureResource

A célszolgáltatás típusa.

clientType

Az alkalmazásügyfél típusa

Érték Description
dapr
django
dotnet
go
java
kafka-springBoot
nodejs
none
php
python
ruby
springBoot

ConfigurationInfo

A konfigurációk létrehozásához vagy alkalmazásokba való mentéshez használt konfigurációs információk

Name Típus Description
action

actionType

Nem kötelező, adja meg, hogy a konfigurációkat alkalmazza-e a forrásalkalmazásban. Ha engedélyezve van, hozzon létre konfigurációkat, és alkalmazza a forrásalkalmazásra. Az alapértelmezett beállítás engedélyezve van. Ha optOut, a rendszer nem módosítja a konfigurációt a forráson.

additionalConfigurations

object

További hozzáadandó konfigurációk szótára. A szolgáltatás automatikusan létrehoz néhány alapkonfigurációt, és ez a tulajdonság a testre szabottabb konfigurációk teljes kitöltésére szolgál

customizedKeys

object

Opcionális. Az alapértelmezett kulcsnév és a testreszabott kulcsnév-leképezés szótára. Ha nincs megadva, a rendszer az alapértelmezett kulcsnevet használja a konfigurációk létrehozásához

daprProperties

DaprProperties

További tulajdonságokat jelez a dapr-ügyféltípushoz

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Azt jelzi, hogy a Linker frissítésekor vagy törlésekor törli-e az előző műveletet

ConfluentBootstrapServer

A szolgáltatás tulajdonságai, ha a célszolgáltatás típusa ConfluentBootstrapServer

Name Típus Description
endpoint

string

A szolgáltatás végpontja.

type string:

ConfluentBootstrapServer

A célszolgáltatás típusa.

ConfluentSchemaRegistry

A szolgáltatás tulajdonságai, ha a célszolgáltatás típusa ConfluentSchemaRegistry

Name Típus Description
endpoint

string

A szolgáltatás végpontja.

type string:

ConfluentSchemaRegistry

A célszolgáltatás típusa.

createdByType

Az erőforrást létrehozó identitás típusa.

Érték Description
Application
Key
ManagedIdentity
User

DaprMetadata

A dapr összetevő metaadatai.

Name Típus Description
name

string

Metaadat-tulajdonság neve.

secretRef

string

A titkos név, ahol a dapr értéket kaphat

value

string

Metaadat-tulajdonság értéke.

DaprProperties

További tulajdonságokat jelez a dapr-ügyféltípushoz

Name Típus Description
componentType

string

A dapr-összetevő típusa

metadata

DaprMetadata[]

További dapr-metaadatok

scopes

string[]

A dapr-összetevő hatókörei

secretStoreComponent

string

Titkos kulcsok lekéréséhez használt titkos tár neve

version

string

A dapr összetevő verziója

DeleteOrUpdateBehavior

A törlési viselkedés jelzi, hogy az erőforrás törlésekor vagy frissítésekor végzett tisztítási művelet

Érték Description
Default
ForcedCleanup

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name Típus Description
info

object

A további információk.

type

string

A további információtípus.

ErrorDetail

A hiba részletei.

Name Típus Description
additionalInfo

ErrorAdditionalInfo[]

A hiba további információi.

code

string

A hibakód.

details

ErrorDetail[]

A hiba részletei.

message

string

A hibaüzenet.

target

string

A hibacél.

ErrorResponse

Hibaválasz

Name Típus Description
error

ErrorDetail

A hibaobjektum.

FirewallRules

A célszolgáltatás tűzfalszabályai. a forrásszolgáltatásból származó kapcsolatok engedélyezéséhez.

Name Típus Description
azureServices

allowType

Ha igaz, engedélyezze az Azure-szolgáltatások számára a célszolgáltatás elérését.

callerClientIP

allowType

Ha igaz, engedélyezze a hívó ügyfél IP-címének elérését a célszolgáltatáshoz. a tulajdonság a helyi alkalmazás célszolgáltatáshoz való csatlakoztatásához használatos.

ipRanges

string[]

Ez az érték a CIDR formátumú IP-címek vagy IP-címtartományok készletét adja meg, amelyeket egy adott adatbázisfiók ügyfél IP-címeinek engedélyezett listájaként kell szerepeltetni.

KeyVaultSecretReferenceSecretInfo

A titkos információ, ha a típus keyVaultSecretReference. A felhasználó a felhasználó kulcstartójában tárolt titkos kulcsot biztosít, a forrás pedig az Azure Kubernetes. A key Vault erőforrás-azonosítója a secretStore.keyVaultId azonosítóhoz van csatolva.

Name Típus Description
name

string

A Key Vault titkos kulcsának neve.

secretType string:

keyVaultSecretReference

A titkos kód típusa.

version

string

A Key Vault titkos kódjának verziója.

KeyVaultSecretUriSecretInfo

A titkos információ, ha a típus keyVaultSecretUri. Ez az a forgatókönyv, amely szerint a felhasználó a felhasználó kulcstartójában tárolt titkos kulcsot biztosít, és a forrás a Web App, a Spring Cloud vagy a Container App.

Name Típus Description
secretType string:

keyVaultSecretUri

A titkos kód típusa.

value

string

URI a kulcsvault titkos kódhoz

LinkerResource

Forrás- és célerőforrás csatolása

Name Típus Description
id

string

Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Az erőforrás neve

properties.authInfo AuthInfoBase:

A hitelesítési típus.

properties.clientType

clientType

Az alkalmazásügyfél típusa

properties.configurationInfo

ConfigurationInfo

Az alkalmazások által felhasznált kapcsolati információk, beleértve a titkos kulcsokat és a kapcsolati sztringeket.

properties.provisioningState

string

A kiépítési állapot.

properties.publicNetworkSolution

PublicNetworkSolution

A hálózati megoldás.

properties.scope

string

kapcsolat hatóköre a forrásszolgáltatásban.

properties.secretStore

SecretStore

A titkos kód értékének biztonságos helyen való tárolásának lehetősége

properties.targetService TargetServiceBase:

A célszolgáltatás tulajdonságai

properties.vNetSolution

VNetSolution

A VNet-megoldás.

systemData

systemData

A rendszeradatok.

type

string

Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

PublicNetworkSolution

Nyilvános hálózati megoldást jelez, tűzfalszabályokat is tartalmaz

Name Típus Description
action

actionType

Opcionális. Nyilvános hálózati megoldást jelez. Ha engedélyezve van, a legjobb megoldásként engedélyezze a célszolgáltatás nyilvános hálózati elérését. Az alapértelmezett beállítás engedélyezve van. Ha leiratkozhat, tiltsa le a nyilvános hálózati hozzáférés konfigurációját.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Azt jelzi, hogy a Linker frissítésekor vagy törlésekor törli-e az előző műveletet (például tűzfalszabályokat).

firewallRules

FirewallRules

A célszolgáltatás tűzfalszabályainak ismertetése annak érdekében, hogy a forrásalkalmazás kapcsolódni tud a célhoz.

SecretAuthInfo

A hitelesítési adatok, ha az authType titkos

Name Típus Description
authType string:

secret

A hitelesítési típus.

name

string

Titkos hitelesítés felhasználóneve vagy fiókneve.

secretInfo SecretInfoBase:

Jelszó vagy kulcstartó titkos kódja a titkos hitelesítéshez.

SecretStore

A titkos kód értékének biztonságos helyen való tárolásának lehetősége

Name Típus Description
keyVaultId

string

A titkos kulcstartó azonosítója

keyVaultSecretName

string

A titkos kulcstartó titkos kódjának neve, amely csak egy titkos kód tárolásakor érvényes

SecretType

A titkos kód típusa.

Érték Description
keyVaultSecretReference
keyVaultSecretUri
rawValue

SelfHostedServer

A szolgáltatás tulajdonságai, ha a célszolgáltatás típusa SelfHostedServer

Name Típus Description
endpoint

string

A szolgáltatás végpontja.

type string:

SelfHostedServer

A célszolgáltatás típusa.

ServicePrincipalCertificateAuthInfo

A hitelesítési adatok, amikor az authType servicePrincipal tanúsítvány

Name Típus Description
authType string:

servicePrincipalCertificate

A hitelesítési típus.

certificate

string

ServicePrincipal-tanúsítvány a servicePrincipal hitelesítéshez.

clientId

string

Application clientId for servicePrincipal auth.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Azt jelzi, hogy a Linker frissítésekor vagy törlésekor törli-e az előző műveletet

principalId

string

A servicePrincipal hitelesítés egyszerű azonosítója.

roles

string[]

Nem kötelező, ez az érték határozza meg a hozzárendelni kívánt Azure-szerepköröket. Automatikusan

ServicePrincipalSecretAuthInfo

A hitelesítési adatok, ha az authType servicePrincipal titkos kód

Name Típus Description
authType string:

servicePrincipalSecret

A hitelesítési típus.

clientId

string

ServicePrincipal-alkalmazás ügyfélazonosítója a servicePrincipal hitelesítéshez.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Azt jelzi, hogy a Linker frissítésekor vagy törlésekor törli-e az előző műveletet

principalId

string

A servicePrincipal hitelesítés egyszerű azonosítója.

roles

string[]

Nem kötelező, ez az érték határozza meg a hozzárendelni kívánt Azure-szerepköröket. Automatikusan

secret

string

Titkos kód a servicePrincipal hitelesítéshez.

userName

string

Az adatbázisban létrehozott felhasználónév, amely az AAD-ben egy felhasználóhoz van leképezve.

SystemAssignedIdentityAuthInfo

A hitelesítési adatok, ha az authType systemAssignedIdentity

Name Típus Description
authType string:

systemAssignedIdentity

A hitelesítési típus.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Azt jelzi, hogy a Linker frissítésekor vagy törlésekor törli-e az előző műveletet

roles

string[]

Nem kötelező, ez az érték határozza meg a hozzárendelni kívánt Azure-szerepkört

userName

string

Az adatbázisban létrehozott felhasználónév, amely az AAD-ben egy felhasználóhoz van leképezve.

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name Típus Description
createdAt

string (date-time)

Az erőforrás-létrehozás időbélyege (UTC).

createdBy

string

Az erőforrást létrehozó identitás.

createdByType

createdByType

Az erőforrást létrehozó identitás típusa.

lastModifiedAt

string (date-time)

Az erőforrás utolsó módosításának időbélyege (UTC)

lastModifiedBy

string

Az erőforrást legutóbb módosító identitás.

lastModifiedByType

createdByType

Az erőforrást legutóbb módosító identitás típusa.

UserAccountAuthInfo

A hitelesítési adatok, ha az authType felhasználói fiók

Name Típus Description
authType string:

userAccount

A hitelesítési típus.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Azt jelzi, hogy a Linker frissítésekor vagy törlésekor törli-e az előző műveletet

principalId

string

A felhasználói fiók egyszerű azonosítója.

roles

string[]

Nem kötelező, ez az érték határozza meg a hozzárendelni kívánt Azure-szerepköröket. Automatikusan

userName

string

Az adatbázisban létrehozott felhasználónév, amely az AAD-ben egy felhasználóhoz van leképezve.

UserAssignedIdentityAuthInfo

A hitelesítési adatok, amikor az authType userAssignedIdentity

Name Típus Description
authType string:

userAssignedIdentity

A hitelesítési típus.

clientId

string

A userAssignedIdentity ügyfélazonosítója.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Azt jelzi, hogy a Linker frissítésekor vagy törlésekor törli-e az előző műveletet

roles

string[]

Nem kötelező, ez az érték határozza meg a hozzárendelni kívánt Azure-szerepkört

subscriptionId

string

A userAssignedIdentity előfizetés-azonosítója.

userName

string

Az adatbázisban létrehozott felhasználónév, amely az AAD-ben egy felhasználóhoz van leképezve.

ValueSecretInfo

A titkos információ, ha a típus rawValue. Olyan forgatókönyvek esetében, amelyekben a felhasználó beírja a titkos kulcsot.

Name Típus Description
secretType string:

rawValue

A titkos kód típusa.

value

string

A titkos kód tényleges értéke.

VNetSolution

A linker virtuális hálózati megoldása

Name Típus Description
deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Azt jelzi, hogy a Linker frissítésekor vagy törlésekor törli-e az előző műveletet

type

vNetSolutionType

A VNet-megoldás típusa.

vNetSolutionType

A VNet-megoldás típusa.

Érték Description
privateLink
serviceEndpoint