Package com.azure.resourcemanager.apimanagement.models

Interface SubscriptionContract

  • public interface SubscriptionContract
    An immutable client-side representation of SubscriptionContract.

    • Method Detail

      • id

        String id()
        Gets the id property: Fully qualified resource Id for the resource.
        Returns:
        the id value.

      • name

        String name()
        Gets the name property: The name of the resource.
        Returns:
        the name value.

      • type

        String type()
        Gets the type property: The type of the resource.
        Returns:
        the type value.

      • ownerId

        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:
        the ownerId value.

      • scope

        String scope()
        Gets the scope property: Scope like /products/{productId} or /apis or /apis/{apiId}.
        Returns:
        the scope value.

      • displayName

        String displayName()
        Gets the displayName property: The name of the subscription, or null if the subscription has no name.
        Returns:
        the displayName value.

      • state

        SubscriptionState state()
        Gets the state property: Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.
        Returns:
        the state value.

      • createdDate

        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:
        the createdDate value.

      • startDate

        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:
        the startDate value.

      • expirationDate

        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:
        the expirationDate value.

      • endDate

        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:
        the endDate value.

      • notificationDate

        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:
        the notificationDate value.

      • primaryKey

        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:
        the primaryKey value.

      • secondaryKey

        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:
        the secondaryKey value.

      • stateComment

        String stateComment()
        Gets the stateComment property: Optional subscription comment added by an administrator when the state is changed to the 'rejected'.
        Returns:
        the stateComment value.

      • allowTracing

        Boolean allowTracing()
        Gets the allowTracing property: Determines whether tracing is enabled.
        Returns:
        the allowTracing value.

      • innerModel

        SubscriptionContractInner innerModel()
        Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.SubscriptionContractInner object.
        Returns:
        the inner object.