Cost Allocation Rules - Create Or Update

Referência

Serviço:: Cost Management

Versão da API:: 2024-08-01

Crie/atualize uma regra para alocar custos entre diferentes recursos em uma conta de cobrança ou inscrição corporativa.

PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules/{ruleName}?api-version=2024-08-01

Parâmetros do URI

Name Em Necessário Tipo Description

Name	Em	Necessário	Tipo	Description
billingAccountId	path	True	string	FaturaçãoID da conta
ruleName	path	True	string	Nome da regra de alocação de custos. O nome não pode incluir espaços ou caracteres não alfanuméricos além de '_' e '-'. O comprimento máximo é de 260 caracteres. Padrão Regex: `[A-Za-z0-9\-_]+`
api-version	query	True	string	A versão da API a ser usada para esta operação.

billingAccountId

path

True

string

FaturaçãoID da conta

ruleName

path

True

string

Nome da regra de alocação de custos. O nome não pode incluir espaços ou caracteres não alfanuméricos além de '_' e '-'. O comprimento máximo é de 260 caracteres.

Padrão Regex: [A-Za-z0-9\-_]+

api-version

query

True

string

A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Tipo	Description
properties	CostAllocationRuleProperties	Propriedades da regra de alocação de custos

Respostas

Name	Tipo	Description
200 OK	CostAllocationRuleDefinition	OK. A solicitação de atualização foi bem-sucedida.
201 Created	CostAllocationRuleDefinition	Criado. O pedido foi bem-sucedido.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

CostAllocationRulesCreateResourceGroup

CostAllocationRulesCreateTag

CostAllocationRulesCreateResourceGroup

Pedido de amostra

HTTP

PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule?api-version=2024-08-01

{
  "properties": {
    "description": "This is a testRule",
    "status": "Active",
    "details": {
      "sourceResources": [
        {
          "resourceType": "Dimension",
          "name": "ResourceGroupName",
          "values": [
            "sampleRG",
            "secondRG"
          ]
        }
      ],
      "targetResources": [
        {
          "resourceType": "Dimension",
          "policyType": "FixedProportion",
          "name": "ResourceGroupName",
          "values": [
            {
              "name": "destinationRG",
              "percentage": 45
            },
            {
              "name": "destinationRG2",
              "percentage": 54
            }
          ]
        }
      ]
    }
  }
}

Resposta da amostra

Código de estado:: 200

{
  "id": "providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule",
  "name": "testRule",
  "type": "Microsoft.CostManagement/costAllocationRules",
  "properties": {
    "description": "This is a testRule",
    "createdDate": "2020-06-18T22:21:51.1287144Z",
    "updatedDate": "2020-06-18T22:21:51.1287144Z",
    "status": "Creating",
    "details": {
      "sourceResources": [
        {
          "resourceType": "Dimension",
          "name": "ResourceGroupName",
          "values": [
            "sampleRG"
          ]
        }
      ],
      "targetResources": [
        {
          "resourceType": "Dimension",
          "policyType": "FixedProportion",
          "name": "ResourceGroupName",
          "values": [
            {
              "name": "destinationRG",
              "percentage": 50
            },
            {
              "name": "destinationRG2",
              "percentage": 50
            }
          ]
        }
      ]
    }
  }
}

Código de estado:: 201

{
  "id": "providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule",
  "name": "testRule",
  "type": "Microsoft.CostManagement/costAllocationRules",
  "properties": {
    "description": "This is a testRule",
    "createdDate": "2020-06-18T22:21:51.1287144Z",
    "updatedDate": "2020-06-18T22:21:51.1287144Z",
    "status": "Creating",
    "details": {
      "sourceResources": [
        {
          "resourceType": "Dimension",
          "name": "ResourceGroupName",
          "values": [
            "sampleRG"
          ]
        }
      ],
      "targetResources": [
        {
          "resourceType": "Dimension",
          "policyType": "FixedProportion",
          "name": "ResourceGroupName",
          "values": [
            {
              "name": "destinationRG",
              "percentage": 50
            },
            {
              "name": "destinationRG2",
              "percentage": 50
            }
          ]
        }
      ]
    }
  }
}

