Compartilhar via

Obter informações de análise de assinatura filtradas por uma consulta de pesquisa

  • Artigo

Aplica-se a: Partner Center | Partner Center operado pela 21Vianet | Partner Center para o Microsoft Cloud for US Government

Como obter informações de análise de assinatura para seus clientes filtradas por uma consulta de pesquisa.

Pré-requisitos

Solicitação REST

Sintaxe da solicitação

Método URI da solicitação
GET {baseURL}/partner/v1/analytics/subscriptions?filter={filter_string}

Parâmetros do URI

Use o seguinte parâmetro de caminho necessário para identificar sua organização e filtrar a pesquisa.

Nome Digitar Obrigatória Descrição
filter_string string Sim O filtro a ser aplicado à análise de assinatura. Consulte as seções Sintaxe do filtro e Campos de filtro para obter a sintaxe, os campos e os operadores a serem usados neste parâmetro.

Sintaxe de filtro

O parâmetro filter deve ser composto como uma série de combinações de campo, valor e operador. Várias combinações podem ser combinadas usando and operadores OR or .

Um exemplo não codificado tem a seguinte aparência:

  • Cadeia de caracteres: ?filter=Field operator 'Value'
  • Booliano: ?filter=Field operator Value
  • Contém ?filter=contains(field,'value')

Filtrar campos

O parâmetro filter da solicitação contém uma ou mais instruções que filtram as linhas na resposta. Cada instrução contém um campo e um valor associados aos eq operadores ou ne . Alguns campos também oferecem suporte aos containsoperadores , , , , gegtlte .le As instruções podem ser combinadas usando and operadores OR or .

A seguir estão exemplos de cadeias de caracteres de filtro:

autoRenewEnabled eq true

autoRenewEnabled eq true and customerMarket eq 'US'

A tabela a seguir mostra uma lista dos campos com suporte e operadores de suporte para o parâmetro filter. Os valores de cadeia de caracteres devem ser cercados por aspas simples.

Parâmetro Operadores suportados Descrição
autoRenewEnabled eq, ne Um valor que indica se a assinatura é renovada automaticamente.
compromissoData de término do compromisso eq, , , , ne, gtltgele A data em que a assinatura termina.
creationDate eq, , , , ne, gtltgele A data em que a assinatura foi criada.
currentStateEndDate eq, , , , ne, gtltgele A data em que o status atual da assinatura será alterado.
clienteMercado eq, ne O país/região em que o cliente faz negócios.
customerName contains O nome do cliente.
customerTenantId eq, ne Uma cadeia de caracteres formatada em GUID que identifica o locatário do cliente.
desprovisionadoData eq, , , , ne, gtltgele A data em que a assinatura foi desprovisionada. O valor padrão é nulo.
effectiveStartDate eq, , , , ne, gtltgele A data de início da assinatura.
friendlyName contains O nome da assinatura.
ID eq, ne Uma cadeia com formato de GUID que identifica a assinatura.
últimoData de renovação eq, , , , ne, gtltgele A data em que a assinatura foi renovada pela última vez. O valor padrão é nulo.
lastUsageDate eq, , , , ne, gtltgele A data em que a assinatura foi usada pela última vez. O valor padrão é nulo.
partnerId eq, ne O PartnerID. Para um revendedor direto, esse valor é o PartnerID do parceiro. Para um revendedor indireto, esse valor é o PartnerID do revendedor indireto.
partnerName string Nome do parceiro para o qual a assinatura foi comprada
productName contains, eq, ne O nome do produto.
nome_do_provedor string Quando a transação de assinatura é para o revendedor indireto, o nome do provedor é o provedor indireto que comprou a assinatura.
status eq, ne O status da assinatura. Os valores suportados são: ACTIVE, SUSPENDEDou DEPROVISIONED.
tipo de assinatura eq, ne O tipo de assinatura. Nota: Este campo diferencia maiúsculas de minúsculas. Os valores suportados são: Office, Azure, Microsoft365, Dynamics, EMS.
AvaliaçãoData de início eq, , , , ne, gtltgele A data em que o período de avaliação da assinatura começou. O valor padrão é nulo.
trialToPaidConversionDate eq, , , , ne, gtltgele A data em que a assinatura é convertida de avaliação para paga. O valor padrão é nulo.

Cabeçalhos da solicitação

Para obter mais informações, confira Cabeçalhos REST do Partner Center.

Corpo da solicitação

Nenhum.

Exemplo de solicitação

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/subscriptions?filter=autoRenewEnabled eq true
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
Content-Type: application/json
Content-Length: 0

Resposta REST

Se for bem-sucedido, o corpo da resposta conterá uma coleção de recursos de Assinatura que atendem aos critérios de filtro.

Códigos de êxito e de erro de resposta

Cada resposta vem com um código de status HTTP que indica sucesso ou falha e informações de depuração. Use uma ferramenta de rastreamento de rede para ler esse código, tipo de erro e outros parâmetros. Para obter a lista completa, confira Códigos de Erro.

Exemplo de resposta

HTTP/1.1 200 OK
Content-Length: 177
Content-Type: application/json; charset=utf-8
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: aaaa0000-bb11-2222-33cc-444444dddddd

{
    "customerTenantId": "735920EB-A564-4C72-9FE5-52632562712C",
    "customerName": "SURFACE TEST2",
    "customerMarket": "US",
    "id": "B76412DA-D382-4688-A6A4-711A207C1C2E",
    "status": "ACTIVE",
    "productName": "UNKNOWN",
    "subscriptionType": "Azure",
    "autoRenewEnabled": true,
    "partnerId": "3B33E682-00C3-41EE-9DD2-A548ADF56438",
    "friendlyName": "MICROSOFT AZURE",
    "creationDate": "2017-06-02T23:11:58.747",
    "effectiveStartDate": "2017-06-02T00:00:00",
    "commitmentEndDate": null,
    "currentStateEndDate": null,
    "trialToPaidConversionDate": null,
    "trialStartDate": null,
    "trialEndDate": null,
    "lastUsageDate": null,
    "deprovisionedDate": null,
    "lastRenewalDate": null,
    "licenseCount": 0
}

Confira também