Shared Private Link Resources - Create Or Update

Serviço:: Search Management

Versão da API:: 2025-05-01

Inicia a criação ou atualização de um recurso de link privado compartilhado gerenciado pelo serviço de pesquisa no grupo de recursos determinado.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos dentro da assinatura atual. Você pode obter esse valor da API do Azure Resource Manager ou do portal.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	O nome do serviço Azure AI Search associado ao grupo de recursos especificado.
sharedPrivateLinkResourceName	path	True	string	O nome do recurso de link privado compartilhado gerenciado pelo serviço Azure AI Search dentro do grupo de recursos especificado.
subscriptionId	path	True	string	O identificador exclusivo de uma assinatura do Microsoft Azure. Você pode obter esse valor da API do Azure Resource Manager ou do portal.
api-version	query	True	string	A versão da API a ser usada para cada solicitação.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-request-id		string (uuid)	Um valor GUID gerado pelo cliente que identifica essa solicitação. Se especificado, isso será incluído nas informações de resposta como uma forma de rastrear a solicitação.

Corpo do Pedido

Name	Tipo	Description
properties	SharedPrivateLinkResourceProperties	Descreve as propriedades de um recurso de link privado compartilhado gerenciado pelo serviço Azure AI Search.

Respostas

Name	Tipo	Description
200 OK	SharedPrivateLinkResource	Os detalhes do recurso de link privado compartilhado que foi criado ou atualizado.
202 Accepted		A operação de criação ou atualização do recurso de link privado compartilhado foi aceita e será concluída de forma assíncrona.
Other Status Codes	CloudError	HTTP 400 (Solicitação incorreta): O nome do recurso de link privado compartilhado fornecido ou a definição de recurso de link privado compartilhado é inválido; Consulte o código de erro e a mensagem na resposta para obter detalhes. HTTP 404 (Não encontrado): Não foi possível encontrar a assinatura, o grupo de recursos, o serviço de pesquisa ou o recurso de link privado compartilhado. HTTP 409 (Conflito): A assinatura especificada está desabilitada.

Segurança

azure_auth

Especifica um fluxo de concessão implícito, conforme suportado na plataforma Microsoft Identity.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

SharedPrivateLinkResourceCreateOrUpdate

Pedido de amostra

HTTP

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

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

Resposta da amostra

Código de estado:: 202

Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2025-05-01
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2025-05-01

Código de estado:: 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
  }
}

Definições

Name	Description
CloudError	Contém informações sobre um erro de API.
CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.
createdByType	O tipo de identidade que criou o recurso.
SharedPrivateLinkResource	Descreve um recurso de link privado compartilhado gerenciado pelo serviço Azure AI Search.
SharedPrivateLinkResourceProperties	Descreve as propriedades de um recurso de link privado compartilhado existente gerenciado pelo serviço Azure AI Search.
SharedPrivateLinkResourceProvisioningState	O estado de provisionamento do recurso de link privado compartilhado. Os valores válidos são Atualizar, Excluir, Falhar, Ter êxito ou Incompleto.
SharedPrivateLinkResourceStatus	Status do recurso de link privado compartilhado. Os valores válidos são Pendente, Aprovado, Rejeitado ou Desconectado.
systemData	Metadados referentes à criação e última modificação do recurso.

CloudError

Object

Contém informações sobre um erro de API.

Name	Tipo	Description
error	CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.
message	string	Uma breve descrição do erro que sugere o que deu errado (para obter detalhes/informações de depuração, consulte a propriedade 'error.message').

CloudErrorBody

Object

Descreve um erro de API específico com um código de erro e uma mensagem.

Name	Tipo	Description
code	string	Um código de erro que descreve a condição de erro com mais precisão do que um código de status HTTP. Pode ser usado para lidar programaticamente com casos de erro específicos.
details	CloudErrorBody[]	Contém erros aninhados relacionados a esse erro.
message	string	Uma mensagem que descreve o erro em detalhes e fornece informações de depuração.
target	string	O destino do erro específico (por exemplo, o nome da propriedade em erro).

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key