Partilhar via

Services - Create Or Update

  • Referência
Serviço:
Search Management
Versão da API:
2024-03-01-preview

Cria ou atualiza um serviço de pesquisa em determinado grupo de recursos. Se o serviço de pesquisa já existir, todas as propriedades serão atualizadas com os valores fornecidos.

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

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

O nome do serviço Azure AI Search a ser criado ou atualizado. Os nomes dos serviços de pesquisa devem conter apenas letras minúsculas, dígitos ou traços, não podem usar traço como os dois primeiros ou últimos caracteres, não podem conter traços consecutivos e devem ter entre 2 e 60 caracteres. Os nomes de serviço de pesquisa devem ser globalmente exclusivos, pois fazem parte do URI do serviço (https://.search.windows.net). Não é possível alterar o nome do serviço após a criação do serviço.
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 Necessário Tipo Description
location True

string

A geolocalização onde o recurso vive
identity

Identity

A identidade do recurso.
properties.authOptions

DataPlaneAuthOptions

Define as opções de como a API do plano de dados de um serviço de pesquisa autentica solicitações. Isso não pode ser definido se 'disableLocalAuth' estiver definido como true.
properties.disableLocalAuth

boolean

Quando definido como true, as chamadas para o serviço de pesquisa não terão permissão para utilizar chaves de API para autenticação. Isso não pode ser definido como true se 'dataPlaneAuthOptions' estiver definido.
properties.disabledDataExfiltrationOptions

SearchDisabledDataExfiltrationOption[]

Uma lista de cenários de exfiltração de dados que não são explicitamente permitidos para o serviço de pesquisa. Atualmente, o único valor suportado é 'Todos' para desativar todos os cenários possíveis de exportação de dados com controles mais refinados planejados para o futuro.
properties.encryptionWithCmk

EncryptionWithCmk

Especifica qualquer política relativa à criptografia de recursos (como índices) usando chaves do gerenciador de clientes em um serviço de pesquisa.
properties.hostingMode

HostingMode

Aplicável apenas para o padrão 3 SKU. Você pode definir essa propriedade para habilitar até 3 partições de alta densidade que permitem até 1000 índices, o que é muito maior do que os índices máximos permitidos para qualquer outra SKU. Para o SKU standard3, o valor é 'default' ou 'highDensity'. Para todos os outros SKUs, esse valor deve ser 'padrão'.
properties.networkRuleSet

NetworkRuleSet

Regras específicas de rede que determinam como o serviço Azure AI Search pode ser alcançado.
properties.partitionCount

integer (int32)

minimum: 1
maximum: 12

O número de partições no serviço de pesquisa; se especificado, pode ser 1, 2, 3, 4, 6 ou 12. Valores maiores que 1 só são válidos para SKUs padrão. Para serviços 'standard3' com hostingMode definido como 'highDensity', os valores permitidos estão entre 1 e 3.
properties.publicNetworkAccess

PublicNetworkAccess

Esse valor pode ser definido como 'habilitado' para evitar alterações significativas nos recursos e modelos existentes do cliente. Se definido como 'desativado', o tráfego na interface pública não é permitido, e as conexões de ponto final privado seriam o método de acesso exclusivo.
properties.replicaCount

integer (int32)

minimum: 1
maximum: 12

O número de réplicas no serviço de pesquisa. Se especificado, deve ser um valor entre 1 e 12 inclusive para SKUs padrão ou entre 1 e 3 inclusive para SKU básico.
properties.semanticSearch

SearchSemanticSearch

Define opções que controlam a disponibilidade da pesquisa semântica. Essa configuração só é possível para determinadas SKUs do Azure AI Search em determinados locais.
sku

Sku

O SKU do serviço de pesquisa, que determina a camada de preço e os limites de capacidade. Esta propriedade é necessária ao criar um novo serviço de pesquisa.
tags

object

Tags de recursos.

Respostas

Name Tipo Description
200 OK

SearchService

A definição de serviço existente foi atualizada com êxito. Se você alterou o número de réplicas ou partições, a operação de escala acontecerá de forma assíncrona. Você pode verificar o status de uma operação de escala por meio da propriedade provisioningState de uma solicitação Get Service.
201 Created

SearchService

Se você solicitou a criação de um serviço de pesquisa gratuito, o serviço agora está provisionado e pronto para uso, sujeito a atraso de propagação de DNS. Para outros tipos de SKU, o provisionamento acontece de forma assíncrona. Você pode verificar o status de uma operação de escala por meio da propriedade provisioningState de uma solicitação Get Service.
Other Status Codes

CloudError

HTTP 400 (Solicitação incorreta): O nome de serviço fornecido ou a definição de serviço é inválida. 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 subscrição ou o grupo de recursos. 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

SearchCreateOrUpdateService
SearchCreateOrUpdateServiceAuthOptions
SearchCreateOrUpdateServiceDisableLocalAuth
SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints
SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs
SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass
SearchCreateOrUpdateServiceWithCmkEnforcement
SearchCreateOrUpdateServiceWithDataExfiltration
SearchCreateOrUpdateServiceWithIdentity
SearchCreateOrUpdateWithSemanticSearch

SearchCreateOrUpdateService

Pedido de amostra

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

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default"
  }
}

Resposta da amostra

Código de estado:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}
Código de estado:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceAuthOptions

Pedido de amostra

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

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    }
  }
}

Resposta da amostra

Código de estado:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    },
    "disabledDataExfiltrationOptions": []
  }
}
Código de estado:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceDisableLocalAuth

Pedido de amostra

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

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "disableLocalAuth": true
  }
}

Resposta da amostra

Código de estado:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": true,
    "authOptions": null,
    "disabledDataExfiltrationOptions": []
  }
}
Código de estado:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": true,
    "authOptions": null,
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints

Pedido de amostra

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

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "publicNetworkAccess": "disabled",
    "hostingMode": "default"
  }
}

Resposta da amostra

Código de estado:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "disabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}
Código de estado:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "disabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs

Pedido de amostra

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

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "hostingMode": "default"
  }
}

Resposta da amostra

Código de estado:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}
Código de estado:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

Pedido de amostra

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

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ],
      "bypass": "AzurePortal"
    },
    "hostingMode": "default"
  }
}

Resposta da amostra

Código de estado:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ],
      "bypass": "AzurePortal"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}
Código de estado:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ],
      "bypass": "AzurePortal"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceWithCmkEnforcement

Pedido de amostra

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

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "encryptionWithCmk": {
      "enforcement": "Enabled"
    }
  }
}

Resposta da amostra

Código de estado:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Enabled",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}
Código de estado:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Enabled",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceWithDataExfiltration

Pedido de amostra

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

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "disabledDataExfiltrationOptions": [
      "All"
    ]
  }
}

Resposta da amostra

Código de estado:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [
      "All"
    ]
  }
}
Código de estado:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [
      "All"
    ]
  }
}

SearchCreateOrUpdateServiceWithIdentity

Pedido de amostra

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

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default"
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-mi": {}
    }
  }
}

Resposta da amostra

Código de estado:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "9d1e1f18-2122-4988-a11c-878782e40a5c",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-mi": {
        "clientId": "cd1dcac8-82dd-45b5-9aed-76795d529f6b",
        "principalId": "24e07a75-1286-41e5-a15d-ded85ec3acd7"
      }
    }
  }
}
Código de estado:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "9d1e1f18-2122-4988-a11c-878782e40a5c",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-mi": {
        "clientId": "cd1dcac8-82dd-45b5-9aed-76795d529f6b",
        "principalId": "24e07a75-1286-41e5-a15d-ded85ec3acd7"
      }
    }
  }
}

SearchCreateOrUpdateWithSemanticSearch

Pedido de amostra

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

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "semanticSearch": "free"
  }
}

Resposta da amostra

Código de estado:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "semanticSearch": "free"
  }
}
Código de estado:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "semanticSearch": "free"
  }
}

Definições

Name Description
AadAuthFailureMode

Descreve qual resposta a API do plano de dados de um serviço de pesquisa enviaria para solicitações que falharam na autenticação.
ApiKeyOnly

Indica que apenas a chave da API pode ser usada para autenticação.
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.
DataPlaneAadOrApiKeyAuthOption

Indica que a chave de API ou um token de acesso de um locatário do Microsoft Entra ID pode ser usado para autenticação.
DataPlaneAuthOptions

Define as opções de como o serviço de pesquisa autentica uma solicitação de plano de dados. Isso não pode ser definido se 'disableLocalAuth' estiver definido como true.
EncryptionWithCmk

Descreve uma política que determina como os recursos dentro do serviço de pesquisa devem ser criptografados com chaves gerenciadas pelo cliente.
HostingMode

Aplicável apenas para o padrão 3 SKU. Você pode definir essa propriedade para habilitar até 3 partições de alta densidade que permitem até 1000 índices, o que é muito maior do que os índices máximos permitidos para qualquer outra SKU. Para o SKU standard3, o valor é 'default' ou 'highDensity'. Para todos os outros SKUs, esse valor deve ser 'padrão'.
Identity

Detalhes sobre a identidade do serviço de pesquisa. Um valor nulo indica que o serviço de pesquisa não tem nenhuma identidade atribuída.
IdentityType

O tipo de identidade usado para o recurso. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada pelo sistema e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades do serviço.
IpRule

A regra de restrição de IP do serviço Azure AI Search.
NetworkRuleSet

Regras específicas de rede que determinam como o serviço Azure AI Search pode ser alcançado.
PrivateEndpoint

O recurso de ponto de extremidade privado do provedor Microsoft.Network.
PrivateEndpointConnection

Descreve uma conexão de ponto de extremidade privada existente com o serviço Azure AI Search.
PrivateEndpointConnectionProperties

Descreve as propriedades de uma conexão de ponto de extremidade privado existente com o serviço de pesquisa.
PrivateLinkServiceConnectionProvisioningState

O estado de provisionamento da conexão de serviço de link privado. Os valores válidos são Atualizar, Excluir, Falhar, Ter êxito, Incompleto ou Cancelado.
PrivateLinkServiceConnectionState

Descreve o estado atual de uma conexão de serviço de Link Privado do Azure existente com o ponto de extremidade privado.
PrivateLinkServiceConnectionStatus

Status da conexão do serviço de link privado. Os valores válidos são Pendente, Aprovado, Rejeitado ou Desconectado.
ProvisioningState

O estado da última operação de provisionamento executada no serviço de pesquisa. O provisionamento é um estado intermediário que ocorre enquanto a capacidade de serviço está sendo estabelecida. Depois que a capacidade é configurada, o provisionamentoState muda para 'bem-sucedido' ou 'falhou'. Os aplicativos cliente podem sondar o status de provisionamento (o intervalo de sondagem recomendado é de 30 segundos a um minuto) usando a operação Obter Serviço de Pesquisa para ver quando uma operação é concluída. Se você estiver usando o serviço gratuito, esse valor tende a voltar como 'bem-sucedido' diretamente na chamada para Criar serviço de pesquisa. Isso ocorre porque o serviço gratuito usa a capacidade que já está configurada.
PublicNetworkAccess

Esse valor pode ser definido como 'habilitado' para evitar alterações significativas nos recursos e modelos existentes do cliente. Se definido como 'desativado', o tráfego na interface pública não é permitido, e as conexões de ponto final privado seriam o método de acesso exclusivo.
SearchBypass

Possíveis origens do tráfego de entrada que pode ignorar as regras definidas na seção 'ipRules'.
SearchDisabledDataExfiltrationOption

Uma lista de cenários de exfiltração de dados que não são explicitamente permitidos para o serviço de pesquisa. Atualmente, o único valor suportado é 'Todos' para desativar todos os cenários possíveis de exportação de dados com controles mais refinados planejados para o futuro.
SearchEncryptionComplianceStatus

Retorna o status de conformidade do serviço de pesquisa em relação a objetos não criptografados por CMK. Se um serviço tiver mais de um objeto não criptografado e a imposição estiver habilitada, o serviço será marcado como não compatível.
SearchEncryptionWithCmk

Descreve como um serviço de pesquisa deve impor a conformidade se encontrar objetos que não são criptografados com a chave gerenciada pelo cliente.
SearchSemanticSearch

Define opções que controlam a disponibilidade da pesquisa semântica. Essa configuração só é possível para determinadas SKUs do Azure AI Search em determinados locais.
SearchService

Descreve um serviço Azure AI Search e seu estado atual.
SearchServiceStatus

O status do serviço de pesquisa. Os valores possíveis incluem: 'em execução': O serviço de pesquisa está em execução e nenhuma operação de provisionamento está em andamento. 'provisionamento': o serviço de pesquisa está sendo provisionado ou ampliado para cima ou para baixo. «Eliminação»: O serviço de pesquisa está a ser eliminado. 'degradado': O serviço de pesquisa está degradado. Isso pode ocorrer quando as unidades de pesquisa subjacentes não estão íntegras. O serviço de pesquisa provavelmente está operacional, mas o desempenho pode ser lento e algumas solicitações podem ser descartadas. 'desativado': O serviço de pesquisa está desativado. Nesse estado, o serviço rejeitará todas as solicitações de API. 'erro': O serviço de pesquisa está em um estado de erro. 'interrompido': o serviço de pesquisa está em uma assinatura desativada. Se o seu serviço estiver nos estados degradado, desativado ou de erro, isso significa que a equipe do Azure AI Search está investigando ativamente o problema subjacente. Os serviços dedicados nesses estados ainda são cobrados com base no número de unidades de pesquisa provisionadas.
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.
Sku

Define a SKU de um serviço de pesquisa, que determina a taxa de faturamento e os limites de capacidade.
SkuName

O SKU do serviço de pesquisa. Os valores válidos incluem: 'grátis': Serviço compartilhado. 'básico': Serviço dedicado com até 3 réplicas. 'standard': Serviço dedicado com até 12 partições e 12 réplicas. 'standard2': Semelhante ao padrão, mas com mais capacidade por unidade de pesquisa. 'standard3': A maior oferta Standard com até 12 partições e 12 réplicas (ou até 3 partições com mais índices se você também definir a propriedade hostingMode como 'highDensity'). 'storage_optimized_l1': Suporta 1TB por partição, até 12 partições. 'storage_optimized_l2': Suporta 2TB por partição, até 12 partições.'
UserAssignedManagedIdentity

Os detalhes da identidade gerenciada atribuída ao usuário atribuída ao serviço de pesquisa.

AadAuthFailureMode

Enumeração

Descreve qual resposta a API do plano de dados de um serviço de pesquisa enviaria para solicitações que falharam na autenticação.

Valor Description
http401WithBearerChallenge

Indica que as solicitações que falharam na autenticação devem ser apresentadas com um código de status HTTP de 401 (Não autorizado) e apresentar um Desafio ao Portador.
http403

Indica que as solicitações que falharam na autenticação devem ser apresentadas com um código de status HTTP de 403 (Proibido).

ApiKeyOnly

Object

Indica que apenas a chave da API pode ser usada para autenticação.

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

DataPlaneAadOrApiKeyAuthOption

Object

Indica que a chave de API ou um token de acesso de um locatário do Microsoft Entra ID pode ser usado para autenticação.

Name Tipo Description
aadAuthFailureMode

AadAuthFailureMode

Descreve qual resposta a API do plano de dados de um serviço de pesquisa enviaria para solicitações que falharam na autenticação.

DataPlaneAuthOptions

Object

Define as opções de como o serviço de pesquisa autentica uma solicitação de plano de dados. Isso não pode ser definido se 'disableLocalAuth' estiver definido como true.

Name Tipo Description
aadOrApiKey

DataPlaneAadOrApiKeyAuthOption

Indica que a chave de API ou um token de acesso de um locatário do Microsoft Entra ID pode ser usado para autenticação.
apiKeyOnly

ApiKeyOnly

Indica que apenas a chave da API pode ser usada para autenticação.

EncryptionWithCmk

Object

Descreve uma política que determina como os recursos dentro do serviço de pesquisa devem ser criptografados com chaves gerenciadas pelo cliente.

Name Tipo Description
encryptionComplianceStatus

SearchEncryptionComplianceStatus

Retorna o status de conformidade do serviço de pesquisa em relação a objetos não criptografados por CMK. Se um serviço tiver mais de um objeto não criptografado e a imposição estiver habilitada, o serviço será marcado como não compatível.
enforcement

SearchEncryptionWithCmk

Descreve como um serviço de pesquisa deve impor a conformidade se encontrar objetos que não são criptografados com a chave gerenciada pelo cliente.

HostingMode

Enumeração

Aplicável apenas para o padrão 3 SKU. Você pode definir essa propriedade para habilitar até 3 partições de alta densidade que permitem até 1000 índices, o que é muito maior do que os índices máximos permitidos para qualquer outra SKU. Para o SKU standard3, o valor é 'default' ou 'highDensity'. Para todos os outros SKUs, esse valor deve ser 'padrão'.

Valor Description
default

O limite do número de índices é determinado pelos limites padrão para a SKU.
highDensity

Aplicação única para SKU standard3, onde o serviço de pesquisa pode ter até 1000 índices.

Identity

Object

Detalhes sobre a identidade do serviço de pesquisa. Um valor nulo indica que o serviço de pesquisa não tem nenhuma identidade atribuída.

Name Tipo Description
principalId

string

O ID principal da identidade atribuída pelo sistema do serviço de pesquisa.
tenantId

string

O ID do locatário da identidade atribuída pelo sistema do serviço de pesquisa.
type

IdentityType

O tipo de identidade usado para o recurso. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada pelo sistema e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades do serviço.
userAssignedIdentities

<string,  UserAssignedManagedIdentity>

A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recursos ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

IdentityType

Enumeração

O tipo de identidade usado para o recurso. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada pelo sistema e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades do serviço.

Valor Description
None

Indica que qualquer identidade associada ao serviço de pesquisa precisa ser removida.
SystemAssigned

Indica que a identidade atribuída pelo sistema para o serviço de pesquisa será habilitada.
SystemAssigned, UserAssigned

Indica que a identidade atribuída pelo sistema para o serviço de pesquisa será habilitada juntamente com a atribuição de uma ou mais identidades atribuídas ao usuário.
UserAssigned

Indica que uma ou mais identidades atribuídas ao usuário serão atribuídas ao serviço de pesquisa.

IpRule

Object

A regra de restrição de IP do serviço Azure AI Search.

Name Tipo Description
value

string

Valor correspondente a um único endereço IPv4 (por exemplo, 123.1.2.3) ou um intervalo de IP em formato CIDR (por exemplo, 123.1.2.3/24) a ser permitido.

NetworkRuleSet

Object

Regras específicas de rede que determinam como o serviço Azure AI Search pode ser alcançado.

Name Tipo Description
bypass

SearchBypass

Possíveis origens do tráfego de entrada que pode ignorar as regras definidas na seção 'ipRules'.
ipRules

IpRule[]

Uma lista de regras de restrição de IP que define a(s) rede(s) de entrada com permissão de acesso ao ponto de extremidade do serviço de pesquisa. Enquanto isso, todas as outras redes IP públicas são bloqueadas pelo firewall. Estas regras de restrição são aplicadas apenas quando o «acesso públicoà rede» do serviço de pesquisa está «ativado»; caso contrário, o tráfego na interface pública não é permitido, mesmo com quaisquer regras de IP públicas, e as conexões de ponto final privadas seriam o método de acesso exclusivo.

PrivateEndpoint

Object

O recurso de ponto de extremidade privado do provedor Microsoft.Network.

Name Tipo Description
id

string

A ID do recurso de ponto de extremidade privado do provedor Microsoft.Network.

PrivateEndpointConnection

Object

Descreve uma conexão de ponto de extremidade privada existente com o serviço Azure AI Search.

Name Tipo Description
id

string

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

string

O nome do recurso
properties

PrivateEndpointConnectionProperties

Descreve as propriedades de uma conexão de ponto de extremidade privada existente com o serviço Azure AI Search.
type

string

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

PrivateEndpointConnectionProperties

Object

Descreve as propriedades de uma conexão de ponto de extremidade privado existente com o serviço de pesquisa.

Name Tipo Description
groupId

string

A ID de grupo do recurso do Azure para o qual o serviço de link privado é destinado.
privateEndpoint

PrivateEndpoint

O recurso de ponto de extremidade privado do provedor Microsoft.Network.
privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Descreve o estado atual de uma conexão de serviço de Link Privado do Azure existente com o ponto de extremidade privado.
provisioningState

PrivateLinkServiceConnectionProvisioningState

O estado de provisionamento da conexão de serviço de link privado. Os valores válidos são Atualizar, Excluir, Falhar, Ter êxito, Incompleto ou Cancelado.

PrivateLinkServiceConnectionProvisioningState

Enumeração

O estado de provisionamento da conexão de serviço de link privado. Os valores válidos são Atualizar, Excluir, Falhar, Ter êxito, Incompleto ou Cancelado.

Valor Description
Canceled

A solicitação de provisionamento para o recurso de conexão do serviço de link privado foi cancelada.
Deleting

A conexão do serviço de link privado está em processo de exclusão.
Failed

A conexão do serviço de link privado não pôde ser provisionada ou excluída.
Incomplete

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

A conexão de serviço de link privado concluiu o provisionamento e está pronta para aprovação.
Updating

A conexão do serviço de link privado está em processo de criação junto com outros recursos para que seja totalmente funcional.

PrivateLinkServiceConnectionState

Object

Descreve o estado atual de uma conexão de serviço de Link Privado do Azure existente com o ponto de extremidade privado.

Name Tipo Default value Description
actionsRequired

string

None

Uma descrição de quaisquer ações adicionais que possam ser necessárias.
description

string

A descrição do estado de conexão do serviço de link privado.
status

PrivateLinkServiceConnectionStatus

Status da conexão do serviço de link privado. Os valores válidos são Pendente, Aprovado, Rejeitado ou Desconectado.

PrivateLinkServiceConnectionStatus

Enumeração

Status da conexão do serviço de link privado. Os valores válidos são Pendente, Aprovado, Rejeitado ou Desconectado.

Valor Description
Approved

A conexão de ponto de extremidade privada foi aprovada e está pronta para uso.
Disconnected

A conexão de ponto de extremidade privado foi removida do serviço.
Pending

A conexão de ponto de extremidade privado foi criada e está pendente de aprovação.
Rejected

A conexão de ponto de extremidade privada foi rejeitada e não pode ser usada.

ProvisioningState

Enumeração

O estado da última operação de provisionamento executada no serviço de pesquisa. O provisionamento é um estado intermediário que ocorre enquanto a capacidade de serviço está sendo estabelecida. Depois que a capacidade é configurada, o provisionamentoState muda para 'bem-sucedido' ou 'falhou'. Os aplicativos cliente podem sondar o status de provisionamento (o intervalo de sondagem recomendado é de 30 segundos a um minuto) usando a operação Obter Serviço de Pesquisa para ver quando uma operação é concluída. Se você estiver usando o serviço gratuito, esse valor tende a voltar como 'bem-sucedido' diretamente na chamada para Criar serviço de pesquisa. Isso ocorre porque o serviço gratuito usa a capacidade que já está configurada.

Valor Description
failed

A última operação de provisionamento falhou.
provisioning

O serviço de pesquisa está sendo provisionado ou dimensionado para cima ou para baixo.
succeeded

A última operação de provisionamento foi concluída com êxito.

PublicNetworkAccess

Enumeração

Esse valor pode ser definido como 'habilitado' para evitar alterações significativas nos recursos e modelos existentes do cliente. Se definido como 'desativado', o tráfego na interface pública não é permitido, e as conexões de ponto final privado seriam o método de acesso exclusivo.

Valor Description
disabled

O serviço de pesquisa não é acessível a partir do tráfego proveniente da Internet pública. O acesso só é permitido em conexões de ponto final privadas aprovadas.
enabled

O serviço de pesquisa é acessível a partir do tráfego proveniente da Internet pública.

SearchBypass

Enumeração

Possíveis origens do tráfego de entrada que pode ignorar as regras definidas na seção 'ipRules'.

Valor Description
AzurePortal

Indica que as solicitações originadas do portal do Azure podem ignorar as regras definidas na seção 'ipRules'.
None

Indica que nenhuma origem pode ignorar as regras definidas na seção 'ipRules'. Este é o padrão.

SearchDisabledDataExfiltrationOption

Enumeração

Uma lista de cenários de exfiltração de dados que não são explicitamente permitidos para o serviço de pesquisa. Atualmente, o único valor suportado é 'Todos' para desativar todos os cenários possíveis de exportação de dados com controles mais refinados planejados para o futuro.

Valor Description
All

Indica que todos os cenários de exfiltração de dados estão desativados.

SearchEncryptionComplianceStatus

Enumeração

Retorna o status de conformidade do serviço de pesquisa em relação a objetos não criptografados por CMK. Se um serviço tiver mais de um objeto não criptografado e a imposição estiver habilitada, o serviço será marcado como não compatível.

Valor Description
Compliant

Indica que o serviço de pesquisa é compatível, seja porque o número de objetos não criptografados por CMK é zero ou a imposição está desabilitada.
NonCompliant

Indica que o serviço de pesquisa tem mais de um objeto não criptografado por CMK.

SearchEncryptionWithCmk

Enumeração

Descreve como um serviço de pesquisa deve impor a conformidade se encontrar objetos que não são criptografados com a chave gerenciada pelo cliente.

Valor Description
Disabled

Nenhuma imposição de criptografia de chave gerenciada pelo cliente será feita. Somente a criptografia interna gerenciada por serviço é usada.
Enabled

O serviço de pesquisa será marcado como não compatível se um ou mais objetos não forem criptografados com uma chave gerenciada pelo cliente.
Unspecified

A política de imposição não é especificada explicitamente, com o comportamento sendo o mesmo como se estivesse definido como 'Desativado'.

SearchSemanticSearch

Enumeração

Define opções que controlam a disponibilidade da pesquisa semântica. Essa configuração só é possível para determinadas SKUs do Azure AI Search em determinados locais.

Valor Description
disabled

Indica que o reranker semântico está desabilitado para o serviço de pesquisa. Este é o padrão.
free

Habilita o reranker semântico em um serviço de pesquisa e indica que ele deve ser usado dentro dos limites do plano gratuito. O plano gratuito limitaria o volume de solicitações de classificação semântica e é oferecido sem custo extra. Este é o padrão para serviços de pesquisa recém-provisionados.
standard

Permite o reranker semântico em um serviço de pesquisa como um recurso faturável, com maior taxa de transferência e volume de consultas semanticamente reclassificadas.

SearchService

Object

Descreve um serviço Azure AI Search e seu estado atual.

Name Tipo Default value Description
id

string

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

Identity

A identidade do recurso.
location

string

A geolocalização onde o recurso vive
name

string

O nome do recurso
properties.authOptions

DataPlaneAuthOptions

Define as opções de como a API do plano de dados de um serviço de pesquisa autentica solicitações. Isso não pode ser definido se 'disableLocalAuth' estiver definido como true.
properties.disableLocalAuth

boolean

Quando definido como true, as chamadas para o serviço de pesquisa não terão permissão para utilizar chaves de API para autenticação. Isso não pode ser definido como true se 'dataPlaneAuthOptions' estiver definido.
properties.disabledDataExfiltrationOptions

SearchDisabledDataExfiltrationOption[]

Uma lista de cenários de exfiltração de dados que não são explicitamente permitidos para o serviço de pesquisa. Atualmente, o único valor suportado é 'Todos' para desativar todos os cenários possíveis de exportação de dados com controles mais refinados planejados para o futuro.
properties.eTag

string

Uma propriedade gerada pelo sistema que representa a etag do serviço que pode ser para controle de simultaneidade otimista durante as atualizações.
properties.encryptionWithCmk

EncryptionWithCmk

Especifica qualquer política relativa à criptografia de recursos (como índices) usando chaves do gerenciador de clientes em um serviço de pesquisa.
properties.hostingMode

HostingMode

default

Aplicável apenas para o padrão 3 SKU. Você pode definir essa propriedade para habilitar até 3 partições de alta densidade que permitem até 1000 índices, o que é muito maior do que os índices máximos permitidos para qualquer outra SKU. Para o SKU standard3, o valor é 'default' ou 'highDensity'. Para todos os outros SKUs, esse valor deve ser 'padrão'.
properties.networkRuleSet

NetworkRuleSet

Regras específicas de rede que determinam como o serviço Azure AI Search pode ser alcançado.
properties.partitionCount

integer (int32)

minimum: 1
maximum: 12 		1

O número de partições no serviço de pesquisa; se especificado, pode ser 1, 2, 3, 4, 6 ou 12. Valores maiores que 1 só são válidos para SKUs padrão. Para serviços 'standard3' com hostingMode definido como 'highDensity', os valores permitidos estão entre 1 e 3.
properties.privateEndpointConnections

PrivateEndpointConnection[]

A lista de conexões de ponto de extremidade privado para o serviço Azure AI Search.
properties.provisioningState

ProvisioningState

O estado da última operação de provisionamento executada no serviço de pesquisa. O provisionamento é um estado intermediário que ocorre enquanto a capacidade de serviço está sendo estabelecida. Depois que a capacidade é configurada, o provisionamentoState muda para 'bem-sucedido' ou 'falhou'. Os aplicativos cliente podem sondar o status de provisionamento (o intervalo de sondagem recomendado é de 30 segundos a um minuto) usando a operação Obter Serviço de Pesquisa para ver quando uma operação é concluída. Se você estiver usando o serviço gratuito, esse valor tende a voltar como 'bem-sucedido' diretamente na chamada para Criar serviço de pesquisa. Isso ocorre porque o serviço gratuito usa a capacidade que já está configurada.
properties.publicNetworkAccess

PublicNetworkAccess

enabled

Esse valor pode ser definido como 'habilitado' para evitar alterações significativas nos recursos e modelos existentes do cliente. Se definido como 'desativado', o tráfego na interface pública não é permitido, e as conexões de ponto final privado seriam o método de acesso exclusivo.
properties.replicaCount

integer (int32)

minimum: 1
maximum: 12 		1

O número de réplicas no serviço de pesquisa. Se especificado, deve ser um valor entre 1 e 12 inclusive para SKUs padrão ou entre 1 e 3 inclusive para SKU básico.
properties.semanticSearch

SearchSemanticSearch

Define opções que controlam a disponibilidade da pesquisa semântica. Essa configuração só é possível para determinadas SKUs do Azure AI Search em determinados locais.
properties.sharedPrivateLinkResources

SharedPrivateLinkResource[]

A lista de recursos de link privado compartilhado gerenciados pelo serviço Azure AI Search.
properties.status

SearchServiceStatus

O status do serviço de pesquisa. Os valores possíveis incluem: 'em execução': O serviço de pesquisa está em execução e nenhuma operação de provisionamento está em andamento. 'provisionamento': o serviço de pesquisa está sendo provisionado ou ampliado para cima ou para baixo. «Eliminação»: O serviço de pesquisa está a ser eliminado. 'degradado': O serviço de pesquisa está degradado. Isso pode ocorrer quando as unidades de pesquisa subjacentes não estão íntegras. O serviço de pesquisa provavelmente está operacional, mas o desempenho pode ser lento e algumas solicitações podem ser descartadas. 'desativado': O serviço de pesquisa está desativado. Nesse estado, o serviço rejeitará todas as solicitações de API. 'erro': O serviço de pesquisa está em um estado de erro. 'interrompido': o serviço de pesquisa está em uma assinatura desativada. Se o seu serviço estiver nos estados degradado, desativado ou de erro, isso significa que a equipe do Azure AI Search está investigando ativamente o problema subjacente. Os serviços dedicados nesses estados ainda são cobrados com base no número de unidades de pesquisa provisionadas.
properties.statusDetails

string

Os detalhes do status do serviço de pesquisa.
sku

Sku

O SKU do serviço de pesquisa, que determina a camada de preço e os limites de capacidade. Esta propriedade é necessária ao criar um novo serviço de pesquisa.
tags

object

Tags de recursos.
type

string

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

SearchServiceStatus

Enumeração

O status do serviço de pesquisa. Os valores possíveis incluem: 'em execução': O serviço de pesquisa está em execução e nenhuma operação de provisionamento está em andamento. 'provisionamento': o serviço de pesquisa está sendo provisionado ou ampliado para cima ou para baixo. «Eliminação»: O serviço de pesquisa está a ser eliminado. 'degradado': O serviço de pesquisa está degradado. Isso pode ocorrer quando as unidades de pesquisa subjacentes não estão íntegras. O serviço de pesquisa provavelmente está operacional, mas o desempenho pode ser lento e algumas solicitações podem ser descartadas. 'desativado': O serviço de pesquisa está desativado. Nesse estado, o serviço rejeitará todas as solicitações de API. 'erro': O serviço de pesquisa está em um estado de erro. 'interrompido': o serviço de pesquisa está em uma assinatura desativada. Se o seu serviço estiver nos estados degradado, desativado ou de erro, isso significa que a equipe do Azure AI Search está investigando ativamente o problema subjacente. Os serviços dedicados nesses estados ainda são cobrados com base no número de unidades de pesquisa provisionadas.

