Class: Azure::ApiManagement::Mgmt::V2016_07_07::Models::ProductUpdateParameters

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2016-07-07/generated/azure_mgmt_api_management/models/product_update_parameters.rb

Overview

Parameters supplied to the CreateOrUpdate Product operation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#approval_required ⇒ Boolean

new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.

Returns:

  • (Boolean) —

    whether subscription approval is required. If false,



40
41
42
 
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/models/product_update_parameters.rb', line 40

def approval_required
  @approval_required
end

#description ⇒ String

Returns Product description.

Returns:

  • (String) —

    Product description.



19
20
21
 
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/models/product_update_parameters.rb', line 19

def description
  @description
end

#name ⇒ String

Returns Product name.

Returns:

  • (String) —

    Product name.



16
17
18
 
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/models/product_update_parameters.rb', line 16

def name
  @name
end

#state ⇒ ProductStateContract

Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Possible values include: ‘NotPublished’, ‘Published’

Returns:



52
53
54
 
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/models/product_update_parameters.rb', line 52

def state
  @state
end

#subscription_required ⇒ Boolean

accessing APIs included in this product. If true, the product is referred to as “protected” and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as “open” and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it’s value is assumed to be true.

Returns:

  • (Boolean) —

    whether a product subscription is required for



32
33
34
 
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/models/product_update_parameters.rb', line 32

def subscription_required
  @subscription_required
end

#subscriptions_limit ⇒ Integer

to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.

Returns:

  • (Integer) —

    whether the number of subscriptions a user can have



46
47
48
 
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/models/product_update_parameters.rb', line 46

def subscriptions_limit
  @subscriptions_limit
end

#terms ⇒ String

accept these terms before he’s allowed to call product API.

Returns:

  • (String) —

    Product terms and conditions. Developer will have to



23
24
25
 
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/models/product_update_parameters.rb', line 23

def terms
  @terms
end

Class Method Details

.mapper ⇒ Object

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



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
 
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/models/product_update_parameters.rb', line 59

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ProductUpdateParameters',
    type: {
      name: 'Composite',
      class_name: 'ProductUpdateParameters',
      model_properties: {
        name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'name',
          constraints: {
            MaxLength: 300,
            MinLength: 1
          },
          type: {
            name: 'String'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'description',
          constraints: {
            MaxLength: 500,
            MinLength: 1
          },
          type: {
            name: 'String'
          }
        },
        terms: {
          client_side_validation: true,
          required: false,
          serialized_name: 'terms',
          type: {
            name: 'String'
          }
        },
        subscription_required: {
          client_side_validation: true,
          required: false,
          serialized_name: 'subscriptionRequired',
          type: {
            name: 'Boolean'
          }
        },
        approval_required: {
          client_side_validation: true,
          required: false,
          serialized_name: 'approvalRequired',
          type: {
            name: 'Boolean'
          }
        },
        subscriptions_limit: {
          client_side_validation: true,
          required: false,
          serialized_name: 'subscriptionsLimit',
          type: {
            name: 'Number'
          }
        },
        state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'state',
          type: {
            name: 'Enum',
            module: 'ProductStateContract'
          }
        }
      }
    }
  }
end