User Subscription - List

Dienst:

API Management

API-Version:

2022-08-01

Listet die Auflistung der Abonnements für den angegebenen Benutzer auf

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/subscriptions?api-version=2022-08-01

Mit optionalen Parametern:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/subscriptions?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string	Der Name des API Management-Diensts. RegEx-Muster: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
userId	path	True	string	Benutzer-ID. Muss im aktuellen API Management Dienst instance eindeutig sein.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
$filter	query		string	| Feld | Nutzung | Unterstützte Operatoren | Unterstützte Funktionen | |-------------|------------------------|-----------------------------------| |Name | filtern | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | |displayName | filtern | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | |ZustandKommentierung | filtern | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | |ownerId | filtern | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | |Bereich | filtern | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | |userId | filtern | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | |productId | filtern | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
$skip	query		integer int32	Die Anzahl der zu überspringenden Datensätze.
$top	query		integer int32	Die Anzahl der zurückzugebenden Datensätze.

Antworten

Name	Typ	Beschreibung
200 OK	SubscriptionCollection	Listet eine Sammlung von Abonnemententitäten auf.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementListUserSubscriptions

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/subscriptions?api-version=2022-08-01

Java

/** Samples for UserSubscription List. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListUserSubscriptions.json
     */
    /**
     * Sample code: ApiManagementListUserSubscriptions.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListUserSubscriptions(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .userSubscriptions()
            .list(
                "rg1", "apimService1", "57681833a40f7eb6c49f6acf", null, null, null, 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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_list_user_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 = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.user_subscription.list(
        resource_group_name="rg1",
        service_name="apimService1",
        user_id="57681833a40f7eb6c49f6acf",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListUserSubscriptions.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

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListUserSubscriptions.json
func ExampleUserSubscriptionClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewUserSubscriptionClient().NewListPager("rg1", "apimService1", "57681833a40f7eb6c49f6acf", &armapimanagement.UserSubscriptionClientListOptions{Filter: nil,
		Top:  nil,
		Skip: 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.SubscriptionCollection = armapimanagement.SubscriptionCollection{
		// 	Value: []*armapimanagement.SubscriptionContract{
		// 		{
		// 			Name: to.Ptr("57681850a40f7eb6c49f6ae3"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/users/subscriptions"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/subscriptions/57681850a40f7eb6c49f6ae3"),
		// 			Properties: &armapimanagement.SubscriptionContractProperties{
		// 				CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2016-06-20T16:22:39.547Z"); return t}()),
		// 				DisplayName: to.Ptr("57681850a40f7eb6c49f6ae5"),
		// 				OwnerID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf"),
		// 				Scope: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7"),
		// 				StartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2016-06-20T00:00:00.000Z"); return t}()),
		// 				State: to.Ptr(armapimanagement.SubscriptionStateActive),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("57681850a40f7eb6c49f6b2b"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/users/subscriptions"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/subscriptions/57681850a40f7eb6c49f6b2b"),
		// 			Properties: &armapimanagement.SubscriptionContractProperties{
		// 				CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2016-06-20T16:22:41.103Z"); return t}()),
		// 				DisplayName: to.Ptr("57681850a40f7eb6c49f6b2d"),
		// 				OwnerID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf"),
		// 				Scope: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7"),
		// 				StartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2016-06-20T00:00:00.000Z"); return t}()),
		// 				State: to.Ptr(armapimanagement.SubscriptionStateActive),
		// 			},
		// 	}},
		// }
	}
}

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

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists the collection of subscriptions of the specified user.
 *
 * @summary Lists the collection of subscriptions of the specified user.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListUserSubscriptions.json
 */
async function apiManagementListUserSubscriptions() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const userId = "57681833a40f7eb6c49f6acf";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.userSubscription.list(resourceGroupName, serviceName, userId)) {
    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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListUserSubscriptions.json
// this example is just showing the usage of "UserSubscription_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 ApiManagementUserResource created on azure
// for more information of creating ApiManagementUserResource, please refer to the document of ApiManagementUserResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string userId = "57681833a40f7eb6c49f6acf";
ResourceIdentifier apiManagementUserResourceId = ApiManagementUserResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, userId);
ApiManagementUserResource apiManagementUser = client.GetApiManagementUserResource(apiManagementUserResourceId);

// get the collection of this ApiManagementUserSubscriptionResource
ApiManagementUserSubscriptionCollection collection = apiManagementUser.GetApiManagementUserSubscriptions();

// invoke the operation and iterate over the result
await foreach (ApiManagementUserSubscriptionResource 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
    SubscriptionContractData 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

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/subscriptions/57681850a40f7eb6c49f6ae3",
      "type": "Microsoft.ApiManagement/service/users/subscriptions",
      "name": "57681850a40f7eb6c49f6ae3",
      "properties": {
        "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf",
        "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7",
        "displayName": "57681850a40f7eb6c49f6ae5",
        "state": "active",
        "createdDate": "2016-06-20T16:22:39.547Z",
        "startDate": "2016-06-20T00:00:00Z"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/subscriptions/57681850a40f7eb6c49f6b2b",
      "type": "Microsoft.ApiManagement/service/users/subscriptions",
      "name": "57681850a40f7eb6c49f6b2b",
      "properties": {
        "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf",
        "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7",
        "displayName": "57681850a40f7eb6c49f6b2d",
        "state": "active",
        "createdDate": "2016-06-20T16:22:41.103Z",
        "startDate": "2016-06-20T00:00:00Z"
      }
    }
  ],
  "nextLink": ""
}

