Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. apimanagement
  5. WorkspaceSubscription
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.apimanagement.WorkspaceSubscription

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Subscription details. 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.

Example Usage

ApiManagementCreateWorkspaceSubscription

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var workspaceSubscription = new AzureNative.ApiManagement.WorkspaceSubscription("workspaceSubscription", new()
    {
        DisplayName = "testsub",
        OwnerId = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
        ResourceGroupName = "rg1",
        Scope = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002",
        ServiceName = "apimService1",
        Sid = "testsub",
        WorkspaceId = "wks1",
    });

});
Copy
package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewWorkspaceSubscription(ctx, "workspaceSubscription", &apimanagement.WorkspaceSubscriptionArgs{
			DisplayName:       pulumi.String("testsub"),
			OwnerId:           pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7"),
			ResourceGroupName: pulumi.String("rg1"),
			Scope:             pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002"),
			ServiceName:       pulumi.String("apimService1"),
			Sid:               pulumi.String("testsub"),
			WorkspaceId:       pulumi.String("wks1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.WorkspaceSubscription;
import com.pulumi.azurenative.apimanagement.WorkspaceSubscriptionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var workspaceSubscription = new WorkspaceSubscription("workspaceSubscription", WorkspaceSubscriptionArgs.builder()
            .displayName("testsub")
            .ownerId("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7")
            .resourceGroupName("rg1")
            .scope("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002")
            .serviceName("apimService1")
            .sid("testsub")
            .workspaceId("wks1")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const workspaceSubscription = new azure_native.apimanagement.WorkspaceSubscription("workspaceSubscription", {
    displayName: "testsub",
    ownerId: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    resourceGroupName: "rg1",
    scope: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002",
    serviceName: "apimService1",
    sid: "testsub",
    workspaceId: "wks1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

workspace_subscription = azure_native.apimanagement.WorkspaceSubscription("workspaceSubscription",
    display_name="testsub",
    owner_id="/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    resource_group_name="rg1",
    scope="/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002",
    service_name="apimService1",
    sid="testsub",
    workspace_id="wks1")
Copy
resources:
  workspaceSubscription:
    type: azure-native:apimanagement:WorkspaceSubscription
    properties:
      displayName: testsub
      ownerId: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7
      resourceGroupName: rg1
      scope: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002
      serviceName: apimService1
      sid: testsub
      workspaceId: wks1
Copy

Create WorkspaceSubscription Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new WorkspaceSubscription(name: string, args: WorkspaceSubscriptionArgs, opts?: CustomResourceOptions);
@overload
def WorkspaceSubscription(resource_name: str,
                          args: WorkspaceSubscriptionArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def WorkspaceSubscription(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          service_name: Optional[str] = None,
                          display_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          scope: Optional[str] = None,
                          workspace_id: Optional[str] = None,
                          app_type: Optional[str] = None,
                          notify: Optional[bool] = None,
                          owner_id: Optional[str] = None,
                          primary_key: Optional[str] = None,
                          secondary_key: Optional[str] = None,
                          allow_tracing: Optional[bool] = None,
                          sid: Optional[str] = None,
                          state: Optional[SubscriptionState] = None)
func NewWorkspaceSubscription(ctx *Context, name string, args WorkspaceSubscriptionArgs, opts ...ResourceOption) (*WorkspaceSubscription, error)
public WorkspaceSubscription(string name, WorkspaceSubscriptionArgs args, CustomResourceOptions? opts = null)
public WorkspaceSubscription(String name, WorkspaceSubscriptionArgs args)
public WorkspaceSubscription(String name, WorkspaceSubscriptionArgs args, CustomResourceOptions options)

type: azure-native:apimanagement:WorkspaceSubscription
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. WorkspaceSubscriptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. WorkspaceSubscriptionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. WorkspaceSubscriptionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. WorkspaceSubscriptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. WorkspaceSubscriptionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var workspaceSubscriptionResource = new AzureNative.Apimanagement.WorkspaceSubscription("workspaceSubscriptionResource", new()
{
    ServiceName = "string",
    DisplayName = "string",
    ResourceGroupName = "string",
    Scope = "string",
    WorkspaceId = "string",
    AppType = "string",
    Notify = false,
    OwnerId = "string",
    PrimaryKey = "string",
    SecondaryKey = "string",
    AllowTracing = false,
    Sid = "string",
    State = "suspended",
});
Copy
example, err := apimanagement.NewWorkspaceSubscription(ctx, "workspaceSubscriptionResource", &apimanagement.WorkspaceSubscriptionArgs{
	ServiceName:       "string",
	DisplayName:       "string",
	ResourceGroupName: "string",
	Scope:             "string",
	WorkspaceId:       "string",
	AppType:           "string",
	Notify:            false,
	OwnerId:           "string",
	PrimaryKey:        "string",
	SecondaryKey:      "string",
	AllowTracing:      false,
	Sid:               "string",
	State:             "suspended",
})
Copy
var workspaceSubscriptionResource = new WorkspaceSubscription("workspaceSubscriptionResource", WorkspaceSubscriptionArgs.builder()
    .serviceName("string")
    .displayName("string")
    .resourceGroupName("string")
    .scope("string")
    .workspaceId("string")
    .appType("string")
    .notify(false)
    .ownerId("string")
    .primaryKey("string")
    .secondaryKey("string")
    .allowTracing(false)
    .sid("string")
    .state("suspended")
    .build());
Copy
workspace_subscription_resource = azure_native.apimanagement.WorkspaceSubscription("workspaceSubscriptionResource",
    service_name=string,
    display_name=string,
    resource_group_name=string,
    scope=string,
    workspace_id=string,
    app_type=string,
    notify=False,
    owner_id=string,
    primary_key=string,
    secondary_key=string,
    allow_tracing=False,
    sid=string,
    state=suspended)
Copy
const workspaceSubscriptionResource = new azure_native.apimanagement.WorkspaceSubscription("workspaceSubscriptionResource", {
    serviceName: "string",
    displayName: "string",
    resourceGroupName: "string",
    scope: "string",
    workspaceId: "string",
    appType: "string",
    notify: false,
    ownerId: "string",
    primaryKey: "string",
    secondaryKey: "string",
    allowTracing: false,
    sid: "string",
    state: "suspended",
});
Copy
type: azure-native:apimanagement:WorkspaceSubscription
properties:
    allowTracing: false
    appType: string
    displayName: string
    notify: false
    ownerId: string
    primaryKey: string
    resourceGroupName: string
    scope: string
    secondaryKey: string
    serviceName: string
    sid: string
    state: suspended
    workspaceId: string
Copy

WorkspaceSubscription Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The WorkspaceSubscription resource accepts the following input properties:

DisplayName This property is required. string
Subscription name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Scope This property is required. string
Scope like /products/{productId} or /apis or /apis/{apiId}.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
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.
AllowTracing bool
Determines whether tracing can be enabled
AppType string
Determines the type of application which send the create user request. Default is legacy publisher portal.
Notify bool
Notify change in Subscription State.

  • If false, do not send any email notification for change of state of subscription
  • If true, send email notification of change of state of subscription
OwnerId string
User (user id path) for whom subscription is being created in form /users/{userId}
PrimaryKey string
Primary subscription key. If not specified during request key will be generated automatically.
SecondaryKey string
Secondary subscription key. If not specified during request key will be generated automatically.
Sid 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.
State Pulumi.AzureNative.ApiManagement.SubscriptionState
Initial subscription state. If no value is specified, subscription is created with Submitted 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.
DisplayName This property is required. string
Subscription name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Scope This property is required. string
Scope like /products/{productId} or /apis or /apis/{apiId}.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
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.
AllowTracing bool
Determines whether tracing can be enabled
AppType string
Determines the type of application which send the create user request. Default is legacy publisher portal.
Notify bool
Notify change in Subscription State.

  • If false, do not send any email notification for change of state of subscription
  • If true, send email notification of change of state of subscription
OwnerId string
User (user id path) for whom subscription is being created in form /users/{userId}
PrimaryKey string
Primary subscription key. If not specified during request key will be generated automatically.
SecondaryKey string
Secondary subscription key. If not specified during request key will be generated automatically.
Sid 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.
State SubscriptionStateEnum
Initial subscription state. If no value is specified, subscription is created with Submitted 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.
displayName This property is required. String
Subscription name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
scope This property is required. String
Scope like /products/{productId} or /apis or /apis/{apiId}.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
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.
allowTracing Boolean
Determines whether tracing can be enabled
appType String
Determines the type of application which send the create user request. Default is legacy publisher portal.
notify_ Boolean
Notify change in Subscription State.

  • If false, do not send any email notification for change of state of subscription
  • If true, send email notification of change of state of subscription
ownerId String
User (user id path) for whom subscription is being created in form /users/{userId}
primaryKey String
Primary subscription key. If not specified during request key will be generated automatically.
secondaryKey String
Secondary subscription key. If not specified during request key will be generated automatically.
sid 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.
state SubscriptionState
Initial subscription state. If no value is specified, subscription is created with Submitted 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.
displayName This property is required. string
Subscription name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
scope This property is required. string
Scope like /products/{productId} or /apis or /apis/{apiId}.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
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.
allowTracing boolean
Determines whether tracing can be enabled
appType string
Determines the type of application which send the create user request. Default is legacy publisher portal.
notify boolean
Notify change in Subscription State.

  • If false, do not send any email notification for change of state of subscription
  • If true, send email notification of change of state of subscription
ownerId string
User (user id path) for whom subscription is being created in form /users/{userId}
primaryKey string
Primary subscription key. If not specified during request key will be generated automatically.
secondaryKey string
Secondary subscription key. If not specified during request key will be generated automatically.
sid 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.
state SubscriptionState
Initial subscription state. If no value is specified, subscription is created with Submitted 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.
display_name This property is required. str
Subscription name.
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.
scope This property is required. str
Scope like /products/{productId} or /apis or /apis/{apiId}.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
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.
allow_tracing bool
Determines whether tracing can be enabled
app_type str
Determines the type of application which send the create user request. Default is legacy publisher portal.
notify bool
Notify change in Subscription State.

  • If false, do not send any email notification for change of state of subscription
  • If true, send email notification of change of state of subscription
owner_id str
User (user id path) for whom subscription is being created in form /users/{userId}
primary_key str
Primary subscription key. If not specified during request key will be generated automatically.
secondary_key str
Secondary subscription key. If not specified during request key will be generated automatically.
sid 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.
state SubscriptionState
Initial subscription state. If no value is specified, subscription is created with Submitted 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.
displayName This property is required. String
Subscription name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
scope This property is required. String
Scope like /products/{productId} or /apis or /apis/{apiId}.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
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.
allowTracing Boolean
Determines whether tracing can be enabled
appType String
Determines the type of application which send the create user request. Default is legacy publisher portal.
notify Boolean
Notify change in Subscription State.

  • If false, do not send any email notification for change of state of subscription
  • If true, send email notification of change of state of subscription
ownerId String
User (user id path) for whom subscription is being created in form /users/{userId}
primaryKey String
Primary subscription key. If not specified during request key will be generated automatically.
secondaryKey String
Secondary subscription key. If not specified during request key will be generated automatically.
sid 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.
state "suspended" | "active" | "expired" | "submitted" | "rejected" | "cancelled"
Initial subscription state. If no value is specified, subscription is created with Submitted 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.

Outputs

All input properties are implicitly available as output properties. Additionally, the WorkspaceSubscription resource produces the following output properties:

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
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
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
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
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
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
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
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
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
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
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
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
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'.

Supporting Types

SubscriptionState
, SubscriptionStateArgs

Suspended
suspended
Active
active
Expired
expired
Submitted
submitted
Rejected
rejected
Cancelled
cancelled
SubscriptionStateSuspended
suspended
SubscriptionStateActive
active
SubscriptionStateExpired
expired
SubscriptionStateSubmitted
submitted
SubscriptionStateRejected
rejected
SubscriptionStateCancelled
cancelled
Suspended
suspended
Active
active
Expired
expired
Submitted
submitted
Rejected
rejected
Cancelled
cancelled
Suspended
suspended
Active
active
Expired
expired
Submitted
submitted
Rejected
rejected
Cancelled
cancelled
SUSPENDED
suspended
ACTIVE
active
EXPIRED
expired
SUBMITTED
submitted
REJECTED
rejected
CANCELLED
cancelled
"suspended"
suspended
"active"
active
"expired"
expired
"submitted"
submitted
"rejected"
rejected
"cancelled"
cancelled

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:apimanagement:WorkspaceSubscription testsub /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native