Cost Allocation Rules - Create Or Update

Reference

Service:: Cost Management

API Version:: 2023-11-01

Vytvořte nebo aktualizujte pravidlo pro přidělování nákladů mezi různé prostředky v rámci fakturačního účtu nebo podnikové registrace.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description

Name	V	Vyžadováno	Typ	Description
billingAccountId	path	True	string	ID fakturačního účtu
ruleName	path	True	string	Název pravidla alokace nákladů. Název nesmí obsahovat mezery ani jiné než alfanumerické znaky než "_" a "-". Maximální délka je 260 znaků. Regex pattern: `[A-Za-z0-9\-_]+`
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

billingAccountId

path

True

string

ID fakturačního účtu

ruleName

path

True

string

Název pravidla alokace nákladů. Název nesmí obsahovat mezery ani jiné než alfanumerické znaky než "_" a "-". Maximální délka je 260 znaků.

Regex pattern: [A-Za-z0-9\-_]+

api-version

query

True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
properties	CostAllocationRuleProperties	Vlastnosti pravidla alokace nákladů

Odpovědi

Name	Typ	Description
200 OK	CostAllocationRuleDefinition	OK. Žádost o aktualizaci byla úspěšná.
201 Created	CostAllocationRuleDefinition	Vytvořen. Žádost byla úspěšná.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

CostAllocationRulesCreateResourceGroup

CostAllocationRulesCreateTag

CostAllocationRulesCreateResourceGroup

Sample Request

HTTP

PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule?api-version=2023-11-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
            }
          ]
        }
      ]
    }
  }
}

Sample Response

Status code:: 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
            }
          ]
        }
      ]
    }
  }
}

Status code:: 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

Sample Request

HTTP

PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule?api-version=2023-11-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
            }
          ]
        }
      ]
    }
  }
}

Sample Response

Status code:: 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
            }
          ]
        }
      ]
    }
  }
}

Status code:: 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
            }
          ]
        }
      ]
    }
  }
}

Definice

Name	Description
CostAllocationPolicyType	Metoda, která se má použít pro přidělování nákladů. FixedProportion označuje, že náklady budou rozděleny na základě zadaných procentuálních hodnot.
CostAllocationProportion	Cílové prostředky a přidělení
CostAllocationResourceType	Kategorie prostředku, který se má použít pro přidělení.
CostAllocationRuleDefinition	Definice modelu pravidla alokace nákladů
CostAllocationRuleDetails	Podrobnosti o zdroji pravidla alokace nákladů
CostAllocationRuleProperties	Vlastnosti pravidla alokace nákladů
ErrorDetails	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uveden v chybové zprávě. Některé chybové odpovědi: 429 TooManyRequests – Požadavek je omezený. Zkuste to znovu po čekání na dobu uvedenou v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after. 503 ServiceUnavailable – Služba je dočasně nedostupná. Po uplynutí časového limitu uvedeného v hlavičce Retry-After zkuste operaci zopakovat.
RuleStatus	Aktuální stav pravidla.
SourceCostAllocationResource	Zdrojové zdroje pro alokaci nákladů
TargetCostAllocationResource	Cílové prostředky pro alokaci nákladů

CostAllocationPolicyType

Metoda, která se má použít pro přidělování nákladů. FixedProportion označuje, že náklady budou rozděleny na základě zadaných procentuálních hodnot.

Name	Typ	Description
FixedProportion	string

CostAllocationProportion

Cílové prostředky a přidělení

Name	Typ	Description
name	string	Cílový prostředek pro alokaci nákladů
percentage	number	Procento zdrojových nákladů, které se mají tomuto prostředku přidělit Tuto hodnotu lze zadat na dvě desetinná místa a celkové procento všech prostředků v tomto pravidle musí být 100,00.

CostAllocationResourceType

Kategorie prostředku, který se má použít pro přidělení.

Name	Typ	Description
Dimension	string	Označuje dimenzi Azure, například ID předplatného nebo název skupiny prostředků, která se používá k přidělení.
Tag	string	Přiděluje náklady na základě párů hodnot klíče značky Azure.

CostAllocationRuleDefinition

