다음을 통해 공유


Linker - Create Or Update

링커 리소스를 만들거나 업데이트합니다.

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
linkerName
path True

string

링커 리소스 이름입니다.

resourceUri
path True

string

연결할 리소스의 정규화된 Azure Resource Manager 식별자입니다.

api-version
query True

string

이 작업에 사용할 API 버전입니다.

요청 본문

Name 형식 Description
properties.authInfo AuthInfoBase:

인증 유형입니다.

properties.clientType

clientType

애플리케이션 클라이언트 유형

properties.configurationInfo

ConfigurationInfo

비밀, 연결 문자열을 포함하여 애플리케이션에서 사용하는 연결 정보입니다.

properties.publicNetworkSolution

PublicNetworkSolution

네트워크 솔루션입니다.

properties.scope

string

원본 서비스의 연결 scope.

properties.secretStore

SecretStore

비밀 값을 안전한 위치에 저장하는 옵션

properties.targetService TargetServiceBase:

대상 서비스 속성

properties.vNetSolution

VNetSolution

VNet 솔루션입니다.

응답

Name 형식 Description
200 OK

LinkerResource

성공적인.

201 Created

LinkerResource

장기 실행 작업.

Other Status Codes

ErrorResponse

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name Description
user_impersonation 사용자 계정 가장

예제

PutLinker

샘플 요청

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

샘플 응답

{
  "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"
    }
  }
}

정의

Name Description
AccessKeyInfoBase

대상 서비스가 Microsoft.Storage와 같은 Azure 리소스인 대상 리소스 속성에서 직접 액세스 키

accessKeyPermissions

accessKey의 권한입니다. ReadWrite 는 Azure Cosmos DB 및 Azure App Configuration ListenSend 용이며 Manage Azure Event Hub 및 Azure Service Bus 위한 것입니다.

actionType

선택 사항입니다. 공용 네트워크 솔루션을 나타냅니다. 사용하도록 설정하면 최상의 시도를 통해 대상 서비스의 공용 네트워크 액세스를 사용하도록 설정합니다. 기본값은 사용입니다. optOut인 경우 공용 네트워크 액세스 구성을 옵트아웃합니다.

allowType

True인 경우 Azure 서비스가 대상 서비스에 액세스하도록 허용합니다.

AuthType

인증 유형입니다.

AzureKeyVaultProperties

형식이 Azure인 경우 리소스 속성은 Key Vault

AzureResource

대상 서비스 유형이 AzureResource인 경우 Azure 리소스 정보

clientType

애플리케이션 클라이언트 유형

ConfigurationInfo

구성을 생성하거나 애플리케이션에 저장하는 데 사용되는 구성 정보

ConfluentBootstrapServer

대상 서비스 유형이 ConfluentBootstrapServer인 경우의 서비스 속성

ConfluentSchemaRegistry

대상 서비스 유형이 ConfluentSchemaRegistry인 경우의 서비스 속성

createdByType

리소스를 만든 ID 유형입니다.

DaprMetadata

dapr 구성 요소 메타데이터입니다.

DaprProperties

dapr 클라이언트 형식에 대한 몇 가지 추가 속성을 나타냅니다.

DeleteOrUpdateBehavior

리소스를 삭제하거나 업데이트할 때 클린 작업을 수행할지 여부를 나타내는 정리 동작

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

ErrorDetail

오류 세부 정보입니다.

ErrorResponse

오류 응답

FirewallRules

대상 서비스의 방화벽 규칙입니다. 원본 서비스에서 연결을 허용합니다.

KeyVaultSecretReferenceSecretInfo

type이 keyVaultSecretReference인 경우의 비밀 정보입니다. 사용자가 사용자의 keyvault에 저장된 비밀을 제공하고 원본이 Azure Kubernetes인 시나리오를 위한 것입니다. Key Vault의 리소스 ID는 secretStore.keyVaultId에 연결됩니다.

KeyVaultSecretUriSecretInfo

