Share via

Subscriptions Interface

Package:
com.microsoft.azure.management.apimanagement.v2019_01_01
Maven Artifact:
com.microsoft.azure.apimanagement.v2019_01_01:azure-mgmt-apimanagement:1.0.0-beta-1

Implements

com.microsoft.azure.arm.collection.SupportsCreating<Blank> com.microsoft.azure.arm.model.HasInner<com.microsoft.azure.management.apimanagement.v2019_01_01.implementation.SubscriptionsInner>

public interface Subscriptions
extends com.microsoft.azure.arm.collection.SupportsCreating<Blank>, com.microsoft.azure.arm.model.HasInner<com.microsoft.azure.management.apimanagement.v2019_01_01.implementation.SubscriptionsInner>

Type representing Subscriptions.

Method Summary

Modifier and Type Method and Description
abstract rx.Completable deleteAsync(String resourceGroupName, String serviceName, String sid, String ifMatch)

Deletes the specified subscription.
abstract rx.Observable<ProductSubscriptionContract> getAsync(String resourceGroupName, String serviceName, String sid)

Gets the specified Subscription entity.
abstract rx.Completable getEntityTagAsync(String resourceGroupName, String serviceName, String sid)

Gets the entity state (Etag) version of the apimanagement subscription specified by its identifier.
abstract rx.Observable<ProductSubscriptionContract> listAsync(String resourceGroupName, String serviceName)

Lists all subscriptions of the API Management service instance.
abstract rx.Completable regeneratePrimaryKeyAsync(String resourceGroupName, String serviceName, String sid)

Regenerates primary key of existing subscription of the API Management service instance.
abstract rx.Completable regenerateSecondaryKeyAsync(String resourceGroupName, String serviceName, String sid)

Regenerates secondary key of existing subscription of the API Management service instance.

Method Details

deleteAsync

public abstract Completable deleteAsync(String resourceGroupName, String serviceName, String sid, String ifMatch)

Deletes the specified subscription.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
sid - Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Returns:

the observable for the request

getAsync

public abstract Observable<ProductSubscriptionContract> getAsync(String resourceGroupName, String serviceName, String sid)

Gets the specified Subscription entity.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
sid - Subscription entity Identifier. The entity represents the association between a user and a product in API Management.

Returns:

the observable for the request

getEntityTagAsync

public abstract Completable getEntityTagAsync(String resourceGroupName, String serviceName, String sid)

Gets the entity state (Etag) version of the apimanagement subscription specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
sid - Subscription entity Identifier. The entity represents the association between a user and a product in API Management.

Returns:

the observable for the request

listAsync

public abstract Observable<ProductSubscriptionContract> listAsync(String resourceGroupName, String serviceName)

Lists all subscriptions of the API Management service instance.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.

Returns:

the observable for the request

regeneratePrimaryKeyAsync

public abstract Completable regeneratePrimaryKeyAsync(String resourceGroupName, String serviceName, String sid)

Regenerates primary key of existing subscription of the API Management service instance.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
sid - Subscription entity Identifier. The entity represents the association between a user and a product in API Management.

Returns:

the observable for the request

regenerateSecondaryKeyAsync

public abstract Completable regenerateSecondaryKeyAsync(String resourceGroupName, String serviceName, String sid)

Regenerates secondary key of existing subscription of the API Management service instance.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
sid - Subscription entity Identifier. The entity represents the association between a user and a product in API Management.

Returns:

the observable for the request

Applies to