Shared Private Link Resources - List By Service
Obtém uma lista de todos os recursos de link privado compartilhados gerenciados pelo serviço determinado.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources?api-version=2023-11-01
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
resource
|
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. |
search
|
path | True |
string |
O nome do serviço de pesquisa associado ao grupo de recursos especificado. |
subscription
|
path | True |
string |
O identificador exclusivo de uma assinatura do Microsoft Azure. Você pode obter esse valor da API de Resource Manager do Azure, das ferramentas de linha de comando ou 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. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
A operação foi realizada com êxito. A resposta contém a lista de todos os recursos de link privado compartilhados gerenciados pelo serviço determinado. |
|
Other Status Codes |
Erro inesperado durante operação. |
Segurança
azure_auth
Microsoft Entra ID fluxo de autorização OAuth2.
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
ListSharedPrivateLinkResourcesByService
Solicitação de exemplo
Resposta de exemplo
{
"value": [
{
"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 |
---|---|
Cloud |
Contém informações sobre um erro de API. |
Cloud |
Descreve um erro de API específico com um código de erro e uma mensagem. |
Shared |
Descreve um Recurso de Link Privado Compartilhado gerenciado pelo serviço de pesquisa. |
Shared |
Resposta que contém uma lista de Recursos de Link Privado Compartilhados. |
Shared |
Descreve as propriedades de um Recurso de Link Privado Compartilhado existente gerenciado pelo serviço de pesquisa. |
Shared |
O estado de provisionamento do recurso de link privado compartilhado. Os valores válidos são Atualização, Exclusão, Falha, Êxito ou Incompleto. |
Shared |
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 |
Descreve um erro de API específico com um código de erro e uma mensagem. |
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 |
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 de pesquisa.
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 |
Descreve as propriedades de um Recurso de Link Privado Compartilhado gerenciado pelo serviço de pesquisa. |
|
type |
string |
Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
SharedPrivateLinkResourceListResult
Resposta que contém uma lista de Recursos de Link Privado Compartilhados.
Nome | Tipo | Description |
---|---|---|
nextLink |
string |
A URL para obter o próximo conjunto de recursos de link privado compartilhado, se houver algum. |
value |
A lista de Recursos de Link Privado Compartilhados. |
SharedPrivateLinkResourceProperties
Descreve as propriedades de um Recurso de Link Privado Compartilhado existente gerenciado pelo serviço de pesquisa.
Nome | Tipo | Description |
---|---|---|
groupId |
string |
A ID do grupo do provedor de recursos para o qual o recurso de link privado compartilhado é usado. |
privateLinkResourceId |
string |
A ID do recurso para o qual o recurso de link privado compartilhado é usado. |
provisioningState |
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 de solicitação 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 ao qual um link privado compartilhado deve ser criado. Isso só é necessário para os recursos cuja configuração de DNS é regional (como Serviço de Kubernetes do Azure). |
status |
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 |
|
Failed |
string |
|
Incomplete |
string |
|
Succeeded |
string |
|
Updating |
string |
SharedPrivateLinkResourceStatus
Status do recurso de link privado compartilhado. Os valores válidos são Pendente, Aprovado, Rejeitado ou Desconectado.
Nome | Tipo | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |