Shared Private Link Resources - Create Or Update

  • Referensi
Service:
Search Management
API Version:
2021-04-01-preview

Memulai pembuatan atau pembaruan sumber daya tautan privat bersama yang dikelola oleh layanan pencarian di grup sumber daya yang diberikan.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}?api-version=2021-04-01-preview

Parameter URI

Name In Required Type Description
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 Azure Cognitive Search yang terkait dengan grup sumber daya yang ditentukan.
sharedPrivateLinkResourceName
 path True
  • string

Nama sumber daya tautan privat bersama yang dikelola oleh layanan Azure Cognitive Search dalam 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 atau portal.
api-version
 query True
  • string

Versi API yang digunakan untuk setiap permintaan.

Header Permintaan

Name Required Type Description
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.

Isi Permintaan

Name Type Description
properties

Menjelaskan properti Sumber Daya Private Link Bersama yang dikelola oleh layanan Azure Cognitive Search.

Respons

Name Type Description
200 OK

Detail sumber daya tautan privat bersama yang dibuat atau diperbarui.
202 Accepted

Operasi pembuatan atau pembaruan sumber daya tautan privat bersama telah diterima dan akan selesai secara asinkron.
Other Status Codes

HTTP 400 (Permintaan Buruk): Nama sumber daya tautan privat bersama yang diberikan atau definisi sumber daya tautan privat bersama tidak valid; Lihat kode kesalahan dan pesan dalam respons untuk detailnya. HTTP 404 (Tidak Ditemukan): Langganan, grup sumber daya, layanan pencarian, atau sumber daya tautan privat bersama tidak dapat ditemukan. HTTP 409 (Konflik): Langganan yang ditentukan dinonaktifkan.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name Description
user_impersonation meniru akun pengguna Anda

Contoh

SharedPrivateLinkResourceCreateOrUpdate

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource?api-version=2021-04-01-preview

{
  "properties": {
    "requestMessage": "please approve",
    "groupId": "blob",
    "privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
    "resourceRegion": null
  }
}

Sample Response

Status code:
202 
Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2021-04-01-preview
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2021-04-01-preview
Status code:
200 
{
  "name": "testResource",
  "type": "Microsoft.Search/searchServices/sharedPrivateLinkResources",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource",
  "properties": {
    "requestMessage": "please approve",
    "groupId": "blob",
    "privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
    "status": "Pending",
    "resourceRegion": null
  }
}

Definisi

CloudError

Berisi informasi tentang kesalahan API.
CloudErrorBody

Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.
SharedPrivateLinkResource

Menjelaskan Sumber Daya Private Link Bersama yang dikelola oleh layanan Azure Cognitive Search.
SharedPrivateLinkResourceProperties

Menjelaskan properti Sumber Daya Private Link Bersama yang sudah ada yang dikelola oleh layanan Azure Cognitive Search.
SharedPrivateLinkResourceProvisioningState

Status penyediaan sumber daya tautan privat bersama. Dapat berupa Memperbarui, Menghapus, Gagal, Berhasil, Tidak Lengkap, atau nilai lain yang belum didokumenkan.
SharedPrivateLinkResourceStatus

Status sumber daya tautan privat bersama. Dapat tertunda, Disetujui, Ditolak, Terputus, atau nilai lain yang belum didokumenkan.

CloudError

Berisi informasi tentang kesalahan API.

Name Type Description
error

Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.
message
  • string

Deskripsi singkat tentang kesalahan yang mengisyaratkan apa yang salah (untuk detail/informasi penelusuran kesalahan merujuk ke properti 'error.message').

CloudErrorBody

Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

Name Type Description
code
  • string

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

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).

SharedPrivateLinkResource

Menjelaskan Sumber Daya Private Link Bersama yang dikelola oleh layanan Azure Cognitive Search.

Name Type Description
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

Menjelaskan properti Sumber Daya Private Link Bersama yang dikelola oleh layanan Azure Cognitive Search.
type
  • string

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

SharedPrivateLinkResourceProperties

Menjelaskan properti Sumber Daya Private Link Bersama yang sudah ada yang dikelola oleh layanan Azure Cognitive Search.

Name Type Description
groupId
  • string

Id grup dari penyedia sumber daya untuk sumber daya tautan privat bersama.
privateLinkResourceId
  • string

Id sumber daya sumber daya untuk sumber daya tautan privat bersama adalah untuk.
provisioningState

Status penyediaan sumber daya tautan privat bersama. Dapat berupa Memperbarui, Menghapus, Gagal, Berhasil, Tidak Lengkap, atau nilai lain yang belum didokumenkan.
requestMessage
  • string

Pesan permintaan untuk meminta persetujuan sumber daya tautan privat bersama.
resourceRegion
  • string

Opsional. Dapat digunakan untuk menentukan lokasi Azure Resource Manager sumber daya tempat tautan privat bersama akan dibuat. Ini hanya diperlukan untuk sumber daya yang konfigurasi DNS-nya regional (seperti Azure Kubernetes Service).
status

Status sumber daya tautan privat bersama. Dapat tertunda, Disetujui, Ditolak, Terputus, atau nilai lain yang belum didokumenkan.

SharedPrivateLinkResourceProvisioningState

Status penyediaan sumber daya tautan privat bersama. Dapat berupa Memperbarui, Menghapus, Gagal, Berhasil, Tidak Lengkap, atau nilai lain yang belum didokumenkan.

Name Type Description
Deleting
  • string

Sumber daya tautan privat bersama sedang dalam proses dihapus.
Failed
  • string

Sumber daya tautan privat bersama gagal disediakan atau dihapus.
Incomplete
  • string

Permintaan provisi untuk sumber daya tautan privat bersama telah diterima tetapi proses pembuatan belum dimulai.
Succeeded
  • string

Sumber daya tautan privat bersama telah selesai menyediakan dan siap untuk disetujui.
Updating
  • string

Sumber daya tautan privat bersama sedang dalam proses dibuat bersama dengan sumber daya lain agar berfungsi penuh.

SharedPrivateLinkResourceStatus

Status sumber daya tautan privat bersama. Dapat tertunda, Disetujui, Ditolak, Terputus, atau nilai lain yang belum didokumenkan.

Name Type Description
Approved
  • string

Sumber daya tautan privat bersama disetujui dan siap digunakan.
Disconnected
  • string

Sumber daya tautan privat bersama telah dihapus dari layanan.
Pending
  • string

Sumber daya tautan privat bersama telah dibuat dan menunggu persetujuan.
Rejected
  • string

Sumber daya tautan privat bersama telah ditolak dan tidak dapat digunakan.