Atualizar marcador

Espaço de nomes: microsoft.graph.search

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Atualize as propriedades de um objeto de marcador .

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global	US Government L4	US Government L5 (DOD)	China operada pela 21Vianet
✅	❌	❌	❌

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão	Permissões com menos privilégios	Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante)	SearchConfiguration.Read.All	SearchConfiguration.ReadWrite.All
Delegado (conta pessoal da Microsoft)	Sem suporte.	Sem suporte.
Application	SearchConfiguration.Read.All	SearchConfiguration.ReadWrite.All

Solicitação HTTP

PATCH /search/bookmarks/{bookmarksId}

Cabeçalhos de solicitação

Nome	Descrição
Autorização	{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type	application/json. Obrigatório.

Corpo da solicitação

No corpo do pedido, forneça apenas os valores das propriedades a atualizar. As propriedades existentes que não estão incluídas no corpo do pedido mantêm os valores anteriores ou são recalculadas com base em alterações a outros valores de propriedade.

A tabela a seguir especifica as propriedades que podem ser atualizadas.

Nota: Quaisquer atualizações às propriedades de uma coleção, como palavras-chave ou categorias, substituem toda a coleção.

Propriedade	Tipo	Descrição
availabilityEndDateTime	DateTimeOffset	Data e hora em que o marcador deixa de aparecer como resultado da pesquisa. Defina como null para sempre disponível. O tipo de carimbo de data/hora representa informações de data e hora com o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z.
availabilityStartDateTime	DateTimeOffset	Data e hora em que o marcador começa a aparecer como um resultado de pesquisa. Defina como null para sempre disponível. O tipo de carimbo de data/hora representa informações de data e hora com o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z.
categories	String collection	Categorias normalmente utilizadas para descrever este marcador. Por exemplo, IT e HR.
description	Cadeia de caracteres	A descrição do marcador apresentada na página de resultados da pesquisa. Herdado de searchAnswer.
displayName	Cadeia de caracteres	O nome do marcador que é apresentado nos resultados da pesquisa. Herdado de searchAnswer.
groupIds	Coleção de cadeias de caracteres	A lista de grupos de segurança que podem ver este marcador.
palavras-chave	microsoft.graph.search.answerKeyword	Palavras-chave que acionam este marcador para aparecerem nos resultados da pesquisa.
languageTags	String collection	Uma lista de nomes de idioma geograficamente específicos nos quais este marcador pode ser visualizado. Cada valor de etiqueta de idioma segue o padrão {language}-{region}. Por exemplo, é inglês, en-us conforme utilizado no Estados Unidos. Para obter a lista de valores possíveis, veja Etiquetas de idioma suportadas.
plataformas	coleção microsoft.graph.devicePlatformType	Lista de dispositivos e sistemas operativos que conseguem ver este marcador. Os valores possíveis são: android, androidForWork, ios, macOS, windowsPhone81, windowsPhone81AndLater, windows10AndLater, androidWorkProfile, unknown, androidASOP, androidMobileApplicationManagement, iOSMobileApplicationManagement e unknownFutureValue.
powerAppIds	String collection	Lista de Power Apps associados a este marcador. Se os utilizadores adicionarem o Power Apps existente a um marcador, podem concluir tarefas diretamente na página de resultados da pesquisa, como introduzir o tempo de férias ou reportar despesas.
state	microsoft.graph.search.answerState	Estado do marcador. Os valores possíveis são: published, draft, excluded, unknownFutureValue.
targetedVariations	coleção microsoft.graph.search.answerVariant	Variações de um marcador para diferentes países ou dispositivos. Utilize quando precisar de mostrar conteúdos diferentes aos utilizadores com base no respetivo dispositivo, país/região ou ambos. As definições de data e grupo aplicam-se a todas as variações.
webUrl	String	A ligação do URL para o marcador. Quando os utilizadores selecionam este marcador nos resultados da pesquisa, são direcionados para o URL especificado. Herdado de searchAnswer.

Resposta

Se tiver êxito, este método retornará um código de resposta 204 No Content.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

HTTP

PATCH https://graph.microsoft.com/beta/search/bookmarks/733b26d5-af76-4eea-ac69-1a0ce8716897
Content-Type: application/json

{
  "description": "Book a fancy vacation in Tuscany or browse museums in Florence."
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models.Search;

var requestBody = new Bookmark
{
	Description = "Book a fancy vacation in Tuscany or browse museums in Florence.",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Search.Bookmarks["{bookmark-id}"].PatchAsync(requestBody);

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

CLI

mgc-beta search bookmarks patch --bookmark-id {bookmark-id} --body '{\
  "description": "Book a fancy vacation in Tuscany or browse museums in Florence."\
}\
'

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Ir

// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodelssearch "github.com/microsoftgraph/msgraph-beta-sdk-go/models/search"
	  //other-imports
)

requestBody := graphmodelssearch.NewBookmark()
description := "Book a fancy vacation in Tuscany or browse museums in Florence."
requestBody.SetDescription(&description) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
bookmarks, err := graphClient.Search().Bookmarks().ByBookmarkId("bookmark-id").Patch(context.Background(), requestBody, nil)

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.beta.models.search.Bookmark bookmark = new com.microsoft.graph.beta.models.search.Bookmark();
bookmark.setDescription("Book a fancy vacation in Tuscany or browse museums in Florence.");
com.microsoft.graph.models.search.Bookmark result = graphClient.search().bookmarks().byBookmarkId("{bookmark-id}").patch(bookmark);

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const bookmark = {
  description: 'Book a fancy vacation in Tuscany or browse museums in Florence.'
};

await client.api('/search/bookmarks/733b26d5-af76-4eea-ac69-1a0ce8716897')
	.version('beta')
	.update(bookmark);

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

PHP

<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\Search\Bookmark;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new Bookmark();
$requestBody->setDescription('Book a fancy vacation in Tuscany or browse museums in Florence.');

$result = $graphServiceClient->search()->bookmarks()->byBookmarkId('bookmark-id')->patch($requestBody)->wait();

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

PowerShell

Import-Module Microsoft.Graph.Beta.Search

$params = @{
	description = "Book a fancy vacation in Tuscany or browse museums in Florence."
}

Update-MgBetaSearchBookmark -BookmarkId $bookmarkId -BodyParameter $params

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.search.bookmark import Bookmark
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = Bookmark(
	description = "Book a fancy vacation in Tuscany or browse museums in Florence.",
)

result = await graph_client.search.bookmarks.by_bookmark_id('bookmark-id').patch(request_body)

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content