Cost Allocation Rules - Get

Odwołanie

Usługa:: Cost Management

Wersja interfejsu API:: 2023-11-01

Uzyskaj regułę alokacji kosztów według nazwy reguły i konta rozliczeniowego lub rejestracji przedsiębiorstwa.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis

billingAccountId

path

True

string

Identyfikator konta rozliczeniowego

ruleName

path

True

string

Nazwa reguły alokacji kosztów. Nazwa nie może zawierać spacji ani znaków innych niż "_" i "-". Maksymalna długość to 260 znaków.

Wzorzec wyrażenia regularnego: [A-Za-z0-9\-_]+

api-version

query

True

string

Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CostAllocationRuleDefinition	OK. Żądanie zakończyło się pomyślnie.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

CostAllocationRules

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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
            }
          ]
        }
      ]
    }
  }
}

Definicje

Nazwa	Opis
CostAllocationPolicyType	Metoda do przydzielenia kosztów. FixedProportion wskazuje, że koszt zostanie podzielony na podstawie określonych wartości procentowych.
CostAllocationProportion	Zasoby docelowe i alokacja
CostAllocationResourceType	Kategoria zasobu do użycia do alokacji.
CostAllocationRuleDefinition	Definicja modelu reguł alokacji kosztów
CostAllocationRuleDetails	Szczegóły zasobu reguły alokacji kosztów
CostAllocationRuleProperties	Właściwości reguły alokacji kosztów
ErrorDetails	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie. Niektóre odpowiedzi na błędy: 429 TooManyRequests — żądanie jest ograniczane. Ponów próbę po upływie czasu określonego w nagłówku "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable — usługa jest tymczasowo niedostępna. Poczekaj przez czas określony w nagłówku „Retry-After” i spróbuj ponownie.
RuleStatus	Bieżący stan reguły.
SourceCostAllocationResource	Zasoby źródłowe do alokacji kosztów
TargetCostAllocationResource	Docelowe zasoby do alokacji kosztów.

CostAllocationPolicyType

Metoda do przydzielenia kosztów. FixedProportion wskazuje, że koszt zostanie podzielony na podstawie określonych wartości procentowych.

Nazwa	Typ	Opis
FixedProportion	string

CostAllocationProportion

Zasoby docelowe i alokacja

Nazwa	Typ	Opis
name	string	Docelowy zasób alokacji kosztów
percentage	number	Procent kosztów źródłowych do przydzielenia do tego zasobu. Tę wartość można określić do dwóch miejsc dziesiętnych, a łączna wartość procentowa wszystkich zasobów w tej regule musi wynosić 100,00.

CostAllocationResourceType

Kategoria zasobu do użycia do alokacji.

Nazwa	Typ	Opis
Dimension	string	Wskazuje wymiar platformy Azure, taki jak identyfikator subskrypcji lub nazwa grupy zasobów, jest używany do alokacji.
Tag	string	Przydziela koszt na podstawie par klucz tagu platformy Azure.

CostAllocationRuleDefinition

Definicja modelu reguł alokacji kosztów

Nazwa	Typ	Opis
id	string	Identyfikator Resource Manager platformy Azure dla reguły. Jest to wartość odczytana.
name	string	Nazwa reguły. Jest to wartość tylko do odczytu.
properties	CostAllocationRuleProperties	Właściwości reguły alokacji kosztów
type	string	Typ zasobu reguły. Jest to wartość tylko do odczytu microsoft.CostManagement/CostAllocationRule.

CostAllocationRuleDetails

Szczegóły zasobu reguły alokacji kosztów

Nazwa	Typ	Opis
sourceResources	SourceCostAllocationResource[]	Zasoby źródłowe do alokacji kosztów. Obecnie ta lista nie może zawierać więcej niż jednego elementu.
targetResources	TargetCostAllocationResource[]	Docelowe zasoby do alokacji kosztów. Obecnie ta lista nie może zawierać więcej niż jednego elementu.

CostAllocationRuleProperties

Właściwości reguły alokacji kosztów

Nazwa	Typ	Opis
createdDate	string	Godzina utworzenia reguły. Reguły, które zmieniają koszt dla tego samego zasobu, są stosowane w kolejności tworzenia.
description	string	Opis reguły alokacji kosztów.
details	CostAllocationRuleDetails	Informacje o zasobie dla reguły alokacji kosztów
status	RuleStatus	Stan reguły
updatedDate	string	Czas ostatniej aktualizacji reguły.

ErrorDetails

Szczegóły błędu.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

ErrorResponse

Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.

Niektóre odpowiedzi na błędy:

429 TooManyRequests — żądanie jest ograniczane. Ponów próbę po upływie czasu określonego w nagłówku "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable — usługa jest tymczasowo niedostępna. Poczekaj przez czas określony w nagłówku „Retry-After” i spróbuj ponownie.

Nazwa	Typ	Opis
error	ErrorDetails	Szczegóły błędu.

RuleStatus

Bieżący stan reguły.

Nazwa	Typ	Opis
Active	string	Reguła jest zapisywana i ma wpływ na alokację kosztów.
NotActive	string	Reguła jest zapisywana, ale nie jest używana do przydzielania kosztów.
Processing	string	Reguła jest zapisywana, a alokacja kosztów jest aktualizowana. Wartość readonly, której nie można przesłać w żądaniu put.

SourceCostAllocationResource

Zasoby źródłowe do alokacji kosztów

Nazwa	Typ	Opis
name	string	Jeśli typ zasobu ma wymiar, musi to być resourceGroupName lub SubscriptionId. Jeśli typ zasobu jest tagem, musi to być prawidłowy tag platformy Azure
resourceType	CostAllocationResourceType	Typ zasobów zawartych w tej regule alokacji kosztów
values	string[]	Zasoby źródłowe do alokacji kosztów. Ta lista nie może zawierać więcej niż 25 wartości.

TargetCostAllocationResource

Docelowe zasoby do alokacji kosztów.

Nazwa	Typ	Opis
name	string	Jeśli typ zasobu ma wymiar, musi to być resourceGroupName lub SubscriptionId. Jeśli typ zasobu jest tagem, musi to być prawidłowy tag platformy Azure
policyType	CostAllocationPolicyType	Metoda alokacji kosztów dla reguły
resourceType	CostAllocationResourceType	Typ zasobów zawartych w tej regule alokacji kosztów
values	CostAllocationProportion[]	Docelowe zasoby do alokacji kosztów. Ta lista nie może zawierać więcej niż 25 wartości.