Partilhar via

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

  • Artigo

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

Como obter informações de análise de subscrição para os seus clientes filtradas por uma consulta de pesquisa.

Pré-requisitos

  • Credenciais conforme descrito na autenticação do Partner Center. Este cenário suporta autenticação apenas com credenciais de Utilizador.

Pedido REST

Sintaxe da solicitação

Método URI do pedido
GET {baseURL}/partner/v1/analytics/subscriptions?filter={filter_string}

Parâmetros de URI

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

Nome Type Obrigatório Description
filter_string string Sim O filtro a ser aplicado à análise de assinatura. Consulte as seções Sintaxe de filtro e Campos de filtro para obter a sintaxe, os campos e os operadores a serem usados nesse parâmetro.

Sintaxe do 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 esta aparência:

  • String: ?filter=Field operator 'Value'
  • Booleano: ?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 or ne . Alguns campos também suportam os containsoperadores , , , ge, gtlte le . As instruções podem ser combinadas usando and operadores or or .

Seguem-se 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 suportados 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 Description
autoRenewEnabled eq, ne Um valor que indica se a subscrição é renovada automaticamente.
compromissoData-limite eq, , , , ge, negtltle A data de término da assinatura.
criaçãoData de criação eq, , , , ge, negtltle A data em que a subscrição foi criada.
currentStateEndDate eq, , , , ge, negtltle 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.
nome_do_cliente contains O nome do cliente.
customerTenantId eq, ne Uma cadeia de caracteres formatada em GUID que identifica o locatário do cliente.
data de desprovisionamento eq, , , , ge, negtltle A data em que a subscrição foi desprovisionada. O valor padrão é null.
effectiveStartDate eq, , , , ge, negtltle A data de início da subscrição.
friendlyNome contains O nome da assinatura.
id eq, ne Uma cadeia de caracteres formatada em GUID que identifica a assinatura.
lastRenewalDate eq, , , , ge, negtltle A data em que a subscrição foi renovada pela última vez. O valor padrão é null.
lastUsageDate eq, , , , ge, negtltle A data em que a assinatura foi usada pela última vez. O valor padrão é null.
ID do parceiro 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.
Nome do parceiro string Nome do parceiro para o qual a subscrição foi adquirida
productName contains, , eqne O nome do produto.
nomedoprovedor string Quando a transação de assinatura é para o revendedor indireto, o nome do provedor é o provedor indireto que comprou a assinatura.
estado eq, ne O estado da subscrição. Os valores suportados são: ATIVE, SUSPENDEDou DEPROVISIONED.
tipo de subscrição 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.
trialStartDate eq, , , , ge, negtltle A data de início do período de avaliação da subscrição. O valor padrão é null.
trialToPaidConversionDate eq, , , , ge, negtltle A data em que a subscrição é convertida de versão experimental para paga. O valor padrão é null.

Cabeçalhos do pedido

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

Corpo do pedido

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 do REST

Se bem-sucedida, o corpo da resposta contém uma coleção de recursos de Assinatura que atendem aos critérios de filtro.

Códigos de sucesso e 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, consulte 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": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
    "customerName": "SURFACE TEST2",
    "customerMarket": "US",
    "id": "B76412DA-D382-4688-A6A4-711A207C1C2E",
    "status": "ACTIVE",
    "productName": "UNKNOWN",
    "subscriptionType": "Azure",
    "autoRenewEnabled": true,
    "partnerId": "bbbbcccc-1111-dddd-2222-eeee3333ffff",
    "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
}

Consulte também