Savings Plan - Validate Update

Referencia

Szolgáltatás:: Billing Benefits

API-verzió:: 2022-11-01

A megtakarítási terv javításának ellenőrzése.

POST https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/validate?api-version=2022-11-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
savingsPlanId	path	True	string	A megtakarítási terv azonosítója
savingsPlanOrderId	path	True	string	A megtakarítási terv rendelésazonosítója
api-version	query	True	string	A szolgáltatás által használandó API-verzió

Kérelem törzse

Name	Típus	Description
benefits	SavingsPlanUpdateRequestProperties[]	Megtakarítási terv javításkérése

Válaszok

Name	Típus	Description
200 OK	SavingsPlanValidateResponse	A kérés befejeződött.
Other Status Codes	ErrorResponse	Váratlan hiba.

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

SavingsPlanValidateUpdate

Mintakérelem

POST https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000/validate?api-version=2022-11-01

{
  "benefits": [
    {
      "appliedScopeType": "ManagementGroup",
      "appliedScopeProperties": {
        "tenantId": "30000000-0000-0000-0000-000000000100",
        "managementGroupId": "/providers/Microsoft.Management/managementGroups/30000000-0000-0000-0000-000000000100"
      }
    },
    {
      "appliedScopeType": "ManagementGroup",
      "appliedScopeProperties": {
        "tenantId": "30000000-0000-0000-0000-000000000100",
        "managementGroupId": "/providers/Microsoft.Management/managementGroups/MockMG"
      }
    }
  ]
}


import com.azure.resourcemanager.billingbenefits.models.AppliedScopeProperties;
import com.azure.resourcemanager.billingbenefits.models.AppliedScopeType;
import com.azure.resourcemanager.billingbenefits.models.SavingsPlanUpdateRequestProperties;
import com.azure.resourcemanager.billingbenefits.models.SavingsPlanUpdateValidateRequest;
import java.util.Arrays;

