A Microsoft Ügyfélszerződés sablon letöltési hivatkozásának lekérése

Cikk
03/05/2024

A következőre vonatkozik: Partnerközpont

Nem vonatkozik a 21Vianet által üzemeltetett Partnerközpontra | Partnerközpont a Microsoft Cloud for US Government számára

A AgreementDocument erőforrást a Partnerközpont jelenleg csak a Microsoft nyilvános felhőjében támogatja.

Ez a cikk azt ismerteti, hogyan töltheti le a Microsoft Ügyfélszerződés sablont az ügyfél országa/régiója és nyelve alapján.

Előfeltételek

Ha a Partnerközpont .NET SDK-t használja, az 1.14-es vagy újabb verzióra van szükség.

Fontos

2023 júniusától a partnerközpont .NET SDK legújabb, 3.4.0-s kiadását archiváljuk. Az SDK-kiadást letöltheti a GitHubról, valamint egy hasznos információkat tartalmazó olvasófájlt.

A partnereket arra ösztönzik, hogy továbbra is használják a Partnerközpont REST API-jait.
Hitelesítő adatok a Partnerközpont hitelesítésében leírtak szerint. Ez a forgatókönyv csak az App+User hitelesítést támogatja.
Az ügyfél országa/régiója, amelyre a Microsoft Ügyfélszerződés sablon vonatkozik.
Az a nyelv, amelyben a Microsoft Ügyfélszerződés-sablont honosítjuk.

Fontos

A Microsoft Ügyfélszerződés ország-/régióspecifikus. Amikor a Microsoft Ügyfélszerződés sablon letöltésére mutató hivatkozást kér, mindenképpen adja meg a megfelelő országot/régiót az ügyfél helye alapján. vagy a támogatott országok/régiók listája, tekintse meg a támogatott országok/régiók és nyelvek listáját.
Egyes országokban/régiókban a Microsoft Ügyfélszerződés több nyelven is elérhető. A legjobb ügyfélélmény érdekében válassza ki az ügyfél igényeinek leginkább megfelelő nyelvet. A támogatott nyelvek listáját a támogatott országok/régiók és nyelvek listájában találja.
Ez a módszer csak a Microsoft Ügyfélszerződés támogatott.

.NET

A Microsoft Ügyfélszerződés-sablon letöltésére szolgáló hivatkozás lekérése:

Kérje le a szerződés metaadatait a Microsoft Ügyfélszerződés. Be kell szereznie a Microsoft Ügyfélszerződés sablonazonosítóját. További információ: Szerződés metaadatainak lekérése Microsoft Ügyfélszerződés.

// IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCustomerAgreement";

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

Használja az IAggregatePartner.AgreementTemplates gyűjteményt.
Hívja meg a ById metódust, és adja meg a Microsoft Ügyfélszerződés sablonazonosítóját.
A Dokumentum tulajdonság beolvasása.
Hívja meg a ByCountry metódust, és adja meg az ügyfél országát/régióját, amelyre a szerződéssablon vonatkozik. Ha a metódus nincs megadva, a lekérdezés alapértelmezés szerint az USA-ba lesz bekapcsolva. A támogatott ország-/régiókódok listájáért tekintse meg a támogatott országok/régiók és nyelvek listáját. Ez a módszer megkülönbözteti a kis- és nagybetűk használatát.
Hívja meg a ByLanguage metódust , és adja meg azt a nyelvet, amelyben a szerződéssablont honosítani kell. A lekérdezés alapértelmezés szerint az EN-US lesz, ha a metódus nincs megadva, vagy ha a megadott ország/régió kódja nem támogatott a megadott ország/régió esetében. A támogatott nyelvi kódok listájáért tekintse meg a támogatott országok/régiók és nyelvek listáját.

Hívja meg a Get vagy a GetAsync metódust.

// IAggregatePartner partnerOperations;

string customerCountry = "US";

string languageForLocalization = "en-US";

var agreementDocument = partnerOperations.   AgreementTemplates.ById   (microsoftCustomerAgreementDetails.   TemplateId).Document.ByCountry   (customerCountry).ByLanguage   (languageForLocalization).Get();

