Atualizar remoteDesktopSecurityConfiguration

Artigo
04/18/2024

Namespace: microsoft.graph

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 remoteDesktopSecurityConfiguration no servicePrincipal. Use essa configuração para habilitar ou desabilitar o protocolo de autenticação RDS (Serviços de Área de Trabalho Remota) Microsoft Entra ID para autenticar um usuário para Microsoft Entra dispositivos ingressados ou Microsoft Entra híbridos.

Essa API está disponível nas seguintes implantações nacionais de nuvem.

Serviço global	Governo dos EUA L4	GOVERNO DOS EUA L5 (DOD)	China operada pela 21Vianet
✅	✅	✅	✅

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão	Permissões menos privilegiadas	Permissões privilegiadas mais altas
Delegado (conta corporativa ou de estudante)	Application-RemoteDesktopConfig.ReadWrite.All	Application.ReadWrite.All, Directory.ReadWrite.All
Delegado (conta pessoal da Microsoft)	Sem suporte.	Sem suporte.
Application	Application-RemoteDesktopConfig.ReadWrite.All	Application.ReadWrite.All, Directory.ReadWrite.All

O usuário chamador também deve receber a função Administrador de Aplicativos ou Administrador de Aplicativos na NuvemMicrosoft Entra função.

Solicitação HTTP

PATCH /servicePrincipals/{servicePrincipalsId}/remoteDesktopSecurityConfiguration

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 da solicitação, forneça apenas os valores das propriedades que devem ser atualizadas. As propriedades existentes que não estão incluídas no corpo da solicitação mantêm seus valores anteriores ou são recalculadas com base em alterações em outros valores de propriedade.

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

Propriedade	Tipo	Descrição
isRemoteDesktopProtocolEnabled	Booliano	Se o novo protocolo de autenticação do RDS (Serviços de Área de Trabalho Remota) Microsoft Entra ID para autenticar um usuário para Microsoft Entra ingressado ou Microsoft Entra dispositivos híbridos ingressados.over RDP está habilitado ou não. Obrigatório.

Resposta

Se for bem-sucedido, esse método retornará um 200 OK código de resposta e um objeto remoteDesktopSecurityConfiguration atualizado no corpo da resposta.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

PATCH https://graph.microsoft.com/beta/servicePrincipals/00af5dfb-85da-4b41-a677-0c6b86dd34f8/remoteDesktopSecurityConfiguration
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.remoteDesktopSecurityConfiguration",
  "isRemoteDesktopProtocolEnabled": true
}


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

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

var requestBody = new RemoteDesktopSecurityConfiguration
{
	OdataType = "#microsoft.graph.remoteDesktopSecurityConfiguration",
	IsRemoteDesktopProtocolEnabled = true,
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.ServicePrincipals["{servicePrincipal-id}"].RemoteDesktopSecurityConfiguration.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.



mgc-beta service-principals remote-desktop-security-configuration patch --service-principal-id {servicePrincipal-id} --body '{\
  "@odata.type": "#microsoft.graph.remoteDesktopSecurityConfiguration",\
  "isRemoteDesktopProtocolEnabled": true\
}\
'

Importante

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



// 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"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewRemoteDesktopSecurityConfiguration()
isRemoteDesktopProtocolEnabled := true
requestBody.SetIsRemoteDesktopProtocolEnabled(&isRemoteDesktopProtocolEnabled) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
remoteDesktopSecurityConfiguration, err := graphClient.ServicePrincipals().ByServicePrincipalId("servicePrincipal-id").RemoteDesktopSecurityConfiguration().Patch(context.Background(), requestBody, nil)

Importante

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


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

RemoteDesktopSecurityConfiguration remoteDesktopSecurityConfiguration = new RemoteDesktopSecurityConfiguration();
remoteDesktopSecurityConfiguration.setOdataType("#microsoft.graph.remoteDesktopSecurityConfiguration");
remoteDesktopSecurityConfiguration.setIsRemoteDesktopProtocolEnabled(true);
RemoteDesktopSecurityConfiguration result = graphClient.servicePrincipals().byServicePrincipalId("{servicePrincipal-id}").remoteDesktopSecurityConfiguration().patch(remoteDesktopSecurityConfiguration);

Importante

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


const options = {
	authProvider,
};

const client = Client.init(options);

const remoteDesktopSecurityConfiguration = {
  '@odata.type': '#microsoft.graph.remoteDesktopSecurityConfiguration',
  isRemoteDesktopProtocolEnabled: true
};

await client.api('/servicePrincipals/00af5dfb-85da-4b41-a677-0c6b86dd34f8/remoteDesktopSecurityConfiguration')
	.version('beta')
	.update(remoteDesktopSecurityConfiguration);

Importante

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


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


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

$requestBody = new RemoteDesktopSecurityConfiguration();
$requestBody->setOdataType('#microsoft.graph.remoteDesktopSecurityConfiguration');
$requestBody->setIsRemoteDesktopProtocolEnabled(true);

$result = $graphServiceClient->servicePrincipals()->byServicePrincipalId('servicePrincipal-id')->remoteDesktopSecurityConfiguration()->patch($requestBody)->wait();

Importante

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


Import-Module Microsoft.Graph.Beta.Applications

$params = @{
	"@odata.type" = "#microsoft.graph.remoteDesktopSecurityConfiguration"
	isRemoteDesktopProtocolEnabled = $true
}

Update-MgBetaServicePrincipalRemoteDesktopSecurityConfiguration -ServicePrincipalId $servicePrincipalId -BodyParameter $params

Importante

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


from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.remote_desktop_security_configuration import RemoteDesktopSecurityConfiguration

graph_client = GraphServiceClient(credentials, scopes)

request_body = RemoteDesktopSecurityConfiguration(
	odata_type = "#microsoft.graph.remoteDesktopSecurityConfiguration",
	is_remote_desktop_protocol_enabled = True,
)

result = await graph_client.service_principals.by_service_principal_id('servicePrincipal-id').remote_desktop_security_configuration.patch(request_body)

Importante

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.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.remoteDesktopSecurityConfiguration",
  "id": "ca738153-c98a-f822-a7d1-5a6e1058462b",
  "isRemoteDesktopProtocolEnabled": true
}

Compartilhar via

Atualizar remoteDesktopSecurityConfiguration

Permissões

Solicitação HTTP

Cabeçalhos de solicitação

Corpo da solicitação

Resposta

Exemplos

Solicitação

Resposta

Comentários

Comentários

Recursos adicionais