Subscriptions - List

Serviço:: Resource Management

Versão da API:: 2022-12-01

Obtém todas as assinaturas de um locatário.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	SubscriptionListResult	Operação do Azure concluída com sucesso.
Other Status Codes	CloudError	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

GetAllSubscriptions

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

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

Resposta de exemplo

Código de status:: 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"
    }
  ]
}

Definições

Nome	Description
CloudError	Uma resposta de erro para uma solicitação de gerenciamento de recursos.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ManagedByTenant	Informações sobre um locatário gerenciando a assinatura.
SpendingLimit	O limite de gastos da assinatura.
Subscription	Informações da assinatura.
SubscriptionListResult	Resposta da operação da lista de assinaturas.
SubscriptionPolicies	Políticas de assinatura.
SubscriptionState	O estado da assinatura. Os valores possíveis são Habilitados, Avisados, PastDue, Desabilitados e Excluídos.

CloudError

Objeto

Uma resposta de erro para uma solicitação de gerenciamento de recursos.

Nome	Tipo	Description
error	ErrorResponse	Resposta de erro Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ManagedByTenant

Objeto

Informações sobre um locatário gerenciando a assinatura.

Nome	Tipo	Description
tenantId	string	A ID do locatário de gerenciamento. Este é um GUID.

SpendingLimit

Enumeração

O limite de gastos da assinatura.

Valor	Description
On	Ligado
Off	Desativado
CurrentPeriodOff	CurrentPeriodOff

Subscription

Objeto

Informações da assinatura.

Nome	Tipo	Description
authorizationSource	string	A origem da autorização da solicitação. Os valores válidos são uma ou mais combinações de Legacy, RoleBased, Bypassed, Direct e Management. Por exemplo, "Herdado, RoleBased".
displayName	string	O nome de exibição da assinatura.
id	string	A ID totalmente qualificada para a assinatura. Por exemplo, /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74
managedByTenants	ManagedByTenant[]	Uma matriz que contém os locatários que gerenciam a assinatura.
state	SubscriptionState	O estado da assinatura. Os valores possíveis são Habilitados, Avisados, PastDue, Desabilitados e Excluídos.
subscriptionId	string	A ID da assinatura.
subscriptionPolicies	SubscriptionPolicies	As políticas de assinatura.
tags	object	As marcas anexadas à assinatura.
tenantId	string	A ID do locatário da assinatura.

SubscriptionListResult

Objeto

Resposta da operação da lista de assinaturas.

Nome	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	Subscription[]	Os itens de assinatura nesta página

SubscriptionPolicies

Objeto

Políticas de assinatura.

Nome	Tipo	Description
locationPlacementId	string	A ID de posicionamento do local da assinatura. A ID indica quais regiões estão visíveis para uma assinatura. Por exemplo, uma assinatura com uma ID de posicionamento de local de Public_2014-09-01 tem acesso a regiões públicas do Azure.
quotaId	string	A ID da cota de assinatura.
spendingLimit	SpendingLimit	O limite de gastos da assinatura.

SubscriptionState

Enumeração

O estado da assinatura. Os valores possíveis são Habilitados, Avisados, PastDue, Desabilitados e Excluídos.

Valor	Description
Enabled	Habilitado
Warned	Avisado
PastDue	PastDue
Disabled	Desactivado
Deleted	Excluída

Compartilhar via

Subscriptions - List

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

GetAllSubscriptions

Solicitação de exemplo

Resposta de exemplo

Definições

CloudError

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedByTenant

SpendingLimit

Subscription

SubscriptionListResult

SubscriptionPolicies

SubscriptionState