Teljes minta található a GetAgreementDetails osztályban a konzoltesztelési alkalmazás projektjéből.

REST-kérés

A Microsoft Ügyfélszerződés-sablon letöltésére szolgáló hivatkozás lekérése:

Kérje le a szerződés metaadatait a Microsoft Ügyfélszerződés. Be kell szereznie a Microsoft Ügyfélszerződés sablonazonosítóját. További információ: Szerződés metaadatainak lekérése Microsoft Ügyfélszerződés.
Hozzon létre egy REST-kérést egy AgreementDocument-erőforrás lekéréséhez. Példaként tekintse meg a kérés szintaxisát . A következő adatokat kell megadnia:
- A Microsoft Ügyfélszerződés sablonazonosítója
- Az az ország/régió, amelyre a Microsoft Ügyfélszerződés sablon vonatkozik
- Az a nyelv, amelyben a Microsoft Ügyfélszerződés-sablon honosítandó

Kérés szintaxisa

Használja az erőforrás következő kérésszintaxisát:

Metódus	Kérés URI-ja
KAP	{baseURL}/v1/agreementtemplates/{agreement-template-id}/document?language={language}&country={country} HTTP/1.1

URI-paraméterek

A kéréshez a következő URI-paramétereket használhatja:

Név	Típus	Kötelező	Leírás
szerződés-sablon azonosítója	sztring	Igen	A szerződéstípus egyedi azonosítója. A Microsoft Ügyfélszerződés sablonazonosítóját a szerződés metaadatainak lekérésével szerezheti be Microsoft Ügyfélszerződés. További információ: Szerződés metaadatainak lekérése Microsoft Ügyfélszerződés. Ez a paraméter megkülönbözteti a kis- és nagybetűk értékét.
Ország	húr	Nem	Azt az országot/régiót jelzi, amelyre a szerződéssablon vonatkozik. Ha a paraméter nincs megadva, a lekérdezés alapértelmezés szerint az USA-ba lesz bekapcsolva. A támogatott ország-/régiókódok listájáért tekintse meg a támogatott országok/régiók és nyelvek listáját.
language	húr	Nem	Azt a nyelvet jelzi, amelyben a szerződéssablont honosítanák. A lekérdezés alapértelmezés szerint az EN-US lesz, ha a paraméter nincs megadva, vagy ha a megadott ország/régió kódja nem támogatott a megadott országban vagy régióban. A támogatott ország-/régiókódok listáját a támogatott országok/régiók és nyelvek listájában találja.

Kérésfejlécek

További információ: Partnerközpont – REST fejlécek.

Kérés törzse

Nincs.

Példa kérése

GET https://api.partnercenter.microsoft.com/v1/agreementtemplates/117a77b0-9360-443b-8795-c6dedc750cf9/document?language=en-US&country=US HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: ab993325-1605-4cf4-bac4-fb584142a31b

REST-válasz

Ha sikeres, ez a metódus egy AgreementDocument-erőforrást ad vissza a válasz törzsében.

Az erőforrás rendelkezik egy downloadUri tulajdonsággel, amely egy URL-sztringet tartalmaz, amely a szerződéssablon letöltéséhez használható. Minden lekérdezéskor egy másik hivatkozás lesz visszaadva. Ez a hivatkozás öt perc elteltével lejár.

Válasz sikeresség és hibakódok

Minden válaszhoz tartozik egy HTTP-állapotkód, amely jelzi a sikert vagy a hibát, valamint egyéb hibakeresési információkat.

A kód, hibatípus és egyéb paraméterek olvasásához használjon hálózati nyomkövetési eszközt. A teljes listát a Partnerközpont REST-hibakódjaiban találja.

Példa válaszra

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
{
    "displayUri":"https://wopihost.int.l2o.microsoft.com/v1/officehost/agreement/files/Preview...",
    "downloadUri":"https://l2oagreementintbn2.blob.core.windows.net/agreementscontainer/Preview...",
    "language":"en-US",
    "country":"US"
}

Támogatott országok/régiók és nyelvek listája