Aracılığıyla paylaş


Linker - Create Or Update

Bağlayıcı kaynağını oluşturun veya güncelleştirin.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
linkerName
path True

string

Bağlayıcı kaynağı adı.

resourceUri
path True

string

Bağlanacak kaynağın tam Azure Resource Manager tanımlayıcısı.

api-version
query True

string

Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name Tür Description
properties.authInfo AuthInfoBase:

Kimlik doğrulama türü.

properties.clientType

clientType

Uygulama istemci türü

properties.configurationInfo

ConfigurationInfo

Gizli diziler, bağlantı dizeleri dahil olmak üzere uygulamalar tarafından kullanılan bağlantı bilgileri.

properties.publicNetworkSolution

PublicNetworkSolution

Ağ çözümü.

properties.scope

string

kaynak hizmette bağlantı kapsamı.

properties.secretStore

SecretStore

Gizli dizi değerini güvenli bir yerde depolama seçeneği

properties.targetService TargetServiceBase:

Hedef hizmet özellikleri

properties.vNetSolution

VNetSolution

Sanal ağ çözümü.

Yanıtlar

Name Tür Description
200 OK

LinkerResource

Başarılı.

201 Created

LinkerResource

Uzun süre çalışan işlem.

Other Status Codes

ErrorResponse

İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name Description
user_impersonation kullanıcı hesabınızın kimliğine bürünme

Örnekler

PutLinker

Örnek isteği

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

{
  "properties": {
    "targetService": {
      "type": "AzureResource",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db"
    },
    "vNetSolution": {
      "type": "serviceEndpoint"
    },
    "authInfo": {
      "authType": "secret",
      "name": "name",
      "secretInfo": {
        "secretType": "rawValue",
        "value": "secret"
      }
    }
  }
}

Örnek yanıt

{
  "type": "Microsoft.ServiceLinker/links",
  "name": "linkName",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName",
  "properties": {
    "authInfo": {
      "authType": "secret",
      "name": "name"
    },
    "vNetSolution": {
      "type": "serviceEndpoint"
    },
    "targetService": {
      "type": "AzureResource",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db"
    }
  }
}
{
  "type": "Microsoft.ServiceLinker/links",
  "name": "linkName",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName",
  "properties": {
    "authInfo": {
      "authType": "secret",
      "name": "name"
    },
    "vNetSolution": {
      "type": "serviceEndpoint"
    },
    "targetService": {
      "type": "AzureResource",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db"
    }
  }
}

Tanımlar

Name Description
AccessKeyInfoBase

Erişim anahtarı doğrudan hedef kaynak özelliklerindendir ve hedef hizmet Microsoft.Storage gibi Azure Kaynağı'dır

accessKeyPermissions

accessKey izinleri. ReadAzure Write Cosmos DB ve Azure Uygulama Yapılandırması ve ListenSendManage Azure Event Hub ile Azure Service Bus içindir.

actionType

İsteğe bağlı. Genel ağ çözümünü gösterir. Etkinleştirilirse, en iyi denemeyle hedef hizmetin genel ağ erişimini etkinleştirin. Varsayılan, etkindir. OptOut ise genel ağ erişim yapılandırmasını devre dışı bırak.

allowType

Doğruysa Azure hizmetlerinin hedef hizmete erişmesine izin verin.

AuthType

Kimlik doğrulama türü.

AzureKeyVaultProperties

Tür Azure Key Vault olduğunda kaynak özellikleri

AzureResource

Hedef hizmet türü AzureResource olduğunda Azure kaynak bilgileri

clientType

Uygulama istemci türü

ConfigurationInfo

Yapılandırma oluşturmak veya uygulamalara kaydetmek için kullanılan yapılandırma bilgileri

ConfluentBootstrapServer

Hedef hizmet türü ConfluentBootstrapServer olduğunda hizmet özellikleri

ConfluentSchemaRegistry

Hedef hizmet türü ConfluentSchemaRegistry olduğunda hizmet özellikleri

createdByType

Kaynağı oluşturan kimliğin türü.

DaprMetadata

Dapr bileşeni meta verileri.

DaprProperties

Dapr istemci türü için bazı ek özellikleri gösterir

DeleteOrUpdateBehavior

Kaynak silindiğinde veya güncelleştirildiğinde temizleme işleminin gerçekleştirilip gerçekleştirilmeyeceğini belirten temizleme davranışı

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

