Subscriptions - List

Get the list of subscriptions.

GET https://adminmanagement.local.azurestack.external/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/subscriptions?api-version=2015-11-01
GET https://adminmanagement.local.azurestack.external/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/subscriptions?api-version=2015-11-01&$filter={$filter}

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription.The subscription ID forms part of the URI for every service call.

api-version
query True
  • string

Client Api Version.

$filter
query
  • string

OData filter parameter.

Responses

Name Type Description
200 OK

OK

Security

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 impersonate your user account

Examples

Get the list of subscriptions.

Sample Request

GET https://adminmanagement.local.azurestack.external/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Subscriptions.Admin/subscriptions?api-version=2015-11-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/subscriptions/5144634d-7e4d-443b-a304-d27e44220fc6",
      "subscriptionId": "5144634d-7e4d-443b-a304-d27e44220fc6",
      "delegatedProviderSubscriptionId": "8158498d-27b1-4ccf-9aa1-de0f925731e6",
      "displayName": "sfsdf",
      "owner": "tenantadmin1@msazurestack.onmicrosoft.com",
      "tenantId": "d9b782d5-d098-4374-8f2c-3907cc34611c",
      "routingResourceManagerType": "Default",
      "offerId": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/resourceGroups/balarg/providers/Microsoft.Subscriptions.Admin/offers/balaoffer",
      "state": "Enabled"
    },
    {
      "id": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/subscriptions/55049d1c-9727-4f79-95b6-50d1f3ee2b28",
      "subscriptionId": "55049d1c-9727-4f79-95b6-50d1f3ee2b28",
      "delegatedProviderSubscriptionId": "8158498d-27b1-4ccf-9aa1-de0f925731e6",
      "displayName": "Test User-tenantadmin1@msazurestack.onmicrosoft.com",
      "owner": "tenantadmin1@msazurestack.onmicrosoft.com",
      "tenantId": "d9b782d5-d098-4374-8f2c-3907cc34611c",
      "routingResourceManagerType": "Default",
      "offerId": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/resourceGroups/TestRG-c895f7cb-18e0-41b4-a4e9-c29131dbbc48/providers/Microsoft.Subscriptions.Admin/offers/TestOffer-e9a634c1-8846-49f0-ab49-65d24262dc41",
      "state": "Enabled"
    },
    {
      "id": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/subscriptions/ad7e95b8-cb96-472e-b48d-46411ddce350",
      "subscriptionId": "ad7e95b8-cb96-472e-b48d-46411ddce350",
      "delegatedProviderSubscriptionId": "8158498d-27b1-4ccf-9aa1-de0f925731e6",
      "displayName": "cnur8007tenantsubscription352",
      "owner": "tenantadmin1@msazurestack.onmicrosoft.com",
      "tenantId": "d9b782d5-d098-4374-8f2c-3907cc34611c",
      "routingResourceManagerType": "Default",
      "offerId": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/resourceGroups/cnur8007subscrrg352/providers/Microsoft.Subscriptions.Admin/offers/cnur8007tenantoffer352",
      "state": "Enabled"
    },
    {
      "id": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/subscriptions/c4d75460-5ea2-486a-a87f-85506f55daa6",
      "subscriptionId": "c4d75460-5ea2-486a-a87f-85506f55daa6",
      "delegatedProviderSubscriptionId": "8158498d-27b1-4ccf-9aa1-de0f925731e6",
      "displayName": "cnur8007tenantdefaultsubscription352",
      "owner": "tenantadmin1@msazurestack.onmicrosoft.com",
      "tenantId": "d9b782d5-d098-4374-8f2c-3907cc34611c",
      "routingResourceManagerType": "Default",
      "offerId": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/resourceGroups/cnur8007subscrrg352/providers/Microsoft.Subscriptions.Admin/offers/cnur8007tenantoffer352",
      "state": "Enabled"
    }
  ]
}

Definitions

ResourceManagerType

Resource manager type.

Subscription

List of supported operations.

SubscriptionList

List of subscriptions.

SubscriptionState

Subscription notification state.

ResourceManagerType

Resource manager type.

Name Type Description
Admin
  • string
Default
  • string

Subscription

List of supported operations.

Name Type Description
delegatedProviderSubscriptionId
  • string

Parent DelegatedProvider subscription identifier.

displayName
  • string

Subscription name.

externalReferenceId
  • string

External reference identifier.

id
  • string

Fully qualified identifier.

offerId
  • string

Identifier of the offer under the scope of a delegated provider.

owner
  • string

Subscription owner.

routingResourceManagerType

Routing resource manager type.

state

Subscription state.

subscriptionId
  • string

Subscription identifier.

tenantId
  • string

Directory tenant identifier.

SubscriptionList

List of subscriptions.

Name Type Description
nextLink
  • string

URI to the next page.

value

Subscription definition.

SubscriptionState

Subscription notification state.

Name Type Description
Deleted
  • string

Final state of subscription. All resources and data are deleted. This state cannot be reversed.

Deleting
  • string

This state is unique to Azure Stack and is only visible to the Azure Stack Operator, and if used, to the respective Delegated Provider. Resources and Data are being deleted before subscription state is set to Deleted. This state cannot be reversed. It means that deletion is in progress.

Disabled
  • string

Subscription is not active and usage is not reported. Resources are shut down (VMs stopped and deallocated, IP addresses are freed, etc). During this period, the Azure Stack Operator can re-enable the subscription which allows creation of new resources but doesn’t automatically restore disabled resources.

Enabled
  • string

Subscription is active. New resources can be created.

NotDefined
  • string

This state is not used in Azure Stack.

PartiallyDeleted
  • string

This state is unique to Azure Stack and is only visible to the Azure Stack Operator, and if used, to the respective Delegated Provider. It means that deletion failed. You can’t reverse the deletion process, so in this state all you can do is restart deletion. This state is not reported to RPs.

PastDue
  • string

This state is not used in Azure Stack.

Warned
  • string

This state is not used in Azure Stack.