Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. getWorkspaceSubscription
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.getWorkspaceSubscription

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the specified Subscription entity.

Uses Azure REST API version 2022-09-01-preview.

Other available API versions: 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]. See the version guide for details.

Using getWorkspaceSubscription

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 getWorkspaceSubscription(args: GetWorkspaceSubscriptionArgs, opts?: InvokeOptions): Promise<GetWorkspaceSubscriptionResult>
function getWorkspaceSubscriptionOutput(args: GetWorkspaceSubscriptionOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceSubscriptionResult>
Copy
def get_workspace_subscription(resource_group_name: Optional[str] = None,
                               service_name: Optional[str] = None,
                               sid: Optional[str] = None,
                               workspace_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetWorkspaceSubscriptionResult
def get_workspace_subscription_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                               service_name: Optional[pulumi.Input[str]] = None,
                               sid: Optional[pulumi.Input[str]] = None,
                               workspace_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetWorkspaceSubscriptionResult]
Copy
func LookupWorkspaceSubscription(ctx *Context, args *LookupWorkspaceSubscriptionArgs, opts ...InvokeOption) (*LookupWorkspaceSubscriptionResult, error)
func LookupWorkspaceSubscriptionOutput(ctx *Context, args *LookupWorkspaceSubscriptionOutputArgs, opts ...InvokeOption) LookupWorkspaceSubscriptionResultOutput
Copy

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

public static class GetWorkspaceSubscription 
{
    public static Task<GetWorkspaceSubscriptionResult> InvokeAsync(GetWorkspaceSubscriptionArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkspaceSubscriptionResult> Invoke(GetWorkspaceSubscriptionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWorkspaceSubscriptionResult> getWorkspaceSubscription(GetWorkspaceSubscriptionArgs args, InvokeOptions options)
public static Output<GetWorkspaceSubscriptionResult> getWorkspaceSubscription(GetWorkspaceSubscriptionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:apimanagement:getWorkspaceSubscription
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
Sid
This property is required.
Changes to this property will trigger replacement.
string
Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
Sid
This property is required.
Changes to this property will trigger replacement.
string
Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
sid
This property is required.
Changes to this property will trigger replacement.
String
Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Workspace identifier. Must be unique in the current API Management service instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
sid
This property is required.
Changes to this property will trigger replacement.
string
Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
workspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
sid
This property is required.
Changes to this property will trigger replacement.
str
Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
workspace_id
This property is required.
Changes to this property will trigger replacement.
str
Workspace identifier. Must be unique in the current API Management service instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
sid
This property is required.
Changes to this property will trigger replacement.
String
Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Workspace identifier. Must be unique in the current API Management service instance.

getWorkspaceSubscription Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
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
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
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
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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'.
AzureApiVersion string
The Azure API version of the resource.
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
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
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
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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'.
azureApiVersion String
The Azure API version of the resource.
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
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
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
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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'.
azureApiVersion string
The Azure API version of the resource.
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
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
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
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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'.
azure_api_version str
The Azure API version of the resource.
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
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
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
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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'.
azureApiVersion String
The Azure API version of the resource.
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
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
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
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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 pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native