ArmApiManagementModelFactory.SubscriptionContractData Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.ApiManagement.Models
Assembly:
Azure.ResourceManager.ApiManagement.dll
Package:
Azure.ResourceManager.ApiManagement v1.2.0
Package:
Azure.ResourceManager.ApiManagement v1.3.0-beta.1
Source:
ArmApiManagementModelFactory.cs
Source:
ArmApiManagementModelFactory.cs

Initializes a new instance of SubscriptionContractData.

public static Azure.ResourceManager.ApiManagement.SubscriptionContractData SubscriptionContractData (Azure.Core.ResourceIdentifier id = default, string name = default, Azure.Core.ResourceType resourceType = default, Azure.ResourceManager.Models.SystemData systemData = default, string ownerId = default, string scope = default, string displayName = default, Azure.ResourceManager.ApiManagement.Models.SubscriptionState? state = default, DateTimeOffset? createdOn = default, DateTimeOffset? startOn = default, DateTimeOffset? expireOn = default, DateTimeOffset? endOn = default, DateTimeOffset? notifiesOn = default, string primaryKey = default, string secondaryKey = default, string stateComment = default, bool? allowTracing = default);
static member SubscriptionContractData : Azure.Core.ResourceIdentifier * string * Azure.Core.ResourceType * Azure.ResourceManager.Models.SystemData * string * string * string * Nullable<Azure.ResourceManager.ApiManagement.Models.SubscriptionState> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * string * string * string * Nullable<bool> -> Azure.ResourceManager.ApiManagement.SubscriptionContractData
Public Shared Function SubscriptionContractData (Optional id As ResourceIdentifier = Nothing, Optional name As String = Nothing, Optional resourceType As ResourceType = Nothing, Optional systemData As SystemData = Nothing, Optional ownerId As String = Nothing, Optional scope As String = Nothing, Optional displayName As String = Nothing, Optional state As Nullable(Of SubscriptionState) = Nothing, Optional createdOn As Nullable(Of DateTimeOffset) = Nothing, Optional startOn As Nullable(Of DateTimeOffset) = Nothing, Optional expireOn As Nullable(Of DateTimeOffset) = Nothing, Optional endOn As Nullable(Of DateTimeOffset) = Nothing, Optional notifiesOn As Nullable(Of DateTimeOffset) = Nothing, Optional primaryKey As String = Nothing, Optional secondaryKey As String = Nothing, Optional stateComment As String = Nothing, Optional allowTracing As Nullable(Of Boolean) = Nothing) As SubscriptionContractData

Parameters

id
ResourceIdentifier

The id.

name
String

The name.

resourceType
ResourceType

The resourceType.

systemData
SystemData

The systemData.

ownerId
String

The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier.

scope
String

Scope like /products/{productId} or /apis or /apis/{apiId}.

displayName
String

The name of the subscription, or null if the subscription has no name.

state
Nullable<SubscriptionState>

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.

createdOn
Nullable<DateTimeOffset>

Subscription creation date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

startOn
Nullable<DateTimeOffset>

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.

expireOn
Nullable<DateTimeOffset>

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.

endOn
Nullable<DateTimeOffset>

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.

notifiesOn
Nullable<DateTimeOffset>

Upcoming subscription expiration notification date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

primaryKey
String

Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

secondaryKey
String

Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

stateComment
String

Optional subscription comment added by an administrator when the state is changed to the 'rejected'.

allowTracing
Nullable<Boolean>

Determines whether tracing is enabled.

Returns

SubscriptionContractData

A new SubscriptionContractData instance for mocking.

Applies to