Shared Private Link Resources - Create Or Update
Initiates the creation or update of a shared private link resource managed by the search service in the given resource group.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}?api-version=2023-11-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. |
search
|
path | True |
string |
The name of the search service associated with the specified resource group. |
shared
|
path | True |
string |
The name of the shared private link resource managed by the search service within the specified resource group. |
subscription
|
path | True |
string |
The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API, command line tools, or the portal. |
api-version
|
query | True |
string |
The API version to use for each request. |
Request Header
Name | Required | Type | Description |
---|---|---|---|
x-ms-client-request-id |
string uuid |
A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request. |
Request Body
Name | Type | Description |
---|---|---|
properties |
Describes the properties of a Shared Private Link Resource managed by the search service. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The details of the shared private link resource that was created or updated. |
|
202 Accepted |
The shared private link resource create or update operation has been accepted and will complete asynchronously. |
|
Other Status Codes |
HTTP 400 (Bad Request): The given shared private link resource name or the shared private link resource definition is invalid; See the error code and message in the response for details. HTTP 404 (Not Found): The subscription, resource group, search service or shared private link resource could not be found. HTTP 409 (Conflict): The specified subscription is disabled. |
Security
azure_auth
Microsoft Entra ID OAuth2 authorization flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
SharedPrivateLinkResourceCreateOrUpdate
Sample request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource?api-version=2023-11-01
{
"properties": {
"requestMessage": "please approve",
"groupId": "blob",
"privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
"resourceRegion": null
}
}
Sample response
Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2023-11-01
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2023-11-01
{
"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
}
}
Definitions
Name | Description |
---|---|
Cloud |
Contains information about an API error. |
Cloud |
Describes a particular API error with an error code and a message. |
Shared |
Describes a Shared Private Link Resource managed by the search service. |
Shared |
Describes the properties of an existing Shared Private Link Resource managed by the search service. |
Shared |
The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. |
Shared |
Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. |
CloudError
Contains information about an API error.
Name | Type | Description |
---|---|---|
error |
Describes a particular API error with an error code and a message. |
CloudErrorBody
Describes a particular API error with an error code and a message.
Name | Type | Description |
---|---|---|
code |
string |
An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. |
details |
Contains nested errors that are related to this error. |
|
message |
string |
A message that describes the error in detail and provides debugging information. |
target |
string |
The target of the particular error (for example, the name of the property in error). |
SharedPrivateLinkResource
Describes a Shared Private Link Resource managed by the search service.
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
The name of the resource |
properties |
Describes the properties of a Shared Private Link Resource managed by the search service. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
SharedPrivateLinkResourceProperties
Describes the properties of an existing Shared Private Link Resource managed by the search service.
Name | Type | Description |
---|---|---|
groupId |
string |
The group id from the provider of resource the shared private link resource is for. |
privateLinkResourceId |
string |
The resource id of the resource the shared private link resource is for. |
provisioningState |
The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. |
|
requestMessage |
string |
The request message for requesting approval of the shared private link resource. |
resourceRegion |
string |
Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service). |
status |
Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. |
SharedPrivateLinkResourceProvisioningState
The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.
Name | Type | Description |
---|---|---|
Deleting |
string |
|
Failed |
string |
|
Incomplete |
string |
|
Succeeded |
string |
|
Updating |
string |
SharedPrivateLinkResourceStatus
Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.
Name | Type | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |