Services - Update

Serviço:

Search Management

Versão da API:

2025-05-01

Atualiza um serviço de pesquisa existente no determinado grupo de recursos.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}?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	O nome do serviço Azure AI Search a ser atualizado.
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
identity	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.
location	string	A localização geográfica do recurso. Essa deve ser uma das regiões geográficas do Azure com suporte e registradas (por exemplo, Oeste dos EUA, Leste dos EUA, Sudeste Asiático e assim por diante). Essa propriedade é necessária ao criar um novo 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.computeType	ComputeType	Configure essa propriedade para dar suporte ao serviço de pesquisa usando a Computação Padrão ou a Computação Confidencial do Azure.
properties.dataExfiltrationProtections	SearchDataExfiltrationProtection[]	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.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.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.endpoint	string (uri)	O ponto de extremidade do serviço Azure AI Search.
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.
properties.upgradeAvailable	UpgradeAvailable	Indica se o serviço de pesquisa tem uma atualização disponível.
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 para ajudar a categorizar o recurso no portal do Azure.

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 retornada na resposta para uma solicitação Get Service.
Other Status Codes	CloudError	HTTP 400 (Solicitação incorreta): A definição de serviço fornecida é inválida ou você tentou alterar uma propriedade que é imutável. 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

SearchUpdateService

SearchUpdateServiceAuthOptions

SearchUpdateServiceDisableLocalAuth

SearchUpdateServiceToAllowAccessFromPrivateEndpoints

SearchUpdateServiceToAllowAccessFromPublicCustomIPs

SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

SearchUpdateServiceToRemoveIdentity

SearchUpdateServiceWithCmkEnforcement

SearchUpdateServiceWithDataExfiltration

SearchUpdateServiceWithSemanticSearch

SearchUpdateServiceWithSku

SearchUpdateService

Pedido de amostra

HTTP

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

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2
  }
}

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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceAuthOptions

Pedido de amostra

HTTP

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

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceDisableLocalAuth

Pedido de amostra

HTTP

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

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": true,
    "authOptions": null,
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceToAllowAccessFromPrivateEndpoints

Pedido de amostra

HTTP

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

{
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "publicNetworkAccess": "disabled"
  }
}

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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "basic"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "disabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceToAllowAccessFromPublicCustomIPs

Pedido de amostra

HTTP

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

{
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    }
  }
}

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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "10.2.3.4"
        }
      ]
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

Pedido de amostra

HTTP

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

{
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ],
      "bypass": "AzureServices"
    }
  }
}

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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "10.2.3.4"
        }
      ],
      "bypass": "AzureServices"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceToRemoveIdentity

Pedido de amostra

HTTP

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

{
  "sku": {
    "name": "standard"
  },
  "identity": {
    "type": "None"
  }
}

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": {},
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceWithCmkEnforcement

Pedido de amostra

HTTP

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

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Enabled",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceWithDataExfiltration

Pedido de amostra

HTTP

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

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "dataExfiltrationProtections": [
      "BlockAll"
    ]
  }
}

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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [
      "BlockAll"
    ],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceWithSemanticSearch

Pedido de amostra

HTTP

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

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "semanticSearch": "standard"
  }
}

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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [],
    "semanticSearch": "standard",
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceWithSku

Pedido de amostra

HTTP

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

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard2"
  }
}

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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard2"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

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.
ComputeType	Configure essa propriedade para dar suporte ao serviço de pesquisa usando a Computação Padrão ou a Computação Confidencial do Azure.
createdByType	O tipo de identidade que criou o recurso.
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	The type of identity used for the resource. 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, provisioningState muda para 'Succeeded' ou 'Failed'. 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'.
SearchDataExfiltrationProtection	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.
SearchServiceUpdate	Os parâmetros usados para atualizar um serviço Azure AI Search.
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.'
systemData	Metadados referentes à criação e última modificação do recurso.
UpgradeAvailable	Indica se o serviço de pesquisa tem uma atualização disponível.
UserAssignedIdentity	Propriedades de identidade atribuídas pelo usuário

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

