Linker - Create Or Update

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

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

URI 매개 변수

Name In Required Type Description
linkerName
path True
  • string

링커 리소스 이름입니다.

resourceUri
path True
  • string

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

api-version
query True
  • string

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

요청 본문

Name Type Description
properties.authInfo AuthInfoBase:

인증 유형입니다.

properties.clientType

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

properties.secretStore

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

properties.targetId
  • string

대상 서비스의 리소스 ID입니다.

properties.vNetSolution

VNet 솔루션입니다.

응답

Name Type Description
200 OK

성공적인.

201 Created

장기 실행 작업입니다.

Other Status Codes

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

보안

azure_auth

OAuth2 Flow Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 사용자 계정 가장

예제

PutLink
PutLinkWithServiceEndpoint

Sample Request

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=2021-11-01-preview

{
  "properties": {
    "targetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db",
    "authInfo": {
      "authType": "secret",
      "name": "name",
      "secret": "secret"
    }
  }
}

Sample Response

{
  "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",
      "name": "name"
    },
    "targetId": "/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",
      "name": "name"
    },
    "targetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
  }
}

PutLinkWithServiceEndpoint

Sample Request

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=2021-11-01-preview

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

Sample Response

{
  "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",
      "name": "name"
    },
    "vNetSolution": {
      "type": "serviceEndpoint"
    },
    "secretStore": {
      "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv"
    },
    "targetId": "/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",
      "name": "name"
    },
    "vNetSolution": {
      "type": "serviceEndpoint"
    },
    "secretStore": {
      "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv"
    },
    "targetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
  }
}

정의

AuthType

인증 유형입니다.

clientType

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

createdByType

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

ErrorAdditionalInfo

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

ErrorDetail

오류 세부 정보입니다.

ErrorResponse

오류 응답

LinkerResource

원본 및 대상 리소스의 링커

SecretAuthInfo

authType이 비밀인 경우 인증 정보

SecretStore

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

ServicePrincipalCertificateAuthInfo

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

ServicePrincipalSecretAuthInfo

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

SystemAssignedIdentityAuthInfo

authType이 systemAssignedIdentity인 경우의 인증 정보

systemData

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

UserAssignedIdentityAuthInfo

authType이 userAssignedIdentity인 경우의 인증 정보

VNetSolution

링커용 VNet 솔루션

vNetSolutionType

VNet 솔루션의 유형입니다.

AuthType

인증 유형입니다.

Name Type Description
secret
  • string
servicePrincipalCertificate
  • string
servicePrincipalSecret
  • string
systemAssignedIdentity
  • string
userAssignedIdentity
  • string

clientType

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

Name Type Description
django
  • string
dotnet
  • string
go
  • string
java
  • string
nodejs
  • string
none
  • string
php
  • string
python
  • string
ruby
  • string
springBoot
  • string

createdByType

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

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorAdditionalInfo

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

Name Type Description
info
  • object

추가 정보입니다.

type
  • string

추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

Name Type Description
additionalInfo

오류 추가 정보입니다.

code
  • string

오류 코드입니다.

details

오류 세부 정보입니다.

message
  • string

오류 메시지입니다.

target
  • string

오류 대상입니다.

ErrorResponse

오류 응답

Name Type Description
error

오류 개체입니다.

LinkerResource

원본 및 대상 리소스의 링커

Name Type Description
id
  • string

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

name
  • string

리소스의 이름입니다.

properties.authInfo AuthInfoBase:

인증 유형입니다.

properties.clientType

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

properties.provisioningState
  • string

프로비전 상태입니다.

properties.secretStore

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

properties.targetId
  • string

대상 서비스의 리소스 ID입니다.

properties.vNetSolution

VNet 솔루션입니다.

systemData

시스템 데이터입니다.

type
  • string

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

SecretAuthInfo

authType이 비밀인 경우 인증 정보

Name Type Description
authType string:
  • secret

인증 유형입니다.

name
  • string

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

secret
  • string

비밀 인증에 대한 암호 또는 계정 키입니다.

SecretStore

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

Name Type Description
keyVaultId
  • string

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

ServicePrincipalCertificateAuthInfo

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

Name Type Description
authType string:
  • servicePrincipalCertificate

인증 유형입니다.

certificate
  • string

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

clientId
  • string

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

principalId
  • string

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

ServicePrincipalSecretAuthInfo

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

Name Type Description
authType string:
  • servicePrincipalSecret

인증 유형입니다.

clientId
  • string

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

principalId
  • string

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

secret
  • string

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

SystemAssignedIdentityAuthInfo

authType이 systemAssignedIdentity인 경우의 인증 정보

Name Type Description
authType string:
  • systemAssignedIdentity

인증 유형입니다.

systemData

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name Type Description
createdAt
  • string

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

createdBy
  • string

리소스를 만든 ID입니다.

createdByType

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

lastModifiedAt
  • string

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

lastModifiedBy
  • string

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

lastModifiedByType

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

UserAssignedIdentityAuthInfo

authType이 userAssignedIdentity인 경우의 인증 정보

Name Type Description
authType string:
  • userAssignedIdentity

인증 유형입니다.

clientId
  • string

userAssignedIdentity의 클라이언트 ID입니다.

subscriptionId
  • string

userAssignedIdentity에 대한 구독 ID입니다.

VNetSolution

링커용 VNet 솔루션

Name Type Description
type

VNet 솔루션의 유형입니다.

vNetSolutionType

VNet 솔루션의 유형입니다.

Name Type Description
privateLink
  • string
serviceEndpoint
  • string