Cost Allocation Rules - Create Or Update

Referenz

Dienst:: Cost Management

API-Version:: 2024-08-01

Erstellen/Aktualisieren einer Regel zum Zuordnen von Kosten zwischen verschiedenen Ressourcen innerhalb eines Abrechnungskontos oder einer Unternehmensregistrierung.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung

Name	In	Erforderlich	Typ	Beschreibung
billingAccountId	path	True	string	BillingAccount-ID
ruleName	path	True	string	Name der Kostenzuordnungsregel. Der Name darf keine Leerzeichen oder keine anderen alphanumerischen Zeichen als '_' und '-' enthalten. Die maximale Länge beträgt 260 Zeichen. RegEx-Muster: `[A-Za-z0-9\-_]+`
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

billingAccountId

path

True

string

BillingAccount-ID

ruleName

path

True

string

Name der Kostenzuordnungsregel. Der Name darf keine Leerzeichen oder keine anderen alphanumerischen Zeichen als '_' und '-' enthalten. Die maximale Länge beträgt 260 Zeichen.

RegEx-Muster: [A-Za-z0-9\-_]+

api-version

query

True

string

Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
properties	CostAllocationRuleProperties	Kostenzuordnungsregeleigenschaften

Antworten

Name	Typ	Beschreibung
200 OK	CostAllocationRuleDefinition	OKAY. Die Updateanforderung ist erfolgreich.
201 Created	CostAllocationRuleDefinition	Erstellt. Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

CostAllocationRulesCreateResourceGroup

CostAllocationRulesCreateTag

CostAllocationRulesCreateResourceGroup

Beispielanforderung

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
            }
          ]
        }
      ]
    }
  }
}

Beispiel für eine Antwort

Statuscode:: 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
            }
          ]
        }
      ]
    }
  }
}

Statuscode:: 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

Beispielanforderung

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
            }
          ]
        }
      ]
    }
  }
}

Beispiel für eine Antwort

Statuscode:: 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
            }
          ]
        }
      ]
    }
  }
}

Statuscode:: 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
            }
          ]
        }
      ]
    }
  }
}

Definitionen

Name	Beschreibung
CostAllocationPolicyType	Methode, die für die Zuordnung von Kosten verwendet werden soll. FixedProportion gibt an, dass die Kosten basierend auf den angegebenen Prozentwerten aufgeteilt werden.
CostAllocationProportion	Zielressourcen und -zuordnung
CostAllocationResourceType	Kategorie der Ressource, die für die Zuordnung verwendet werden soll.
CostAllocationRuleDefinition	Definition des Kostenzuordnungsregelmodells
CostAllocationRuleDetails	Ressourcendetails der Kostenzuordnungsregel
CostAllocationRuleProperties	Die Eigenschaften einer Kostenzuordnungsregel
ErrorDetails	Die Details des Fehlers.
ErrorResponse	Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben. Einige Fehlerantworten: 429 TooManyRequests – Anforderung wird gedrosselt. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit. 503 ServiceUnavailable – Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "Retry-After" angegebene Zeit.
RuleStatus	Aktueller Status der Regel.
SourceCostAllocationResource	Quellressourcen für die Kostenzuordnung
TargetCostAllocationResource	Zielressourcen für die Kostenzuordnung.

CostAllocationPolicyType

Methode, die für die Zuordnung von Kosten verwendet werden soll. FixedProportion gibt an, dass die Kosten basierend auf den angegebenen Prozentwerten aufgeteilt werden.

Name	Typ	Beschreibung
FixedProportion	string

CostAllocationProportion

Zielressourcen und -zuordnung

Name	Typ	Beschreibung
name	string	Zielressource für kostenzuordnung
percentage	number	Prozentsatz der Quellkosten, die dieser Ressource zugeordnet werden sollen. Dieser Wert kann auf zwei Dezimalstellen angegeben werden, und der Gesamtprozentsatz aller Ressourcen in dieser Regel muss auf 100,00 addiert werden.

CostAllocationResourceType

Kategorie der Ressource, die für die Zuordnung verwendet werden soll.

Name	Typ	Beschreibung
Dimension	string	Gibt eine Azure-Dimension an, z. B. eine Abonnement-ID oder einen Ressourcengruppennamen, wird für die Zuordnung verwendet.
Tag	string	Ordnet Kosten basierend auf Azure Tag-Schlüsselwertpaaren zu.