/**
 * Samples for SavingsPlan ValidateUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/
     * SavingsPlanValidateUpdate.json
     */
    /**
     * Sample code: SavingsPlanValidateUpdate.
     * 
     * @param manager Entry point to BillingBenefitsManager.
     */
    public static void
        savingsPlanValidateUpdate(com.azure.resourcemanager.billingbenefits.BillingBenefitsManager manager) {
        manager.savingsPlans().validateUpdateWithResponse("20000000-0000-0000-0000-000000000000",
            "30000000-0000-0000-0000-000000000000",
            new SavingsPlanUpdateValidateRequest().withBenefits(Arrays.asList(
                new SavingsPlanUpdateRequestProperties().withAppliedScopeType(AppliedScopeType.MANAGEMENT_GROUP)
                    .withAppliedScopeProperties(new AppliedScopeProperties()
                        .withTenantId("30000000-0000-0000-0000-000000000100").withManagementGroupId(
                            "/providers/Microsoft.Management/managementGroups/30000000-0000-0000-0000-000000000100")),
                new SavingsPlanUpdateRequestProperties().withAppliedScopeType(AppliedScopeType.MANAGEMENT_GROUP)
                    .withAppliedScopeProperties(
                        new AppliedScopeProperties().withTenantId("30000000-0000-0000-0000-000000000100")
                            .withManagementGroupId("/providers/Microsoft.Management/managementGroups/MockMG")))),
            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

from azure.identity import DefaultAzureCredential
from azure.mgmt.billingbenefits import BillingBenefitsRP

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billingbenefits
# USAGE
    python savings_plan_validate_update.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 = BillingBenefitsRP(
        credential=DefaultAzureCredential(),
    )

    response = client.savings_plan.validate_update(
        savings_plan_order_id="20000000-0000-0000-0000-000000000000",
        savings_plan_id="30000000-0000-0000-0000-000000000000",
        body={
            "benefits": [
                {
                    "appliedScopeProperties": {
                        "managementGroupId": "/providers/Microsoft.Management/managementGroups/30000000-0000-0000-0000-000000000100",
                        "tenantId": "30000000-0000-0000-0000-000000000100",
                    },
                    "appliedScopeType": "ManagementGroup",
                },
                {
                    "appliedScopeProperties": {
                        "managementGroupId": "/providers/Microsoft.Management/managementGroups/MockMG",
                        "tenantId": "30000000-0000-0000-0000-000000000100",
                    },
                    "appliedScopeType": "ManagementGroup",
                },
            ]
        },
    )
    print(response)


# x-ms-original-file: specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanValidateUpdate.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

package armbillingbenefits_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/billingbenefits/armbillingbenefits/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanValidateUpdate.json
func ExampleSavingsPlanClient_ValidateUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbillingbenefits.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSavingsPlanClient().ValidateUpdate(ctx, "20000000-0000-0000-0000-000000000000", "30000000-0000-0000-0000-000000000000", armbillingbenefits.SavingsPlanUpdateValidateRequest{
		Benefits: []*armbillingbenefits.SavingsPlanUpdateRequestProperties{
			{
				AppliedScopeProperties: &armbillingbenefits.AppliedScopeProperties{
					ManagementGroupID: to.Ptr("/providers/Microsoft.Management/managementGroups/30000000-0000-0000-0000-000000000100"),
					TenantID:          to.Ptr("30000000-0000-0000-0000-000000000100"),
				},
				AppliedScopeType: to.Ptr(armbillingbenefits.AppliedScopeTypeManagementGroup),
			},
			{
				AppliedScopeProperties: &armbillingbenefits.AppliedScopeProperties{
					ManagementGroupID: to.Ptr("/providers/Microsoft.Management/managementGroups/MockMG"),
					TenantID:          to.Ptr("30000000-0000-0000-0000-000000000100"),
				},
				AppliedScopeType: to.Ptr(armbillingbenefits.AppliedScopeTypeManagementGroup),
			}},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SavingsPlanValidateResponse = armbillingbenefits.SavingsPlanValidateResponse{
	// 	Benefits: []*armbillingbenefits.SavingsPlanValidResponseProperty{
	// 		{
	// 			Valid: to.Ptr(true),
	// 		},
	// 		{
	// 			Valid: to.Ptr(true),
	// 	}},
	// }
}

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

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

/**
 * This sample demonstrates how to Validate savings plan patch.
 *
 * @summary Validate savings plan patch.
 * x-ms-original-file: specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanValidateUpdate.json
 */
async function savingsPlanValidateUpdate() {
  const savingsPlanOrderId = "20000000-0000-0000-0000-000000000000";
  const savingsPlanId = "30000000-0000-0000-0000-000000000000";
  const body = {
    benefits: [
      {
        appliedScopeProperties: {
          managementGroupId:
            "/providers/Microsoft.Management/managementGroups/30000000-0000-0000-0000-000000000100",
          tenantId: "30000000-0000-0000-0000-000000000100",
        },
        appliedScopeType: "ManagementGroup",
      },
      {
        appliedScopeProperties: {
          managementGroupId: "/providers/Microsoft.Management/managementGroups/MockMG",
          tenantId: "30000000-0000-0000-0000-000000000100",
        },
        appliedScopeType: "ManagementGroup",
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new BillingBenefitsRP(credential);
  const result = await client.savingsPlan.validateUpdate(savingsPlanOrderId, savingsPlanId, body);
  console.log(result);
}

savingsPlanValidateUpdate().catch(console.error);

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

{
  "benefits": [
    {
      "valid": true
    },
    {
      "valid": true
    }
  ]
}

Definíciók

Name	Description
AppliedScopeProperties	Az alkalmazott hatókörtípusra jellemző tulajdonságok. Nem kötelező, ha nem alkalmazható.
AppliedScopeType	Az alkalmazott hatókör típusa.
BillingPlan	A számlázási csomagot ISO 8601 formátumban jelöli. Csak havi számlázási csomagokhoz szükséges.
Commitment	Elkötelezettség a juttatás iránt.
CommitmentGrain	Kötelezettségvállalási szem.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
PurchaseRequest
RenewProperties
SavingsPlanUpdateRequestProperties	Megtakarítási terv javításkérése
SavingsPlanUpdateValidateRequest
SavingsPlanValidateResponse
SavingsPlanValidResponseProperty	Juttatási hatókör válasz tulajdonsága
Sku	Az erőforráshoz alkalmazni kívánt termékváltozat
Term	A juttatás kifejezésének jelölése ISO 8601 formátumban.

AppliedScopeProperties

Objektum

Az alkalmazott hatókörtípusra jellemző tulajdonságok. Nem kötelező, ha nem alkalmazható.

Name	Típus	Description
displayName	string	Megjelenítendő név
managementGroupId	string	Annak a felügyeleti csoportnak a teljes azonosítója, ahol az előnyt alkalmazni kell.
resourceGroupId	string	Az erőforráscsoport teljes azonosítója.
subscriptionId	string	Az előfizetés teljes azonosítója.
tenantId	string	Bérlőazonosító, ahol az előny érvényesül.

AppliedScopeType

Enumerálás

Az alkalmazott hatókör típusa.

Érték	Description
ManagementGroup
Shared
Single

BillingPlan

Enumerálás

A számlázási csomagot ISO 8601 formátumban jelöli. Csak havi számlázási csomagokhoz szükséges.

Érték	Description
P1M

Commitment

Objektum

Elkötelezettség a juttatás iránt.

Name	Típus	Description
amount	number (double)
currencyCode	string	A vásárlási rekord által használt pénznem ISO 4217 3 betűs pénznemkódja.
grain	CommitmentGrain	Kötelezettségvállalási szem.

CommitmentGrain

Enumerálás

Kötelezettségvállalási szem.

Érték	Description
Hourly

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

PurchaseRequest

Objektum

Name	Típus	Alapértelmezett érték	Description
properties.appliedScopeProperties	AppliedScopeProperties		Az alkalmazott hatókörtípusra jellemző tulajdonságok. Nem kötelező, ha nem alkalmazható.
properties.appliedScopeType	AppliedScopeType		Az alkalmazott hatókör típusa.
properties.billingPlan	BillingPlan		A számlázási csomagot ISO 8601 formátumban jelöli. Csak havi számlázási csomagokhoz szükséges.
properties.billingScopeId	string		Előfizetés, amely az előny megvásárlásáért lesz felszámítva
properties.commitment	Commitment		Elkötelezettség a juttatás iránt.
properties.displayName	string		A megtakarítási terv rövid neve
properties.effectiveDateTime	string (date-time)		A megtakarítási terv DateTime-jának kezdetekor előnyt nyújtunk.
properties.renew	boolean	False	Ha ezt igaz értékre állítja, automatikusan megvásárol egy új juttatást a lejárati dátumon.
properties.term	Term		A juttatás kifejezésének jelölése ISO 8601 formátumban.
sku	Sku		Az erőforráshoz alkalmazni kívánt termékváltozat

RenewProperties

Objektum

Name	Típus	Description
purchaseProperties	PurchaseRequest

SavingsPlanUpdateRequestProperties

Objektum

Megtakarítási terv javításkérése

Name	Típus	Alapértelmezett érték	Description
appliedScopeProperties	AppliedScopeProperties		Az alkalmazott hatókörtípusra jellemző tulajdonságok. Nem kötelező, ha nem alkalmazható.
appliedScopeType	AppliedScopeType		Az alkalmazott hatókör típusa.
displayName	string		Megjelenítendő név
renew	boolean	False	Ha ezt igaz értékre állítja, automatikusan megvásárol egy új juttatást a lejárati dátumon.
renewProperties	RenewProperties

SavingsPlanUpdateValidateRequest

Objektum

Name	Típus	Description
benefits	SavingsPlanUpdateRequestProperties[]	Megtakarítási terv javításkérése

SavingsPlanValidateResponse

Objektum

Name	Típus	Description
benefits	SavingsPlanValidResponseProperty[]	Juttatási hatókör válasz tulajdonsága
nextLink	string	A következő oldal lekéréséhez kattintson az URL-címre.

SavingsPlanValidResponseProperty

Objektum

Juttatási hatókör válasz tulajdonsága

Name	Típus	Description
reason	string	Hiba oka, ha a megadott bemenet érvénytelen volt
reasonCode	string	Hiba okkódja, ha a megadott bemenet érvénytelen volt
valid	boolean	Azt jelzi, hogy a megadott bemenet érvényes volt-e

Sku

Objektum

Az erőforráshoz alkalmazni kívánt termékváltozat

Name	Típus	Description
name	string	Az alkalmazandó termékváltozat neve

Term

Enumerálás

A juttatás kifejezésének jelölése ISO 8601 formátumban.

Érték	Description
P1Y
P3Y
P5Y

Megosztás a következőn keresztül:

Savings Plan - Validate Update

URI-paraméterek

Kérelem törzse

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

SavingsPlanValidateUpdate

Mintakérelem

Mintaválasz

Definíciók

AppliedScopeProperties

AppliedScopeType

BillingPlan

Commitment

CommitmentGrain

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PurchaseRequest

RenewProperties

SavingsPlanUpdateRequestProperties

SavingsPlanUpdateValidateRequest

SavingsPlanValidateResponse

SavingsPlanValidResponseProperty

Sku

Term