Redeem Invitation Code - Redeem Invitation Code

Szolgáltatás:

Education

API-verzió:

2021-12-01-preview

Kód beváltása beváltható tesztkörnyezethez való csatlakozáshoz

POST https://management.azure.com/providers/Microsoft.Education/redeemInvitationCode?api-version=2021-12-01-preview

URI-paraméterek

Name	In	Kötelező	Típus	Description
api-version	query	True	string	Az ügyfélkéréshez használandó API verziója. A jelenlegi verzió: 2021-12-01-preview

Kérelem törzse

Name	Kötelező	Típus	Description
firstName	True	string	a kérelmező utóneve
lastName	True	string	a kérelmező vezetékneve
redeemCode	True	string	kód beváltása

Válaszok

Name	Típus	Description
200 OK		beváltott kód
Other Status Codes	ErrorResponseBody	Azt a hibát írja le, ha a művelet nem sikeres.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

RedeemCode

Mintakérelem

HTTP

POST https://management.azure.com/providers/Microsoft.Education/redeemInvitationCode?api-version=2021-12-01-preview

{
  "redeemCode": "exampleRedeemCode",
  "firstName": "test",
  "lastName": "user"
}

Java

import com.azure.resourcemanager.education.models.RedeemRequest;

/**
 * Samples for ResourceProvider RedeemInvitationCode.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/education/resource-manager/Microsoft.Education/preview/2021-12-01-preview/examples/RedeemCode.json
     */
    /**
     * Sample code: RedeemCode.
     * 
     * @param manager Entry point to EducationManager.
     */
    public static void redeemCode(com.azure.resourcemanager.education.EducationManager manager) {
        manager.resourceProviders().redeemInvitationCodeWithResponse(
            new RedeemRequest().withRedeemCode("fakeTokenPlaceholder").withFirstName("test").withLastName("user"),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.education import EducationManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-education
# USAGE
    python redeem_code.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = EducationManagementClient(
        credential=DefaultAzureCredential(),
    )

    response = client.redeem_invitation_code(
        parameters={"firstName": "test", "lastName": "user", "redeemCode": "exampleRedeemCode"},
    )
    print(response)


# x-ms-original-file: specification/education/resource-manager/Microsoft.Education/preview/2021-12-01-preview/examples/RedeemCode.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armeducation_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/education/armeducation"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b9b91929c304f8fb44002267b6c98d9fb9dde014/specification/education/resource-manager/Microsoft.Education/preview/2021-12-01-preview/examples/RedeemCode.json
func ExampleManagementClient_RedeemInvitationCode() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armeducation.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewManagementClient().RedeemInvitationCode(ctx, armeducation.RedeemRequest{
		FirstName:  to.Ptr("test"),
		LastName:   to.Ptr("user"),
		RedeemCode: to.Ptr("exampleRedeemCode"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { EducationManagementClient } = require("@azure/arm-education");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Redeem invite code to join a redeemable lab
 *
 * @summary Redeem invite code to join a redeemable lab
 * x-ms-original-file: specification/education/resource-manager/Microsoft.Education/preview/2021-12-01-preview/examples/RedeemCode.json
 */
async function redeemCode() {
  const parameters = {
    firstName: "test",
    lastName: "user",
    redeemCode: "exampleRedeemCode",
  };
  const credential = new DefaultAzureCredential();
  const client = new EducationManagementClient(credential);
  const result = await client.redeemInvitationCode(parameters);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Mintaválasz

Állapotkód:

200

Definíciók

Name	Description
ErrorResponse	A hibaválasz formátumát ismerteti.
ErrorResponseBody	A hibaválasz azt jelzi, hogy a szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.
RedeemRequest	kérés beváltása.

ErrorResponse

Objektum

A hibaválasz formátumát ismerteti.

Name	Típus	Description
code	string	Hibakód
message	string	A művelet sikertelen voltát jelző hibaüzenet.

ErrorResponseBody

Objektum

A hibaválasz azt jelzi, hogy a szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.

Name	Típus	Description
error	ErrorResponse	A hiba részletei.

RedeemRequest

Objektum

kérés beváltása.

Name	Típus	Description
firstName	string	a kérelmező utóneve
lastName	string	a kérelmező vezetékneve
redeemCode	string	kód beváltása