Actualizar el alias de una suscripciónUpdate the nickname for a subscription

Se aplica aApplies To

  • Centro de partnersPartner Center
  • Centro de partners operado por 21VianetPartner Center operated by 21Vianet
  • Centro de partners para Microsoft Cloud AlemaniaPartner Center for Microsoft Cloud Germany
  • Centro de partners para Microsoft Cloud for US GovernmentPartner Center for Microsoft Cloud for US Government

Actualiza el nombre descriptivo o el alias para la suscripciónde un cliente.Updates the friendly name or nickname for a customer's Subscription. Este nombre aparece en el centro de partners para ayudar a diferenciar las suscripciones de la cuenta del cliente.This name appears in Partner Center to help differentiate the subscriptions in the customer's account.

En el panel del centro de Partners, esta operación se puede realizar seleccionando un clienteen primer lugar.In the Partner Center dashboard, this operation can be performed by first selecting a customer. A continuación, seleccione la suscripción en la que desea cambiar el nombre.Then, select the subscription in question that you wish to rename. Para finalizar, cambie el nombre en el campo alias de suscripción y, a continuación, seleccione enviar.To finish, change the name in the Subscription nickname field, then select Submit.

Requisitos previosPrerequisites

  • Credenciales tal como se describen en el artículo Autenticación del Centro de partners.Credentials as described in Partner Center authentication. Este escenario admite la autenticación con las credenciales de aplicación y aplicación independientes.This scenario supports authentication with both standalone App and App+User credentials.

  • Un id. de cliente (customer-tenant-id).A customer ID (customer-tenant-id). Si no conoces el identificador del cliente, puedes buscarlo en el panel del Centro de partners.If you don't know the customer's ID, you can look it up in the Partner Center dashboard. Selecciona CSP en el menú del Centro de partners, seguido de Clientes.Select CSP from the Partner Center menu, followed by Customers. En la lista de clientes, selecciona el cliente y, a continuación, elige Cuenta.Select the customer from the customer list, then select Account. En la página Cuenta del cliente, busca el Id. de Microsoft en la sección Información de la cuenta del cliente.On the customer’s Account page, look for the Microsoft ID in the Customer Account Info section. El identificador de Microsoft es el mismo que el de cliente (customer-tenant-id).The Microsoft ID is the same as the customer ID (customer-tenant-id).

  • IDENTIFICADOR de suscripción.A subscription ID.

C#C#

Para actualizar el alias de la suscripción de un cliente, primero obtenga la suscripcióny, a continuación, cambie la propiedad FriendlyName de la suscripción.To update the nickname of a customer's subscription, first Get the subscription, then change the subscription's FriendlyName property. Una vez realizado el cambio, use la colección colección ipartner. customers y llame al método ById () .Once the change is made, use your IPartner.Customers collection and call the ById() method. Después, llame a la propiedad subscriptions , seguido del método ById () .Then call the Subscriptions property, followed by the ById() method. A continuación, finalice llamando al método patch () .Then, finish by calling the Patch() method.

// IAggregatePartner partnerOperations;
// var SelectedcustomerId as string;

ResourceCollection<Subscription> customerSubscriptions = partnerOperations.Customers.ById(selectedCustomerId).Subscriptions.Get();
Subscription selectedSubscription = customerSubscriptions.Items.FirstOrDefault(sub => sub.Status == SubscriptionStatus.Active);

// Apply changes to subscription;

var updatedSubscription = partnerOperations.Customers.ById(selectedCustomerId).Subscriptions.ById(selectedSubscription.Id).Patch(selectedSubscription);

Ejemplo: aplicación de prueba de consola.Sample: Console test app. Proyecto: PartnerSDK. FeatureSamples ( clase): UpdateSubscription.CSProject: PartnerSDK.FeatureSamples Class: UpdateSubscription.cs

Solicitud RESTREST request

Sintaxis de la solicitudRequest syntax

MétodoMethod URI de solicitudRequest URI
PATCHPATCH {baseurl}/v1/customers/{customer-tenant-ID}/subscriptions/{ID-for-subscription} http/1.1{baseURL}/v1/customers/{customer-tenant-id}/subscriptions/{id-for-subscription} HTTP/1.1

Parámetro de URIURI parameter

En esta tabla se muestra el parámetro de consulta necesario para actualizar el alias de la suscripción.This table lists the required query parameter to update the subscription nickname.

