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 |
---|---|---|---|---|
connector
|
path | True |
string |
Az erőforrás neve. |
location
|
path | True |
string minLength: 1 |
Az Azure-régió neve. |
resource
|
path | True |
string minLength: 1maxLength: 90 |
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket. |
subscription
|
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 |
Az alkalmazásügyfél típusa |
|
properties.configurationInfo |
Az alkalmazások által felhasznált kapcsolati információk, beleértve a titkos kulcsokat és a kapcsolati sztringeket. |
|
properties.publicNetworkSolution |
A hálózati megoldás. |
|
properties.scope |
string |
kapcsolat hatóköre a forrásszolgáltatásban. |
properties.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 |
A VNet-megoldás. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
Sikeres. |
|
201 Created |
Hosszú ideig futó művelet. |
|
Other Status Codes |
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 |
---|---|
Access |
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 |
access |
Az accessKey engedélyei.
|
action |
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. |
allow |
Ha igaz, engedélyezze az Azure-szolgáltatások számára a célszolgáltatás elérését. |
Auth |
A hitelesítési típus. |
Azure |
Az erőforrás tulajdonságai, ha a típus az Azure Key Vault |
Azure |
Az Azure-erőforrás adatai, ha a célszolgáltatás típusa az AzureResource |
client |
Az alkalmazásügyfél típusa |
Configuration |
A konfigurációk létrehozásához vagy alkalmazásokba való mentéshez használt konfigurációs információk |
Confluent |
A szolgáltatás tulajdonságai, ha a célszolgáltatás típusa ConfluentBootstrapServer |
Confluent |
A szolgáltatás tulajdonságai, ha a célszolgáltatás típusa ConfluentSchemaRegistry |
created |
Az erőforrást létrehozó identitás típusa. |
Dapr |
A dapr összetevő metaadatai. |
Dapr |
További tulajdonságokat jelez a dapr-ügyféltípushoz |
Delete |
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 |
Error |
Az erőforrás-kezelési hiba további információi. |
Error |
A hiba részletei. |
Error |
Hibaválasz |
Firewall |
A célszolgáltatás tűzfalszabályai. a forrásszolgáltatásból származó kapcsolatok engedélyezéséhez. |
Key |
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. |
Key |
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. |
Linker |
Forrás- és célerőforrás csatolása |
Public |
Nyilvános hálózati megoldást jelez, tűzfalszabályokat is tartalmaz |
Secret |
A hitelesítési adatok, ha az authType titkos |
Secret |
A titkos kód értékének biztonságos helyen való tárolásának lehetősége |
Secret |
A titkos kód típusa. |
Self |
A szolgáltatás tulajdonságai, ha a célszolgáltatás típusa SelfHostedServer |
Service |
A hitelesítési adatok, amikor az authType servicePrincipal tanúsítvány |
Service |
A hitelesítési adatok, ha az authType servicePrincipal titkos kód |
System |
A hitelesítési adatok, ha az authType systemAssignedIdentity |
system |
Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok. |
User |
A hitelesítési adatok, ha az authType felhasználói fiók |
User |
A hitelesítési adatok, amikor az authType userAssignedIdentity |
Value |
A titkos információ, ha a típus rawValue. Olyan forgatókönyvek esetében, amelyekben a felhasználó beírja a titkos kulcsot. |
VNet |
A linker virtuális hálózati megoldása |
v |
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:
access |
A hitelesítési típus. |
permissions |
Az accessKey engedélyei.
|
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:
Key |
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: |
Az Azure-erőforrás-kapcsolattal kapcsolatos tulajdonságok. |
type | string: |
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 |
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 |
További tulajdonságokat jelez a dapr-ügyféltípushoz |
|
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: |
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: |
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 |
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 |
A hiba további információi. |
|
code |
string |
A hibakód. |
details |
A hiba részletei. |
|
message |
string |
A hibaüzenet. |
target |
string |
A hibacél. |
ErrorResponse
Hibaválasz
Name | Típus | Description |
---|---|---|
error |
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 |
Ha igaz, engedélyezze az Azure-szolgáltatások számára a célszolgáltatás elérését. |
|
callerClientIP |
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:
key |
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:
key |
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 |
Az alkalmazásügyfél típusa |
|
properties.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 |
A hálózati megoldás. |
|
properties.scope |
string |
kapcsolat hatóköre a forrásszolgáltatásban. |
properties.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 |
A VNet-megoldás. |
|
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 |
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 |
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 |
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: |
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:
service |
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 |
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:
service |
A hitelesítési típus. |
clientId |
string |
ServicePrincipal-alkalmazás ügyfélazonosítója a servicePrincipal hitelesítéshez. |
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:
system |
A hitelesítési típus. |
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 |
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 |
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:
user |
A hitelesítési típus. |
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:
user |
A hitelesítési típus. |
clientId |
string |
A userAssignedIdentity ügyfélazonosítója. |
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:
raw |
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 |
Azt jelzi, hogy a Linker frissítésekor vagy törlésekor törli-e az előző műveletet |
|
type |
A VNet-megoldás típusa. |
vNetSolutionType
A VNet-megoldás típusa.
Érték | Description |
---|---|
privateLink | |
serviceEndpoint |