Definice modelu pravidla alokace nákladů

Name	Typ	Description
id	string	ID Resource Manager Azure pro pravidlo. Jedná se o hodnotu read ony.
name	string	Název pravidla: Jedná se o hodnotu jen pro čtení.
properties	CostAllocationRuleProperties	Vlastnosti pravidla alokace nákladů
type	string	Typ prostředku pravidla. Toto je hodnota Microsoft.CostManagement/CostAllocationRule určená jen pro čtení.

CostAllocationRuleDetails

Podrobnosti o zdroji pravidla alokace nákladů

Name	Typ	Description
sourceResources	SourceCostAllocationResource[]	Zdrojové prostředky pro alokaci nákladů. V tuto chvíli může tento seznam obsahovat maximálně jeden prvek.
targetResources	TargetCostAllocationResource[]	Cílové prostředky pro alokaci nákladů V tuto chvíli může tento seznam obsahovat maximálně jeden prvek.

CostAllocationRuleProperties

Vlastnosti pravidla alokace nákladů

Name	Typ	Description
createdDate	string	Čas, ve kterém bylo pravidlo vytvořeno. Pravidla, která mění náklady na stejný prostředek, se použijí v pořadí vytvoření.
description	string	Popis pravidla alokace nákladů
details	CostAllocationRuleDetails	Informace o zdroji pro pravidlo alokace nákladů
status	RuleStatus	Stav pravidla
updatedDate	string	Čas poslední aktualizace pravidla

ErrorDetails

Podrobnosti o chybě.

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva označující, proč operace selhala.

ErrorResponse

Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uveden v chybové zprávě.

Některé chybové odpovědi:

429 TooManyRequests – Požadavek je omezený. Zkuste to znovu po čekání na dobu uvedenou v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after.
503 ServiceUnavailable – Služba je dočasně nedostupná. Po uplynutí časového limitu uvedeného v hlavičce Retry-After zkuste operaci zopakovat.

Name	Typ	Description
error	ErrorDetails	Podrobnosti o chybě.

RuleStatus

Aktuální stav pravidla.

Name	Typ	Description
Active	string	Pravidlo se uloží a ovlivní alokaci nákladů.
NotActive	string	Pravidlo se uloží, ale nepoužívá se k přidělení nákladů.
Processing	string	Pravidlo se uloží a alokace nákladů se aktualizuje. Hodnota jen pro čtení, kterou nelze odeslat v požadavku put.

SourceCostAllocationResource

Zdrojové zdroje pro alokaci nákladů

Name	Typ	Description
name	string	Pokud je typ prostředku dimenze, musí to být ResourceGroupName nebo SubscriptionId. Pokud je typ prostředku značka, musí se jednat o platnou značku Azure.
resourceType	CostAllocationResourceType	Typ prostředků obsažených v tomto pravidle alokace nákladů
values	string[]	Zdrojové prostředky pro alokaci nákladů. Tento seznam nesmí obsahovat více než 25 hodnot.

TargetCostAllocationResource

Cílové prostředky pro alokaci nákladů

Name	Typ	Description
name	string	Pokud je typ prostředku dimenze, musí to být ResourceGroupName nebo SubscriptionId. Pokud je typ prostředku značka, musí se jednat o platnou značku Azure.
policyType	CostAllocationPolicyType	Metoda alokace nákladů pro pravidlo
resourceType	CostAllocationResourceType	Typ prostředků obsažených v tomto pravidle alokace nákladů
values	CostAllocationProportion[]	Cílové prostředky pro alokaci nákladů Tento seznam nesmí obsahovat více než 25 hodnot.

Sdílet prostřednictvím

Cost Allocation Rules - Create Or Update

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Scopes

Příklady

CostAllocationRulesCreateResourceGroup

Sample Request

Sample Response

CostAllocationRulesCreateTag

Sample Request

Sample Response

Definice

CostAllocationPolicyType

CostAllocationProportion

CostAllocationResourceType

CostAllocationRuleDefinition

CostAllocationRuleDetails

CostAllocationRuleProperties

ErrorDetails

ErrorResponse

RuleStatus

SourceCostAllocationResource

TargetCostAllocationResource

Další materiály