ErrorDetail

Hata ayrıntısı.

ErrorResponse

Hata yanıtı

FirewallRules

Hedef hizmetin güvenlik duvarı kuralları. kaynak hizmetten bağlantılara izin vermek için.

KeyVaultSecretReferenceSecretInfo

Tür keyVaultSecretReference olduğunda gizli dizi bilgileri. Bu, kullanıcının keyvault dosyasında depolanan bir gizli dizi sağladığı ve kaynağın Azure Kubernetes olduğu senaryoya yöneliktir. Key Vault'un kaynak kimliği secretStore.keyVaultId ile bağlantılıdır.

KeyVaultSecretUriSecretInfo

Tür keyVaultSecretUri olduğunda gizli dizi bilgileri. Bu, kullanıcının keyvault dosyasında depolanan bir gizli dizi sağladığı ve kaynağın Web Uygulaması, Spring Cloud veya Container App olduğu senaryoya yöneliktir.

LinkerResource

Kaynak ve hedef kaynağın bağlayıcısı

PublicNetworkSolution

Genel ağ çözümünü gösterir, güvenlik duvarı kurallarını dahil edin

SecretAuthInfo

authType gizli olduğunda kimlik doğrulama bilgileri

SecretStore

Gizli dizi değerini güvenli bir yerde depolama seçeneği

SecretType

Gizli dizi türü.

SelfHostedServer

Hedef hizmet türü SelfHostedServer olduğunda hizmet özellikleri

ServicePrincipalCertificateAuthInfo

authType servicePrincipal sertifikası olduğunda kimlik doğrulama bilgileri

ServicePrincipalSecretAuthInfo

authType servicePrincipal gizli dizisi olduğunda kimlik doğrulama bilgileri

SystemAssignedIdentityAuthInfo

authType systemAssignedIdentity olduğunda kimlik doğrulama bilgileri

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

UserAccountAuthInfo

authType kullanıcı hesabı olduğunda kimlik doğrulama bilgileri

UserAssignedIdentityAuthInfo

authType userAssignedIdentity olduğunda kimlik doğrulama bilgileri

ValueSecretInfo

Tür rawValue olduğunda gizli dizi bilgileri. Kullanıcının gizli diziyi giriş yaptığı senaryolar içindir.

VNetSolution

Bağlayıcı için sanal ağ çözümü

vNetSolutionType

Sanal ağ çözümünün türü.

AccessKeyInfoBase

Erişim anahtarı doğrudan hedef kaynak özelliklerindendir ve hedef hizmet Microsoft.Storage gibi Azure Kaynağı'dır

Name Tür Description
authType string:

accessKey

Kimlik doğrulama türü.

permissions

accessKeyPermissions[]

accessKey'in izinleri. ReadAzure Write Cosmos DB ve Azure Uygulama Yapılandırması, ListenSend ve Manage Azure Event Hub ile Azure Service Bus içindir.

accessKeyPermissions

accessKey izinleri. ReadAzure Write Cosmos DB ve Azure Uygulama Yapılandırması ve ListenSendManage Azure Event Hub ile Azure Service Bus içindir.

Name Tür Description
Listen

string

Manage

string

Read

string

Send

string

Write

string

actionType

İsteğe bağlı. Genel ağ çözümünü gösterir. Etkinleştirilirse, en iyi denemeyle hedef hizmetin genel ağ erişimini etkinleştirin. Varsayılan, etkindir. OptOut ise genel ağ erişim yapılandırmasını devre dışı bırak.

Name Tür Description
enable

string

optOut

string

allowType

Doğruysa Azure hizmetlerinin hedef hizmete erişmesine izin verin.

Name Tür Description
false

string

true

string

AuthType

Kimlik doğrulama türü.

Name Tür Description
accessKey

string

secret

string

servicePrincipalCertificate

string

servicePrincipalSecret

string

systemAssignedIdentity

string

userAccount

string

userAssignedIdentity

string

AzureKeyVaultProperties

Tür Azure Key Vault olduğunda kaynak özellikleri

Name Tür Description
connectAsKubernetesCsiDriver

boolean

Kubernetes CSI Sürücüsü üzerinden bağlanıyorsanız true.

type string:

KeyVault

Azure kaynak türü.

AzureResource

Hedef hizmet türü AzureResource olduğunda Azure kaynak bilgileri

