Mendapatkan metadata perjanjian untuk Perjanjian Pelanggan Microsoft

  • Artikel

Berlaku untuk: Pusat Mitra

Tidak berlaku untuk: Pusat Mitra yang dioperasikan oleh 21Vianet | Pusat Mitra untuk Microsoft Cloud untuk Pemerintah AS

Metadata perjanjian untuk Perjanjian Pelanggan Microsoft saat ini hanya didukung oleh Pusat Mitra di cloud publik Microsoft.

Anda harus mengambil metadata perjanjian untuk Perjanjian Pelanggan Microsoft sebelum dapat:

Prasyarat

  • Jika Anda menggunakan Pusat Mitra .NET SDK, diperlukan versi 1.14 atau yang lebih baru.

    Penting

    Pada Juni 2023, Pusat Mitra terbaru .NET SDK rilis 3.4.0 sekarang diarsipkan. Anda dapat mengunduh rilis SDK dari GitHub, bersama dengan file readme yang berisi informasi yang berguna.

    Mitra didorong untuk terus menggunakan REST API Pusat Mitra.

  • Kredensial seperti yang dijelaskan dalam autentikasi Pusat Mitra. Skenario ini hanya mendukung autentikasi Aplikasi+Pengguna.

.NET (versi 1.14 atau yang lebih baru)

Untuk mengambil metadata perjanjian untuk Perjanjian Pelanggan Microsoft:

  1. Pertama, ambil koleksi IAggregatePartner.AgreementDetails .

  2. Panggil metode ByAgreementType untuk memfilter koleksi ke Perjanjian Pelanggan Microsoft.

  3. Terakhir, panggil metode Get atau GetAsync .

// IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCustomerAgreement";

var microsoftCustomerAgreementDetails = partnerOperations.AgreementDetails.ByAgreementType(agreementType).Get().Items.Single();

Sampel lengkap dapat ditemukan di kelas GetAgreementDetails dari proyek aplikasi pengujian konsol.

Permintaan REST

Untuk mengambil metadata perjanjian untuk Perjanjian Pelanggan Microsoft:

  1. Buat permintaan REST untuk mengambil koleksi AgreementMetaData .

  2. Gunakan parameter kueri agreementType untuk mencakup hasil hanya ke Perjanjian Pelanggan Microsoft.

Minta sintaks

Metode URI Permintaan
GET {baseURL}/v1/agreements?agreementType={agreement-type} HTTP/1.1

Parameter URI

Gunakan parameter URI berikut dengan permintaan Anda:

Nama Tipe Diperlukan Deskripsi
jenis perjanjian string No Gunakan parameter ini untuk mencakup respons kueri terhadap jenis perjanjian tertentu. Nilai yang didukung adalah:

MicrosoftCloudAgreement yang menyertakan metadata perjanjian hanya dari jenis MicrosoftCloudAgreement

MicrosoftCustomerAgreement yang menyertakan metadata perjanjian hanya dari jenis MicrosoftCustomerAgreement.

* yang mengembalikan semua metadata perjanjian. (Jangan gunakan * kecuali kode Anda memiliki logika runtime yang diperlukan untuk menangani jenis perjanjian yang tidak dikenal karena Microsoft mungkin memperkenalkan metadata perjanjian dengan jenis perjanjian baru kapan saja.)

Catatan: Jika parameter URI tidak ditentukan, kueri default ke MicrosoftCloudAgreement untuk kompatibilitas mundur.

Header permintaan

Untuk informasi selengkapnya, lihat Header REST Pusat Mitra.

Isi permintaan

Tidak ada.

Contoh permintaan

GET https://api.partnercenter.microsoft.com/v1/agreements?agreementType=MicrosoftCustomerAgreement HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: ab993325-1605-4cf4-bac4-fb584142a31b

Respons REST

Jika berhasil, metode ini mengembalikan kumpulan sumber daya AgreementMetaData dalam isi respons.

Kode kesalahan dan keberhasilan respons

Setiap respons dilengkapi dengan kode status HTTP yang menunjukkan keberhasilan atau kegagalan dan informasi penelusuran kesalahan lainnya.

Gunakan alat pelacakan jaringan untuk membaca kode ini, jenis kesalahan, dan parameter lainnya. Untuk daftar lengkapnya, lihat Kode kesalahan REST Pusat Mitra.

Contoh tanggapan

HTTP/1.1 200 OK
Content-Length: 620
Content-Type: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: ab993325-1605-4cf4-bac4-fb584142a31b
{
    "totalCount": 1,
    "items": [
        {
            "templateId": "117a77b0-9360-443b-8795-c6dedc750cf9",
            "agreementType": "MicrosoftCustomerAgreement",
            "agreementLink": "https://aka.ms/customeragreement",
            "versionRank": 0
        }
    ],
    "attributes": {
        "objectType": "Collection"
    }
}