Linker - List

서비스:: Service Connector

API 버전:: 2022-11-01-preview

리소스에 연결하는 링커 목록을 반환합니다. 리소스 프로비전 중에 애플리케이션 및 대상 서비스를 모두 구성하도록 지원하는 입니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
resourceUri	path	True	string	연결할 리소스의 정규화된 Azure Resource Manager 식별자입니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	ResourceList	링커 세부 정보입니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 흐름.

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

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

LinkerList

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.servicelinker import ServiceLinkerManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-servicelinker
# USAGE
    python linker_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ServiceLinkerManagementClient(
        credential=DefaultAzureCredential(),
    )

    response = client.linker.list(
        resource_uri="subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2022-11-01-preview/examples/LinkerList.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

샘플 응답

상태 코드:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/links/linkName",
      "name": "linkName",
      "type": "Microsoft.ServiceLinker/links",
      "properties": {
        "authInfo": {
          "authType": "secret",
          "name": "username"
        },
        "targetService": {
          "type": "AzureResource",
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
        }
      },
      "systemData": {
        "createdAt": "2020-07-12T22:05:09Z"
      }
    }
  ]
}

정의

Name	Description
AccessKeyInfoBase	대상 서비스가 Microsoft.Storage와 같은 Azure 리소스인 대상 리소스 속성에서 직접 액세스 키
accessKeyPermissions	accessKey의 권한입니다. `Read` 및 `Write` Azure Cosmos DB 및 Azure App Configuration, `Listen`, `Send` 및 `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	keyVaultSecretReference 유형인 경우의 비밀 정보입니다. 사용자가 사용자의 keyvault에 저장된 비밀을 제공하고 원본이 Azure Kubernetes인 시나리오를 위한 것입니다. Key Vault의 리소스 ID는 secretStore.keyVaultId에 연결됩니다.
KeyVaultSecretUriSecretInfo	keyVaultSecretUri 유형인 경우의 비밀 정보입니다. 사용자가 사용자의 키 자격 증명 모음에 저장된 비밀을 제공하고 원본이 웹앱, Spring Cloud 또는 Container App인 시나리오를 위한 것입니다.
LinkerResource	원본 및 대상 리소스의 링커
PublicNetworkSolution	공용 네트워크 솔루션을 나타내고 방화벽 규칙을 포함합니다.
ResourceList	링커 목록입니다.
SecretAuthInfo	authType이 비밀인 경우의 인증 정보
SecretStore	보안 위치에 비밀 값을 저장하는 옵션
SecretType	비밀 형식입니다.
SelfHostedServer	대상 서비스 유형이 SelfHostedServer인 경우의 서비스 속성
ServicePrincipalCertificateAuthInfo	authType이 servicePrincipal 인증서인 경우의 인증 정보
ServicePrincipalSecretAuthInfo	authType이 servicePrincipal 비밀인 경우의 인증 정보
SystemAssignedIdentityAuthInfo	authType이 systemAssignedIdentity인 경우의 인증 정보
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.
UserAccountAuthInfo	authType이 사용자 계정인 경우의 인증 정보
UserAssignedIdentityAuthInfo	authType이 userAssignedIdentity인 경우의 인증 정보
ValueSecretInfo	rawValue 형식인 경우의 비밀 정보입니다. 사용자가 비밀을 입력하는 시나리오를 위한 것입니다.
VNetSolution	링커용 VNet 솔루션
vNetSolutionType	VNet 솔루션의 유형입니다.

AccessKeyInfoBase

Object

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

Name	형식	Description
authType	string: accessKey	인증 유형입니다.
permissions	accessKeyPermissions[]	accessKey의 권한입니다. `Read` 및 `Write` Azure Cosmos DB 및 Azure App Configuration, `Listen`, `Send` 및 `Manage` Azure Event Hub 및 Azure Service Bus용입니다.

accessKeyPermissions

열거형

accessKey의 권한입니다. Read 및 Write Azure Cosmos DB 및 Azure App Configuration, Listen, Send 및 Manage Azure Event Hub 및 Azure Service Bus용입니다.

값	Description
Read
Write
Listen
Send
Manage

actionType

열거형

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

값	Description
enable
optOut

allowType

열거형

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

값	Description
true
false

AuthType

열거형

인증 유형입니다.

값	Description
systemAssignedIdentity
userAssignedIdentity
servicePrincipalSecret
servicePrincipalCertificate
secret
accessKey
userAccount

AzureKeyVaultProperties

Object

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

Name	형식	Description
connectAsKubernetesCsiDriver	boolean	True이면 Kubernetes CSI 드라이버를 통해 연결합니다.
type	string: KeyVault	Azure 리소스 종류입니다.

AzureResource

Object

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

Name	형식	Description
id	string	Azure 리소스의 ID입니다.
resourceProperties	AzureResourcePropertiesBase: AzureKeyVaultProperties	Azure 리소스 연결 관련 속성입니다.
type	string: AzureResource	대상 서비스 유형입니다.

clientType

열거형

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

값	Description
none
dotnet
java
python
go
php
ruby
django
nodejs
springBoot
kafka-springBoot
dapr

ConfigurationInfo

Object

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

Name	형식	Description
action	actionType	선택 사항으로, 원본 애플리케이션에 구성을 적용할지 여부를 나타냅니다. 사용하도록 설정하면 구성을 생성하고 원본 애플리케이션에 적용합니다. 기본값은 사용 설정입니다. optOut인 경우 원본에서 구성이 변경되지 않습니다.
additionalConfigurations	object	추가할 추가 구성의 사전입니다. 서비스는 기본 구성 집합을 자동으로 생성하며 이 속성은 더 많은 사용자 지정 구성을 완전히 채우는 것입니다.
customizedKeys	object	선택 사항. 기본 키 이름 및 사용자 지정된 키 이름 매핑의 사전입니다. 지정하지 않으면 구성 생성에 기본 키 이름이 사용됩니다.
daprProperties	DaprProperties	dapr 클라이언트 형식에 대한 몇 가지 추가 속성을 나타냅니다.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	링커가 업데이트 또는 삭제 중일 때 이전 작업을 정리할지 여부를 나타냅니다.

ConfluentBootstrapServer

Object

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

Name	형식	Description
endpoint	string	서비스의 엔드포인트입니다.
type	string: ConfluentBootstrapServer	대상 서비스 유형입니다.

ConfluentSchemaRegistry

Object

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

Name	형식	Description
endpoint	string	서비스의 엔드포인트입니다.
type	string: ConfluentSchemaRegistry	대상 서비스 유형입니다.

createdByType

열거형

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

값	Description
User
Application
ManagedIdentity
Key

DaprMetadata

Object

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

Name	형식	Description
name	string	메타데이터 속성 이름입니다.
secretRef	string	dapr이 값을 가져올 수 있는 비밀 이름
value	string	메타데이터 속성 값입니다.

DaprProperties

Object

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

Name	형식	Description
componentType	string	dapr 구성 요소 형식
metadata	DaprMetadata[]	추가 dapr 메타데이터
scopes	string[]	dapr 구성 요소 범위
secretStoreComponent	string	비밀을 검색할 비밀 저장소 dapr의 이름
version	string	dapr 구성 요소 버전

DeleteOrUpdateBehavior

열거형

리소스를 삭제하거나 업데이트할 때 정리 작업 여부를 나타내는 정리 동작

값	Description
Default
ForcedCleanup

ErrorAdditionalInfo

Object

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

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

FirewallRules

Object

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

Name	형식	Description
azureServices	allowType	True인 경우 Azure 서비스가 대상 서비스에 액세스하도록 허용합니다.
callerClientIP	allowType	호출자 클라이언트 IP가 true인 경우 대상 서비스에 액세스하도록 허용합니다. 이 속성은 로컬 애플리케이션을 대상 서비스에 연결할 때 사용됩니다.
ipRanges	string[]	이 값은 지정된 데이터베이스 계정에 대해 허용된 클라이언트 IP 목록으로 포함할 CIDR 형식의 IP 주소 또는 IP 주소 범위 집합을 지정합니다.

KeyVaultSecretReferenceSecretInfo

Object

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

Name	형식	Description
name	string	Key Vault 비밀의 이름입니다.
secretType	string: keyVaultSecretReference	비밀 형식입니다.
version	string	Key Vault 비밀의 버전입니다.

KeyVaultSecretUriSecretInfo

Object

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

Name	형식	Description
secretType	string: keyVaultSecretUri	비밀 형식입니다.
value	string	keyvault 비밀에 대한 URI

LinkerResource

Object

원본 및 대상 리소스의 링커

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	리소스의 이름
properties.authInfo	AuthInfoBase: AccessKeyInfoBase SecretAuthInfo ServicePrincipalCertificateAuthInfo ServicePrincipalSecretAuthInfo SystemAssignedIdentityAuthInfo UserAccountAuthInfo UserAssignedIdentityAuthInfo	인증 유형입니다.
properties.clientType	clientType	애플리케이션 클라이언트 유형
properties.configurationInfo	ConfigurationInfo	비밀, 연결 문자열을 포함하여 애플리케이션에서 사용하는 연결 정보입니다.
properties.provisioningState	string	프로비전 상태입니다.
properties.publicNetworkSolution	PublicNetworkSolution	네트워크 솔루션입니다.
properties.scope	string	원본 서비스의 연결 범위입니다.
properties.secretStore	SecretStore	보안 위치에 비밀 값을 저장하는 옵션
properties.targetService	TargetServiceBase: AzureResource ConfluentBootstrapServer ConfluentSchemaRegistry SelfHostedServer	대상 서비스 속성
properties.vNetSolution	VNetSolution	VNet 솔루션입니다.
systemData	systemData	시스템 데이터입니다.
type	string	리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

PublicNetworkSolution

Object

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

Name	형식	Description
action	actionType	선택 사항. 공용 네트워크 솔루션을 나타냅니다. 사용하도록 설정하면 최상의 시도를 통해 대상 서비스의 공용 네트워크 액세스를 사용하도록 설정합니다. 기본값은 사용 설정입니다. optOut인 경우 공용 네트워크 액세스 구성을 옵트아웃합니다.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	링커가 업데이트 또는 삭제 중일 때 이전 작업(예: 방화벽 규칙)을 정리할지 여부를 나타냅니다.
firewallRules	FirewallRules	대상 서비스의 방화벽 규칙을 설명하여 원본 애플리케이션이 대상에 연결할 수 있는지 확인합니다.

ResourceList

Object

링커 목록입니다.

Name	형식	Description
nextLink	string	링커 목록의 다음 페이지를 가져오는 데 사용되는 링커입니다.
value	LinkerResource[]	링커 목록입니다.

SecretAuthInfo

Object

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

Name	형식	Description
authType	string: secret	인증 유형입니다.
name	string	비밀 인증의 사용자 이름 또는 계정 이름입니다.
secretInfo	SecretInfoBase: KeyVaultSecretReferenceSecretInfo KeyVaultSecretUriSecretInfo ValueSecretInfo	비밀 인증에 대한 암호 또는 키 자격 증명 모음 비밀입니다.

SecretStore

Object

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

Name	형식	Description
keyVaultId	string	비밀을 저장할 키 자격 증명 모음 ID
keyVaultSecretName	string	비밀을 저장할 키 자격 증명 모음 비밀 이름입니다. 하나의 비밀을 저장할 때만 유효합니다.

SecretType

열거형

비밀 형식입니다.

값	Description
rawValue
keyVaultSecretUri
keyVaultSecretReference

SelfHostedServer

Object

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

Name	형식	Description
endpoint	string	서비스의 엔드포인트입니다.
type	string: SelfHostedServer	대상 서비스 유형입니다.

ServicePrincipalCertificateAuthInfo

Object

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

Object

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

Name	형식	Description
authType	string: servicePrincipalSecret	인증 유형입니다.
clientId	string	servicePrincipal 인증에 대한 ServicePrincipal application clientId입니다.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	링커가 업데이트 또는 삭제 중일 때 이전 작업을 정리할지 여부를 나타냅니다.
principalId	string	servicePrincipal 인증의 보안 주체 ID입니다.
roles	string[]	선택 사항으로, 이 값은 할당할 Azure 역할을 지정합니다. 자동
secret	string	servicePrincipal 인증에 대한 비밀입니다.
userName	string	AAD의 사용자에 매핑되는 데이터베이스에서 만든 사용자 이름입니다.

SystemAssignedIdentityAuthInfo

Object

authType이 systemAssignedIdentity인 경우의 인증 정보

Name	형식	Description
authType	string: systemAssignedIdentity	인증 유형입니다.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	링커가 업데이트 또는 삭제 중일 때 이전 작업을 정리할지 여부를 나타냅니다.
roles	string[]	선택 사항으로, 이 값은 할당할 Azure 역할을 지정합니다.
userName	string	AAD의 사용자에 매핑되는 데이터베이스에서 만든 사용자 이름입니다.

systemData

Object

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

Name	형식	Description
createdAt	string (date-time)	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string (date-time)	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID의 형식입니다.

UserAccountAuthInfo

Object

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

Name	형식	Description
authType	string: userAccount	인증 유형입니다.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	링커가 업데이트 또는 삭제 중일 때 이전 작업을 정리할지 여부를 나타냅니다.
principalId	string	사용자 계정의 보안 주체 ID입니다.
roles	string[]	선택 사항으로, 이 값은 할당할 Azure 역할을 지정합니다. 자동
userName	string	AAD의 사용자에 매핑되는 데이터베이스에서 만든 사용자 이름입니다.

UserAssignedIdentityAuthInfo

Object

authType이 userAssignedIdentity인 경우의 인증 정보

Name	형식	Description
authType	string: userAssignedIdentity	인증 유형입니다.
clientId	string	userAssignedIdentity의 클라이언트 ID입니다.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	링커가 업데이트 또는 삭제 중일 때 이전 작업을 정리할지 여부를 나타냅니다.
roles	string[]	선택 사항으로, 이 값은 할당할 Azure 역할을 지정합니다.
subscriptionId	string	userAssignedIdentity의 구독 ID입니다.
userName	string	AAD의 사용자에 매핑되는 데이터베이스에서 만든 사용자 이름입니다.

ValueSecretInfo

Object

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

Name	형식	Description
secretType	string: rawValue	비밀 형식입니다.
value	string	비밀의 실제 값입니다.

VNetSolution

Object

링커용 VNet 솔루션

Name	형식	Description
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	링커가 업데이트 또는 삭제 중일 때 이전 작업을 정리할지 여부를 나타냅니다.
type	vNetSolutionType	VNet 솔루션의 유형입니다.

vNetSolutionType

열거형

VNet 솔루션의 유형입니다.

값	Description
serviceEndpoint
privateLink

다음을 통해 공유

Linker - List

URI 매개 변수

응답

보안

azure_auth

범위

예제

LinkerList

샘플 요청

샘플 응답

정의

AccessKeyInfoBase

accessKeyPermissions

actionType

allowType

AuthType

AzureKeyVaultProperties

AzureResource

clientType

ConfigurationInfo

ConfluentBootstrapServer

ConfluentSchemaRegistry

createdByType

DaprMetadata

DaprProperties

DeleteOrUpdateBehavior

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FirewallRules

KeyVaultSecretReferenceSecretInfo

KeyVaultSecretUriSecretInfo

LinkerResource

PublicNetworkSolution

ResourceList

SecretAuthInfo

SecretStore

SecretType

SelfHostedServer

ServicePrincipalCertificateAuthInfo

ServicePrincipalSecretAuthInfo

SystemAssignedIdentityAuthInfo

systemData

UserAccountAuthInfo

UserAssignedIdentityAuthInfo

ValueSecretInfo

VNetSolution

vNetSolutionType