Subscriptions - List

Služba:

Resource Management

Verze rozhraní API:

2022-12-01

Získá všechna předplatná pro tenanta.

GET https://management.azure.com/subscriptions?api-version=2022-12-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	SubscriptionListResult	Operace Azure byla úspěšně dokončena.
Other Status Codes	CloudError	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

Příklady

GetAllSubscriptions

Ukázkový požadavek

HTTP

GET https://management.azure.com/subscriptions?api-version=2022-12-01

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource.subscriptions import SubscriptionClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource-subscriptions
# USAGE
    python get_subscriptions.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SubscriptionClient(
        credential=DefaultAzureCredential(),
    )

    response = client.subscriptions.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/subscriptions/stable/2022-12-01/examples/GetSubscriptions.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Ukázková odpověď

Stavový kód:

200

{
  "nextLink": "http://nextlink",
  "value": [
    {
      "authorizationSource": "RoleBased",
      "displayName": "Example Subscription",
      "id": "/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
      "managedByTenants": [
        {
          "tenantId": "8f70baf1-1f6e-46a2-a1ff-238dac1ebfb7"
        }
      ],
      "state": "Enabled",
      "subscriptionId": "291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
      "subscriptionPolicies": {
        "locationPlacementId": "Internal_2014-09-01",
        "quotaId": "Internal_2014-09-01",
        "spendingLimit": "Off"
      },
      "tags": {
        "tagKey1": "tagValue1",
        "tagKey2": "tagValue2"
      },
      "tenantId": "31c75423-32d6-4322-88b7-c478bdde4858"
    },
    {
      "authorizationSource": "RoleBased",
      "displayName": "Example Subscription2",
      "id": "/subscriptions/72ac930a-f34e-42d8-b06d-dc2a9e12ed71",
      "managedByTenants": [
        {
          "tenantId": "8f70baf1-1f6e-46a2-a1ff-238dac1ebfb7"
        },
        {
          "tenantId": "f7fb6af2-321d-47c8-9c0f-b0239eaad39a"
        }
      ],
      "state": "Enabled",
      "subscriptionId": "72ac930a-f34e-42d8-b06d-dc2a9e12ed71",
      "subscriptionPolicies": {
        "locationPlacementId": "Internal_2014-09-01",
        "quotaId": "Internal_2014-09-01",
        "spendingLimit": "Off"
      },
      "tags": {
        "tagKey1": "tagValue1",
        "tagKey2": "tagValue2"
      },
      "tenantId": "2a0ff0de-96b2-4859-bb7c-a430d07a3e0c"
    }
  ]
}

Definice

Name	Description
CloudError	Odpověď na chybu žádosti o správu prostředků.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
ManagedByTenant	Informace o tenantovi, který spravuje předplatné.
SpendingLimit	Limit útraty předplatného.
Subscription	Informace o předplatném
SubscriptionListResult	Odpověď operace seznamu odběrů.
SubscriptionPolicies	Zásady předplatného
SubscriptionState	Stav předplatného. Možné hodnoty jsou Povolené, Warned, PastDue, Disabled a Deleted.

CloudError

Objekt

Odpověď na chybu žádosti o správu prostředků.

Name	Typ	Description
error	ErrorResponse	Chybová odpověď Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

ManagedByTenant

Objekt

Informace o tenantovi, který spravuje předplatné.

Name	Typ	Description
tenantId	string	ID tenanta pro správu tenanta. Toto je identifikátor GUID.

SpendingLimit

Výčet

Limit útraty předplatného.

Hodnota	Description
On	On
Off	Vypnuto
CurrentPeriodOff	CurrentPeriodOff

Subscription

Objekt

Informace o předplatném

Name	Typ	Description
authorizationSource	string	Zdroj autorizace požadavku. Platné hodnoty jsou jedna nebo více kombinací starší verze, RoleBased, Vynechané, Přímé a správy. Například Legacy, RoleBased.
displayName	string	Zobrazovaný název předplatného.
id	string	Plně kvalifikované ID předplatného. Například /subscriptions/8d65815f-a5b6-402f-9298-045155da7d7d74
managedByTenants	ManagedByTenant[]	Pole obsahující tenanty, kteří spravují předplatné.
state	SubscriptionState	Stav předplatného. Možné hodnoty jsou Povolené, Warned, PastDue, Disabled a Deleted.
subscriptionId	string	ID předplatného.
subscriptionPolicies	SubscriptionPolicies	Zásady předplatného.
tags	object	Značky připojené k předplatnému.
tenantId	string	ID tenanta předplatného.

SubscriptionListResult

Objekt

Odpověď operace seznamu odběrů.

Name	Typ	Description
nextLink	string (uri)	Odkaz na další stránku položek
value	Subscription[]	Položky předplatného na této stránce

SubscriptionPolicies

Objekt

Zásady předplatného

Name	Typ	Description
locationPlacementId	string	ID umístění umístění předplatného. ID označuje, které oblasti jsou viditelné pro předplatné. Například předplatné s ID umístění umístění Public_2014-09-01 má přístup k veřejným oblastem Azure.
quotaId	string	ID kvóty předplatného.
spendingLimit	SpendingLimit	Limit útraty předplatného.

SubscriptionState

Výčet

Stav předplatného. Možné hodnoty jsou Povolené, Warned, PastDue, Disabled a Deleted.

Hodnota	Description
Enabled	Enabled
Warned	Varováno
PastDue	PastDue
Disabled	Disabled
Deleted	Odstraněno