다음을 통해 공유

Private Link Resources - List Supported

  • 참조
서비스:
Search Management
API 버전:
2023-11-01

지정된 서비스에 대해 지원되는 모든 프라이빗 링크 리소스 유형의 목록을 가져옵니다.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateLinkResources?api-version=2023-11-01

URI 매개 변수

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

string

현재 구독 내의 리소스 그룹 이름입니다. Azure 리소스 관리자 API 또는 포털에서 이 값을 가져올 수 있습니다.
searchServiceName
 path True

string

지정된 리소스 그룹과 연결된 검색 서비스의 이름입니다.
subscriptionId
 path True

string

Microsoft Azure 구독의 고유 식별자입니다. Azure Resource Manager API, 명령줄 도구 또는 포털에서 이 값을 가져올 수 있습니다.
api-version
 query True

string

각 요청에 사용할 API 버전입니다.

요청 헤더

Name 필수 형식 Description
x-ms-client-request-id

string

uuid

이 요청을 식별하는 클라이언트에서 생성한 GUID 값입니다. 지정된 경우 요청을 추적하는 방법으로 응답 정보에 포함됩니다.

응답

Name 형식 Description
200 OK

PrivateLinkResourcesResult

작업에 성공했습니다. 응답에는 지정된 서비스에 대해 지원되는 모든 프라이빗 링크 리소스 유형의 목록이 포함됩니다.
Other Status Codes

CloudError

작업 중 예기치 않은 오류가 발생했습니다.

보안

azure_auth

OAuth2 권한 부여 흐름을 Microsoft Entra ID.

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

범위

Name Description
user_impersonation 사용자 계정 가장

예제

ListSupportedPrivateLinkResources

샘플 요청

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateLinkResources?api-version=2023-11-01

샘플 응답

상태 코드:
200 
{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateLinkResources/searchService",
      "name": "searchService",
      "type": "Microsoft.Search/searchServices/privateLinkResources",
      "properties": {
        "groupId": "searchService",
        "requiredMembers": [
          "searchService"
        ],
        "requiredZoneNames": [
          "privatelink.search.windows.net"
        ],
        "shareablePrivateLinkResourceTypes": [
          {
            "name": "blob",
            "properties": {
              "type": "Microsoft.Storage/storageAccounts",
              "groupId": "blob",
              "description": "Azure Cognitive Search indexers can connect to blobs in Azure Storage for reading data (data source), for writing intermediate results of indexer execution (annotation cache, preview) or for storing any knowledge store projections (preview)"
            }
          },
          {
            "name": "table",
            "properties": {
              "type": "Microsoft.Storage/storageAccounts",
              "groupId": "table",
              "description": "Azure Cognitive Search indexers can connect to tables in Azure Storage for reading data (data source), for writing book-keeping information about intermediate results of indexer execution (annotation cache, preview) or for storing any knowledge store projections (preview)"
            }
          },
          {
            "name": "Sql",
            "properties": {
              "type": "Microsoft.DocumentDB/databaseAccounts",
              "groupId": "Sql",
              "description": "Azure Cognitive Search indexers can connect to CosmosDB using the SQL head for reading data (data source)."
            }
          },
          {
            "name": "plr",
            "properties": {
              "type": "Microsoft.Sql/servers",
              "groupId": "sqlServer",
              "description": "Azure Cognitive Search indexers can connect to AzureSQL databases in a SQL server for reading data (data source)."
            }
          },
          {
            "name": "vault",
            "properties": {
              "type": "Microsoft.KeyVault/vaults",
              "groupId": "vault",
              "description": "Azure Cognitive Search can access keys in Azure Key Vault to encrypt search index and synonym map data"
            }
          },
          {
            "name": "plr",
            "properties": {
              "type": "Microsoft.DBforMySQL/servers",
              "groupId": "mysqlServer",
              "description": "Azure Cognitive Search indexers can connect to MySQL databases for reading data (data source, preview)."
            }
          },
          {
            "name": "site",
            "properties": {
              "type": "Microsoft.Web/sites",
              "groupId": "sites",
              "description": "Azure Cognitive Search indexers can connect to App Services when executing custom web api skills that can be present in a skillset (optional) attached to the indexer."
            }
          }
        ]
      }
    }
  ]
}

정의

Name Description
CloudError

API 오류에 대한 정보를 포함합니다.
CloudErrorBody

