This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.77.0 published on Thursday, Dec 12, 2024 by Pulumi
azure-native.apimanagement.getWorkspaceSubscription
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.77.0 published on Thursday, Dec 12, 2024 by Pulumi
Gets the specified Subscription entity. 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.
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>
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]
func LookupWorkspaceSubscription(ctx *Context, args *LookupWorkspaceSubscriptionArgs, opts ...InvokeOption) (*LookupWorkspaceSubscriptionResult, error)
func LookupWorkspaceSubscriptionOutput(ctx *Context, args *LookupWorkspaceSubscriptionOutputArgs, opts ...InvokeOption) LookupWorkspaceSubscriptionResultOutput
> 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)
}
public static CompletableFuture<GetWorkspaceSubscriptionResult> getWorkspaceSubscription(GetWorkspaceSubscriptionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:apimanagement:getWorkspaceSubscription
arguments:
# arguments dictionary
The following arguments are supported:
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name 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.
- Workspace
Id string - Workspace identifier. Must be unique in the current API Management service instance.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name 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.
- Workspace
Id string - Workspace identifier. Must be unique in the current API Management service instance.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name 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.
- workspace
Id String - Workspace identifier. Must be unique in the current API Management service instance.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- service
Name 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.
- workspace
Id string - Workspace identifier. Must be unique in the current API Management service instance.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- 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.
- workspace_
id str - Workspace identifier. Must be unique in the current API Management service instance.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name 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.
- workspace
Id String - Workspace identifier. Must be unique in the current API Management service instance.
getWorkspaceSubscription Result
The following output properties are available:
- Created
Date 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"
- Allow
Tracing bool - Determines whether tracing is enabled
- Display
Name string - The name of the subscription, or null if the subscription has no name.
- End
Date 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. - Expiration
Date 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. - Notification
Date 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. - Owner
Id 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.
- Primary
Key string - Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
- Secondary
Key string - Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
- Start
Date 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. - State
Comment string - Optional subscription comment added by an administrator when the state is changed to the 'rejected'.
- Created
Date 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"
- Allow
Tracing bool - Determines whether tracing is enabled
- Display
Name string - The name of the subscription, or null if the subscription has no name.
- End
Date 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. - Expiration
Date 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. - Notification
Date 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. - Owner
Id 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.
- Primary
Key string - Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
- Secondary
Key string - Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
- Start
Date 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. - State
Comment string - Optional subscription comment added by an administrator when the state is changed to the 'rejected'.
- created
Date 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"
- allow
Tracing Boolean - Determines whether tracing is enabled
- display
Name String - The name of the subscription, or null if the subscription has no name.
- end
Date 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. - expiration
Date 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. - notification
Date 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. - owner
Id 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.
- primary
Key String - Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
- secondary
Key String - Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
- start
Date 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. - state
Comment String - Optional subscription comment added by an administrator when the state is changed to the 'rejected'.
- created
Date 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"
- allow
Tracing boolean - Determines whether tracing is enabled
- display
Name string - The name of the subscription, or null if the subscription has no name.
- end
Date 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. - expiration
Date 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. - notification
Date 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. - owner
Id 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.
- primary
Key string - Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
- secondary
Key string - Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
- start
Date 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. - state
Comment 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
- 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'.
- created
Date 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"
- allow
Tracing Boolean - Determines whether tracing is enabled
- display
Name String - The name of the subscription, or null if the subscription has no name.
- end
Date 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. - expiration
Date 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. - notification
Date 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. - owner
Id 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.
- primary
Key String - Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
- secondary
Key String - Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
- start
Date 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. - state
Comment 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 v1 docs if using the v1 version of this package.
Azure Native v2.77.0 published on Thursday, Dec 12, 2024 by Pulumi