Class: Azure::ApiManagement::Mgmt::V2017_03_01::Models::SubscriptionUpdateParameters

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-03-01/generated/azure_mgmt_api_management/models/subscription_update_parameters.rb

Overview

Subscription update details.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#display_name ⇒ String

Returns Subscription name.

Returns:

  • (String) —

    Subscription name.



29
30
31
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/subscription_update_parameters.rb', line 29

def display_name
  @display_name
end

#expiration_date ⇒ DateTime

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.

Returns:

  • (DateTime) —

    Subscription expiration date. The setting is for



26
27
28
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/subscription_update_parameters.rb', line 26

def expiration_date
  @expiration_date
end

#primary_key ⇒ String

Returns Primary subscription key.

Returns:

  • (String) —

    Primary subscription key.



32
33
34
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/subscription_update_parameters.rb', line 32

def primary_key
  @primary_key
end

#product_id ⇒ String

Returns Product identifier path: /products/productId.

Returns:

  • (String) —

    Product identifier path: /products/productId



19
20
21
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/subscription_update_parameters.rb', line 19

def product_id
  @product_id
end

#secondary_key ⇒ String

Returns Secondary subscription key.

Returns:

  • (String) —

    Secondary subscription key.



35
36
37
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/subscription_update_parameters.rb', line 35

def secondary_key
  @secondary_key
end

#state ⇒ SubscriptionState

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. Possible values include: ‘suspended’, ‘active’, ‘expired’, ‘submitted’, ‘rejected’, ‘cancelled’

Returns:



47
48
49
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/subscription_update_parameters.rb', line 47

def state
  @state
end

#state_comment ⇒ String

administrator.

Returns:

  • (String) —

    Comments describing subscription state change by the



51
52
53
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/subscription_update_parameters.rb', line 51

def state_comment
  @state_comment
end

#user_id ⇒ String

Returns User identifier path: /users/uid.

Returns:

  • (String) —

    User identifier path: /users/uid



16
17
18
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/subscription_update_parameters.rb', line 16

def user_id
  @user_id
end

Class Method Details

.mapper ⇒ Object

Mapper for SubscriptionUpdateParameters class as Ruby Hash. This will be used for serialization/deserialization.



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
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/subscription_update_parameters.rb', line 58

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'SubscriptionUpdateParameters',
    type: {
      name: 'Composite',
      class_name: 'SubscriptionUpdateParameters',
      model_properties: {
        user_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.userId',
          type: {
            name: 'String'
          }
        },
        product_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.productId',
          type: {
            name: 'String'
          }
        },
        expiration_date: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.expirationDate',
          type: {
            name: 'DateTime'
          }
        },
        display_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.displayName',
          type: {
            name: 'String'
          }
        },
        primary_key: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.primaryKey',
          constraints: {
            MaxLength: 256,
            MinLength: 1
          },
          type: {
            name: 'String'
          }
        },
        secondary_key: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.secondaryKey',
          constraints: {
            MaxLength: 256,
            MinLength: 1
          },
          type: {
            name: 'String'
          }
        },
        state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.state',
          type: {
            name: 'Enum',
            module: 'SubscriptionState'
          }
        },
        state_comment: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.stateComment',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end