User Subscription - Get

Referência

Serviço:: API Management

Versão da API:: 2021-08-01

Obtém a entidade subscrição especificada associada a um utilizador específico.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos.
serviceName	path	True	string	O nome do serviço Gestão de API. Padrão Regex: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
sid	path	True	string	Identificador da entidade de subscrição. A entidade representa a associação entre um utilizador e um produto no Gestão de API. Padrão Regex: `^[^*#&+:<>?]+$`
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
userId	path	True	string	Identificador de utilizador. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
api-version	query	True	string	Versão da API a utilizar com o pedido de cliente.

Respostas

Name

Tipo

Description

200 OK

SubscriptionContract

O corpo da resposta contém a entidade Subscrição especificada.

Cabeçalhos

ETag: string

Other Status Codes

Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

ApiManagementGetUserSubscription

Pedido de amostra

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1/subscriptions/5fa9b096f3df14003c070001?api-version=2021-08-01

import com.azure.core.util.Context;

/** Samples for UserSubscription Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetUserSubscription.json
     */
    /**
     * Sample code: ApiManagementGetUserSubscription.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementGetUserSubscription(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .userSubscriptions()
            .getWithResponse("rg1", "apimService1", "1", "5fa9b096f3df14003c070001", 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.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_get_user_subscription.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.get(
        resource_group_name="rg1",
        service_name="apimService1",
        user_id="1",
        sid="5fa9b096f3df14003c070001",
    )
    print(response)


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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetUserSubscription.json
func ExampleUserSubscriptionClient_Get() {
	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)
	}
	res, err := clientFactory.NewUserSubscriptionClient().Get(ctx, "rg1", "apimService1", "1", "5fa9b096f3df14003c070001", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SubscriptionContract = armapimanagement.SubscriptionContract{
	// 	Name: to.Ptr("5fa9b096f3df14003c070001"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/users/subscriptions"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1/subscriptions/5fa9b096f3df14003c070001"),
	// 	Properties: &armapimanagement.SubscriptionContractProperties{
	// 		AllowTracing: to.Ptr(true),
	// 		CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-09T21:11:50.58Z"); return t}()),
	// 		OwnerID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"),
	// 		Scope: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/starter"),
	// 		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

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

/**
 * This sample demonstrates how to Gets the specified Subscription entity associated with a particular user.
 *
 * @summary Gets the specified Subscription entity associated with a particular user.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetUserSubscription.json
 */
async function apiManagementGetUserSubscription() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const userId = "1";
  const sid = "5fa9b096f3df14003c070001";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.userSubscription.get(resourceGroupName, serviceName, userId, sid);
  console.log(result);
}

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

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

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetUserSubscription.json
// this example is just showing the usage of "UserSubscription_Get" 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 = "1";
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
string sid = "5fa9b096f3df14003c070001";
NullableResponse<ApiManagementUserSubscriptionResource> response = await collection.GetIfExistsAsync(sid);
ApiManagementUserSubscriptionResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result 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 = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Resposta da amostra

Código de estado:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1/subscriptions/5fa9b096f3df14003c070001",
  "type": "Microsoft.ApiManagement/service/users/subscriptions",
  "name": "5fa9b096f3df14003c070001",
  "properties": {
    "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1",
    "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/starter",
    "state": "active",
    "createdDate": "2020-11-09T21:11:50.58Z",
    "allowTracing": true
  }
}

Definições

Name	Description
ErrorFieldContract	Contrato de campo de erro.
ErrorResponse	Resposta a Erros.
SubscriptionContract	Detalhes da subscrição.
SubscriptionState	Estado da subscrição. Os estados possíveis estão * ativos – a subscrição está ativa, * suspensa – a subscrição está bloqueada e o subscritor não pode chamar as APIs do produto, * submetidas – o pedido de subscrição foi feito pelo programador, mas ainda não foi aprovado ou rejeitado, * rejeitado – o pedido de subscrição foi negado por um administrador, * cancelado – a subscrição foi cancelada pelo programador ou administrador, * expirou – a subscrição atingiu a data de expiração e foi desativada.

ErrorFieldContract

Contrato de campo de erro.