Name Tür Description
id

string

Azure kaynağının kimliği.

resourceProperties AzureResourcePropertiesBase:

AzureKeyVaultProperties

Azure kaynak bağlantısıyla ilgili özellikler.

type string:

AzureResource

Hedef hizmet türü.

clientType

Uygulama istemci türü

Name Tür Description
dapr

string

django

string

dotnet

string

go

string

java

string

kafka-springBoot

string

nodejs

string

none

string

php

string

python

string

ruby

string

springBoot

string

ConfigurationInfo

Yapılandırma oluşturmak veya uygulamalara kaydetmek için kullanılan yapılandırma bilgileri

Name Tür Description
action

actionType

İsteğe bağlı olarak, kaynak uygulamaya yapılandırma uygulanıp uygulanmayacağını belirtin. Etkinleştirilirse, yapılandırmalar oluşturun ve kaynak uygulamaya uygulanır. Varsayılan, etkindir. OptOut ise, kaynakta yapılandırma değişikliği yapılmaz.

additionalConfigurations

object

Eklenecek ek yapılandırmaların sözlüğü. Hizmet bir dizi temel yapılandırmayı otomatik olarak oluşturur ve bu özellik daha özelleştirilmiş yapılandırmaları tam olarak doldurmaktır

customizedKeys

object

İsteğe bağlı. Varsayılan anahtar adı ve özelleştirilmiş anahtar adı eşlemesi sözlüğü. Belirtilmezse, yapılandırma oluşturmak için varsayılan anahtar adı kullanılır

daprProperties

DaprProperties

Dapr istemci türü için bazı ek özellikleri gösterir

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Linker güncelleştirirken veya silerken önceki işlemin temizlenip temizlenmeyeceğini gösterir

ConfluentBootstrapServer

Hedef hizmet türü ConfluentBootstrapServer olduğunda hizmet özellikleri

Name Tür Description
endpoint

string

Hizmet uç noktası.

type string:

ConfluentBootstrapServer

Hedef hizmet türü.

ConfluentSchemaRegistry

Hedef hizmet türü ConfluentSchemaRegistry olduğunda hizmet özellikleri

Name Tür Description
endpoint

string

Hizmet uç noktası.

type string:

ConfluentSchemaRegistry

Hedef hizmet türü.

createdByType

Kaynağı oluşturan kimliğin türü.

Name Tür Description
Application

string

Key

string

ManagedIdentity

string

User

string

DaprMetadata

Dapr bileşeni meta verileri.

Name Tür Description
name

string

Meta veri özellik adı.

secretRef

string

Dapr değerini alabildiği gizli dizi adı

value

string

Meta veri özellik değeri.

DaprProperties

Dapr istemci türü için bazı ek özellikleri gösterir

Name Tür Description
componentType

string

Dapr bileşen türü

metadata

DaprMetadata[]

Ek dapr meta verileri

scopes

string[]

Dapr bileşeni kapsamları

secretStoreComponent

string

Gizli dizi alınacak gizli dizi deposunun adı

version

string

Dapr bileşeni sürümü

DeleteOrUpdateBehavior

Kaynak silindiğinde veya güncelleştirildiğinde temizleme işleminin gerçekleştirilip gerçekleştirilmeyeceğini belirten temizleme davranışı

Name Tür Description
Default

string

ForcedCleanup

string

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name Tür Description
info

object

Ek bilgiler.

type

string

Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name Tür Description
additionalInfo

ErrorAdditionalInfo[]

Hata ek bilgileri.

code

string

Hata kodu.

details

ErrorDetail[]

Hata ayrıntıları.

message

string

Hata iletisi.

target

string

Hata hedefi.

ErrorResponse

Hata yanıtı

Name Tür Description
error

ErrorDetail

Hata nesnesi.

FirewallRules

Hedef hizmetin güvenlik duvarı kuralları. kaynak hizmetten bağlantılara izin vermek için.

Name Tür Description
azureServices

allowType

Doğruysa Azure hizmetlerinin hedef hizmete erişmesine izin verin.

callerClientIP

allowType

Doğruysa çağıran istemci IP'sinin hedef hizmete erişmesine izin verin. özelliği, yerel uygulama hedef hizmete bağlanırken kullanılır.

ipRanges

string[]

