Savings Plan - Validate Update

Referencia

Servicio:: Billing Benefits

Versión de la API:: 2022-11-01

Valide la revisión del plan de ahorro.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
savingsPlanId	path	True	string	Identificador del plan de ahorro
savingsPlanOrderId	path	True	string	Id. de pedido del plan de ahorro
api-version	query	True	string	Versión de api que va a usar el servicio

Cuerpo de la solicitud

Nombre	Tipo	Description
benefits	SavingsPlanUpdateRequestProperties[]	Solicitud de revisión del plan de ahorro

Respuestas

Nombre	Tipo	Description
200 OK	SavingsPlanValidateResponse	La solicitud se ha completado.
Other Status Codes	ErrorResponse	Error inesperado.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

SavingsPlanValidateUpdate

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
AppliedScopeProperties	Propiedades específicas del tipo de ámbito aplicado. No es necesario si no es aplicable.
AppliedScopeType	Tipo del ámbito aplicado.
BillingPlan	Representa el plan de facturación en formato ISO 8601. Solo es necesario para los planes de facturación mensuales.
Commitment	Compromiso con el beneficio.
CommitmentGrain	Grano de compromiso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
PurchaseRequest
RenewProperties
SavingsPlanUpdateRequestProperties	Solicitud de revisión del plan de ahorro
SavingsPlanUpdateValidateRequest
SavingsPlanValidateResponse
SavingsPlanValidResponseProperty	Propiedad de respuesta del ámbito de la ventaja
Sku	SKU que se va a aplicar para este recurso
Term	Represente el término de beneficio en formato ISO 8601.

AppliedScopeProperties

Object

Propiedades específicas del tipo de ámbito aplicado. No es necesario si no es aplicable.

Nombre	Tipo	Description
displayName	string	Nombre para mostrar
managementGroupId	string	Identificador completo del grupo de administración en el que se debe aplicar la ventaja.
resourceGroupId	string	Identificador completo del grupo de recursos.
subscriptionId	string	Identificador completo de la suscripción.
tenantId	string	Identificador de inquilino en el que se aplica la ventaja.

AppliedScopeType

Enumeración

Tipo del ámbito aplicado.

Valor	Description
ManagementGroup
Shared
Single

BillingPlan

Enumeración

Representa el plan de facturación en formato ISO 8601. Solo es necesario para los planes de facturación mensuales.

Valor	Description
P1M

Commitment

Object

Compromiso con el beneficio.

Nombre	Tipo	Description
amount	number (double)
currencyCode	string	El código de moneda iso 4217 de 3 letras para la moneda utilizada por este registro de compra.
grain	CommitmentGrain	Grano de compromiso.

CommitmentGrain

Enumeración

Grano de compromiso.

Valor	Description
Hourly

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

PurchaseRequest

Object

Nombre	Tipo	Valor predeterminado	Description
properties.appliedScopeProperties	AppliedScopeProperties		Propiedades específicas del tipo de ámbito aplicado. No es necesario si no es aplicable.
properties.appliedScopeType	AppliedScopeType		Tipo del ámbito aplicado.
properties.billingPlan	BillingPlan		Representa el plan de facturación en formato ISO 8601. Solo es necesario para los planes de facturación mensuales.
properties.billingScopeId	string		Suscripción que se cobrará por comprar la ventaja
properties.commitment	Commitment		Compromiso con el beneficio.
properties.displayName	string		Nombre descriptivo del plan de ahorro
properties.effectiveDateTime	string (date-time)		DateTime del plan de ahorro comienza a proporcionar beneficios.
properties.renew	boolean	False	Si se establece en true, se adquirirá automáticamente una nueva ventaja en la fecha de expiración.
properties.term	Term		Represente el término de beneficio en formato ISO 8601.
sku	Sku		SKU que se va a aplicar para este recurso

RenewProperties

Object

Nombre	Tipo	Description
purchaseProperties	PurchaseRequest

SavingsPlanUpdateRequestProperties

Object

Solicitud de revisión del plan de ahorro

Nombre	Tipo	Valor predeterminado	Description
appliedScopeProperties	AppliedScopeProperties		Propiedades específicas del tipo de ámbito aplicado. No es necesario si no es aplicable.
appliedScopeType	AppliedScopeType		Tipo del ámbito aplicado.
displayName	string		Nombre para mostrar
renew	boolean	False	Si se establece en true, se adquirirá automáticamente una nueva ventaja en la fecha de expiración.
renewProperties	RenewProperties

SavingsPlanUpdateValidateRequest

Object

Nombre	Tipo	Description
benefits	SavingsPlanUpdateRequestProperties[]	Solicitud de revisión del plan de ahorro

SavingsPlanValidateResponse

Object

Nombre	Tipo	Description
benefits	SavingsPlanValidResponseProperty[]	Propiedad de respuesta del ámbito de la ventaja
nextLink	string	Dirección URL para obtener la página siguiente.

SavingsPlanValidResponseProperty

Object

Propiedad de respuesta del ámbito de la ventaja

Nombre	Tipo	Description
reason	string	Motivo del error si la entrada proporcionada no era válida
reasonCode	string	Código de motivo del error si la entrada proporcionada no era válida
valid	boolean	Indica si la entrada proporcionada era válida.

Sku

Object

SKU que se va a aplicar para este recurso

Nombre	Tipo	Description
name	string	Nombre de la SKU que se va a aplicar

Term

Enumeración

Represente el término de beneficio en formato ISO 8601.

Valor	Description
P1Y
P3Y
P5Y

Compartir a través de

Savings Plan - Validate Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

SavingsPlanValidateUpdate

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AppliedScopeProperties

AppliedScopeType

BillingPlan

Commitment

CommitmentGrain

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PurchaseRequest

RenewProperties

SavingsPlanUpdateRequestProperties

SavingsPlanUpdateValidateRequest

SavingsPlanValidateResponse

SavingsPlanValidResponseProperty

Sku

Term