ComputeType

Enumeração

Configure essa propriedade para dar suporte ao serviço de pesquisa usando a Computação Padrão ou a Computação Confidencial do Azure.

Valor	Description
confidential	Crie o serviço com a Computação Confidencial do Azure.
default	Crie o serviço com a computação padrão.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

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	The type of identity used for the resource. 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,  UserAssignedIdentity>	The list of user identities associated with the resource. 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

The type of identity used for the resource. 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 (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	PrivateEndpointConnectionProperties	Descreve as propriedades de uma conexão de ponto de extremidade privada existente com o serviço Azure AI Search.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
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, provisioningState muda para 'Succeeded' ou 'Failed'. 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
AzureServices	Indica que as solicitações originadas dos serviços confiáveis 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.

SearchDataExfiltrationProtection

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
BlockAll	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 (arm-id)		Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	Identity		The identity of the resource.
location	string		The geo-location where the resource lives
name	string		The name of the resource
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.computeType	ComputeType		Configure essa propriedade para dar suporte ao serviço de pesquisa usando a Computação Padrão ou a Computação Confidencial do Azure.
properties.dataExfiltrationProtections	SearchDataExfiltrationProtection[]		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.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.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.endpoint	string (uri)		O ponto de extremidade do serviço Azure AI Search.
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, provisioningState muda para 'Succeeded' ou 'Failed'. 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.serviceUpgradedAt	string (date-time)		A data e a hora em que o serviço de pesquisa foi atualizado pela última vez. Este campo será nulo até que o serviço seja atualizado pela primeira vez.
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.
properties.upgradeAvailable	UpgradeAvailable		Indica se o serviço de pesquisa tem uma atualização disponível.
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.
systemData	systemData		Metadados do Azure Resource Manager do serviço de pesquisa que contêm informações createdBy e modifiedBy.
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.

SearchServiceUpdate

Object

Os parâmetros usados para atualizar um serviço Azure AI Search.

Name	Tipo	Default value	Description
id	string (arm-id)		Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	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.
location	string		A localização geográfica do recurso. Essa deve ser uma das regiões geográficas do Azure com suporte e registradas (por exemplo, Oeste dos EUA, Leste dos EUA, Sudeste Asiático e assim por diante). Essa propriedade é necessária ao criar um novo recurso.
name	string		The name of the resource
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.computeType	ComputeType		Configure essa propriedade para dar suporte ao serviço de pesquisa usando a Computação Padrão ou a Computação Confidencial do Azure.
properties.dataExfiltrationProtections	SearchDataExfiltrationProtection[]		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.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.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.endpoint	string (uri)		O ponto de extremidade do serviço Azure AI Search.
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, provisioningState muda para 'Succeeded' ou 'Failed'. 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.serviceUpgradedAt	string (date-time)		A data e a hora em que o serviço de pesquisa foi atualizado pela última vez. Este campo será nulo até que o serviço seja atualizado pela primeira vez.
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.
properties.upgradeAvailable	UpgradeAvailable		Indica se o serviço de pesquisa tem uma atualização disponível.
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.
systemData	systemData		Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object		Tags para ajudar a categorizar o recurso no portal do Azure.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResource

Object

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

Name	Tipo	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	SharedPrivateLinkResourceProperties	Descreve as propriedades de um recurso de link privado compartilhado gerenciado pelo serviço Azure AI Search.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
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.

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

UpgradeAvailable

Enumeração

Indica se o serviço de pesquisa tem uma atualização disponível.

Valor	Description
available	Há uma atualização disponível para o serviço.
notAvailable	Uma atualização não está disponível no momento para o serviço.

UserAssignedIdentity

Object

Propriedades de identidade atribuídas pelo usuário

Name	Tipo	Description
clientId	string (uuid)	The client ID of the assigned identity.
principalId	string (uuid)	The principal ID of the assigned identity.