-
Notifications
You must be signed in to change notification settings - Fork 180
/
SubscriptionUpdateParameters.yml
133 lines (133 loc) · 4.41 KB
/
SubscriptionUpdateParameters.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
### YamlMime:TSType
name: SubscriptionUpdateParameters
uid: '@azure/arm-apimanagement.SubscriptionUpdateParameters'
package: '@azure/arm-apimanagement'
summary: Subscription update details.
fullName: SubscriptionUpdateParameters
remarks: ''
isDeprecated: false
type: interface
properties:
- name: allowTracing
uid: '@azure/arm-apimanagement.SubscriptionUpdateParameters.allowTracing'
package: '@azure/arm-apimanagement'
summary: Determines whether tracing can be enabled
fullName: allowTracing
remarks: ''
isDeprecated: false
syntax:
content: 'allowTracing?: boolean'
return:
description: ''
type: boolean
- name: displayName
uid: '@azure/arm-apimanagement.SubscriptionUpdateParameters.displayName'
package: '@azure/arm-apimanagement'
summary: Subscription name.
fullName: displayName
remarks: ''
isDeprecated: false
syntax:
content: 'displayName?: string'
return:
description: ''
type: string
- name: expirationDate
uid: '@azure/arm-apimanagement.SubscriptionUpdateParameters.expirationDate'
package: '@azure/arm-apimanagement'
summary: >-
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.
fullName: expirationDate
remarks: ''
isDeprecated: false
syntax:
content: 'expirationDate?: Date'
return:
description: ''
type: Date
- name: ownerId
uid: '@azure/arm-apimanagement.SubscriptionUpdateParameters.ownerId'
package: '@azure/arm-apimanagement'
summary: 'User identifier path: /users/{userId}'
fullName: ownerId
remarks: ''
isDeprecated: false
syntax:
content: 'ownerId?: string'
return:
description: ''
type: string
- name: primaryKey
uid: '@azure/arm-apimanagement.SubscriptionUpdateParameters.primaryKey'
package: '@azure/arm-apimanagement'
summary: Primary subscription key.
fullName: primaryKey
remarks: ''
isDeprecated: false
syntax:
content: 'primaryKey?: string'
return:
description: ''
type: string
- name: scope
uid: '@azure/arm-apimanagement.SubscriptionUpdateParameters.scope'
package: '@azure/arm-apimanagement'
summary: Scope like /products/{productId} or /apis or /apis/{apiId}
fullName: scope
remarks: ''
isDeprecated: false
syntax:
content: 'scope?: string'
return:
description: ''
type: string
- name: secondaryKey
uid: '@azure/arm-apimanagement.SubscriptionUpdateParameters.secondaryKey'
package: '@azure/arm-apimanagement'
summary: Secondary subscription key.
fullName: secondaryKey
remarks: ''
isDeprecated: false
syntax:
content: 'secondaryKey?: string'
return:
description: ''
type: string
- name: state
uid: '@azure/arm-apimanagement.SubscriptionUpdateParameters.state'
package: '@azure/arm-apimanagement'
summary: >-
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.
fullName: state
remarks: ''
isDeprecated: false
syntax:
content: 'state?: SubscriptionState'
return:
description: ''
type: <xref uid="@azure/arm-apimanagement.SubscriptionState" />
- name: stateComment
uid: '@azure/arm-apimanagement.SubscriptionUpdateParameters.stateComment'
package: '@azure/arm-apimanagement'
summary: >-
Comments describing subscription state change by the administrator when
the state is changed to the 'rejected'.
fullName: stateComment
remarks: ''
isDeprecated: false
syntax:
content: 'stateComment?: string'
return:
description: ''
type: string