CostAllocationRulesCreateTag

Pedido de amostra

HTTP

PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule?api-version=2024-08-01

{
  "properties": {
    "description": "This is a testRule",
    "status": "Active",
    "details": {
      "sourceResources": [
        {
          "resourceType": "Tag",
          "name": "category",
          "values": [
            "devops"
          ]
        }
      ],
      "targetResources": [
        {
          "resourceType": "Dimension",
          "policyType": "FixedProportion",
          "name": "ResourceGroupName",
          "values": [
            {
              "name": "destinationRG",
              "percentage": 33.33
            },
            {
              "name": "destinationRG2",
              "percentage": 33.33
            },
            {
              "name": "destinationRG3",
              "percentage": 33.34
            }
          ]
        }
      ]
    }
  }
}

Resposta da amostra

Código de estado:: 200

{
  "id": "providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule",
  "name": "testRule",
  "type": "Microsoft.CostManagement/costAllocationRules",
  "properties": {
    "description": "This is a testRule",
    "createdDate": "2020-06-18T22:21:51.1287144Z",
    "updatedDate": "2020-06-18T22:21:51.1287144Z",
    "status": "Creating",
    "details": {
      "sourceResources": [
        {
          "resourceType": "Dimension",
          "name": "ResourceGroupName",
          "values": [
            "sampleRG"
          ]
        }
      ],
      "targetResources": [
        {
          "resourceType": "Dimension",
          "policyType": "FixedProportion",
          "name": "ResourceGroupName",
          "values": [
            {
              "name": "destinationRG",
              "percentage": 50
            },
            {
              "name": "destinationRG2",
              "percentage": 50
            }
          ]
        }
      ]
    }
  }
}

Código de estado:: 201

{
  "id": "providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule",
  "name": "testRule",
  "type": "Microsoft.CostManagement/costAllocationRules",
  "properties": {
    "description": "This is a testRule",
    "createdDate": "2020-06-18T22:21:51.1287144Z",
    "updatedDate": "2020-06-18T22:21:51.1287144Z",
    "status": "Creating",
    "details": {
      "sourceResources": [
        {
          "resourceType": "Dimension",
          "name": "ResourceGroupName",
          "values": [
            "sampleRG"
          ]
        }
      ],
      "targetResources": [
        {
          "resourceType": "Dimension",
          "policyType": "FixedProportion",
          "name": "ResourceGroupName",
          "values": [
            {
              "name": "destinationRG",
              "percentage": 50
            },
            {
              "name": "destinationRG2",
              "percentage": 50
            }
          ]
        }
      ]
    }
  }
}

Definições

Name	Description
CostAllocationPolicyType	Método a utilizar para a imputação dos custos. FixedProportion indica que o custo será dividido com base em valores percentuais especificados.
CostAllocationProportion	Destinar recursos e alocação
CostAllocationResourceType	Categoria de recurso a utilizar para alocação.
CostAllocationRuleDefinition	A definição do modelo de regra de alocação de custos
CostAllocationRuleDetails	Detalhes do recurso da regra de alocação de custos
CostAllocationRuleProperties	As propriedades de uma regra de alocação de custos
ErrorDetails	Os detalhes do erro.
ErrorResponse	A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro. Algumas respostas de erro: 429 TooManyRequests - A solicitação está limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiçoIndisponível - O serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "Retry-After".
RuleStatus	Situação atual da regra.
SourceCostAllocationResource	Recursos de origem para alocação de custos
TargetCostAllocationResource	Direcione recursos para alocação de custos.

CostAllocationPolicyType

Método a utilizar para a imputação dos custos. FixedProportion indica que o custo será dividido com base em valores percentuais especificados.

Name	Tipo	Description
FixedProportion	string

CostAllocationProportion

Destinar recursos e alocação

Name	Tipo	Description
name	string	Recurso de destino para alocação de custos
percentage	number	Porcentagem do custo de origem a ser alocado a este recurso. Esse valor pode ser especificado com duas casas decimais e a porcentagem total de todos os recursos nesta regra deve ser somada a 100,00.