오류 코드와 메시지가 있는 특정 API 오류에 대해 설명합니다.
PrivateLinkResource

검색 서비스에 대해 지원되는 프라이빗 링크 리소스에 대해 설명합니다.
PrivateLinkResourceProperties

검색 서비스에 대해 지원되는 프라이빗 링크 리소스의 속성에 대해 설명합니다. 지정된 API 버전의 경우 공유 프라이빗 링크 리소스를 만들 때 '지원되는' groupId를 나타냅니다.
PrivateLinkResourcesResult

지원되는 Private Link 리소스 목록을 포함하는 응답입니다.
ShareablePrivateLinkResourceProperties

프라이빗 링크 서비스에 온보딩되고 검색에서 지원되는 리소스 유형의 속성에 대해 설명합니다.
ShareablePrivateLinkResourceType

프라이빗 링크 서비스에 온보딩되었으며 검색에서 지원되는 리소스 종류에 대해 설명합니다.

CloudError

API 오류에 대한 정보를 포함합니다.

Name 형식 Description
error

CloudErrorBody

오류 코드와 메시지가 있는 특정 API 오류에 대해 설명합니다.

CloudErrorBody

오류 코드와 메시지가 있는 특정 API 오류에 대해 설명합니다.

Name 형식 Description
code

string

HTTP 상태 코드보다 더 정확하게 오류 조건을 설명하는 오류 코드입니다. 프로그래밍 방식으로 특정 오류 사례를 처리하는 데 사용할 수 있습니다.
details

CloudErrorBody[]

이 오류와 관련된 중첩된 오류를 포함합니다.
message

string

오류를 자세히 설명하고 디버깅 정보를 제공하는 메시지입니다.
target

string

특정 오류의 대상(예: 오류에 있는 속성의 이름)입니다.

PrivateLinkResource

검색 서비스에 대해 지원되는 프라이빗 링크 리소스에 대해 설명합니다.

Name 형식 Description
id

string

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

string

리소스의 이름입니다.
properties

PrivateLinkResourceProperties

검색 서비스에 대해 지원되는 프라이빗 링크 리소스의 속성에 대해 설명합니다.
type

string

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

PrivateLinkResourceProperties

검색 서비스에 대해 지원되는 프라이빗 링크 리소스의 속성에 대해 설명합니다. 지정된 API 버전의 경우 공유 프라이빗 링크 리소스를 만들 때 '지원되는' groupId를 나타냅니다.

Name 형식 Description
groupId

string

프라이빗 링크 리소스의 그룹 ID입니다.
requiredMembers

string[]

프라이빗 링크 리소스의 필수 멤버 목록입니다.
requiredZoneNames

string[]

프라이빗 링크 리소스의 필수 DNS 영역 이름 목록입니다.
shareablePrivateLinkResourceTypes

ShareablePrivateLinkResourceType[]

프라이빗 링크 서비스에 온보딩되고 검색에서 지원되는 리소스 목록입니다.

PrivateLinkResourcesResult

지원되는 Private Link 리소스 목록을 포함하는 응답입니다.

Name 형식 Description
value

PrivateLinkResource[]

지원되는 Private Link 리소스 목록입니다.

ShareablePrivateLinkResourceProperties

프라이빗 링크 서비스에 온보딩되고 검색에서 지원되는 리소스 유형의 속성에 대해 설명합니다.

Name 형식 Description
description

string

프라이빗 링크 서비스에 온보딩되었으며 검색에서 지원되는 리소스 종류에 대한 설명입니다.
groupId

string

프라이빗 링크 서비스에 온보딩되고 검색에서 지원되는 리소스에 대한 리소스 공급자 그룹 ID입니다.
type

string

프라이빗 링크 서비스에 온보딩되었으며 검색에서 지원되는 리소스에 대한 리소스 공급자 유형입니다.

ShareablePrivateLinkResourceType

프라이빗 링크 서비스에 온보딩되었으며 검색에서 지원되는 리소스 종류에 대해 설명합니다.

Name 형식 Description
name

string

프라이빗 링크 서비스에 온보딩되었으며 검색에서 지원되는 리소스 유형의 이름입니다.
properties

ShareablePrivateLinkResourceProperties

프라이빗 링크 서비스에 온보딩되고 검색에서 지원되는 리소스 유형의 속성에 대해 설명합니다.