Name	Tipo	Description
code	string	Código de erro ao nível da propriedade.
message	string	Representação legível por humanos do erro ao nível da propriedade.
target	string	Nome da propriedade.

ErrorResponse

Resposta a Erros.

Name	Tipo	Description
error.code	string	Código de erro definido pelo serviço. Este código serve como um sub-estado para o código de erro HTTP especificado na resposta.
error.details	ErrorFieldContract[]	A lista de campos inválidos enviados a pedido, em caso de erro de validação.
error.message	string	Representação legível por humanos do erro.

SubscriptionContract

Detalhes da subscrição.

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.allowTracing	boolean	Determina se o rastreio está ativado
properties.createdDate	string	Data de criação da subscrição. A data está em conformidade com o seguinte formato: `yyyy-MM-ddTHH:mm:ssZ` conforme especificado pela norma ISO 8601.
properties.displayName	string	O nome da subscrição ou nulo se a subscrição não tiver nome.
properties.endDate	string	Data em que a subscrição foi cancelada ou expirou. A definição destina-se apenas a fins de auditoria e a subscrição não é cancelada automaticamente. O ciclo de vida da subscrição pode ser gerido com a `state` propriedade . A data está em conformidade com o seguinte formato: `yyyy-MM-ddTHH:mm:ssZ` conforme especificado pela norma ISO 8601.
properties.expirationDate	string	Data de expiração da subscrição. A definição destina-se apenas a fins de auditoria e a subscrição não expira automaticamente. O ciclo de vida da subscrição pode ser gerido com a `state` propriedade . A data está em conformidade com o seguinte formato: `yyyy-MM-ddTHH:mm:ssZ` conforme especificado pela norma ISO 8601.
properties.notificationDate	string	Data de notificação de expiração da subscrição futura. A data está em conformidade com o seguinte formato: `yyyy-MM-ddTHH:mm:ssZ` conforme especificado pela norma ISO 8601.
properties.ownerId	string	O identificador de recurso do utilizador do proprietário da subscrição. O valor é um URL relativo válido no formato de /users/{userId} em que {userId} é um identificador de utilizador.
properties.primaryKey	string	Chave primária da subscrição. Esta propriedade não será preenchida em operações "GET"! Utilize o pedido POST "/listSecrets" para obter o valor.
properties.scope	string	Âmbito como /products/{productId} ou /apis ou /apis/{apiId}.
properties.secondaryKey	string	Chave secundária da subscrição. Esta propriedade não será preenchida em operações "GET"! Utilize o pedido POST "/listSecrets" para obter o valor.
properties.startDate	string	Data de ativação da subscrição. A definição destina-se apenas a fins de auditoria e a subscrição não é ativada automaticamente. O ciclo de vida da subscrição pode ser gerido com a `state` propriedade . A data está em conformidade com o seguinte formato: `yyyy-MM-ddTHH:mm:ssZ` conforme especificado pela norma ISO 8601.
properties.state	SubscriptionState	Estado da subscrição. Os estados possíveis estão * ativos – a subscrição está ativa, * suspensa – a subscrição está bloqueada e o subscritor não pode chamar as APIs do produto, * submetidas – o pedido de subscrição foi feito pelo programador, mas ainda não foi aprovado ou rejeitado, * rejeitado – o pedido de subscrição foi negado por um administrador, * cancelado – a subscrição foi cancelada pelo programador ou administrador, * expirou – a subscrição atingiu a data de expiração e foi desativada.
properties.stateComment	string	Comentário de subscrição opcional adicionado por um administrador quando o estado é alterado para "rejeitado".
type	string	O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SubscriptionState

Estado da subscrição. Os estados possíveis estão * ativos – a subscrição está ativa, * suspensa – a subscrição está bloqueada e o subscritor não pode chamar as APIs do produto, * submetidas – o pedido de subscrição foi feito pelo programador, mas ainda não foi aprovado ou rejeitado, * rejeitado – o pedido de subscrição foi negado por um administrador, * cancelado – a subscrição foi cancelada pelo programador ou administrador, * expirou – a subscrição atingiu a data de expiração e foi desativada.

Name	Tipo	Description
active	string
cancelled	string
expired	string
rejected	string
submitted	string
suspended	string