SubscriptionContract Interface
public interface SubscriptionContract
An immutable client-side representation of SubscriptionContract.
Method Summary
| Modifier and Type | Method and Description |
|---|---|
| abstract Boolean |
allowTracing()
Gets the allow |
|
abstract
Offset |
createdDate()
Gets the created |
| abstract String |
displayName()
Gets the display |
|
abstract
Offset |
endDate()
Gets the end |
|
abstract
Offset |
expirationDate()
Gets the expiration |
| abstract String |
id()
Gets the id property: Fully qualified resource Id for the resource. |
|
abstract
Subscription |
innerModel()
Gets the inner com. |
| abstract String |
name()
Gets the name property: The name of the resource. |
|
abstract
Offset |
notificationDate()
Gets the notification |
| abstract String |
ownerId()
Gets the owner |
| abstract String |
primaryKey()
Gets the primary |
| abstract String |
scope()
Gets the scope property: Scope like /products/{product |
| abstract String |
secondaryKey()
Gets the secondary |
|
abstract
Offset |
startDate()
Gets the start |
|
abstract
Subscription |
state()
Gets the state property: Subscription state. |
| abstract String |
stateComment()
Gets the state |
| abstract String |
type()
Gets the type property: The type of the resource. |
Method Details
allowTracing
public abstract Boolean allowTracing()
Gets the allowTracing property: Determines whether tracing is enabled.
Returns:
createdDate
public abstract OffsetDateTime createdDate()
Gets the createdDate property: Subscription creation date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
Returns:
displayName
public abstract String displayName()
Gets the displayName property: The name of the subscription, or null if the subscription has no name.
Returns:
endDate
public abstract OffsetDateTime endDate()
Gets the endDate property: Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
Returns:
expirationDate
public abstract OffsetDateTime expirationDate()
Gets the expirationDate property: Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
Returns:
id
public abstract String id()
Gets the id property: Fully qualified resource Id for the resource.
Returns:
innerModel
public abstract SubscriptionContractInner innerModel()
Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.SubscriptionContractInner object.
Returns:
name
public abstract String name()
Gets the name property: The name of the resource.
Returns:
notificationDate
public abstract OffsetDateTime notificationDate()
Gets the notificationDate property: Upcoming subscription expiration notification date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
Returns:
ownerId
public abstract String ownerId()
Gets the ownerId property: The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier.
Returns:
primaryKey
public abstract String primaryKey()
Gets the primaryKey property: Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
Returns:
scope
public abstract String scope()
Gets the scope property: Scope like /products/{productId} or /apis or /apis/{apiId}.
Returns:
secondaryKey
public abstract String secondaryKey()
Gets the secondaryKey property: Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
Returns:
startDate
public abstract OffsetDateTime startDate()
Gets the startDate property: Subscription activation date. The setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
Returns:
state
public abstract SubscriptionState state()
Gets the state property: Subscription 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.
Returns:
stateComment
public abstract String stateComment()
Gets the stateComment property: Optional subscription comment added by an administrator when the state is changed to the 'rejected'.
Returns:
type
public abstract String type()
Gets the type property: The type of the resource.
Returns:
Applies to
Azure SDK for Java
Feedback
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: https://aka.ms/ContentUserFeedback.
Submit and view feedback for