Subscriptions - List

Tjänst:

Resource Management

API-version:

2022-12-01

Hämtar alla prenumerationer för en klientorganisation.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	SubscriptionListResult	Azure-operationen slutfördes framgångsrikt.
Other Status Codes	CloudError	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

GetAllSubscriptions

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
CloudError	Ett felsvar för en resurshanteringsbegäran.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
ManagedByTenant	Information om en klientorganisation som hanterar prenumerationen.
SpendingLimit	Utgiftsgränsen för prenumerationen.
Subscription	Prenumerationsinformation.
SubscriptionListResult	Åtgärdssvar för prenumerationslista.
SubscriptionPolicies	Prenumerationsprinciper.
SubscriptionState	Prenumerationstillståndet. Möjliga värden är Aktiverad, Varnad, PastDue, Inaktiverad och Borttagen.

CloudError

Objekt

Ett felsvar för en resurshanteringsbegäran.

Name	Typ	Description
error	ErrorResponse	Felsvar Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

ManagedByTenant

Objekt

Information om en klientorganisation som hanterar prenumerationen.

Name	Typ	Description
tenantId	string	Klientorganisations-ID för den hanterande klientorganisationen. Det här är ett GUID.

SpendingLimit

Uppräkning

Utgiftsgränsen för prenumerationen.

Värde	Description
On	På
Off	Av
CurrentPeriodOff	CurrentPeriodOff

Subscription

Objekt

Prenumerationsinformation.

Name	Typ	Description
authorizationSource	string	Begärans auktoriseringskälla. Giltiga värden är en eller flera kombinationer av Legacy, RoleBased, Bypassed, Direct och Management. Till exempel "Legacy, RoleBased".
displayName	string	Visningsnamnet för prenumerationen.
id	string	Det fullständigt kvalificerade ID:t för prenumerationen. Till exempel /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74
managedByTenants	ManagedByTenant[]	En matris som innehåller klientorganisationer som hanterar prenumerationen.
state	SubscriptionState	Prenumerationstillståndet. Möjliga värden är Aktiverad, Varnad, PastDue, Inaktiverad och Borttagen.
subscriptionId	string	Prenumerations-ID:t.
subscriptionPolicies	SubscriptionPolicies	Prenumerationsprinciperna.
tags	object	Taggarna som är kopplade till prenumerationen.
tenantId	string	Prenumerationens klient-ID.

SubscriptionListResult

Objekt

Åtgärdssvar för prenumerationslista.

Name	Typ	Description
nextLink	string (uri)	Länken till nästa sida med objekt
value	Subscription[]	Prenumerationspunkterna på denna sida

SubscriptionPolicies

Objekt

Prenumerationsprinciper.

Name	Typ	Description
locationPlacementId	string	Placerings-ID för prenumerationsplats. ID:t anger vilka regioner som är synliga för en prenumeration. En prenumeration med platsplacerings-ID:t Public_2014-09-01 har till exempel åtkomst till offentliga Azure-regioner.
quotaId	string	Prenumerationens kvot-ID.
spendingLimit	SpendingLimit	Utgiftsgränsen för prenumerationen.

SubscriptionState

Uppräkning

Prenumerationstillståndet. Möjliga värden är Aktiverad, Varnad, PastDue, Inaktiverad och Borttagen.

Värde	Description
Enabled	Aktiverad
Warned	Varnas
PastDue	PastDue
Disabled	Inaktiverad
Deleted	Borttagen