SubscriptionCreateParameters Class
- java.
lang. Object - com.
microsoft. azure. management. apimanagement. v2019_01_01.SubscriptionCreateParameters
- com.
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/{user |
java.lang.String |
primaryKey()
Get primary subscription key. |
java.lang.String |
scope()
Get scope like /products/{product |
java.lang.String |
secondaryKey()
Get secondary subscription key. |
Subscription |
state()
Get initial subscription state. |
Subscription |
withAllowTracing(Boolean allowTracing)
Set determines whether tracing can be enabled. |
Subscription |
withDisplayName(String displayName)
Set subscription name. |
Subscription |
withOwnerId(String ownerId)
Set user (user id path) for whom subscription is being created in form /users/{user |
Subscription |
withPrimaryKey(String primaryKey)
Set primary subscription key. |
Subscription |
withScope(String scope)
Set scope like /products/{product |
Subscription |
withSecondaryKey(String secondaryKey)
Set secondary subscription key. |
Subscription |
withState(SubscriptionState state)
Set initial subscription state. |
Methods inherited from java.lang.Object
Constructor Details
SubscriptionCreateParameters
public SubscriptionCreateParameters()
Method Details
allowTracing
public Boolean allowTracing()
Get determines whether tracing can be enabled.
Returns:
displayName
public String displayName()
Get subscription name.
Returns:
ownerId
public String ownerId()
Get user (user id path) for whom subscription is being created in form /users/{userId}.
Returns:
primaryKey
public String primaryKey()
Get primary subscription key. If not specified during request key will be generated automatically.
Returns:
scope
public String scope()
Get scope like /products/{productId} or /apis or /apis/{apiId}.
Returns:
secondaryKey
public String secondaryKey()
Get secondary subscription key. If not specified during request key will be generated automatically.
Returns:
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:
withAllowTracing
public SubscriptionCreateParameters withAllowTracing(Boolean allowTracing)
Set determines whether tracing can be enabled.
Parameters:
Returns:
withDisplayName
public SubscriptionCreateParameters withDisplayName(String displayName)
Set subscription name.
Parameters:
Returns:
withOwnerId
public SubscriptionCreateParameters withOwnerId(String ownerId)
Set user (user id path) for whom subscription is being created in form /users/{userId}.
Parameters:
Returns:
withPrimaryKey
public SubscriptionCreateParameters withPrimaryKey(String primaryKey)
Set primary subscription key. If not specified during request key will be generated automatically.
Parameters:
Returns:
withScope
public SubscriptionCreateParameters withScope(String scope)
Set scope like /products/{productId} or /apis or /apis/{apiId}.
Parameters:
Returns:
withSecondaryKey
public SubscriptionCreateParameters withSecondaryKey(String secondaryKey)
Set secondary subscription key. If not specified during request key will be generated automatically.
Parameters:
Returns:
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:
Returns:
Applies to
Azure SDK for Java
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for