Bu değer, belirli bir veritabanı hesabı için izin verilen istemci IP'leri listesi olarak eklenecek CIDR formundaki IP adresleri veya IP adresi aralıkları kümesini belirtir.

KeyVaultSecretReferenceSecretInfo

Tür keyVaultSecretReference olduğunda gizli dizi bilgileri. Bu, kullanıcının keyvault dosyasında depolanan bir gizli dizi sağladığı ve kaynağın Azure Kubernetes olduğu senaryoya yöneliktir. Key Vault'un kaynak kimliği secretStore.keyVaultId ile bağlantılıdır.

Name Tür Description
name

string

Key Vault gizli dizisinin adı.

secretType string:

keyVaultSecretReference

Gizli dizi türü.

version

string

Key Vault gizli dizisinin sürümü.

KeyVaultSecretUriSecretInfo

Tür keyVaultSecretUri olduğunda gizli dizi bilgileri. Bu, kullanıcının keyvault dosyasında depolanan bir gizli dizi sağladığı ve kaynağın Web Uygulaması, Spring Cloud veya Container App olduğu senaryoya yöneliktir.

Name Tür Description
secretType string:

keyVaultSecretUri

Gizli dizi türü.

value

string

Keyvault gizli dizisine URI

LinkerResource

Kaynak ve hedef kaynağın bağlayıcısı

Name Tür Description
id

string

Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Kaynağın adı

properties.authInfo AuthInfoBase:

Kimlik doğrulama türü.

properties.clientType

clientType

Uygulama istemci türü

properties.configurationInfo

ConfigurationInfo

Uygulamalar tarafından kullanılan gizli diziler, bağlantı dizeleri gibi bağlantı bilgileri.

properties.provisioningState

string

Sağlama durumu.

properties.publicNetworkSolution

PublicNetworkSolution

Ağ çözümü.

properties.scope

string

bağlantı kapsamı.

properties.secretStore

SecretStore

Gizli dizi değerini güvenli bir yerde depolama seçeneği

properties.targetService TargetServiceBase:

Hedef hizmet özellikleri

properties.vNetSolution

VNetSolution

Sanal ağ çözümü.

systemData

systemData

Sistem verileri.

type

string

Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

PublicNetworkSolution

Genel ağ çözümünü gösterir, güvenlik duvarı kurallarını dahil edin

Name Tür Description
action

actionType

İsteğe bağlı. Genel ağ çözümünü gösterir. Etkinleştirilirse, en iyi deneme ile hedef hizmetin genel ağ erişimini etkinleştirin. Varsayılan, etkindir. optOut ise genel ağ erişim yapılandırmasını devre dışı bırak.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Bağlayıcı güncelleştirirken veya silerken önceki işlemin (güvenlik duvarı kuralları gibi) temizlenip temizlenmeyeceğini gösterir

firewallRules

FirewallRules

Kaynak uygulamanın hedefe bağlanabileceğinden emin olmak için hedef hizmetin güvenlik duvarı kurallarını açıklayın.

SecretAuthInfo

authType gizli olduğunda kimlik doğrulama bilgileri

Name Tür Description
authType string:

secret

Kimlik doğrulama türü.

name

string

Gizli kimlik doğrulaması için kullanıcı adı veya hesap adı.

secretInfo SecretInfoBase:

Gizli dizi kimlik doğrulaması için parola veya anahtar kasası gizli dizisi.

SecretStore

Gizli dizi değerini güvenli bir yerde depolama seçeneği

Name Tür Description
keyVaultId

string

Gizli dizi depolamak için anahtar kasası kimliği

keyVaultSecretName

string

Gizli dizi depolamak için anahtar kasası gizli dizisi adı, yalnızca bir gizli dizi depolanırken geçerlidir

SecretType

Gizli dizi türü.

Name Tür Description
keyVaultSecretReference

string

keyVaultSecretUri

string

rawValue

string

SelfHostedServer

Hedef hizmet türü SelfHostedServer olduğunda hizmet özellikleri

Name Tür Description
endpoint

string

Hizmet uç noktası.

type string:

SelfHostedServer

Hedef hizmet türü.

ServicePrincipalCertificateAuthInfo

authType servicePrincipal sertifikası olduğunda kimlik doğrulama bilgileri

Name Tür Description
authType string:

servicePrincipalCertificate

Kimlik doğrulama türü.

certificate

string

servicePrincipal kimlik doğrulaması için ServicePrincipal sertifikası.

clientId

