Subscription - Update

Referência

Service:: API Management

API Version:: 2022-08-01

Atualizações os detalhes de uma subscrição especificada pelo respetivo identificador.

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

With optional parameters:

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}?notify={notify}&api-version=2022-08-01&appType={appType}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
serviceName	path	True	string	O nome do serviço Gestão de API. Regex pattern: `^[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. Regex pattern: `^[^*#&+:<>?]+$`
subscriptionId	path	True	string	O ID da subscrição de destino.
api-version	query	True	string	A versão da API a utilizar para esta operação.
appType	query		AppType	Determina o tipo de aplicação que envia o pedido de criação de utilizador. A predefinição é o portal do publicador legado.
notify	query		boolean	Notificar a alteração no Estado da Subscrição. Se for falso, não envie nenhuma notificação por e-mail para alterar o estado da subscrição Se for verdadeiro, envie uma notificação por e-mail sobre a alteração do estado da subscrição

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
If-Match	True	string	ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.

Corpo do Pedido

Name	Tipo	Description
properties.allowTracing	boolean	Determina se o rastreio pode ser ativado
properties.displayName	string	Nome da subscrição.
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.ownerId	string	Caminho do identificador de utilizador: /users/{userId}
properties.primaryKey	string	Chave de subscrição primária.
properties.scope	string	Âmbito como /products/{productId} ou /apis ou /apis/{apiId}
properties.secondaryKey	string	Chave de subscrição secundária.
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ários que descrevem a alteração do estado da subscrição pelo administrador quando o estado é alterado para "rejeitado".

Respostas

Name	Tipo	Description
200 OK	SubscriptionContract	Os detalhes da subscrição foram atualizados com êxito. Headers ETag: string
Other Status Codes	ErrorResponse	Resposta de erro que descreve o motivo pela qual a operação falhou.

Name

Tipo

Description

200 OK

SubscriptionContract

Os detalhes da subscrição foram atualizados com êxito.

Headers

ETag: string

Other Status Codes

ErrorResponse

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

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

ApiManagementUpdateSubscription

Sample Request

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


{
  "properties": {
    "displayName": "testsub"
  }
}

import com.azure.resourcemanager.apimanagement.models.SubscriptionUpdateParameters;

/** Samples for Subscription Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateSubscription.json
     */
    /**
     * Sample code: ApiManagementUpdateSubscription.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementUpdateSubscription(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .subscriptions()
            .updateWithResponse(
                "rg1",
                "apimService1",
                "testsub",
                "*",
                new SubscriptionUpdateParameters().withDisplayName("testsub"),
                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

from typing import Any, IO, Union

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_update_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.subscription.update(
        resource_group_name="rg1",
        service_name="apimService1",
        sid="testsub",
        if_match="*",
        parameters={"properties": {"displayName": "testsub"}},
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateSubscription.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/azcore/to"
	"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/ApiManagementUpdateSubscription.json
func ExampleSubscriptionClient_Update() {
	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.NewSubscriptionClient().Update(ctx, "rg1", "apimService1", "testsub", "*", armapimanagement.SubscriptionUpdateParameters{
		Properties: &armapimanagement.SubscriptionUpdateParameterProperties{
			DisplayName: to.Ptr("testsub"),
		},
	}, &armapimanagement.SubscriptionClientUpdateOptions{Notify: nil,
		AppType: 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("testsub"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/subscriptions"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub"),
	// 	Properties: &armapimanagement.SubscriptionContractProperties{
	// 		CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-02T17:59:06.223Z"); return t}()),
	// 		DisplayName: to.Ptr("testsub"),
	// 		OwnerID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b"),
	// 		Scope: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002"),
	// 		State: to.Ptr(armapimanagement.SubscriptionStateSubmitted),
	// 	},
	// }
}

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 Updates the details of a subscription specified by its identifier.
 *
 * @summary Updates the details of a subscription specified by its identifier.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateSubscription.json
 */
async function apiManagementUpdateSubscription() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const sid = "testsub";
  const ifMatch = "*";
  const parameters = { displayName: "testsub" };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.subscription.update(
    resourceGroupName,
    serviceName,
    sid,
    ifMatch,
    parameters
  );
  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

Sample Response

Status code:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub",
  "type": "Microsoft.ApiManagement/service/subscriptions",
  "name": "testsub",
  "properties": {
    "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b",
    "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
    "displayName": "testsub",
    "state": "submitted",
    "createdDate": "2017-06-02T17:59:06.223Z"
  }
}

Definições

Name	Description
AppType	Determina o tipo de aplicação que envia o pedido de criação de utilizador. A predefinição é o portal do publicador legado.
ErrorFieldContract	Contrato de Campo de Erro.
ErrorResponse	Resposta do Erro.
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.
SubscriptionUpdateParameters	Detalhes da atualização da subscrição.

AppType

Determina o tipo de aplicação que envia o pedido de criação de utilizador. A predefinição é o portal do publicador legado.

Name	Tipo	Description
developerPortal	string	O pedido de criação do utilizador foi enviado pelo novo portal do programador.
portal	string	O pedido de criação do utilizador foi enviado pelo portal do programador legado.

ErrorFieldContract

Contrato de Campo de Erro.

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

ErrorResponse

Resposta do Erro.

Name	Tipo	Description
error.code	string	Código de erro definido pelo serviço. Este código serve como um subestado para o código de erro HTTP especificado na resposta.
error.details	ErrorFieldContract[]	A lista de campos inválidos enviados no 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 do 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