azure-native.apimanagement.Subscription
Explore with Pulumi AI
Subscription details. Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2020-12-01.
Other available API versions: 2016-07-07, 2016-10-10, 2018-01-01, 2019-01-01, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.
Example Usage
ApiManagementCreateSubscription
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var subscription = new AzureNative.ApiManagement.Subscription("subscription", 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/products/5600b59475ff190048060002",
ServiceName = "apimService1",
Sid = "testsub",
});
});
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.NewSubscription(ctx, "subscription", &apimanagement.SubscriptionArgs{
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/products/5600b59475ff190048060002"),
ServiceName: pulumi.String("apimService1"),
Sid: pulumi.String("testsub"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.Subscription;
import com.pulumi.azurenative.apimanagement.SubscriptionArgs;
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 subscription = new Subscription("subscription", SubscriptionArgs.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/products/5600b59475ff190048060002")
.serviceName("apimService1")
.sid("testsub")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
subscription = azure_native.apimanagement.Subscription("subscription",
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/products/5600b59475ff190048060002",
service_name="apimService1",
sid="testsub")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const subscription = new azure_native.apimanagement.Subscription("subscription", {
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/products/5600b59475ff190048060002",
serviceName: "apimService1",
sid: "testsub",
});
resources:
subscription:
type: azure-native:apimanagement:Subscription
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/products/5600b59475ff190048060002
serviceName: apimService1
sid: testsub
Create Subscription Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Subscription(name: string, args: SubscriptionArgs, opts?: CustomResourceOptions);
@overload
def Subscription(resource_name: str,
args: SubscriptionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Subscription(resource_name: str,
opts: Optional[ResourceOptions] = None,
display_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
scope: Optional[str] = None,
service_name: Optional[str] = None,
allow_tracing: Optional[bool] = 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,
sid: Optional[str] = None,
state: Optional[SubscriptionState] = None)
func NewSubscription(ctx *Context, name string, args SubscriptionArgs, opts ...ResourceOption) (*Subscription, error)
public Subscription(string name, SubscriptionArgs args, CustomResourceOptions? opts = null)
public Subscription(String name, SubscriptionArgs args)
public Subscription(String name, SubscriptionArgs args, CustomResourceOptions options)
type: azure-native:apimanagement:Subscription
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args SubscriptionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args SubscriptionArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args SubscriptionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SubscriptionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SubscriptionArgs
- 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 subscriptionResource = new AzureNative.ApiManagement.Subscription("subscriptionResource", new()
{
DisplayName = "string",
ResourceGroupName = "string",
Scope = "string",
ServiceName = "string",
AllowTracing = false,
AppType = "string",
Notify = false,
OwnerId = "string",
PrimaryKey = "string",
SecondaryKey = "string",
Sid = "string",
State = AzureNative.ApiManagement.SubscriptionState.Suspended,
});
example, err := apimanagement.NewSubscription(ctx, "subscriptionResource", &apimanagement.SubscriptionArgs{
DisplayName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
Scope: pulumi.String("string"),
ServiceName: pulumi.String("string"),
AllowTracing: pulumi.Bool(false),
AppType: pulumi.String("string"),
Notify: pulumi.Bool(false),
OwnerId: pulumi.String("string"),
PrimaryKey: pulumi.String("string"),
SecondaryKey: pulumi.String("string"),
Sid: pulumi.String("string"),
State: apimanagement.SubscriptionStateSuspended,
})
var subscriptionResource = new Subscription("subscriptionResource", SubscriptionArgs.builder()
.displayName("string")
.resourceGroupName("string")
.scope("string")
.serviceName("string")
.allowTracing(false)
.appType("string")
.notify(false)
.ownerId("string")
.primaryKey("string")
.secondaryKey("string")
.sid("string")
.state("suspended")
.build());
subscription_resource = azure_native.apimanagement.Subscription("subscriptionResource",
display_name="string",
resource_group_name="string",
scope="string",
service_name="string",
allow_tracing=False,
app_type="string",
notify=False,
owner_id="string",
primary_key="string",
secondary_key="string",
sid="string",
state=azure_native.apimanagement.SubscriptionState.SUSPENDED)
const subscriptionResource = new azure_native.apimanagement.Subscription("subscriptionResource", {
displayName: "string",
resourceGroupName: "string",
scope: "string",
serviceName: "string",
allowTracing: false,
appType: "string",
notify: false,
ownerId: "string",
primaryKey: "string",
secondaryKey: "string",
sid: "string",
state: azure_native.apimanagement.SubscriptionState.Suspended,
});
type: azure-native:apimanagement:Subscription
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
Subscription 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 Subscription resource accepts the following input properties:
- Display
Name string - Subscription name.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Scope string
- Scope like /products/{productId} or /apis or /apis/{apiId}.
- Service
Name string - The name of the API Management service.
- Allow
Tracing bool - Determines whether tracing can be enabled
- App
Type 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
- Owner
Id string - User (user id path) for whom subscription is being created in form /users/{userId}
- Primary
Key string - Primary subscription key. If not specified during request key will be generated automatically.
- Secondary
Key string - Secondary subscription key. If not specified during request key will be generated automatically.
- Sid string
- Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
- State
Pulumi.
Azure Native. Api Management. Subscription State - 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 string - Subscription name.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Scope string
- Scope like /products/{productId} or /apis or /apis/{apiId}.
- Service
Name string - The name of the API Management service.
- Allow
Tracing bool - Determines whether tracing can be enabled
- App
Type 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
- Owner
Id string - User (user id path) for whom subscription is being created in form /users/{userId}
- Primary
Key string - Primary subscription key. If not specified during request key will be generated automatically.
- Secondary
Key string - Secondary subscription key. If not specified during request key will be generated automatically.
- Sid string
- Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
- State
Subscription
State Enum - 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 String - Subscription name.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- scope String
- Scope like /products/{productId} or /apis or /apis/{apiId}.
- service
Name String - The name of the API Management service.
- allow
Tracing Boolean - Determines whether tracing can be enabled
- app
Type 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
- owner
Id String - User (user id path) for whom subscription is being created in form /users/{userId}
- primary
Key String - Primary subscription key. If not specified during request key will be generated automatically.
- secondary
Key String - Secondary subscription key. If not specified during request key will be generated automatically.
- sid String
- Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
- state
Subscription
State - 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 string - Subscription name.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- scope string
- Scope like /products/{productId} or /apis or /apis/{apiId}.
- service
Name string - The name of the API Management service.
- allow
Tracing boolean - Determines whether tracing can be enabled
- app
Type 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
- owner
Id string - User (user id path) for whom subscription is being created in form /users/{userId}
- primary
Key string - Primary subscription key. If not specified during request key will be generated automatically.
- secondary
Key string - Secondary subscription key. If not specified during request key will be generated automatically.
- sid string
- Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
- state
Subscription
State - 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 str - Subscription name.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- scope str
- Scope like /products/{productId} or /apis or /apis/{apiId}.
- service_
name str - The name of the API Management service.
- 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 str
- Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
- state
Subscription
State - 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 String - Subscription name.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- scope String
- Scope like /products/{productId} or /apis or /apis/{apiId}.
- service
Name String - The name of the API Management service.
- allow
Tracing Boolean - Determines whether tracing can be enabled
- app
Type 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
- owner
Id String - User (user id path) for whom subscription is being created in form /users/{userId}
- primary
Key String - Primary subscription key. If not specified during request key will be generated automatically.
- secondary
Key String - Secondary subscription key. If not specified during request key will be generated automatically.
- sid 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 Subscription resource produces the following output properties:
- 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
- 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"
- 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. - 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
- 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"
- 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. - 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
- 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"
- 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. - 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
- 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"
- 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. - 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
- 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'.
- 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
- 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"
- 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. - 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'.
Supporting Types
SubscriptionState, SubscriptionStateArgs
- Suspended
- suspended
- Active
- active
- Expired
- expired
- Submitted
- submitted
- Rejected
- rejected
- Cancelled
- cancelled
- Subscription
State Suspended - suspended
- Subscription
State Active - active
- Subscription
State Expired - expired
- Subscription
State Submitted - submitted
- Subscription
State Rejected - rejected
- Subscription
State 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
- "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:Subscription testsub /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0