CostAllocationRuleDefinition

Definition des Kostenzuordnungsregelmodells

Name	Typ	Beschreibung
id	string	Azure Resource Manager-ID für die Regel. Dies ist ein schreibgeschützter Wert.
name	string	Name der Regel. Dies ist ein schreibgeschützter Wert.
properties	CostAllocationRuleProperties	Kostenzuordnungsregeleigenschaften
type	string	Ressourcentyp der Regel. Dies ist ein schreibgeschützter Wert von Microsoft.CostManagement/CostAllocationRule.

CostAllocationRuleDetails

Ressourcendetails der Kostenzuordnungsregel

Name	Typ	Beschreibung
sourceResources	SourceCostAllocationResource[]	Quellressourcen für die Kostenzuordnung. Zu diesem Zeitpunkt kann diese Liste nicht mehr als ein Element enthalten.
targetResources	TargetCostAllocationResource[]	Zielressourcen für die Kostenzuordnung. Zu diesem Zeitpunkt kann diese Liste nicht mehr als ein Element enthalten.

CostAllocationRuleProperties

Die Eigenschaften einer Kostenzuordnungsregel

Name	Typ	Beschreibung
createdDate	string	Zeitpunkt, zu dem die Regel erstellt wurde. Regeln, die die Kosten für dieselbe Ressource ändern, werden in der Reihenfolge der Erstellung angewendet.
description	string	Beschreibung einer Kostenzuteilungsregel.
details	CostAllocationRuleDetails	Ressourceninformationen für die Kostenzuordnungsregel
status	RuleStatus	Status der Regel
updatedDate	string	Zeitpunkt, zu dem die Regel zuletzt aktualisiert wurde.

ErrorDetails

Die Details des Fehlers.

Name	Typ	Beschreibung
code	string	Fehlercode.
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ErrorResponse

Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Einige Fehlerantworten:

429 TooManyRequests – Anforderung wird gedrosselt. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit.
503 ServiceUnavailable – Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "Retry-After" angegebene Zeit.

Name	Typ	Beschreibung
error	ErrorDetails	Die Details des Fehlers.

RuleStatus

Aktueller Status der Regel.

Name	Typ	Beschreibung
Active	string	Die Regel wird gespeichert und wirkt sich auf die Kostenzuteilung aus.
NotActive	string	Regel wird gespeichert, aber nicht zum Zuordnen von Kosten verwendet.
Processing	string	Regel wird gespeichert und Kostenzuordnung wird aktualisiert. Readonly-Wert, der nicht in einer Put-Anforderung übermittelt werden kann.

SourceCostAllocationResource

Quellressourcen für die Kostenzuordnung

Name	Typ	Beschreibung
name	string	Wenn der Ressourcentyp dimensioniert ist, muss dies entweder "ResourceGroupName" oder "SubscriptionId" sein. Wenn der Ressourcentyp tagt, muss dies ein gültiges Azure-Tag sein.
resourceType	CostAllocationResourceType	Ressourcentyp, der in dieser Kostenzuordnungsregel enthalten ist
values	string[]	Quellressourcen für die Kostenzuordnung. Diese Liste darf nicht mehr als 25 Werte enthalten.

TargetCostAllocationResource

Zielressourcen für die Kostenzuordnung.

Name	Typ	Beschreibung
name	string	Wenn der Ressourcentyp dimensioniert ist, muss dies entweder "ResourceGroupName" oder "SubscriptionId" sein. Wenn der Ressourcentyp tagt, muss dies ein gültiges Azure-Tag sein.
policyType	CostAllocationPolicyType	Methode der Kostenzuteilung für die Regel
resourceType	CostAllocationResourceType	Ressourcentyp, der in dieser Kostenzuordnungsregel enthalten ist
values	CostAllocationProportion[]	Zielressourcen für die Kostenzuordnung. Diese Liste darf nicht mehr als 25 Werte enthalten.

Freigeben über

Cost Allocation Rules - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

CostAllocationRulesCreateResourceGroup

Beispielanforderung

Beispiel für eine Antwort

CostAllocationRulesCreateTag

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CostAllocationPolicyType

CostAllocationProportion

CostAllocationResourceType

CostAllocationRuleDefinition

CostAllocationRuleDetails

CostAllocationRuleProperties

ErrorDetails

ErrorResponse

RuleStatus

SourceCostAllocationResource

TargetCostAllocationResource

Zusätzliche Ressourcen