type이 keyVaultSecretUri인 경우의 비밀 정보입니다. 사용자가 사용자의 keyvault에 저장된 비밀을 제공하고 원본이 웹앱, Spring Cloud 또는 Container App인 시나리오를 위한 것입니다.

LinkerResource

원본 및 대상 리소스의 링커

PublicNetworkSolution

공용 네트워크 솔루션을 나타내고 방화벽 규칙을 포함합니다.

SecretAuthInfo

authType이 비밀인 경우의 인증 정보

SecretStore

비밀 값을 안전한 위치에 저장하는 옵션

SecretType

비밀 형식입니다.

SelfHostedServer

대상 서비스 유형이 SelfHostedServer인 경우의 서비스 속성

ServicePrincipalCertificateAuthInfo

authType이 servicePrincipal 인증서인 경우의 인증 정보

ServicePrincipalSecretAuthInfo

authType이 servicePrincipal 비밀인 경우의 인증 정보

SystemAssignedIdentityAuthInfo

authType이 systemAssignedIdentity인 경우의 인증 정보

systemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

UserAccountAuthInfo

authType이 사용자 계정인 경우의 인증 정보

UserAssignedIdentityAuthInfo

authType이 userAssignedIdentity인 경우의 인증 정보

ValueSecretInfo

type이 rawValue인 경우 비밀 정보입니다. 사용자가 비밀을 입력하는 시나리오를 위한 것입니다.

VNetSolution

링커용 VNet 솔루션

vNetSolutionType

VNet 솔루션의 유형입니다.

AccessKeyInfoBase

대상 서비스가 Microsoft.Storage와 같은 Azure 리소스인 대상 리소스 속성에서 직접 액세스 키

Name 형식 Description
authType string:

accessKey

인증 유형입니다.

permissions

accessKeyPermissions[]

accessKey의 권한입니다. ReadWrite 는 Azure Cosmos DB 및 Azure App Configuration ListenSend 용이며 Manage Azure Event Hub 및 Azure Service Bus 위한 것입니다.

accessKeyPermissions

accessKey의 권한입니다. ReadWrite 는 Azure Cosmos DB 및 Azure App Configuration ListenSend 용이며 Manage Azure Event Hub 및 Azure Service Bus 위한 것입니다.

Name 형식 Description
Listen

string

Manage

string

Read

string

Send

string

Write

string

actionType

선택 사항입니다. 공용 네트워크 솔루션을 나타냅니다. 사용하도록 설정하면 최상의 시도를 통해 대상 서비스의 공용 네트워크 액세스를 사용하도록 설정합니다. 기본값은 사용입니다. optOut인 경우 공용 네트워크 액세스 구성을 옵트아웃합니다.

Name 형식 Description
enable

string

optOut

string

allowType

True인 경우 Azure 서비스가 대상 서비스에 액세스하도록 허용합니다.

Name 형식 Description
false

string

true

string

AuthType

인증 유형입니다.

Name 형식 Description
accessKey

string

secret

string

servicePrincipalCertificate

string

servicePrincipalSecret

string

systemAssignedIdentity

string

userAccount

string

userAssignedIdentity

string

AzureKeyVaultProperties

형식이 Azure인 경우 리소스 속성은 Key Vault

Name 형식 Description
connectAsKubernetesCsiDriver

boolean

True이면 Kubernetes CSI 드라이버를 통해 연결합니다.

type string:

KeyVault

Azure 리소스 종류입니다.

AzureResource

대상 서비스 유형이 AzureResource인 경우 Azure 리소스 정보

Name 형식 Description
id

string

Azure 리소스의 ID입니다.

resourceProperties AzureResourcePropertiesBase:

AzureKeyVaultProperties

Azure 리소스 연결 관련 속성입니다.

type string:

AzureResource

대상 서비스 유형입니다.

clientType

애플리케이션 클라이언트 유형

Name 형식 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

구성을 생성하거나 애플리케이션에 저장하는 데 사용되는 구성 정보

Name 형식 Description
action

actionType

