Compartilhar via

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

Aplica-se a: Partner Center | Partner Center operado pela 21Vianet | Partner Center para 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 de solicitação

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

Parâmetros de URI

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

Nome Tipo Necessário Descrição
filter_string cadeia de caracteres Sim O filtro a ser aplicado nas análises de assinaturas. Consulte as seções Sintaxe de Filtro e Campos de Filtro para a sintaxe, campos e operadores a serem usados neste parâmetro.

Sintaxe de filtro

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

Um exemplo não codificado tem esta 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 de filtro 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 operadores eq ou ne. Alguns campos também dão suporte aos operadores contains, gt, lt, gee le. Declarações podem ser combinadas usando operadores and ou or.

Veja a seguir 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 de filtro. Os valores de cadeia de caracteres devem estar delimitados por aspas simples.

Parâmetro Operadores com suporte Descrição
autoRenewEnabled eq, ne Um valor que indica se a assinatura é renovada automaticamente.
commitmentEndDate eq, ne, gt, lt, , gele A data em que a assinatura termina.
data de criação eq, ne, gt, lt, , gele A data em que a assinatura foi criada.
currentStateEndDate eq, ne, gt, lt, , gele A data em que o status atual da assinatura será alterado.
marketMarket eq, ne O país/região em que o cliente faz negócios.
nomeDoCliente contains O nome do cliente.
customerTenantId eq, ne Uma cadeia de caracteres formatada por GUID que identifica o locatário do cliente.
data desprovisionada eq, ne, gt, lt, , gele A data em que a assinatura foi desprovisionada. O valor padrão é nulo.
data de início efetiva eq, ne, gt, lt, , gele A data em que a assinatura é iniciada.
nome amigável contains O nome da assinatura.
id eq, ne Uma cadeia de caracteres formatada por GUID que identifica a assinatura.
data da última renovação eq, ne, gt, lt, , gele A data em que a assinatura foi renovada pela última vez. O valor padrão é nulo.
data_de_uso_passado eq, ne, gt, lt, , gele A data em que a assinatura foi usada pela última vez. O valor padrão é nulo.
partnerId eq, ne O ID do Parceiro. Para um revendedor direto, esse valor é o PartnerID do parceiro. Para um revendedor indireto, esse valor é o PartnerID do revendedor indireto.
Nome do Parceiro cadeia de caracteres Nome do parceiro para o qual a assinatura foi comprada
NomeDoProduto contains, , eqne O nome do produto.
nomeDoProvedor cadeia de caracteres 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 status da assinatura. Os valores com suporte são: ATIVO, SUSPENSOou DESPROVISIONADO.
tipo de assinatura eq, ne O tipo de assinatura. Observação: esse campo diferencia maiúsculas de minúsculas. Os valores com suporte são: Office, Azure, Microsoft365, Dynamics, EMS.
trialStartDate eq, ne, gt, lt, , gele A data em que o período de avaliação da assinatura foi iniciado. O valor padrão é nulo.
trialToPaidConversionDate eq, ne, gt, lt, , gele 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 contém uma coleção de recursos Assinatura que atendem aos critérios de filtro.

Códigos de erro e êxito de resposta

Cada resposta vem com um código de status HTTP que indica êxito ou falha e também inclui informações de depuração. Use uma ferramenta de rastreamento de rede para ler este 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

  • Last updated on