Billing Subscriptions - Validate Move Eligibility

Service:

Billing

API Version:

2021-10-01

Valida si los cargos de una suscripción se pueden mover a una nueva sección de factura. Esta operación es compatible con las cuentas de facturación con Contrato de cliente de Microsoft de tipo de contrato.

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/validateMoveEligibility?api-version=2021-10-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
billingAccountName	path	True	string	Identificador que identifica de forma única una cuenta de facturación.
billingSubscriptionName	path	True	string	Identificador que identifica de forma única una suscripción.
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente. La versión actual es 2021-10-01.

Cuerpo de la solicitud

Nombre	Tipo	Description
destinationEnrollmentAccountId	string	Identificador de la cuenta de inscripción de destino.
destinationInvoiceSectionId	string	Identificador de la sección de factura de destino.

Respuestas

Nombre	Tipo	Description
200 OK	ValidateMoveBillingSubscriptionEligibilityResult	Aceptar. La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

SubscriptionMoveValidateFailure

SubscriptionMoveValidateSuccess

SubscriptionMoveValidateFailure

Sample Request

HTTP

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/418b0e9c-5dc3-4260-918f-30b90619fe07/validateMoveEligibility?api-version=2021-10-01

{
  "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/e004d7ce-feca-4341-97c9-9f11cae37858/invoiceSections/06febd6b-3cb7-47fe-ac7d-7b4e83e80f53"
}

dotnet

using System;
using System.Threading.Tasks;
using System.Xml;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Billing;
using Azure.ResourceManager.Billing.Models;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2021-10-01/examples/ValidateSubscriptionMoveFailure.json
// this example is just showing the usage of "BillingSubscriptions_ValidateMoveEligibility" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this BillingSubscriptionResource created on azure
// for more information of creating BillingSubscriptionResource, please refer to the document of BillingSubscriptionResource
string billingAccountName = "{billingAccountName}";
string billingSubscriptionName = "418b0e9c-5dc3-4260-918f-30b90619fe07";
ResourceIdentifier billingSubscriptionResourceId = BillingSubscriptionResource.CreateResourceIdentifier(billingAccountName, billingSubscriptionName);
BillingSubscriptionResource billingSubscription = client.GetBillingSubscriptionResource(billingSubscriptionResourceId);

// invoke the operation
BillingSubscriptionMoveContent content = new BillingSubscriptionMoveContent()
{
    DestinationInvoiceSectionId = new ResourceIdentifier("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/e004d7ce-feca-4341-97c9-9f11cae37858/invoiceSections/06febd6b-3cb7-47fe-ac7d-7b4e83e80f53"),
};
BillingSubscriptionValidateMoveEligibilityResult result = await billingSubscription.ValidateMoveEligibilityAsync(content);

Console.WriteLine($"Succeeded: {result}");

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

Sample Response

Status code:

200

{
  "isMoveEligible": false,
  "errorDetails": {
    "code": "SubscriptionNotActive",
    "message": "Invoice Sections can only be changed for active subscriptions."
  }
}

SubscriptionMoveValidateSuccess

Sample Request

HTTP

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/418b0e9c-5dc3-4260-918f-30b90619fe07/validateMoveEligibility?api-version=2021-10-01

{
  "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/e004d7ce-feca-4341-97c9-9f11cae37858/invoiceSections/06febd6b-3cb7-47fe-ac7d-7b4e83e80f53"
}

dotnet

using System;
using System.Threading.Tasks;
using System.Xml;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Billing;
using Azure.ResourceManager.Billing.Models;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2021-10-01/examples/ValidateSubscriptionMoveSuccess.json
// this example is just showing the usage of "BillingSubscriptions_ValidateMoveEligibility" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this BillingSubscriptionResource created on azure
// for more information of creating BillingSubscriptionResource, please refer to the document of BillingSubscriptionResource
string billingAccountName = "{billingAccountName}";
string billingSubscriptionName = "418b0e9c-5dc3-4260-918f-30b90619fe07";
ResourceIdentifier billingSubscriptionResourceId = BillingSubscriptionResource.CreateResourceIdentifier(billingAccountName, billingSubscriptionName);
BillingSubscriptionResource billingSubscription = client.GetBillingSubscriptionResource(billingSubscriptionResourceId);

