Cost Allocation Rules - Get

Referens

Service:: Cost Management

API Version:: 2023-11-01

Hämta en kostnadsallokeringsregel efter regelnamn och faktureringskonto eller företagsregistrering.

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

URI-parametrar

Name I Obligatorisk Typ Description

billingAccountId

path

True

string

FaktureringKonto-ID

ruleName

path

True

string

Namn på kostnadsallokeringsregel. Namnet får inte innehålla blanksteg eller andra icke-alfanumeriska tecken än _och -. Maxlängden är 260 tecken.

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

api-version

query

True

string

Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	CostAllocationRuleDefinition	OK. Begäran har slutförts.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

CostAllocationRules

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule?api-version=2023-11-01

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": "NotActive",
    "details": {
      "sourceResources": [
        {
          "resourceType": "Dimension",
          "name": "ResourceGroupName",
          "values": [
            "sampleRG"
          ]
        }
      ],
      "targetResources": [
        {
          "resourceType": "Dimension",
          "policyType": "FixedProportion",
          "name": "ResourceGroupName",
          "values": [
            {
              "name": "destinationRG",
              "percentage": 50
            },
            {
              "name": "destinationRG2",
              "percentage": 50
            }
          ]
        }
      ]
    }
  }
}

Definitioner

Name	Description
CostAllocationPolicyType	Metod att använda för att allokera kostnader. FixedProportion anger att kostnaden delas upp baserat på angivna procentvärden.
CostAllocationProportion	Målresurser och allokering
CostAllocationResourceType	Resurskategori som ska användas för allokering.
CostAllocationRuleDefinition	Modelldefinitionen för kostnadsallokeringsregeln
CostAllocationRuleDetails	Resursinformation för kostnadsallokeringsregeln
CostAllocationRuleProperties	Egenskaperna för en kostnadsallokeringsregel
ErrorDetails	Information om felet.
ErrorResponse	Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet. Några felsvar: 429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Vänta så lång tid som anges i rubriken ”Retry-After” och försök igen.
RuleStatus	Aktuell status för regeln.
SourceCostAllocationResource	Källresurser för kostnadsallokering
TargetCostAllocationResource	Målresurser för kostnadsallokering.

CostAllocationPolicyType

Metod att använda för att allokera kostnader. FixedProportion anger att kostnaden delas upp baserat på angivna procentvärden.

Name	Typ	Description
FixedProportion	string

CostAllocationProportion

Målresurser och allokering

Name	Typ	Description
name	string	Målresurs för kostnadsallokering
percentage	number	Procentandel av källkostnaden som ska allokeras till den här resursen. Det här värdet kan anges till två decimaler och den totala procentandelen av alla resurser i den här regeln måste summeras till 100,00.

CostAllocationResourceType

Resurskategori som ska användas för allokering.

Name	Typ	Description
Dimension	string	Anger att en Azure-dimension, till exempel ett prenumerations-ID eller resursgruppsnamn, används för allokering.
Tag	string	Allokerar kostnader baserat på Nyckel/värde-par för Azure-taggar.

CostAllocationRuleDefinition

Modelldefinitionen för kostnadsallokeringsregeln

Name	Typ	Description
id	string	Azure Resource Manager-ID för regeln. Det här är ett ony-värde för läsning.
name	string	Regelns namn. Det här är ett skrivskyddat värde.
properties	CostAllocationRuleProperties	Egenskaper för kostnadsallokeringsregel
type	string	Regelns resurstyp. Det här är ett skrivskyddat värde för Microsoft.CostManagement/CostAllocationRule.

CostAllocationRuleDetails

Resursinformation för kostnadsallokeringsregeln

Name	Typ	Description
sourceResources	SourceCostAllocationResource[]	Källresurser för kostnadsallokering. För närvarande får den här listan inte innehålla fler än ett element.
targetResources	TargetCostAllocationResource[]	Målresurser för kostnadsallokering. För närvarande får den här listan inte innehålla fler än ett element.

CostAllocationRuleProperties

Egenskaperna för en kostnadsallokeringsregel

Name	Typ	Description
createdDate	string	Tidpunkt då regeln skapades. Regler som ändrar kostnaden för samma resurs tillämpas i skapandeordning.
description	string	Beskrivning av en kostnadsallokeringsregel.
details	CostAllocationRuleDetails	Resursinformation för kostnadsallokeringsregeln
status	RuleStatus	Status för regeln
updatedDate	string	Tidpunkt då regeln senast uppdaterades.

ErrorDetails

Information om felet.

Name	Typ	Description
code	string	Felkod.
message	string	Felmeddelande som anger varför åtgärden misslyckades.

ErrorResponse

Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Några felsvar:

429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Vänta så lång tid som anges i rubriken ”Retry-After” och försök igen.

Name	Typ	Description
error	ErrorDetails	Information om felet.

RuleStatus

Aktuell status för regeln.

Name	Typ	Description
Active	string	Regeln sparas och påverkar kostnadsallokeringen.
NotActive	string	Regeln sparas men används inte för att allokera kostnader.
Processing	string	Regeln sparas och kostnadsallokeringen uppdateras. Skrivskyddat värde som inte kan skickas i en put-begäran.

SourceCostAllocationResource

Källresurser för kostnadsallokering

Name	Typ	Description
name	string	Om resurstypen är dimension måste den vara antingen ResourceGroupName eller SubscriptionId. Om resurstypen är tagg måste detta vara en giltig Azure-tagg
resourceType	CostAllocationResourceType	Typ av resurser som ingår i den här kostnadsallokeringsregeln
values	string[]	Källresurser för kostnadsallokering. Den här listan får inte innehålla fler än 25 värden.

TargetCostAllocationResource

Målresurser för kostnadsallokering.

Name	Typ	Description
name	string	Om resurstypen är dimension måste den vara antingen ResourceGroupName eller SubscriptionId. Om resurstypen är tagg måste detta vara en giltig Azure-tagg
policyType	CostAllocationPolicyType	Metod för kostnadsallokering för regeln
resourceType	CostAllocationResourceType	Typ av resurser som ingår i den här kostnadsallokeringsregeln
values	CostAllocationProportion[]	Målresurser för kostnadsallokering. Den här listan får inte innehålla fler än 25 värden.