Definitionen

Name	Beschreibung
ErrorFieldContract	Fehlerfeldvertrag.
ErrorResponse	Fehlerantwort.
SubscriptionCollection	Ausgelagerte Abonnementlistendarstellung.
SubscriptionContract	Abonnementdetails.
SubscriptionState	Abonnementstatus. Mögliche Zustände sind * aktiv – das Abonnement ist aktiv, * angehalten – das Abonnement ist blockiert, und der Abonnent kann keine APIs des Produkts aufrufen, * übermittelt – die Abonnementanforderung wurde vom Entwickler gestellt, aber noch nicht genehmigt oder abgelehnt, * abgelehnt – die Abonnementanforderung wurde von einem Administrator abgelehnt, * gekündigt – das Abonnement wurde vom Entwickler oder Administrator gekündigt, * abgelaufen – das Abonnement hat sein Ablaufdatum erreicht und wurde deaktiviert.

ErrorFieldContract

Fehlerfeldvertrag.

Name	Typ	Beschreibung
code	string	Fehlercode auf Eigenschaftsebene.
message	string	Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene.
target	string	Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error.code	string	Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.
error.details	ErrorFieldContract[]	Die Liste der ungültigen Felder, die im Falle eines Überprüfungsfehlers gesendet werden.
error.message	string	Lesbare Darstellung des Fehlers.

SubscriptionCollection

Ausgelagerte Abonnementlistendarstellung.

Name	Typ	Beschreibung
count	integer	Gesamtzahl der Datensätze auf allen Seiten.
nextLink	string	Link zur nächsten Seite, falls vorhanden.
value	SubscriptionContract[]	Seitenwerte.

SubscriptionContract

Abonnementdetails.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.allowTracing	boolean	Bestimmt, ob die Ablaufverfolgung aktiviert ist
properties.createdDate	string	Erstellungsdatum des Abonnements. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.
properties.displayName	string	Der Name des Abonnements oder NULL, wenn das Abonnement keinen Namen hat.
properties.endDate	string	Datum, an dem das Abonnement gekündigt wurde oder abgelaufen ist. Die Einstellung dient nur zu Überwachungszwecken, und das Abonnement wird nicht automatisch gekündigt. Der Abonnementlebenszyklus kann mithilfe der state -Eigenschaft verwaltet werden. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.
properties.expirationDate	string	Ablaufdatum des Abonnements. Die Einstellung dient nur zu Überwachungszwecken, und das Abonnement ist nicht automatisch abgelaufen. Der Abonnementlebenszyklus kann mithilfe der state -Eigenschaft verwaltet werden. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.
properties.notificationDate	string	Benachrichtigungsdatum des bevorstehenden Abonnementablaufs. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.
properties.ownerId	string	Die Benutzer-ID des Abonnementeigentümers. Der Wert ist eine gültige relative URL im Format "/users/{userId}", wobei {userId} ein Benutzerbezeichner ist.
properties.primaryKey	string	Primärschlüssel des Abonnements. Diese Eigenschaft wird bei "GET"-Vorgängen nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen.
properties.scope	string	Bereich wie /products/{productId} oder /apis oder /apis/{apiId}.
properties.secondaryKey	string	Sekundärer Abonnementschlüssel. Diese Eigenschaft wird bei "GET"-Vorgängen nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen.
properties.startDate	string	Abonnementaktivierungsdatum. Die Einstellung dient nur zu Überwachungszwecken, und das Abonnement wird nicht automatisch aktiviert. Der Abonnementlebenszyklus kann mithilfe der state -Eigenschaft verwaltet werden. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.
properties.state	SubscriptionState	Abonnementstatus. Mögliche Zustände sind * aktiv – das Abonnement ist aktiv, * angehalten – das Abonnement ist blockiert, und der Abonnent kann keine APIs des Produkts aufrufen, * übermittelt – die Abonnementanforderung wurde vom Entwickler gestellt, aber noch nicht genehmigt oder abgelehnt, * abgelehnt – die Abonnementanforderung wurde von einem Administrator abgelehnt, * gekündigt – das Abonnement wurde vom Entwickler oder Administrator gekündigt, * abgelaufen – das Abonnement hat sein Ablaufdatum erreicht und wurde deaktiviert.
properties.stateComment	string	Optionaler Abonnementkommentar, der von einem Administrator hinzugefügt wird, wenn der Status in "abgelehnt" geändert wird.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

SubscriptionState

Abonnementstatus. Mögliche Zustände sind * aktiv – das Abonnement ist aktiv, * angehalten – das Abonnement ist blockiert, und der Abonnent kann keine APIs des Produkts aufrufen, * übermittelt – die Abonnementanforderung wurde vom Entwickler gestellt, aber noch nicht genehmigt oder abgelehnt, * abgelehnt – die Abonnementanforderung wurde von einem Administrator abgelehnt, * gekündigt – das Abonnement wurde vom Entwickler oder Administrator gekündigt, * abgelaufen – das Abonnement hat sein Ablaufdatum erreicht und wurde deaktiviert.

Name	Typ	Beschreibung
active	string
cancelled	string
expired	string
rejected	string
submitted	string
suspended	string