선택 사항으로, 원본 애플리케이션에 구성을 적용할지 여부를 나타냅니다. 사용하도록 설정되면 구성을 생성하고 원본 애플리케이션에 적용합니다. 기본값은 사용입니다. optOut이면 원본에서 구성이 변경되지 않습니다.

additionalConfigurations

object

추가할 추가 구성의 사전입니다. 서비스는 기본 구성 집합을 자동으로 생성하며 이 속성은 더 많은 사용자 지정 구성을 완전히 채우는 것입니다.

customizedKeys

object

선택 사항입니다. 기본 키 이름 및 사용자 지정된 키 이름 매핑의 사전입니다. 지정하지 않으면 구성 생성에 기본 키 이름이 사용됩니다.

daprProperties

DaprProperties

dapr 클라이언트 형식에 대한 몇 가지 추가 속성을 나타냅니다.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

링커가 업데이트 또는 삭제 중일 때 이전 작업을 클린 여부를 나타냅니다.

ConfluentBootstrapServer

대상 서비스 유형이 ConfluentBootstrapServer인 경우의 서비스 속성

Name 형식 Description
endpoint

string

서비스의 엔드포인트입니다.

type string:

ConfluentBootstrapServer

대상 서비스 유형입니다.

ConfluentSchemaRegistry

대상 서비스 유형이 ConfluentSchemaRegistry인 경우의 서비스 속성

Name 형식 Description
endpoint

string

서비스의 엔드포인트입니다.

type string:

ConfluentSchemaRegistry

대상 서비스 유형입니다.

createdByType

리소스를 만든 ID 유형입니다.

Name 형식 Description
Application

string

Key

string

ManagedIdentity

string

User

string

DaprMetadata

dapr 구성 요소 메타데이터입니다.

Name 형식 Description
name

string

메타데이터 속성 이름입니다.

secretRef

string

dapr이 값을 가져올 수 있는 비밀 이름

value

string

메타데이터 속성 값.

DaprProperties

dapr 클라이언트 형식에 대한 몇 가지 추가 속성을 나타냅니다.

Name 형식 Description
componentType

string

dapr 구성 요소 형식

metadata

DaprMetadata[]

추가 dapr 메타데이터

scopes

string[]

dapr 구성 요소 범위

secretStoreComponent

string

비밀을 검색할 비밀 저장소 dapr의 이름

version

string

dapr 구성 요소 버전

DeleteOrUpdateBehavior

리소스를 삭제하거나 업데이트할 때 클린 작업을 수행할지 여부를 나타내는 정리 동작

Name 형식 Description
Default

string

ForcedCleanup

string

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name 형식 Description
info

object

추가 정보입니다.

type

string

추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

Name 형식 Description
additionalInfo

ErrorAdditionalInfo[]

오류 추가 정보입니다.

code

string

오류 코드입니다.

details

ErrorDetail[]

오류 세부 정보입니다.

message

string

오류 메시지입니다.

target

string

오류 대상입니다.

ErrorResponse

오류 응답

Name 형식 Description
error

ErrorDetail

Error 개체.

FirewallRules

대상 서비스의 방화벽 규칙입니다. 원본 서비스에서 연결을 허용합니다.

Name 형식 Description
azureServices

allowType

True인 경우 Azure 서비스가 대상 서비스에 액세스하도록 허용합니다.

callerClientIP

allowType

호출자 클라이언트 IP가 true인 경우 대상 서비스에 액세스하도록 허용합니다. 속성은 대상 서비스에 로컬 애플리케이션을 연결할 때 사용됩니다.

ipRanges

string[]

이 값은 지정된 데이터베이스 계정에 대해 허용된 클라이언트 IP 목록으로 포함할 CIDR 양식의 IP 주소 또는 IP 주소 범위 집합을 지정합니다.

KeyVaultSecretReferenceSecretInfo

type이 keyVaultSecretReference인 경우의 비밀 정보입니다. 사용자가 사용자의 keyvault에 저장된 비밀을 제공하고 원본이 Azure Kubernetes인 시나리오를 위한 것입니다. Key Vault의 리소스 ID는 secretStore.keyVaultId에 연결됩니다.

