Compartilhar via


Shared Private Link Resources - Create Or Update

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

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
resourceGroupName
path True

string

O nome do grupo de recursos dentro da assinatura atual. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.

searchServiceName
path True

string

O nome do serviço Pesquisa de IA do Azure associado ao grupo de recursos especificado.

Padrão Regex: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$

sharedPrivateLinkResourceName
path True

string

O nome do recurso de link privado compartilhado gerenciado pelo serviço Pesquisa de IA do Azure dentro do grupo de recursos especificado.

subscriptionId
path True

string

O identificador exclusivo de uma assinatura do Microsoft Azure. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.

api-version
query True

string

A versão da API a ser usada para cada solicitação.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
x-ms-client-request-id

string

uuid

Um valor de GUID gerado pelo cliente que identifica esta solicitação. Se especificado, isso será incluído nas informações de resposta como uma maneira de acompanhar a solicitação.

Corpo da solicitação

Nome Tipo Description
properties

SharedPrivateLinkResourceProperties

Descreve as propriedades de um recurso de link privado compartilhado gerenciado pelo serviço Pesquisa de IA do Azure.

Respostas

Nome 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 do Microsoft Identity.

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

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

SharedPrivateLinkResourceCreateOrUpdate

Solicitação de exemplo

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

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

Resposta de exemplo

Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2024-03-01-preview
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2024-03-01-preview
{
  "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

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

SharedPrivateLinkResource

Descreve um recurso de link privado compartilhado gerenciado pelo serviço Pesquisa de IA do Azure.

SharedPrivateLinkResourceProperties

Descreve as propriedades de um recurso de link privado compartilhado existente gerenciado pelo serviço Pesquisa de IA do Azure.

SharedPrivateLinkResourceProvisioningState

O estado de provisionamento do recurso de link privado compartilhado. Os valores válidos são Atualização, Exclusão, Falha, Êxito ou Incompleto.

SharedPrivateLinkResourceStatus

Status do recurso de link privado compartilhado. Os valores válidos são Pendente, Aprovado, Rejeitado ou Desconectado.

CloudError

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

Nome 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 indica o que deu errado (para obter detalhes/informações de depuração, consulte a propriedade 'error.message').

CloudErrorBody

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

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

SharedPrivateLinkResource

Descreve um recurso de link privado compartilhado gerenciado pelo serviço Pesquisa de IA do Azure.

Nome Tipo Description
id

string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

O nome do recurso

properties

SharedPrivateLinkResourceProperties

Descreve as propriedades de um recurso de link privado compartilhado gerenciado pelo serviço Pesquisa de IA do Azure.

type

string

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Descreve as propriedades de um recurso de link privado compartilhado existente gerenciado pelo serviço Pesquisa de IA do Azure.

Nome Tipo Description
groupId

string

A ID do grupo do provedor de recursos para o qual o recurso de link privado compartilhado se destina.

privateLinkResourceId

string

A ID do recurso para o qual o recurso de link privado compartilhado se destina.

provisioningState

SharedPrivateLinkResourceProvisioningState

O estado de provisionamento do recurso de link privado compartilhado. Os valores válidos são Atualização, Exclusão, Falha, Êxito ou Incompleto.

requestMessage

string

A mensagem para solicitar a aprovação do recurso de link privado compartilhado.

resourceRegion

string

Opcional. Pode ser usado para especificar o local Resource Manager do Azure do recurso para o qual um link privado compartilhado está sendo criado. Isso só é necessário para os recursos cuja configuração de DNS é regional (como Serviço de Kubernetes do Azure).

status

SharedPrivateLinkResourceStatus

Status do recurso de link privado compartilhado. Os valores válidos são Pendente, Aprovado, Rejeitado ou Desconectado.

SharedPrivateLinkResourceProvisioningState

O estado de provisionamento do recurso de link privado compartilhado. Os valores válidos são Atualização, Exclusão, Falha, Êxito ou Incompleto.

Nome Tipo Description
Deleting

string

O recurso de link privado compartilhado está em processo de exclusão.

Failed

string

O recurso de link privado compartilhado não foi provisionado ou excluído.

Incomplete

string

A solicitação de provisionamento para o recurso de link privado compartilhado foi aceita, mas o processo de criação ainda não começou.

Succeeded

string

O recurso de link privado compartilhado concluiu o provisionamento e está pronto para aprovação.

Updating

string

O recurso de link privado compartilhado está em processo de criação junto com outros recursos para que ele seja totalmente funcional.

SharedPrivateLinkResourceStatus

Status do recurso de link privado compartilhado. Os valores válidos são Pendente, Aprovado, Rejeitado ou Desconectado.

Nome Tipo Description
Approved

string

O recurso de link privado compartilhado é aprovado e está pronto para uso.

Disconnected

string

O recurso de link privado compartilhado foi removido do serviço.

Pending

string

O recurso de link privado compartilhado foi criado e está com aprovação pendente.

Rejected

string

O recurso de link privado compartilhado foi rejeitado e não pode ser usado.