Subscription interface
Interfaz que representa una suscripción.
Métodos
Detalles del método
createOrUpdate(string, string, string, SubscriptionCreateParameters, SubscriptionCreateOrUpdateOptionalParams)
Crea o actualiza la suscripción del usuario especificado al producto especificado
function createOrUpdate(resourceGroupName: string, serviceName: string, sid: string, parameters: SubscriptionCreateParameters, options?: SubscriptionCreateOrUpdateOptionalParams): Promise<SubscriptionCreateOrUpdateResponse>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- sid
-
string
Identificador de entidad de suscripción. La entidad representa la asociación entre un usuario y un producto en API Management.
- parameters
- SubscriptionCreateParameters
Cree parámetros.
Parámetros de opciones.
Devoluciones
Promise<SubscriptionCreateOrUpdateResponse>
delete(string, string, string, string, SubscriptionDeleteOptionalParams)
Elimina la suscripción especificada.
function delete(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, options?: SubscriptionDeleteOptionalParams): Promise<void>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- sid
-
string
Identificador de entidad de suscripción. La entidad representa la asociación entre un usuario y un producto en API Management.
- ifMatch
-
string
ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta de encabezado de la solicitud GET o debe ser * para la actualización incondicional.
- options
- SubscriptionDeleteOptionalParams
Parámetros de opciones.
Devoluciones
Promise<void>
get(string, string, string, SubscriptionGetOptionalParams)
Obtiene la entidad Subscription especificada.
function get(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetOptionalParams): Promise<SubscriptionGetResponse>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- sid
-
string
Identificador de entidad de suscripción. La entidad representa la asociación entre un usuario y un producto en API Management.
- options
- SubscriptionGetOptionalParams
Parámetros de opciones.
Devoluciones
Promise<SubscriptionGetResponse>
getEntityTag(string, string, string, SubscriptionGetEntityTagOptionalParams)
Obtiene la versión de estado de entidad (Etag) de la suscripción de apimanagement especificada por su identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetEntityTagOptionalParams): Promise<SubscriptionGetEntityTagHeaders>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- sid
-
string
Identificador de entidad de suscripción. La entidad representa la asociación entre un usuario y un producto en API Management.
Parámetros de opciones.
Devoluciones
Promise<SubscriptionGetEntityTagHeaders>
list(string, string, SubscriptionListOptionalParams)
Enumera todas las suscripciones de la instancia del servicio API Management
function list(resourceGroupName: string, serviceName: string, options?: SubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- options
- SubscriptionListOptionalParams
Parámetros de opciones.
Devoluciones
listSecrets(string, string, string, SubscriptionListSecretsOptionalParams)
Obtiene las claves de suscripción especificadas.
function listSecrets(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionListSecretsOptionalParams): Promise<SubscriptionListSecretsResponse>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- sid
-
string
Identificador de entidad de suscripción. La entidad representa la asociación entre un usuario y un producto en API Management.
Parámetros de opciones.
Devoluciones
Promise<SubscriptionListSecretsResponse>
regeneratePrimaryKey(string, string, string, SubscriptionRegeneratePrimaryKeyOptionalParams)
Vuelve a generar la clave principal de una suscripción existente de la instancia del servicio API Management.
function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegeneratePrimaryKeyOptionalParams): Promise<void>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- sid
-
string
Identificador de entidad de suscripción. La entidad representa la asociación entre un usuario y un producto en API Management.
Parámetros de opciones.
Devoluciones
Promise<void>
regenerateSecondaryKey(string, string, string, SubscriptionRegenerateSecondaryKeyOptionalParams)
Vuelve a generar la clave secundaria de una suscripción existente de la instancia del servicio API Management.
function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegenerateSecondaryKeyOptionalParams): Promise<void>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- sid
-
string
Identificador de entidad de suscripción. La entidad representa la asociación entre un usuario y un producto en API Management.
Parámetros de opciones.
Devoluciones
Promise<void>
update(string, string, string, string, SubscriptionUpdateParameters, SubscriptionUpdateOptionalParams)
Novedades los detalles de una suscripción especificada por su identificador.
function update(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: SubscriptionUpdateOptionalParams): Promise<SubscriptionUpdateResponse>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- sid
-
string
Identificador de entidad de suscripción. La entidad representa la asociación entre un usuario y un producto en API Management.
- ifMatch
-
string
ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta de encabezado de la solicitud GET o debe ser * para la actualización incondicional.
- parameters
- SubscriptionUpdateParameters
Actualice los parámetros.
- options
- SubscriptionUpdateOptionalParams
Parámetros de opciones.
Devoluciones
Promise<SubscriptionUpdateResponse>