Name 형식 Description
name

string

Key Vault 비밀의 이름입니다.

secretType string:

keyVaultSecretReference

비밀 형식입니다.

version

string

Key Vault 비밀의 버전입니다.

KeyVaultSecretUriSecretInfo

type이 keyVaultSecretUri인 경우의 비밀 정보입니다. 사용자가 사용자의 keyvault에 저장된 비밀을 제공하고 원본이 웹앱, Spring Cloud 또는 Container App인 시나리오를 위한 것입니다.

Name 형식 Description
secretType string:

keyVaultSecretUri

비밀 형식입니다.

value

string

keyvault 비밀에 대한 URI

LinkerResource

원본 및 대상 리소스의 링커

Name 형식 Description
id

string

리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

리소스의 이름입니다.

properties.authInfo AuthInfoBase:

인증 유형입니다.

properties.clientType

clientType

애플리케이션 클라이언트 유형

properties.configurationInfo

ConfigurationInfo

비밀, 연결 문자열을 포함하여 애플리케이션에서 사용하는 연결 정보입니다.

properties.provisioningState

string

프로비저닝 상태입니다.

properties.publicNetworkSolution

PublicNetworkSolution

네트워크 솔루션입니다.

properties.scope

string

원본 서비스의 연결 scope.

properties.secretStore

SecretStore

비밀 값을 안전한 위치에 저장하는 옵션

properties.targetService TargetServiceBase:

대상 서비스 속성

properties.vNetSolution

VNetSolution

VNet 솔루션입니다.

systemData

systemData

시스템 데이터입니다.

type

string

리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

PublicNetworkSolution

공용 네트워크 솔루션을 나타내고 방화벽 규칙을 포함합니다.

Name 형식 Description
action

actionType

선택 사항입니다. 공용 네트워크 솔루션을 나타냅니다. 사용하도록 설정하면 최상의 시도를 통해 대상 서비스의 공용 네트워크 액세스를 사용하도록 설정합니다. 기본값은 사용입니다. optOut인 경우 공용 네트워크 액세스 구성을 옵트아웃합니다.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

링커가 업데이트하거나 삭제할 때 이전 작업(예: 방화벽 규칙)을 클린 여부를 나타냅니다.

firewallRules

FirewallRules

원본 애플리케이션이 대상에 연결할 수 있도록 대상 서비스의 방화벽 규칙을 설명합니다.

SecretAuthInfo

authType이 비밀인 경우의 인증 정보

Name 형식 Description
authType string:

secret

인증 유형입니다.

name

string

비밀 인증의 사용자 이름 또는 계정 이름입니다.

secretInfo SecretInfoBase:

비밀 인증을 위한 암호 또는 키 자격 증명 모음 비밀입니다.

SecretStore

비밀 값을 안전한 위치에 저장하는 옵션

Name 형식 Description
keyVaultId

string

비밀을 저장할 키 자격 증명 모음 ID

keyVaultSecretName

string

비밀을 저장할 키 자격 증명 모음 비밀 이름이며, 하나의 비밀을 저장할 때만 유효합니다.

SecretType

비밀 형식입니다.

Name 형식 Description
keyVaultSecretReference

string

keyVaultSecretUri

string

rawValue

string

SelfHostedServer

대상 서비스 유형이 SelfHostedServer인 경우의 서비스 속성

Name 형식 Description
endpoint

string

서비스의 엔드포인트입니다.

type string:

SelfHostedServer

대상 서비스 유형입니다.

ServicePrincipalCertificateAuthInfo

authType이 servicePrincipal 인증서인 경우의 인증 정보

Name 형식 Description
authType string:

servicePrincipalCertificate

인증 유형입니다.

certificate

string

servicePrincipal 인증에 대한 ServicePrincipal 인증서입니다.

clientId

string

servicePrincipal 인증에 대한 Application clientId입니다.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

링커가 업데이트 또는 삭제 중일 때 이전 작업을 클린 여부를 나타냅니다.