// invoke the operation
BillingSubscriptionMoveContent content = new BillingSubscriptionMoveContent()
{
    DestinationInvoiceSectionId = new ResourceIdentifier("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/e004d7ce-feca-4341-97c9-9f11cae37858/invoiceSections/06febd6b-3cb7-47fe-ac7d-7b4e83e80f53"),
};
BillingSubscriptionValidateMoveEligibilityResult result = await billingSubscription.ValidateMoveEligibilityAsync(content);

Console.WriteLine($"Succeeded: {result}");

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

Sample Response

Status code:

200

{
  "isMoveEligible": true
}

Definiciones

Nombre	Description
ErrorDetails	Detalles del error.
ErrorResponse	La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.
ErrorSubDetails	Los subdelementos del error.
MoveBillingSubscriptionRequest	Solicite parámetros para transferir la suscripción de facturación.
subscriptionTransferValidationErrorCode	Código de error para la validación del traslado de la suscripción de facturación.
ValidateMoveBillingSubscriptionEligibilityError	Detalles del error de la validación de idoneidad de transferencia
ValidateMoveBillingSubscriptionEligibilityResult	Resultado de la validación de idoneidad de transferencia.

ErrorDetails

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error.
details	ErrorSubDetails[]	Los subdelementos del error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.
target	string	Destino del error concreto.

ErrorResponse

La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Nombre	Tipo	Description
error	ErrorDetails	Detalles del error.

ErrorSubDetails

Los subdelementos del error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.
target	string	Destino del error concreto.

MoveBillingSubscriptionRequest

Solicite parámetros para transferir la suscripción de facturación.

Nombre	Tipo	Description
destinationEnrollmentAccountId	string	Identificador de la cuenta de inscripción de destino.
destinationInvoiceSectionId	string	Identificador de la sección de factura de destino.

subscriptionTransferValidationErrorCode

Código de error para la validación del traslado de la suscripción de facturación.

Nombre	Tipo	Description
AccountIsLocked	string
AssetHasCap	string
AssetNotActive	string
BillingAccountInactive	string
BillingProfilePastDue	string
CrossBillingAccountNotAllowed	string
DestinationBillingProfileInactive	string
DestinationBillingProfileNotFound	string
DestinationBillingProfilePastDue	string
DestinationInvoiceSectionInactive	string
DestinationInvoiceSectionNotFound	string
InsufficientPermissionOnDestination	string
InsufficientPermissionOnSource	string
InvalidDestination	string
InvalidSource	string
InvoiceSectionIsRestricted	string
MarketplaceNotEnabledOnDestination	string
ProductInactive	string
ProductNotFound	string
ProductTypeNotSupported	string
SourceBillingProfilePastDue	string
SourceInvoiceSectionInactive	string
SubscriptionNotActive	string
SubscriptionTypeNotSupported	string

ValidateMoveBillingSubscriptionEligibilityError

Detalles del error de la validación de idoneidad de transferencia

Nombre	Tipo	Description
code	subscriptionTransferValidationErrorCode	Código de error para la validación del traslado de la suscripción de facturación.
details	string	Mensaje de error detallado que explica el error.
message	string	El mensaje de error.

ValidateMoveBillingSubscriptionEligibilityResult

Resultado de la validación de idoneidad de transferencia.

Nombre	Tipo	Description
errorDetails	ValidateMoveBillingSubscriptionEligibilityError	Detalles del error de validación.
isMoveEligible	boolean	Especifica si la suscripción es apta para moverse.