NombreName TipoType ObligatorioRequired DescripciónDescription
customer-tenant-idcustomer-tenant-id guidguid YY El identificador de inquilino de cliente (un GUID).The customer-tenant-id (a GUID).
id-for-subscriptionid-for-subscription guidguid YY IDENTIFICADOR de la suscripción (un GUID).The subscription ID (a GUID).

Encabezados de solicitudRequest headers

Para obtener más información, consulta Encabezados REST del Centro de partners.For more information, see Partner Center REST headers.

Cuerpo de la solicitudRequest body

Un recurso Subscription es necesario en el cuerpo de la solicitud.A full Subscription resource is required in the request body. Asegúrese de que se ha actualizado la propiedad FriendlyName .Ensure the FriendlyName property has been updated.

Ejemplo de solicitudRequest example

PATCH https://api.partnercenter.microsoft.com/v1/customers/<customer-tenant-id>/subscriptions/<subscriptionID> HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: ca7c39f7-1a80-43bc-90d8-ee7d1cad3831
MS-CorrelationId: ec8f62e5-1d92-47e9-8d5d-1924af105f2c
Content-Type: application/json
Content-Length: 1029
Expect: 100-continue
Connection: Keep-Alive

{
    "Id": "<subscriptionID>",
    "FriendlyName": "nickname",
    "Quantity": 2,
    "UnitType": "none",
    "ParentSubscriptionId": null,
    "CreationDate": "2015-11-25T06:41:12Z",
    "EffectiveStartDate": "2015-11-24T08:00:00Z",
    "CommitmentEndDate": "2016-12-12T08:00:00Z",
    "Status": "active",
    "AutoRenewEnabled": false,
    "BillingType": "none",
    "PartnerId": null,
    "ContractType": "subscription",
    OrderId": "6183db3d-6318-4e52-877e-25806e4971be",
    "Attributes": {
        "Etag": "<etag>",
        "ObjectType": "Subscription"
    }
}

Respuesta RESTREST response

Si se realiza correctamente, este método devuelve las propiedades de recurso de suscripción actualizadas en el cuerpo de respuesta.If successful, this method returns updated Subscription resource properties in the response body.

Códigos de error y de respuesta correctosResponse success and error codes

Cada respuesta incluye un código de estado HTTP que indica si la operación se ha realizado correctamente o con errores y proporciona información de depuración adicional.Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use una herramienta de seguimiento de red para leer este código, el tipo de error y los parámetros adicionales.Use a network trace tool to read this code, error type, and additional parameters. Para obtener la lista completa, consulte Códigos de error.For the full list, see Error Codes.

Ejemplo de respuestaResponse example

PATCH https://api.partnercenter.microsoft.com/v1/customers/<customer-tenant-id>/subscriptions/<subscriptionID> HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-Contract-Version: v1
MS-RequestId: ca7c39f7-1a80-43bc-90d8-ee7d1cad3831
MS-CorrelationId: ec8f62e5-1d92-47e9-8d5d-1924af105f2c
Content-Type: application/json
Content-Length: 1029
Expect: 100-continue
Connection: Keep-Alive

{
    "Id": "<subscriptionID>",
    "FriendlyName": "nickname",
    "Quantity": 2,
    "UnitType": "none",
    "ParentSubscriptionId": null,
    "CreationDate": "2015-11-25T06:41:12Z",
    "EffectiveStartDate": "2015-11-24T08:00:00Z",
    "CommitmentEndDate": "2016-12-12T08:00:00Z",
    "Status": "active",
    "AutoRenewEnabled": false,
    "BillingType": "none",
    "PartnerId": null,
    "ContractType": "subscription",
    "Links": {
        "Offer": {
            "Uri": "/v1/offers/0CCA44D6-68E9-4762-94EE-31ECE98783B9",
            "Method": "GET",
            "Headers": []
        },
        "Entitlement": {
            "Uri": "/entitlements?key=<key>",
            "Method": "GET",
            "Headers": []
        },
        "Self": {
            "Uri": "/subscriptions?key=<key>",
            "Method": "GET",
            "Headers": []
        }
    },
    "OrderId": "6183db3d-6318-4e52-877e-25806e4971be",
    "Attributes": {
        "Etag": "<etag>",
        "ObjectType": "Subscription"
    }
}