CostAllocationResourceType

Categoria de recurso a utilizar para alocação.

Name	Tipo	Description
Dimension	string	Indica que uma dimensão do Azure, como uma ID de assinatura ou nome de grupo de recursos, está sendo usada para alocação.
Tag	string	Aloca o custo com base nos pares de valores de chave da Tag do Azure.

CostAllocationRuleDefinition

A definição do modelo de regra de alocação de custos

Name	Tipo	Description
id	string	ID do Azure Resource Manager para a regra. Este é um valor de leitura.
name	string	Nome da regra. Este é um valor somente leitura.
properties	CostAllocationRuleProperties	Propriedades da regra de alocação de custos
type	string	Tipo de recurso da regra. Este é um valor somente leitura de Microsoft.CostManagement/CostAllocationRule.

CostAllocationRuleDetails

Detalhes do recurso da regra de alocação de custos

Name	Tipo	Description
sourceResources	SourceCostAllocationResource[]	Recursos de origem para alocação de custos. Neste momento, esta lista não pode conter mais do que um elemento.
targetResources	TargetCostAllocationResource[]	Direcione recursos para alocação de custos. Neste momento, esta lista não pode conter mais do que um elemento.

CostAllocationRuleProperties

As propriedades de uma regra de alocação de custos

Name	Tipo	Description
createdDate	string	Momento em que a regra foi criada. As regras que alteram o custo para o mesmo recurso são aplicadas por ordem de criação.
description	string	Descrição de uma regra de repartição de custos.
details	CostAllocationRuleDetails	Informações de recursos para a regra de alocação de custos
status	RuleStatus	Estatuto da regra
updatedDate	string	Hora em que a regra foi atualizada pela última vez.

ErrorDetails

Os detalhes do erro.

Name	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro indicando por que a operação falhou.

ErrorResponse

A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Algumas respostas de erro:

429 TooManyRequests - A solicitação está limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiçoIndisponível - O serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "Retry-After".

Name	Tipo	Description
error	ErrorDetails	Os detalhes do erro.

RuleStatus

Situação atual da regra.

Name	Tipo	Description
Active	string	A regra é salva e afeta a alocação de custos.
NotActive	string	A regra é salva, mas não usada para alocar custos.
Processing	string	A regra é salva e a alocação de custos está sendo atualizada. Valor somente leitura que não pode ser enviado em uma solicitação put.

SourceCostAllocationResource

Recursos de origem para alocação de custos

Name	Tipo	Description
name	string	Se o tipo de recurso for dimensão, deverá ser ResourceGroupName ou SubscriptionId. Se o tipo de recurso for a tag, esta deve ser uma marca válida do Azure
resourceType	CostAllocationResourceType	Tipo de recursos contidos nesta regra de alocação de custos
values	string[]	Recursos de origem para alocação de custos. Esta lista não pode conter mais de 25 valores.

TargetCostAllocationResource

Direcione recursos para alocação de custos.

Name	Tipo	Description
name	string	Se o tipo de recurso for dimensão, deverá ser ResourceGroupName ou SubscriptionId. Se o tipo de recurso for a tag, esta deve ser uma marca válida do Azure
policyType	CostAllocationPolicyType	Método de imputação dos custos da regra
resourceType	CostAllocationResourceType	Tipo de recursos contidos nesta regra de alocação de custos
values	CostAllocationProportion[]	Direcione recursos para alocação de custos. Esta lista não pode conter mais de 25 valores.

Partilhar via

Cost Allocation Rules - Create Or Update

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

CostAllocationRulesCreateResourceGroup

Pedido de amostra

Resposta da amostra

CostAllocationRulesCreateTag

Pedido de amostra

Resposta da amostra

Definições

CostAllocationPolicyType

CostAllocationProportion

CostAllocationResourceType

CostAllocationRuleDefinition

CostAllocationRuleDetails

CostAllocationRuleProperties

ErrorDetails

ErrorResponse

RuleStatus

SourceCostAllocationResource

TargetCostAllocationResource

Recursos adicionais