Share via


Microsoft.Billing billingAccounts/billingProfiles 2018-11-01-preview

Bicep resource definition

The billingAccounts/billingProfiles resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Billing/billingAccounts/billingProfiles resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Billing/billingAccounts/billingProfiles@2018-11-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    address: {
      addressLine1: 'string'
      addressLine2: 'string'
      addressLine3: 'string'
      city: 'string'
      companyName: 'string'
      country: 'string'
      firstName: 'string'
      lastName: 'string'
      postalCode: 'string'
      region: 'string'
    }
    displayName: 'string'
    enabledAzureSKUs: [
      {
        skuId: 'string'
      }
    ]
    invoiceSections: [
      {
        properties: {
          billingProfiles: [
            {
              properties: ...
            }
          ]
          displayName: 'string'
        }
      }
    ]
    poNumber: 'string'
  }
}

Property Values

Microsoft.Billing/billingAccounts/billingProfiles

Name Description Value
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: billingAccounts
properties A billing profile. BillingProfileProperties

Address

Name Description Value
addressLine1 Address Line1. string
addressLine2 Address Line2. string
addressLine3 Address Line3. string
city Address City. string
companyName Company Name. string
country Country code uses ISO2, 2-digit format. string
firstName First Name. string
lastName Last Name. string
postalCode Address Postal Code. string
region Address Region. string

BillingProfile

Name Description Value
properties A billing profile. BillingProfileProperties

BillingProfileProperties

Name Description Value
address Billing address. Address
displayName The billing profile name. string
enabledAzureSKUs Information about the product. EnabledAzureSKUs[]
invoiceSections The invoice sections associated to the billing profile. InvoiceSection[]
poNumber Purchase order number. string

EnabledAzureSKUs

Name Description Value
skuId The sku id. string

InvoiceSection

Name Description Value
properties The InvoiceSection. InvoiceSectionProperties

InvoiceSectionProperties

Name Description Value
billingProfiles The billing profiles associated to the billing account. BillingProfile[]
displayName The name of the InvoiceSection. string

ARM template resource definition

The billingAccounts/billingProfiles resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Billing/billingAccounts/billingProfiles resource, add the following JSON to your template.

{
  "type": "Microsoft.Billing/billingAccounts/billingProfiles",
  "apiVersion": "2018-11-01-preview",
  "name": "string",
  "properties": {
    "address": {
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "city": "string",
      "companyName": "string",
      "country": "string",
      "firstName": "string",
      "lastName": "string",
      "postalCode": "string",
      "region": "string"
    },
    "displayName": "string",
    "enabledAzureSKUs": [
      {
        "skuId": "string"
      }
    ],
    "invoiceSections": [
      {
        "properties": {
          "billingProfiles": [
            {
              "properties": ...
            }
          ],
          "displayName": "string"
        }
      }
    ],
    "poNumber": "string"
  }
}

Property Values

Microsoft.Billing/billingAccounts/billingProfiles

Name Description Value
apiVersion The api version '2018-11-01-preview'
name The resource name string (required)
properties A billing profile. BillingProfileProperties
type The resource type 'Microsoft.Billing/billingAccounts/billingProfiles'

Address

Name Description Value
addressLine1 Address Line1. string
addressLine2 Address Line2. string
addressLine3 Address Line3. string
city Address City. string
companyName Company Name. string
country Country code uses ISO2, 2-digit format. string
firstName First Name. string
lastName Last Name. string
postalCode Address Postal Code. string
region Address Region. string

BillingProfile

Name Description Value
properties A billing profile. BillingProfileProperties

BillingProfileProperties

Name Description Value
address Billing address. Address
displayName The billing profile name. string
enabledAzureSKUs Information about the product. EnabledAzureSKUs[]
invoiceSections The invoice sections associated to the billing profile. InvoiceSection[]
poNumber Purchase order number. string

EnabledAzureSKUs

Name Description Value
skuId The sku id. string

