Products - Get

Service:

Billing

API Version:

2020-05-01

Obtient un produit par ID. L’opération est prise en charge uniquement pour les comptes de facturation avec le type de contrat Contrat client Microsoft.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}?api-version=2020-05-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
billingAccountName	path	True	string	ID qui identifie de manière unique un compte de facturation.
productName	path	True	string	ID qui identifie un produit de manière unique.
api-version	query	True	string	Version de l’API à utiliser avec la demande cliente. La version actuelle est 01/05/2020.

Réponses

Nom	Type	Description
200 OK	Product	OK. La demande a réussi.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Product

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}?api-version=2020-05-01

Java

/** Samples for Products Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Product.json
     */
    /**
     * Sample code: Product.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void product(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.products().getWithResponse("{billingAccountName}", "{productName}", 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.billing import BillingManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billing
# USAGE
    python product.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 = BillingManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.products.get(
        billing_account_name="{billingAccountName}",
        product_name="{productName}",
    )
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Product.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 armbilling_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/billing/armbilling"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Product.json
func ExampleProductsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbilling.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewProductsClient().Get(ctx, "{billingAccountName}", "{productName}", 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.Product = armbilling.Product{
	// 	Name: to.Ptr("{productName}"),
	// 	Type: to.Ptr("Microsoft.Billing/billingAccounts/products"),
	// 	ID: to.Ptr("/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/{productName}"),
	// 	Properties: &armbilling.ProductProperties{
	// 		AutoRenew: to.Ptr(armbilling.AutoRenewOn),
	// 		AvailabilityID: to.Ptr("AvailabilityId1"),
	// 		BillingFrequency: to.Ptr(armbilling.BillingFrequencyMonthly),
	// 		BillingProfileDisplayName: to.Ptr("Contoso operations billing"),
	// 		BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000"),
	// 		DisplayName: to.Ptr("AIP Dev"),
	// 		InvoiceSectionDisplayName: to.Ptr("Contoso operations invoiceSection"),
	// 		InvoiceSectionID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}"),
	// 		LastCharge: &armbilling.Amount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](5000),
	// 		},
	// 		LastChargeDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-15T17:32:28.000Z"); return t}()),
	// 		ProductType: to.Ptr("Subscription"),
	// 		ProductTypeID: to.Ptr("A12345"),
	// 		PurchaseDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-05-01T17:32:28.000Z"); return t}()),
	// 		Quantity: to.Ptr[float32](4),
	// 		SKUDescription: to.Ptr("Enterprise Agreement Development"),
	// 		SKUID: to.Ptr("0001"),
	// 		Status: to.Ptr(armbilling.ProductStatusTypeActive),
	// 		TenantID: to.Ptr("515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce"),
	// 	},
	// }
}

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 { BillingManagementClient } = require("@azure/arm-billing");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
 *
 * @summary Gets a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Product.json
 */
async function product() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const billingAccountName = "{billingAccountName}";
  const productName = "{productName}";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const result = await client.products.get(billingAccountName, productName);
  console.log(result);
}

product().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

Sample Response

Status code:

200

{
  "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/{productName}",
  "name": "{productName}",
  "type": "Microsoft.Billing/billingAccounts/products",
  "properties": {
    "autoRenew": "On",
    "productTypeId": "A12345",
    "productType": "Subscription",
    "displayName": "AIP Dev",
    "status": "Active",
    "purchaseDate": "2018-05-01T17:32:28Z",
    "lastCharge": {
      "currency": "USD",
      "value": 5000
    },
    "lastChargeDate": "2018-06-15T17:32:28Z",
    "billingFrequency": "Monthly",
    "quantity": 4,
    "skuId": "0001",
    "skuDescription": "Enterprise Agreement Development",
    "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce",
    "availabilityId": "AvailabilityId1",
    "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}",
    "invoiceSectionDisplayName": "Contoso operations invoiceSection",
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
    "billingProfileDisplayName": "Contoso operations billing"
  }
}

Définitions

Nom	Description
Amount	Montant.
AutoRenew	Indique si le renouvellement automatique est activé ou désactivé pour un produit.
BillingFrequency	Fréquence à laquelle le produit sera facturé.
ErrorDetails	Détails de l’erreur.
ErrorResponse	La réponse d’erreur indique que le service n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur.
ErrorSubDetails
Product	Un produit.
ProductStatusType	Status actuelle du produit.
Reseller	Détails du revendeur.

Amount

Montant.

Nom	Type	Description
currency	string	Devise de la valeur du montant.
value	number	Valeur du montant.

AutoRenew

Indique si le renouvellement automatique est activé ou désactivé pour un produit.

Nom	Type	Description
Off	string
On	string

BillingFrequency

Fréquence à laquelle le produit sera facturé.

Nom	Type	Description
Monthly	string
OneTime	string
UsageBased	string

ErrorDetails

Détails de l’erreur.

Nom	Type	Description
code	string	Code d’erreur.
details	ErrorSubDetails[]	Sous-détails de l’erreur.
message	string	Message d’erreur indiquant la raison de l’échec de l’opération.
target	string	Cible de l’erreur particulière.

ErrorResponse

La réponse d’erreur indique que le service n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur.

Nom	Type	Description
error	ErrorDetails	Détails de l’erreur.

ErrorSubDetails

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d’erreur indiquant la raison de l’échec de l’opération.
target	string	Cible de l’erreur particulière.

Product

Un produit.

Nom	Type	Description
id	string	ID de ressource.
name	string	Nom de la ressource.
properties.autoRenew	AutoRenew	Indique si le renouvellement automatique est activé ou désactivé pour un produit.
properties.availabilityId	string	Disponibilité du produit.
properties.billingFrequency	BillingFrequency	Fréquence à laquelle le produit sera facturé.
properties.billingProfileDisplayName	string	Nom du profil de facturation auquel le produit est facturé.
properties.billingProfileId	string	ID du profil de facturation auquel le produit est facturé.
properties.customerDisplayName	string	Nom du client pour lequel le produit a été acheté. Le champ s’applique uniquement à Contrat Partenaire Microsoft compte de facturation.
properties.customerId	string	ID du client pour lequel le produit a été acheté. Le champ s’applique uniquement à Contrat Partenaire Microsoft compte de facturation.
properties.displayName	string	Nom d’affichage du produit.
properties.endDate	string	Date à laquelle le produit sera renouvelé ou annulé.
properties.invoiceSectionDisplayName	string	Nom de la section de facture à laquelle le produit est facturé.
properties.invoiceSectionId	string	ID de la section de facture à laquelle le produit est facturé.
properties.lastCharge	Amount	Frais du dernier mois.
properties.lastChargeDate	string	Date de la dernière charge.
properties.productType	string	Description du type de produit.
properties.productTypeId	string	ID du type de produit.
properties.purchaseDate	string	Date d’achat du produit.
properties.quantity	number	Quantité achetée pour le produit.
properties.reseller	Reseller	Revendeur pour ce produit.
properties.skuDescription	string	Description de la référence sku du produit.
properties.skuId	string	ID de référence du produit.
properties.status	ProductStatusType	Status actuelle du produit.
properties.tenantId	string	ID du locataire dans lequel le produit est utilisé.
type	string	Type de ressource.

ProductStatusType

Status actuelle du produit.

Nom	Type	Description
Active	string
AutoRenew	string
Cancelled	string
Disabled	string
Expired	string
Expiring	string
Inactive	string
PastDue	string

Reseller

Détails du revendeur.

Nom	Type	Description
description	string	Nom du revendeur.
resellerId	string	ID MPN du revendeur.