Возвращает все подписки для клиента.
GET https://management.azure.com/subscriptions?api-version=2022-12-01
Параметры URI
| Имя |
В |
Обязательно |
Тип |
Описание |
|
api-version
|
query |
True
|
string
|
Версия API, используемая для данной операции.
|
Ответы
| Имя |
Тип |
Описание |
|
200 OK
|
SubscriptionListResult
|
ОК . Возвращает массив подписок.
|
|
Other Status Codes
|
CloudError
|
Ответ об ошибке, описывающий причину сбоя операции.
|
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
| Имя |
Описание |
|
user_impersonation
|
олицетворения учетной записи пользователя
|
Примеры
GetAllSubscriptions
Образец запроса
GET https://management.azure.com/subscriptions?api-version=2022-12-01
/**
* Samples for Subscriptions List.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscriptions.json
*/
/**
* Sample code: GetAllSubscriptions.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void getAllSubscriptions(com.azure.resourcemanager.AzureResourceManager azure) {
azure.genericResources().manager().subscriptionClient().getSubscriptions()
.list(com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.resource import SubscriptionClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-resource
# 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/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
package armsubscriptions_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armsubscriptions"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4f4073bdb028bc84bc3e6405c1cbaf8e89b83caf/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscriptions.json
func ExampleClient_NewListPager() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armsubscriptions.NewClientFactory(cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewClient().NewListPager(nil)
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.SubscriptionListResult = armsubscriptions.SubscriptionListResult{
// Value: []*armsubscriptions.Subscription{
// {
// AuthorizationSource: to.Ptr("RoleBased"),
// DisplayName: to.Ptr("Example Subscription"),
// ID: to.Ptr("/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05"),
// ManagedByTenants: []*armsubscriptions.ManagedByTenant{
// {
// TenantID: to.Ptr("8f70baf1-1f6e-46a2-a1ff-238dac1ebfb7"),
// }},
// State: to.Ptr(armsubscriptions.SubscriptionStateEnabled),
// SubscriptionID: to.Ptr("291bba3f-e0a5-47bc-a099-3bdcb2a50a05"),
// SubscriptionPolicies: &armsubscriptions.SubscriptionPolicies{
// LocationPlacementID: to.Ptr("Internal_2014-09-01"),
// QuotaID: to.Ptr("Internal_2014-09-01"),
// SpendingLimit: to.Ptr(armsubscriptions.SpendingLimitOff),
// },
// Tags: map[string]*string{
// "tagKey1": to.Ptr("tagValue1"),
// "tagKey2": to.Ptr("tagValue2"),
// },
// TenantID: to.Ptr("31c75423-32d6-4322-88b7-c478bdde4858"),
// },
// {
// AuthorizationSource: to.Ptr("RoleBased"),
// DisplayName: to.Ptr("Example Subscription2"),
// ID: to.Ptr("/subscriptions/72ac930a-f34e-42d8-b06d-dc2a9e12ed71"),
// ManagedByTenants: []*armsubscriptions.ManagedByTenant{
// {
// TenantID: to.Ptr("8f70baf1-1f6e-46a2-a1ff-238dac1ebfb7"),
// },
// {
// TenantID: to.Ptr("f7fb6af2-321d-47c8-9c0f-b0239eaad39a"),
// }},
// State: to.Ptr(armsubscriptions.SubscriptionStateEnabled),
// SubscriptionID: to.Ptr("72ac930a-f34e-42d8-b06d-dc2a9e12ed71"),
// SubscriptionPolicies: &armsubscriptions.SubscriptionPolicies{
// LocationPlacementID: to.Ptr("Internal_2014-09-01"),
// QuotaID: to.Ptr("Internal_2014-09-01"),
// SpendingLimit: to.Ptr(armsubscriptions.SpendingLimitOff),
// },
// Tags: map[string]*string{
// "tagKey1": to.Ptr("tagValue1"),
// "tagKey2": to.Ptr("tagValue2"),
// },
// TenantID: to.Ptr("2a0ff0de-96b2-4859-bb7c-a430d07a3e0c"),
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { SubscriptionClient } = require("@azure/arm-resources-subscriptions");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Gets all subscriptions for a tenant.
*
* @summary Gets all subscriptions for a tenant.
* x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscriptions.json
*/
async function getAllSubscriptions() {
const credential = new DefaultAzureCredential();
const client = new SubscriptionClient(credential);
const resArray = new Array();
for await (let item of client.subscriptions.list()) {
resArray.push(item);
}
console.log(resArray);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
// Generated from example definition: specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscriptions.json
// this example is just showing the usage of "Subscriptions_List" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this TenantResource created on azure
// for more information of creating TenantResource, please refer to the document of TenantResource
var tenant = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;
// get the collection of this SubscriptionResource
SubscriptionCollection collection = tenant.GetSubscriptions();
// invoke the operation and iterate over the result
await foreach (SubscriptionResource item in collection.GetAllAsync())
{
// the variable item is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SubscriptionData resourceData = item.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}
Console.WriteLine($"Succeeded");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Пример ответа
{
"value": [
{
"id": "/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
"subscriptionId": "291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
"tenantId": "31c75423-32d6-4322-88b7-c478bdde4858",
"displayName": "Example Subscription",
"state": "Enabled",
"subscriptionPolicies": {
"locationPlacementId": "Internal_2014-09-01",
"quotaId": "Internal_2014-09-01",
"spendingLimit": "Off"
},
"authorizationSource": "RoleBased",
"managedByTenants": [
{
"tenantId": "8f70baf1-1f6e-46a2-a1ff-238dac1ebfb7"
}
],
"tags": {
"tagKey1": "tagValue1",
"tagKey2": "tagValue2"
}
},
{
"id": "/subscriptions/72ac930a-f34e-42d8-b06d-dc2a9e12ed71",
"subscriptionId": "72ac930a-f34e-42d8-b06d-dc2a9e12ed71",
"tenantId": "2a0ff0de-96b2-4859-bb7c-a430d07a3e0c",
"displayName": "Example Subscription2",
"state": "Enabled",
"subscriptionPolicies": {
"locationPlacementId": "Internal_2014-09-01",
"quotaId": "Internal_2014-09-01",
"spendingLimit": "Off"
},
"authorizationSource": "RoleBased",
"managedByTenants": [
{
"tenantId": "8f70baf1-1f6e-46a2-a1ff-238dac1ebfb7"
},
{
"tenantId": "f7fb6af2-321d-47c8-9c0f-b0239eaad39a"
}
],
"tags": {
"tagKey1": "tagValue1",
"tagKey2": "tagValue2"
}
}
],
"nextLink": "..."
}
Определения
CloudError
Ответ об ошибке для запроса на управление ресурсами.
| Имя |
Тип |
Описание |
|
error
|
ErrorResponse
|
Сообщение об ошибке
Общие ответы об ошибках для всех API-интерфейсов Azure Resource Manager возвращать сведения об ошибках для неудачных операций. (Это также соответствует формату ответа об ошибке OData.)
|
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
| Имя |
Тип |
Описание |
|
info
|
object
|
Дополнительные сведения.
|
|
type
|
string
|
Тип дополнительных сведений.
|
ErrorDetail
Сведения об ошибке.
| Имя |
Тип |
Описание |
|
additionalInfo
|
ErrorAdditionalInfo[]
|
Дополнительные сведения об ошибке.
|
|
code
|
string
|
Код ошибки.
|
|
details
|
ErrorDetail[]
|
Сведения об ошибке.
|
|
message
|
string
|
Сообщение об ошибке.
|
|
target
|
string
|
Целевой объект ошибки.
|
ErrorResponse
Сообщение об ошибке
ManagedByTenant
Сведения о клиенте, управляя подпиской.
| Имя |
Тип |
Описание |
|
tenantId
|
string
|
Идентификатор управляющего клиента. Это идентификатор GUID.
|
spendingLimit
Предельная сумма расходов на подписку.
| Имя |
Тип |
Описание |
|
CurrentPeriodOff
|
string
|
|
|
Off
|
string
|
|
|
On
|
string
|
|
Subscription
Информация о подписке.
| Имя |
Тип |
Описание |
|
authorizationSource
|
string
|
Источник авторизации запроса. Допустимые значения — это одно или несколько сочетаний устаревших версий, RoleBased, Bypassed, Direct и Management. Например, "Устаревшая версия, RoleBased".
|
|
displayName
|
string
|
Отображаемое имя подписки.
|
|
id
|
string
|
Полный идентификатор подписки. Например, /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74
|
|
managedByTenants
|
ManagedByTenant[]
|
Массив, содержащий клиентов, управляющих подпиской.
|
|
state
|
SubscriptionState
|
Состояние подписки. Возможные значения: Enabled, Warned, PastDue, Disabled и Deleted.
|
|
subscriptionId
|
string
|
Идентификатор подписки.
|
|
subscriptionPolicies
|
SubscriptionPolicies
|
Политики подписки.
|
|
tags
|
object
|
Теги, присоединенные к подписке.
|
|
tenantId
|
string
|
Идентификатор клиента подписки.
|
SubscriptionListResult
Ответ операции получения списка подписок.
| Имя |
Тип |
Описание |
|
nextLink
|
string
|
URL-адрес для получения следующего набора результатов.
|
|
value
|
Subscription[]
|
Массив подписок.
|
SubscriptionPolicies
Политики подписок.
| Имя |
Тип |
Описание |
|
locationPlacementId
|
string
|
Идентификатор размещения расположения подписки. Идентификатор указывает, какие регионы являются видимыми для подписки. Например, подписка с идентификатором размещения расположения Public_2014-09-01 имеет доступ к общедоступным регионам Azure.
|
|
quotaId
|
string
|
Идентификатор квоты подписки.
|
|
spendingLimit
|
spendingLimit
|
Предельная сумма расходов на подписку.
|
SubscriptionState
Состояние подписки. Возможные значения: Enabled, Warned, PastDue, Disabled и Deleted.
| Имя |
Тип |
Описание |
|
Deleted
|
string
|
|
|
Disabled
|
string
|
|
|
Enabled
|
string
|
|
|
PastDue
|
string
|
|
|
Warned
|
string
|
|