Valor Description
degraded

O serviço de pesquisa está degradado porque as unidades de pesquisa subjacentes não estão íntegras.
deleting

O serviço de pesquisa está a ser eliminado.
disabled

O serviço de pesquisa está desativado e todas as solicitações de API serão rejeitadas.
error

O serviço de pesquisa está em estado de erro, indicando uma falha no fornecimento ou a ser excluído.
provisioning

O serviço de pesquisa está sendo provisionado ou dimensionado para cima ou para baixo.
running

O serviço de pesquisa está em execução e nenhuma operação de provisionamento está em andamento.
stopped

O serviço de pesquisa está em uma assinatura desativada.

SharedPrivateLinkResource

Object

Descreve um recurso de link privado compartilhado gerenciado pelo serviço Azure AI Search.

Name Tipo Description
id

string

ID de recurso totalmente qualificado 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 Azure AI Search.
type

string

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

SharedPrivateLinkResourceProperties

Object

Descreve as propriedades de um recurso de link privado compartilhado existente gerenciado pelo serviço Azure AI Search.

Name Tipo Description
groupId

string

A ID de grupo do provedor de recurso para o qual o recurso de link privado compartilhado é destinado.
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 Atualizar, Excluir, Falhar, Ter ê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 do Azure Resource Manager 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 o Serviço Kubernetes do Azure).
status

SharedPrivateLinkResourceStatus

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

SharedPrivateLinkResourceProvisioningState

Enumeração

O estado de provisionamento do recurso de link privado compartilhado. Os valores válidos são Atualizar, Excluir, Falhar, Ter êxito ou Incompleto.

Valor Description
Deleting

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

O recurso de link privado compartilhado não pôde ser provisionado ou excluído.
Incomplete

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

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

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

SharedPrivateLinkResourceStatus

Enumeração

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

Valor Description
Approved

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

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

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

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

Sku

Object

Define a SKU de um serviço de pesquisa, que determina a taxa de faturamento e os limites de capacidade.

Name Tipo Description
name

SkuName

O SKU do serviço de pesquisa. Os valores válidos incluem: 'grátis': Serviço compartilhado. 'básico': Serviço dedicado com até 3 réplicas. 'standard': Serviço dedicado com até 12 partições e 12 réplicas. 'standard2': Semelhante ao padrão, mas com mais capacidade por unidade de pesquisa. 'standard3': A maior oferta Standard com até 12 partições e 12 réplicas (ou até 3 partições com mais índices se você também definir a propriedade hostingMode como 'highDensity'). 'storage_optimized_l1': Suporta 1TB por partição, até 12 partições. 'storage_optimized_l2': Suporta 2TB por partição, até 12 partições.'

SkuName

Enumeração

O SKU do serviço de pesquisa. Os valores válidos incluem: 'grátis': Serviço compartilhado. 'básico': Serviço dedicado com até 3 réplicas. 'standard': Serviço dedicado com até 12 partições e 12 réplicas. 'standard2': Semelhante ao padrão, mas com mais capacidade por unidade de pesquisa. 'standard3': A maior oferta Standard com até 12 partições e 12 réplicas (ou até 3 partições com mais índices se você também definir a propriedade hostingMode como 'highDensity'). 'storage_optimized_l1': Suporta 1TB por partição, até 12 partições. 'storage_optimized_l2': Suporta 2TB por partição, até 12 partições.'

Valor Description
basic

Nível faturável para um serviço dedicado com até 3 réplicas.
free

Nível gratuito, sem garantias de SLA e um subconjunto dos recursos oferecidos em níveis faturáveis.
standard

Nível faturável para um serviço dedicado com até 12 partições e 12 réplicas.
standard2

Semelhante ao 'padrão', mas com mais capacidade por unidade de pesquisa.
standard3

A maior oferta Standard com até 12 partições e 12 réplicas (ou até 3 partições com mais índices se você também definir a propriedade hostingMode como 'highDensity').
storage_optimized_l1

Nível faturável para um serviço dedicado que suporta 1 TB por partição, até 12 partições.
storage_optimized_l2

Nível faturável para um serviço dedicado que suporta 2 TB por partição, até 12 partições.

UserAssignedManagedIdentity

Object

Os detalhes da identidade gerenciada atribuída ao usuário atribuída ao serviço de pesquisa.

Name Tipo Description
clientId

string

O ID do cliente da identidade atribuída ao usuário.
principalId

string

O ID principal da identidade atribuída ao usuário.