InvoiceSection

Name Description Value
properties The InvoiceSection. InvoiceSectionProperties

InvoiceSectionProperties

Name Description Value
billingProfiles The billing profiles associated to the billing account. BillingProfile[]
displayName The name of the InvoiceSection. string

Usage Examples

Terraform (AzAPI provider) resource definition

The billingAccounts/billingProfiles resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Billing/billingAccounts/billingProfiles resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Billing/billingAccounts/billingProfiles@2018-11-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      address = {
        addressLine1 = "string"
        addressLine2 = "string"
        addressLine3 = "string"
        city = "string"
        companyName = "string"
        country = "string"
        firstName = "string"
        lastName = "string"
        postalCode = "string"
        region = "string"
      }
      displayName = "string"
      enabledAzureSKUs = [
        {
          skuId = "string"
        }
      ]
      invoiceSections = [
        {
          properties = {
            billingProfiles = [
              {
                properties = ...
              }
            ]
            displayName = "string"
          }
        }
      ]
      poNumber = "string"
    }
  }
}

Property Values

Microsoft.Billing/billingAccounts/billingProfiles

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: billingAccounts
properties A billing profile. BillingProfileProperties
type The resource type "Microsoft.Billing/billingAccounts/billingProfiles@2018-11-01-preview"

Address

Name Description Value
addressLine1 Address Line1. string
addressLine2 Address Line2. string
addressLine3 Address Line3. string
city Address City. string
companyName Company Name. string
country Country code uses ISO2, 2-digit format. string
firstName First Name. string
lastName Last Name. string
postalCode Address Postal Code. string
region Address Region. string

BillingProfile

Name Description Value
properties A billing profile. BillingProfileProperties

BillingProfileProperties

Name Description Value
address Billing address. Address
displayName The billing profile name. string
enabledAzureSKUs Information about the product. EnabledAzureSKUs[]
invoiceSections The invoice sections associated to the billing profile. InvoiceSection[]
poNumber Purchase order number. string

EnabledAzureSKUs

Name Description Value
skuId The sku id. string

InvoiceSection

Name Description Value
properties The InvoiceSection. InvoiceSectionProperties

InvoiceSectionProperties

Name Description Value
billingProfiles The billing profiles associated to the billing account. BillingProfile[]
displayName The name of the InvoiceSection. string

Usage Examples

Terraform Samples

A basic example of deploying Billing Accounts Billing Profiles.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "billing_account_id" {
  type        = string
  description = "Specify Billing Account Id for Billing Profile"
}

variable "payment_method_id" {
  type        = string
  description = "Specify Payment Method Id (For example: Credit Card and etc)"
}

variable "payment_sca_id" {
  type        = string
  description = "Specify Payment SCA Id for Payment Method Validation"
}

resource "azapi_resource" "billingProfile" {
  type      = "Microsoft.Billing/billingAccounts/billingProfiles@2024-04-01"
  parent_id = "/providers/Microsoft.Billing/billingAccounts/${var.billing_account_id}"
  name      = var.resource_name

  body = {
    properties = {
      billTo = {
        addressLine1   = "TestWay"
        city           = "Redmond"
        companyName    = "TestCompany"
        country        = "US"
        postalCode     = "12345-1234"
        region         = "WA"
        isValidAddress = true
      }
      displayName = var.resource_name
      enabledAzurePlans = [
        {
          skuId = "0001"
        }
      ]
      shipTo = {
        addressLine1   = "TestWay"
        city           = "Redmond"
        companyName    = "TestCompany"
        country        = "US"
        postalCode     = "12345-1234"
        region         = "WA"
        isValidAddress = true
      }
    }
  }

  create_headers = {
    "X-Ms-Payment-Method-Id" = var.payment_method_id
    "X-Ms-Payment-Sca-Id"    = var.payment_sca_id
  }

  schema_validation_enabled = false
  response_export_values    = ["*"]
}