Docs Packages
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. apimanagement
  5. getSubscription
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.getSubscription

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Gets the specified Subscription entity. API Version: 2020-12-01.

    Using getSubscription

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSubscription(args: GetSubscriptionArgs, opts?: InvokeOptions): Promise<GetSubscriptionResult>
function getSubscriptionOutput(args: GetSubscriptionOutputArgs, opts?: InvokeOptions): Output<GetSubscriptionResult>
    def get_subscription(resource_group_name: Optional[str] = None,
                     service_name: Optional[str] = None,
                     sid: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetSubscriptionResult
def get_subscription_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                     service_name: Optional[pulumi.Input[str]] = None,
                     sid: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetSubscriptionResult]
    func LookupSubscription(ctx *Context, args *LookupSubscriptionArgs, opts ...InvokeOption) (*LookupSubscriptionResult, error)
func LookupSubscriptionOutput(ctx *Context, args *LookupSubscriptionOutputArgs, opts ...InvokeOption) LookupSubscriptionResultOutput

    > Note: This function is named LookupSubscription in the Go SDK.

    public static class GetSubscription 
{
    public static Task<GetSubscriptionResult> InvokeAsync(GetSubscriptionArgs args, InvokeOptions? opts = null)
    public static Output<GetSubscriptionResult> Invoke(GetSubscriptionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSubscriptionResult> getSubscription(GetSubscriptionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:apimanagement:getSubscription
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group.
    ServiceName string
    The name of the API Management service.
    Sid string
    Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
    ResourceGroupName string
    The name of the resource group.
    ServiceName string
    The name of the API Management service.
    Sid string
    Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
    resourceGroupName String
    The name of the resource group.
    serviceName String
    The name of the API Management service.
    sid String
    Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
    resourceGroupName string
    The name of the resource group.
    serviceName string
    The name of the API Management service.
    sid string
    Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
    resource_group_name str
    The name of the resource group.
    service_name str
    The name of the API Management service.
    sid str
    Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
    resourceGroupName String
    The name of the resource group.
    serviceName String
    The name of the API Management service.
    sid String
    Subscription entity Identifier. The entity represents the association between a user and a product in API Management.

    getSubscription Result

    The following output properties are available:

    CreatedDate string
    Subscription creation date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    Id string
    Resource ID.
    Name string
    Resource name.
    Scope string
    Scope like /products/{productId} or /apis or /apis/{apiId}.
    State string
    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.
    Type string
    Resource type for API Management resource.
    AllowTracing bool
    Determines whether tracing is enabled
    DisplayName string
    The name of the subscription, or null if the subscription has no name.
    EndDate string
    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.
    ExpirationDate string
    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.
    NotificationDate string
    Upcoming subscription expiration notification date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    OwnerId string
    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.
    PrimaryKey string
    Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
    SecondaryKey string
    Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
    StartDate string
    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.
    StateComment string
    Optional subscription comment added by an administrator when the state is changed to the 'rejected'.
    CreatedDate string
    Subscription creation date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    Id string
    Resource ID.
    Name string
    Resource name.
    Scope string
    Scope like /products/{productId} or /apis or /apis/{apiId}.
    State string
    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.
    Type string
    Resource type for API Management resource.
    AllowTracing bool
    Determines whether tracing is enabled
    DisplayName string
    The name of the subscription, or null if the subscription has no name.
    EndDate string
    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.
    ExpirationDate string
    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.
    NotificationDate string
    Upcoming subscription expiration notification date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    OwnerId string
    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.
    PrimaryKey string
    Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
    SecondaryKey string
    Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
    StartDate string
    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.
    StateComment string
    Optional subscription comment added by an administrator when the state is changed to the 'rejected'.
    createdDate String
    Subscription creation date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    id String
    Resource ID.
    name String
    Resource name.
    scope String
    Scope like /products/{productId} or /apis or /apis/{apiId}.
    state String
    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.
    type String
    Resource type for API Management resource.
    allowTracing Boolean
    Determines whether tracing is enabled
    displayName String
    The name of the subscription, or null if the subscription has no name.
    endDate String
    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.
    expirationDate String
    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.
    notificationDate String
    Upcoming subscription expiration notification date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    ownerId String
    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.
    primaryKey String
    Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
    secondaryKey String
    Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
    startDate String
    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.
    stateComment String
    Optional subscription comment added by an administrator when the state is changed to the 'rejected'.
    createdDate string
    Subscription creation date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    id string
    Resource ID.
    name string
    Resource name.
    scope string
    Scope like /products/{productId} or /apis or /apis/{apiId}.
    state string
    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.
    type string
    Resource type for API Management resource.
    allowTracing boolean
    Determines whether tracing is enabled
    displayName string
    The name of the subscription, or null if the subscription has no name.
    endDate string
    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.
    expirationDate string
    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.
    notificationDate string
    Upcoming subscription expiration notification date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    ownerId string
    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.
    primaryKey string
    Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
    secondaryKey string
    Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
    startDate string
    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.
    stateComment string
    Optional subscription comment added by an administrator when the state is changed to the 'rejected'.
    created_date str
    Subscription creation date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    id str
    Resource ID.
    name str
    Resource name.
    scope str
    Scope like /products/{productId} or /apis or /apis/{apiId}.
    state str
    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.
    type str
    Resource type for API Management resource.
    allow_tracing bool
    Determines whether tracing is enabled
    display_name str
    The name of the subscription, or null if the subscription has no name.
    end_date str
    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.
    expiration_date str
    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.
    notification_date str
    Upcoming subscription expiration notification date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    owner_id str
    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.
    primary_key str
    Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
    secondary_key str
    Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
    start_date str
    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.
    state_comment str
    Optional subscription comment added by an administrator when the state is changed to the 'rejected'.
    createdDate String
    Subscription creation date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    id String
    Resource ID.
    name String
    Resource name.
    scope String
    Scope like /products/{productId} or /apis or /apis/{apiId}.
    state String
    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.
    type String
    Resource type for API Management resource.
    allowTracing Boolean
    Determines whether tracing is enabled
    displayName String
    The name of the subscription, or null if the subscription has no name.
    endDate String
    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.
    expirationDate String
    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.
    notificationDate String
    Upcoming subscription expiration notification date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    ownerId String
    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.
    primaryKey String
    Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
    secondaryKey String
    Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
    startDate String
    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.
    stateComment String
    Optional subscription comment added by an administrator when the state is changed to the 'rejected'.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native