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.
Obtenha os detalhes de um ficheiro de contrato, incluindo o idioma e as informações da versão. O ficheiro predefinido pode ter várias versões, cada uma com o seu próprio idioma, que podem ser obtidas ao especificar o cabeçalho Accept-Language .
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) |
Agreement.Read.All |
Agreement.ReadWrite.All |
| Delegado (conta pessoal da Microsoft) |
Sem suporte. |
Sem suporte. |
| Aplicativo |
Sem suporte. |
Sem suporte. |
Importante
Em cenários delegados com contas escolares ou profissionais, tem de ser atribuída uma função de Microsoft Entra suportada ao utilizador com sessão iniciada.
O Leitor de Segurança é a função com menos privilégios suportada para esta operação. Mais funções com privilégios suportadas para esta operação: Leitor Global, Administrador de Acesso Condicional, Administrador de Segurança.
Solicitação HTTP
GET /agreements/{agreementsId}/file
Parâmetros de consulta opcionais
Este método não suporta parâmetros de consulta OData para ajudar a personalizar a resposta. Para obter informações gerais, acesse Parâmetros de consulta OData.
Corpo da solicitação
Não forneça um corpo de solicitação para esse método.
Resposta
Se for bem-sucedido, este método devolve um 200 OK código de resposta e uma coleção de objetos agreementFile no corpo da resposta.
Exemplos
Exemplo 1: Obter o ficheiro de contrato predefinido
Solicitação
GET https://graph.microsoft.com/beta/identityGovernance/termsOfUse/agreements/94410bbf-3d3e-4683-8149-f034e55c39dd/file
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.IdentityGovernance.TermsOfUse.Agreements["{agreement-id}"].File.GetAsync();
// 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"
//other-imports
)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
file, err := graphClient.IdentityGovernance().TermsOfUse().Agreements().ByAgreementId("agreement-id").File().Get(context.Background(), nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
AgreementFile result = graphClient.identityGovernance().termsOfUse().agreements().byAgreementId("{agreement-id}").file().get();
const options = {
authProvider,
};
const client = Client.init(options);
let agreementFile = await client.api('/identityGovernance/termsOfUse/agreements/94410bbf-3d3e-4683-8149-f034e55c39dd/file')
.version('beta')
.get();
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$result = $graphServiceClient->identityGovernance()->termsOfUse()->agreements()->byAgreementId('agreement-id')->file()->get()->wait();
Import-Module Microsoft.Graph.Beta.Identity.Governance
Get-MgBetaIdentityGovernanceTermsOfUseAgreementFile -AgreementId $agreementId
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
result = await graph_client.identity_governance.terms_of_use.agreements.by_agreement_id('agreement-id').file.get()
Resposta
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/termsOfUse/agreements('94410bbf-3d3e-4683-8149-f034e55c39dd')/file/$entity",
"@odata.type": "#microsoft.graph.agreementFileLocalization",
"id": "08033369-8972-42a3-8533-90bbd2757a01",
"fileName": "TOU.pdf",
"displayName": "Contoso ToU for guest users",
"language": "en",
"isDefault": true,
"isMajorVersion": false,
"createdDateTime": "2022-03-04T13:14:13.9361722Z",
"fileData": null
}
Exemplo 2: Obter o ficheiro de contrato para um idioma específico
Solicitação
O exemplo seguinte mostra como obter o ficheiro de contrato para o fr-FR idioma. Se não existir nenhum ficheiro de contrato, é devolvido o ficheiro de contrato predefinido.
GET https://graph.microsoft.com/beta/agreements/94410bbf-3d3e-4683-8149-f034e55c39dd/file
Accept-Language: fr-FR
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Agreements["{agreement-id}"].File.GetAsync((requestConfiguration) =>
{
requestConfiguration.Headers.Add("Accept-Language", "fr-FR");
});
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
abstractions "github.com/microsoft/kiota-abstractions-go"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphagreements "github.com/microsoftgraph/msgraph-beta-sdk-go/agreements"
//other-imports
)
headers := abstractions.NewRequestHeaders()
headers.Add("Accept-Language", "fr-FR")
configuration := &graphagreements.ItemFileRequestBuilderGetRequestConfiguration{
Headers: headers,
}
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
file, err := graphClient.Agreements().ByAgreementId("agreement-id").File().Get(context.Background(), configuration)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
AgreementFile result = graphClient.agreements().byAgreementId("{agreement-id}").file().get(requestConfiguration -> {
requestConfiguration.headers.add("Accept-Language", "fr-FR");
});
const options = {
authProvider,
};
const client = Client.init(options);
let agreementFile = await client.api('/agreements/94410bbf-3d3e-4683-8149-f034e55c39dd/file')
.version('beta')
.header('Accept-Language','fr-FR')
.get();
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Agreements\Item\File\FileRequestBuilderGetRequestConfiguration;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestConfiguration = new FileRequestBuilderGetRequestConfiguration();
$headers = [
'Accept-Language' => 'fr-FR',
];
$requestConfiguration->headers = $headers;
$result = $graphServiceClient->agreements()->byAgreementId('agreement-id')->file()->get($requestConfiguration)->wait();
Import-Module Microsoft.Graph.Beta.Identity.Governance
Get-MgBetaAgreementFile -AgreementId $agreementId
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.agreements.item.file.file_request_builder import FileRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_configuration = RequestConfiguration()
request_configuration.headers.add("Accept-Language", "fr-FR")
result = await graph_client.agreements.by_agreement_id('agreement-id').file.get(request_configuration = request_configuration)
Resposta
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#agreements('94410bbf-3d3e-4683-8149-f034e55c39dd')/file/$entity",
"@odata.type": "#microsoft.graph.agreementFileLocalization",
"id": "90d1723c-52c1-40e3-a51a-da99a82c0327",
"fileName": "Contoso ToU for guest users (French)",
"displayName": "Contoso ToU for guest users (French)",
"language": "fr-FR",
"isDefault": false,
"isMajorVersion": false,
"createdDateTime": "2022-03-04T14:38:22.8292386Z",
"fileData": null
}