string

servicePrincipal kimlik doğrulaması için uygulama clientId değeri.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Linker güncelleştirirken veya silerken önceki işlemin temizlenip temizlenmeyeceğini gösterir

principalId

string

servicePrincipal kimlik doğrulaması için asıl kimlik.

roles

string[]

İsteğe bağlı olarak, bu değer atanacak Azure rollerini belirtir. Otomatik olarak

ServicePrincipalSecretAuthInfo

authType servicePrincipal gizli dizisi olduğunda kimlik doğrulama bilgileri

Name Tür Description
authType string:

servicePrincipalSecret

Kimlik doğrulama türü.

clientId

string

servicePrincipal kimlik doğrulaması için ServicePrincipal uygulaması clientId.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Linker güncelleştirirken veya silerken önceki işlemin temizlenip temizlenmeyeceğini gösterir

principalId

string

servicePrincipal kimlik doğrulaması için asıl kimlik.

roles

string[]

İsteğe bağlı olarak, bu değer atanacak Azure rollerini belirtir. Otomatik olarak

secret

string

servicePrincipal kimlik doğrulaması için gizli dizi.

userName

string

AAD'deki bir kullanıcıyla eşlenen veritabanında oluşturulan kullanıcı adı.

SystemAssignedIdentityAuthInfo

authType systemAssignedIdentity olduğunda kimlik doğrulama bilgileri

Name Tür Description
authType string:

systemAssignedIdentity

Kimlik doğrulama türü.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Linker güncelleştirirken veya silerken önceki işlemin temizlenip temizlenmeyeceğini gösterir

roles

string[]

İsteğe bağlı olarak, bu değer atanacak Azure rolünü belirtir

userName

string

AAD'deki bir kullanıcıyla eşlenen veritabanında oluşturulan kullanıcı adı.

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name Tür Description
createdAt

string

Kaynak oluşturma (UTC) zaman damgası.

createdBy

string

Kaynağı oluşturan kimlik.

createdByType

createdByType

Kaynağı oluşturan kimliğin türü.

lastModifiedAt

string

Kaynağın son değişikliğinin zaman damgası (UTC)

lastModifiedBy

string

Kaynağı son değiştiren kimlik.

lastModifiedByType

createdByType

Kaynağı en son değiştiren kimliğin türü.

UserAccountAuthInfo

authType kullanıcı hesabı olduğunda kimlik doğrulama bilgileri

Name Tür Description
authType string:

userAccount

Kimlik doğrulama türü.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Bağlayıcı güncelleştirirken veya silerken önceki işlemin temizlenip temizlenmeyeceğini gösterir

principalId

string

Kullanıcı hesabının Asıl Kimliği.

roles

string[]

İsteğe bağlı olarak, bu değer atanacak Azure rollerini belirtir. Otomatik olarak

userName

string

AAD'deki bir kullanıcıyla eşlenen veritabanında oluşturulan kullanıcı adı.

UserAssignedIdentityAuthInfo

authType userAssignedIdentity olduğunda kimlik doğrulama bilgileri

Name Tür Description
authType string:

userAssignedIdentity

Kimlik doğrulama türü.

clientId

string

userAssignedIdentity için İstemci Kimliği.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Linker güncelleştirirken veya silerken önceki işlemin temizlenip temizlenmeyeceğini gösterir

roles

string[]

İsteğe bağlı olarak, bu değer atanacak Azure rolünü belirtir

subscriptionId

string

userAssignedIdentity için abonelik kimliği.

userName

string

AAD'deki bir kullanıcıyla eşlenen veritabanında oluşturulan kullanıcı adı.

ValueSecretInfo

Tür rawValue olduğunda gizli dizi bilgileri. Kullanıcının gizli diziyi giriş yaptığı senaryolar içindir.

Name Tür Description
secretType string:

rawValue

Gizli dizi türü.

value

string

Gizli dizinin gerçek değeri.

VNetSolution

Bağlayıcı için sanal ağ çözümü

Name Tür Description
deleteOrUpdateBehavior

DeleteOrUpdateBehavior

Linker güncelleştirirken veya silerken önceki işlemin temizlenip temizlenmeyeceğini gösterir

type

vNetSolutionType

Sanal ağ çözümünün türü.

vNetSolutionType

Sanal ağ çözümünün türü.

Name Tür Description
privateLink

string

serviceEndpoint

string