principalId

string

servicePrincipal 인증의 보안 주체 ID입니다.

roles

string[]

선택 사항인 이 값은 할당할 Azure 역할을 지정합니다. 자동

ServicePrincipalSecretAuthInfo

authType이 servicePrincipal 비밀인 경우의 인증 정보

Name 형식 Description
authType string:

servicePrincipalSecret

인증 유형입니다.

clientId

string

servicePrincipal 인증에 대한 ServicePrincipal 애플리케이션 clientId입니다.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

링커가 업데이트 또는 삭제 중일 때 이전 작업을 클린 여부를 나타냅니다.

principalId

string

servicePrincipal 인증의 보안 주체 ID입니다.

roles

string[]

선택 사항인 이 값은 할당할 Azure 역할을 지정합니다. 자동

secret

string

servicePrincipal 인증에 대한 비밀입니다.

userName

string

AAD의 사용자에 매핑되는 데이터베이스에서 만든 사용자 이름입니다.

SystemAssignedIdentityAuthInfo

authType이 systemAssignedIdentity인 경우의 인증 정보

Name 형식 Description
authType string:

systemAssignedIdentity

인증 유형입니다.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

링커가 업데이트 또는 삭제 중일 때 이전 작업을 클린 여부를 나타냅니다.

roles

string[]

선택 사항인 이 값은 할당할 Azure 역할을 지정합니다.

userName

string

AAD의 사용자에 매핑되는 데이터베이스에서 만든 사용자 이름입니다.

systemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

Name 형식 Description
createdAt

string

UTC(리소스 만들기)의 타임스탬프입니다.

createdBy

string

리소스를 만든 ID입니다.

createdByType

createdByType

리소스를 만든 ID 유형입니다.

lastModifiedAt

string

리소스 마지막 수정의 타임스탬프(UTC)

lastModifiedBy

string

리소스를 마지막으로 수정한 ID입니다.

lastModifiedByType

createdByType

리소스를 마지막으로 수정한 ID 유형입니다.

UserAccountAuthInfo

authType이 사용자 계정인 경우의 인증 정보

Name 형식 Description
authType string:

userAccount

인증 유형입니다.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

링커를 업데이트하거나 삭제할 때 이전 작업을 클린 여부를 나타냅니다.

principalId

string

사용자 계정의 보안 주체 ID입니다.

roles

string[]

선택 사항인 이 값은 할당할 Azure 역할을 지정합니다. 자동

userName

string

AAD의 사용자에 매핑되는 데이터베이스에서 만든 사용자 이름입니다.

UserAssignedIdentityAuthInfo

authType이 userAssignedIdentity인 경우의 인증 정보

Name 형식 Description
authType string:

userAssignedIdentity

인증 유형입니다.

clientId

string

userAssignedIdentity에 대한 클라이언트 ID입니다.

deleteOrUpdateBehavior

DeleteOrUpdateBehavior

링커가 업데이트 또는 삭제 중일 때 이전 작업을 클린 여부를 나타냅니다.

roles

string[]

선택 사항인 이 값은 할당할 Azure 역할을 지정합니다.

subscriptionId

string

userAssignedIdentity에 대한 구독 ID입니다.

userName

string

AAD의 사용자에 매핑되는 데이터베이스에서 만든 사용자 이름입니다.

ValueSecretInfo

type이 rawValue인 경우 비밀 정보입니다. 사용자가 비밀을 입력하는 시나리오를 위한 것입니다.

Name 형식 Description
secretType string:

rawValue

비밀 형식입니다.

value

string

비밀의 실제 값입니다.

VNetSolution

링커용 VNet 솔루션

Name 형식 Description
deleteOrUpdateBehavior

DeleteOrUpdateBehavior

링커가 업데이트 또는 삭제 중일 때 이전 작업을 클린 여부를 나타냅니다.

type

vNetSolutionType

VNet 솔루션의 유형입니다.

vNetSolutionType

VNet 솔루션의 유형입니다.

Name 형식 Description
privateLink

string

serviceEndpoint

string