다음을 통해 공유


검색 쿼리로 필터링된 구독 분석 정보 가져오기

에 적용됨 : 파트너 센터 | 21Vianet에서 운영하는 파트너 센터 | 미국 정부용 Microsoft 클라우드의 파트너 센터

검색 쿼리로 필터링된 고객에 대한 구독 분석 정보를 가져오는 방법입니다.

필수 구성 요소

  • 자격 증명은 파트너 센터 인증에 설명된 대로입니다. 이 시나리오에서는 사용자 자격 증명으로만 인증을 지원합니다.

REST 요청

요청 구문

메서드 요청 URI
가져오기 {baseURL}/partner/v1/analytics/subscriptions?filter={filter_string}

URI 매개 변수

다음 필수 경로 매개 변수를 사용하여 조직을 식별하고 검색을 필터링합니다.

이름 유형 필수 묘사
필터 문자열 문자열 구독 분석에 적용할 필터입니다. 이 매개 변수에 사용할 구문, 필드 및 연산자는 필터 구문 및 필터 필드 섹션을 참조하세요.

필터 구문

필터 매개 변수는 일련의 필드, 값 및 연산자 조합으로 구성되어야 합니다. and 또는 or 연산자를 사용하여 여러 조합을 결합할 수 있습니다.

인코딩되지 않은 예제는 다음과 같습니다.

  • 문자열: ?filter=Field operator 'Value'
  • 부울: ?filter=Field operator Value
  • ?filter=contains(field,'value')를 포함하고 있습니다.

필터 필드

요청의 필터 매개 변수에는 응답의 행을 필터링하는 하나 이상의 문이 포함되어 있습니다. 각 문에는 eq 또는 ne 연산자와 연결된 필드와 값이 포함됩니다. 일부 필드는 contains, gt, lt, gele 연산자도 지원합니다. 문은 and 또는 or 연산자를 사용하여 결합할 수 있습니다.

다음은 필터 문자열의 예입니다.

autoRenewEnabled eq true

autoRenewEnabled eq true and customerMarket eq 'US'

다음 표에서는 필터 매개 변수에 대해 지원되는 필드 및 지원 연산자 목록을 보여줍니다. 문자열 값은 작은따옴표로 묶어야 합니다.

매개 변수 지원되는 연산자 묘사
자동 갱신 사용 설정 eq, ne 구독이 자동으로 갱신되는지 여부를 나타내는 값입니다.
약정 종료일 eq, ne, gt, lt, ge, le 구독이 종료되는 날짜입니다.
생성일 eq, ne, gt, lt, ge, le 구독을 만든 날짜입니다.
현재상태종료날짜 eq, ne, gt, lt, ge, le 구독의 현재 상태가 변경되는 날짜입니다.
고객 시장 eq, ne 고객이 비즈니스를 수행하는 국가/지역입니다.
고객 이름 contains 고객의 이름입니다.
고객테넌트ID eq, ne 고객 테넌트를 식별하는 GUID 형식 문자열입니다.
deprovisionedDate eq, ne, gt, lt, ge, le 구독 프로비전을 해제한 날짜입니다. 기본값은 null입니다.
유효 시작일 eq, ne, gt, lt, ge, le 구독이 시작되는 날짜입니다.
친숙한 이름 contains 구독의 이름입니다.
아이디 eq, ne 구독을 식별하는 GUID 형식 문자열입니다.
마지막 갱신일 eq, ne, gt, lt, ge, le 구독이 마지막으로 갱신된 날짜입니다. 기본값은 null입니다.
마지막 사용 날짜 eq, ne, gt, lt, ge, le 구독이 마지막으로 사용된 날짜입니다. 기본값은 null입니다.
partnerId eq, ne PartnerID입니다. 직접 재판매인의 경우 이 값은 파트너의 PartnerID입니다. 간접 재판매인의 경우 이 값은 간접 재판매인의 PartnerID입니다.
partnerName 문자열 구독을 구매한 파트너의 이름
productName contains, eq, ne 제품의 이름입니다.
제공자이름 문자열 간접 재판매인에 대한 구독 트랜잭션인 경우 공급자 이름은 구독을 구입한 간접 공급자입니다.
상태 eq, ne 구독 상태입니다. 지원되는 값은 ACTIVE, SUSPENDED또는 DEPROVISIONED.
구독 유형 eq, ne 구독 유형입니다. 참고: 이 필드는 대/소문자를 구분합니다. 지원되는 값은 Office, Azure, Microsoft365, Dynamics, EMS.
시험 시작일 eq, ne, gt, lt, ge, le 구독의 평가판 기간이 시작된 날짜입니다. 기본값은 null입니다.
체험에서 유료 전환 날짜 eq, ne, gt, lt, ge, le 구독이 평가판에서 유료로 변환되는 날짜입니다. 기본값은 null입니다.

요청 헤더

자세한 내용은 파트너 센터 REST 헤더 참조하세요.

요청 본문

없음.

요청 예제

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

REST 응답

성공하면 응답 본문에는 필터 조건을 충족하는 구독 리소스 컬렉션이 포함됩니다.

응답 성공 및 오류 코드

각 응답에는 성공 또는 실패 및 디버깅 정보를 나타내는 HTTP 상태 코드가 함께 제공됩니다. 네트워크 추적 도구를 사용하여 이 코드, 오류 유형 및 기타 매개 변수를 읽습니다. 전체 목록은 오류 코드참조하세요.

응답 예제

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
}

참고 항목