Bagikan melalui


Private Link Resources - List Supported

Mendapatkan daftar semua jenis sumber daya tautan privat yang didukung untuk layanan tertentu.

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
resourceGroupName
path True

string

Nama grup sumber daya dalam langganan saat ini. Anda dapat memperoleh nilai ini dari Azure Resource Manager API atau portal.

searchServiceName
path True

string

Nama layanan pencarian yang terkait dengan grup sumber daya yang ditentukan.

subscriptionId
path True

string

Pengidentifikasi unik untuk langganan Microsoft Azure. Anda dapat memperoleh nilai ini dari Azure Resource Manager API, alat baris perintah, atau portal.

api-version
query True

string

Versi API yang digunakan untuk setiap permintaan.

Header Permintaan

Nama Diperlukan Jenis Deskripsi
x-ms-client-request-id

string

uuid

Nilai GUID yang dihasilkan klien yang mengidentifikasi permintaan ini. Jika ditentukan, ini akan disertakan dalam informasi respons sebagai cara untuk melacak permintaan.

Respons

Nama Jenis Deskripsi
200 OK

PrivateLinkResourcesResult

Operasi berhasil. Respons berisi daftar semua jenis sumber daya tautan privat yang didukung untuk layanan tertentu.

Other Status Codes

CloudError

Terjadi kesalahan tak terduga selama operasi.

Keamanan

azure_auth

Microsoft Entra ID alur otorisasi OAuth2.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama Deskripsi
user_impersonation meniru akun pengguna Anda

Contoh

ListSupportedPrivateLinkResources

Permintaan sampel

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

Respon sampel

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

Definisi

Nama Deskripsi
CloudError

Berisi informasi tentang kesalahan API.

CloudErrorBody

Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

PrivateLinkResource

Menjelaskan sumber daya tautan privat yang didukung untuk layanan pencarian.

PrivateLinkResourceProperties

Menjelaskan properti sumber daya tautan privat yang didukung untuk layanan pencarian. Untuk versi API tertentu, ini mewakili groupId 'didukung' saat membuat sumber daya tautan privat bersama.

PrivateLinkResourcesResult

Respons yang berisi daftar Sumber Daya Private Link yang didukung.

ShareablePrivateLinkResourceProperties

Menjelaskan properti jenis sumber daya yang telah di-onboard ke layanan tautan privat dan yang didukung oleh pencarian.

ShareablePrivateLinkResourceType

Menjelaskan jenis sumber daya yang telah di-onboard ke layanan tautan privat dan yang didukung oleh pencarian.

CloudError

Berisi informasi tentang kesalahan API.

Nama Jenis Deskripsi
error

CloudErrorBody

Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

CloudErrorBody

Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

Nama Jenis Deskripsi
code

string

Kode kesalahan yang menjelaskan kondisi kesalahan lebih tepat daripada kode status HTTP. Dapat digunakan untuk menangani kasus kesalahan tertentu secara terprogram.

details

CloudErrorBody[]

Berisi kesalahan berlapis yang terkait dengan kesalahan ini.

message

string

Pesan yang menjelaskan kesalahan secara rinci dan menyediakan informasi penelusuran kesalahan.

target

string

Target kesalahan tertentu (misalnya, nama properti dalam kesalahan).

PrivateLinkResource

Menjelaskan sumber daya tautan privat yang didukung untuk layanan pencarian.

Nama Jenis Deskripsi
id

string

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Nama sumber daya.

properties

PrivateLinkResourceProperties

Menjelaskan properti sumber daya tautan privat yang didukung untuk layanan pencarian.

type

string

Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

PrivateLinkResourceProperties

Menjelaskan properti sumber daya tautan privat yang didukung untuk layanan pencarian. Untuk versi API tertentu, ini mewakili groupId 'didukung' saat membuat sumber daya tautan privat bersama.

Nama Jenis Deskripsi
groupId

string

ID grup sumber daya tautan privat.

requiredMembers

string[]

Daftar anggota sumber daya tautan privat yang diperlukan.

requiredZoneNames

string[]

Daftar nama zona DNS yang diperlukan dari sumber daya tautan privat.

shareablePrivateLinkResourceTypes

ShareablePrivateLinkResourceType[]

Daftar sumber daya yang di-onboard ke layanan tautan privat dan yang didukung oleh pencarian.

PrivateLinkResourcesResult

Respons yang berisi daftar Sumber Daya Private Link yang didukung.

Nama Jenis Deskripsi
value

PrivateLinkResource[]

Daftar Sumber Daya Private Link yang didukung.

ShareablePrivateLinkResourceProperties

Menjelaskan properti jenis sumber daya yang telah di-onboard ke layanan tautan privat dan yang didukung oleh pencarian.

Nama Jenis Deskripsi
description

string

Deskripsi jenis sumber daya yang telah di-onboard ke layanan tautan privat dan yang didukung oleh pencarian.

groupId

string

Id grup penyedia sumber daya untuk sumber daya yang telah di-onboard ke layanan tautan privat dan yang didukung oleh pencarian.

type

string

Jenis penyedia sumber daya untuk sumber daya yang telah di-onboard ke layanan tautan privat dan yang didukung oleh pencarian.

ShareablePrivateLinkResourceType

Menjelaskan jenis sumber daya yang telah di-onboard ke layanan tautan privat dan yang didukung oleh pencarian.

Nama Jenis Deskripsi
name

string

Nama jenis sumber daya yang telah di-onboard ke layanan tautan privat dan yang didukung oleh pencarian.

properties

ShareablePrivateLinkResourceProperties

Menjelaskan properti jenis sumber daya yang telah di-onboard ke layanan tautan privat dan yang didukung oleh pencarian.