SubscriptionCreateParameters Class

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

• java.lang.Object
• • com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters

public class SubscriptionCreateParameters

Subscription create details.

Constructor Summary

Constructor	Description
SubscriptionCreateParameters()

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	allowTracing() Get determines whether tracing can be enabled.
java.lang.String	displayName() Get subscription name.
java.lang.String	ownerId() Get user (user id path) for whom subscription is being created in form /users/{userId}.
java.lang.String	primaryKey() Get primary subscription key.
java.lang.String	scope() Get scope like /products/{productId} or /apis or /apis/{apiId}.
java.lang.String	secondaryKey() Get secondary subscription key.
SubscriptionState	state() Get initial subscription state.
SubscriptionCreateParameters	withAllowTracing(Boolean allowTracing) Set determines whether tracing can be enabled.
SubscriptionCreateParameters	withDisplayName(String displayName) Set subscription name.
SubscriptionCreateParameters	withOwnerId(String ownerId) Set user (user id path) for whom subscription is being created in form /users/{userId}.
SubscriptionCreateParameters	withPrimaryKey(String primaryKey) Set primary subscription key.
SubscriptionCreateParameters	withScope(String scope) Set scope like /products/{productId} or /apis or /apis/{apiId}.
SubscriptionCreateParameters	withSecondaryKey(String secondaryKey) Set secondary subscription key.
SubscriptionCreateParameters	withState(SubscriptionState state) Set initial subscription state.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

SubscriptionCreateParameters

public SubscriptionCreateParameters()

Method Details

allowTracing

public Boolean allowTracing()

Get determines whether tracing can be enabled.

Returns:

the allowTracing value

displayName

public String displayName()

Get subscription name.

Returns:

the displayName value

ownerId

public String ownerId()

Get user (user id path) for whom subscription is being created in form /users/{userId}.

Returns:

the ownerId value

primaryKey

public String primaryKey()

Get primary subscription key. If not specified during request key will be generated automatically.

Returns:

the primaryKey value

scope

public String scope()

Get scope like /products/{productId} or /apis or /apis/{apiId}.

Returns:

the scope value

secondaryKey

public String secondaryKey()

Get secondary subscription key. If not specified during request key will be generated automatically.

Returns:

the secondaryKey value

state

public SubscriptionState state()

Get initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active \u2013 the subscription is active, * suspended \u2013 the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted \u2013 the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected \u2013 the subscription request has been denied by an administrator, * cancelled \u2013 the subscription has been cancelled by the developer or administrator, * expired \u2013 the subscription reached its expiration date and was deactivated. Possible values include: 'suspended', 'active', 'expired', 'submitted', 'rejected', 'cancelled'.

Returns:

the state value

withAllowTracing

public SubscriptionCreateParameters withAllowTracing(Boolean allowTracing)

Set determines whether tracing can be enabled.

Parameters:

allowTracing - the allowTracing value to set

Returns:

the SubscriptionCreateParameters object itself.

withDisplayName

public SubscriptionCreateParameters withDisplayName(String displayName)

Set subscription name.

Parameters:

displayName - the displayName value to set

Returns:

the SubscriptionCreateParameters object itself.

withOwnerId

public SubscriptionCreateParameters withOwnerId(String ownerId)

Set user (user id path) for whom subscription is being created in form /users/{userId}.

Parameters:

ownerId - the ownerId value to set

Returns:

the SubscriptionCreateParameters object itself.

withPrimaryKey

public SubscriptionCreateParameters withPrimaryKey(String primaryKey)

Set primary subscription key. If not specified during request key will be generated automatically.

Parameters:

primaryKey - the primaryKey value to set

Returns:

the SubscriptionCreateParameters object itself.

withScope

public SubscriptionCreateParameters withScope(String scope)

Set scope like /products/{productId} or /apis or /apis/{apiId}.

Parameters:

scope - the scope value to set

Returns:

the SubscriptionCreateParameters object itself.

withSecondaryKey

public SubscriptionCreateParameters withSecondaryKey(String secondaryKey)

Set secondary subscription key. If not specified during request key will be generated automatically.

Parameters:

secondaryKey - the secondaryKey value to set

Returns:

the SubscriptionCreateParameters object itself.

withState

public SubscriptionCreateParameters withState(SubscriptionState state)

Set initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active \u2013 the subscription is active, * suspended \u2013 the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted \u2013 the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected \u2013 the subscription request has been denied by an administrator, * cancelled \u2013 the subscription has been cancelled by the developer or administrator, * expired \u2013 the subscription reached its expiration date and was deactivated. Possible values include: 'suspended', 'active', 'expired', 'submitted', 'rejected', 'cancelled'.

Parameters:

state - the state value to set

Returns:

the SubscriptionCreateParameters object itself.