Workspace Subscription - Update

Referencia

Servicio:: API Management

Versión de la API:: 2024-05-01

Actualiza los detalles de una suscripción especificada por su identificador.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nombre del servicio API Management.
sid	path	True	string maxLength: 256 pattern: ^[^*#&+:<>?]+$	Identificador de entidad de suscripción. La entidad representa la asociación entre un usuario y un producto en API Management.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identificador del área de trabajo. Debe ser único en la instancia actual del servicio API Management.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.
appType	query		AppType	Determina el tipo de aplicación que envía la solicitud de creación de usuario. El valor predeterminado es el portal del publicador heredado.
notify	query		boolean	Notificar el cambio en el estado de la suscripción. Si es false, no envíe ninguna notificación por correo electrónico para el cambio de estado de la suscripción. Si es true, envíe una notificación por correo electrónico del cambio de estado de la suscripción.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
If-Match	True	string	ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta del encabezado de la solicitud GET o debe ser * para la actualización incondicional.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.allowTracing	boolean	Determina si se puede habilitar el seguimiento
properties.displayName	string	Nombre de la suscripción.
properties.expirationDate	string (date-time)	Fecha de expiración de la suscripción. La configuración solo tiene fines de auditoría y la suscripción no expira automáticamente. El ciclo de vida de la suscripción se puede administrar mediante la propiedad `state`. La fecha se ajusta al siguiente formato: `yyyy-MM-ddTHH:mm:ssZ` según lo especificado por el estándar ISO 8601.
properties.ownerId	string	Ruta de acceso del identificador de usuario: /users/{userId}
properties.primaryKey	string minLength: 1 maxLength: 256	Clave de suscripción principal.
properties.scope	string	Ámbito como /products/{productId} o /apis o /apis/{apiId}
properties.secondaryKey	string minLength: 1 maxLength: 256	Clave de suscripción secundaria.
properties.state	SubscriptionState	Estado de la suscripción. Los estados posibles son * activos : la suscripción está activa, * suspendida : la suscripción está bloqueada y el suscriptor no puede llamar a ninguna API del producto, * enviada : el desarrollador ha realizado la solicitud de suscripción, pero aún no se ha aprobado o rechazado, * rechazado , la solicitud de suscripción se ha denegado por un administrador, * cancelado : la suscripción la ha cancelado el desarrollador o el administrador, * expirado: la suscripción alcanzó su fecha de expiración y se desactivó.
properties.stateComment	string	Comentarios que describen el cambio de estado de suscripción por el administrador cuando el estado se cambia a "rechazado".

Respuestas

Nombre	Tipo	Description
200 OK	SubscriptionContract	Los detalles de la suscripción se actualizaron correctamente. Encabezados ETag: string
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Nombre

Tipo

Description

200 OK

SubscriptionContract

Los detalles de la suscripción se actualizaron correctamente.

Encabezados

ETag: string

Other Status Codes

ErrorResponse

Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

ApiManagementUpdateWorkspaceSubscription

Solicitud de ejemplo

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub?api-version=2024-05-01


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

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
AppType	Determina el tipo de aplicación que envía la solicitud de creación de usuario. El valor predeterminado es el portal heredado.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
SubscriptionContract	Detalles de la suscripción.
SubscriptionState	Estado de la suscripción. Los estados posibles son * activos : la suscripción está activa, * suspendida : la suscripción está bloqueada y el suscriptor no puede llamar a ninguna API del producto, * enviada : el desarrollador ha realizado la solicitud de suscripción, pero aún no se ha aprobado o rechazado, * rechazado , la solicitud de suscripción se ha denegado por un administrador, * cancelado : la suscripción la ha cancelado el desarrollador o el administrador, * expirado: la suscripción alcanzó su fecha de expiración y se desactivó.
SubscriptionUpdateParameters	Detalles de actualización de la suscripción.

AppType

Enumeración

Determina el tipo de aplicación que envía la solicitud de creación de usuario. El valor predeterminado es el portal heredado.

Valor	Description
developerPortal	El nuevo portal para desarrolladores envió una solicitud de creación de usuarios.
portal	El portal para desarrolladores heredado envió la solicitud de creación de usuarios.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

SubscriptionContract

Object

Detalles de la suscripción.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso
properties.allowTracing	boolean	Determina si el seguimiento está habilitado
properties.createdDate	string (date-time)	Fecha de creación de la suscripción. La fecha se ajusta al siguiente formato: `yyyy-MM-ddTHH:mm:ssZ` según lo especificado por el estándar ISO 8601.
properties.displayName	string minLength: 0 maxLength: 100	Nombre de la suscripción o null si la suscripción no tiene ningún nombre.
properties.endDate	string (date-time)	Fecha en la que se canceló o expiró la suscripción. La configuración es solo para fines de auditoría y la suscripción no se cancela automáticamente. El ciclo de vida de la suscripción se puede administrar mediante la propiedad `state`. La fecha se ajusta al siguiente formato: `yyyy-MM-ddTHH:mm:ssZ` según lo especificado por el estándar ISO 8601.
properties.expirationDate	string (date-time)	Fecha de expiración de la suscripción. La configuración solo tiene fines de auditoría y la suscripción no expira automáticamente. El ciclo de vida de la suscripción se puede administrar mediante la propiedad `state`. La fecha se ajusta al siguiente formato: `yyyy-MM-ddTHH:mm:ssZ` según lo especificado por el estándar ISO 8601.
properties.notificationDate	string (date-time)	Próxima fecha de notificación de expiración de la suscripción. La fecha se ajusta al siguiente formato: `yyyy-MM-ddTHH:mm:ssZ` según lo especificado por el estándar ISO 8601.
properties.ownerId	string	Identificador de recursos de usuario del propietario de la suscripción. El valor es una dirección URL relativa válida en el formato /users/{userId} donde {userId} es un identificador de usuario.
properties.primaryKey	string minLength: 1 maxLength: 256	Clave principal de suscripción. ¡Esta propiedad no se rellenará en las operaciones 'GET'! Use la solicitud POST "/listSecrets" para obtener el valor.
properties.scope	string	Ámbito como /products/{productId} o /apis o /apis/{apiId}.
properties.secondaryKey	string minLength: 1 maxLength: 256	Clave secundaria de suscripción. ¡Esta propiedad no se rellenará en las operaciones 'GET'! Use la solicitud POST "/listSecrets" para obtener el valor.
properties.startDate	string (date-time)	Fecha de activación de la suscripción. La configuración es solo para fines de auditoría y la suscripción no se activa automáticamente. El ciclo de vida de la suscripción se puede administrar mediante la propiedad `state`. La fecha se ajusta al siguiente formato: `yyyy-MM-ddTHH:mm:ssZ` según lo especificado por el estándar ISO 8601.
properties.state	SubscriptionState	Estado de la suscripción. Los estados posibles son * activos : la suscripción está activa, * suspendida : la suscripción está bloqueada y el suscriptor no puede llamar a ninguna API del producto, * enviada : el desarrollador ha realizado la solicitud de suscripción, pero aún no se ha aprobado o rechazado, * rechazado , la solicitud de suscripción se ha denegado por un administrador, * cancelado : la suscripción la ha cancelado el desarrollador o el administrador, * expirado: la suscripción alcanzó su fecha de expiración y se desactivó.
properties.stateComment	string	Comentario de suscripción opcional agregado por un administrador cuando se cambia el estado a "rechazado".
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SubscriptionState

Enumeración

Estado de la suscripción. Los estados posibles son * activos : la suscripción está activa, * suspendida : la suscripción está bloqueada y el suscriptor no puede llamar a ninguna API del producto, * enviada : el desarrollador ha realizado la solicitud de suscripción, pero aún no se ha aprobado o rechazado, * rechazado , la solicitud de suscripción se ha denegado por un administrador, * cancelado : la suscripción la ha cancelado el desarrollador o el administrador, * expirado: la suscripción alcanzó su fecha de expiración y se desactivó.

Valor	Description
active
cancelled
expired
rejected
submitted
suspended

SubscriptionUpdateParameters

Object

Detalles de actualización de la suscripción.

Nombre	Tipo	Description
properties.allowTracing	boolean	Determina si se puede habilitar el seguimiento
properties.displayName	string	Nombre de la suscripción.
properties.expirationDate	string (date-time)	Fecha de expiración de la suscripción. La configuración solo tiene fines de auditoría y la suscripción no expira automáticamente. El ciclo de vida de la suscripción se puede administrar mediante la propiedad `state`. La fecha se ajusta al siguiente formato: `yyyy-MM-ddTHH:mm:ssZ` según lo especificado por el estándar ISO 8601.
properties.ownerId	string	Ruta de acceso del identificador de usuario: /users/{userId}
properties.primaryKey	string minLength: 1 maxLength: 256	Clave de suscripción principal.
properties.scope	string	Ámbito como /products/{productId} o /apis o /apis/{apiId}
properties.secondaryKey	string minLength: 1 maxLength: 256	Clave de suscripción secundaria.
properties.state	SubscriptionState	Estado de la suscripción. Los estados posibles son * activos : la suscripción está activa, * suspendida : la suscripción está bloqueada y el suscriptor no puede llamar a ninguna API del producto, * enviada : el desarrollador ha realizado la solicitud de suscripción, pero aún no se ha aprobado o rechazado, * rechazado , la solicitud de suscripción se ha denegado por un administrador, * cancelado : la suscripción la ha cancelado el desarrollador o el administrador, * expirado: la suscripción alcanzó su fecha de expiración y se desactivó.
properties.stateComment	string	Comentarios que describen el cambio de estado de suscripción por el administrador cuando el estado se cambia a "rechazado".

Compartir a través de

Workspace Subscription - Update

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

ApiManagementUpdateWorkspaceSubscription

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AppType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SubscriptionContract

SubscriptionState

SubscriptionUpdateParameters

Recursos adicionales