Class: Azure::IotHub::Mgmt::V2018_12_01_preview::Models::SharedAccessSignatureAuthorizationRule

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-12-01-preview/generated/azure_mgmt_iot_hub/models/shared_access_signature_authorization_rule.rb

Overview

The properties of an IoT hub shared access policy.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#key_nameString

Returns The name of the shared access policy.

Returns:

  • (String)

    The name of the shared access policy.



16
17
18
# File 'lib/2018-12-01-preview/generated/azure_mgmt_iot_hub/models/shared_access_signature_authorization_rule.rb', line 16

def key_name
  @key_name
end

#primary_keyString

Returns The primary key.

Returns:

  • (String)

    The primary key.



19
20
21
# File 'lib/2018-12-01-preview/generated/azure_mgmt_iot_hub/models/shared_access_signature_authorization_rule.rb', line 19

def primary_key
  @primary_key
end

#rightsAccessRights

policy. Possible values include: ‘RegistryRead’, ‘RegistryWrite’, ‘ServiceConnect’, ‘DeviceConnect’, ‘RegistryRead, RegistryWrite’, ‘RegistryRead, ServiceConnect’, ‘RegistryRead, DeviceConnect’, ‘RegistryWrite, ServiceConnect’, ‘RegistryWrite, DeviceConnect’, ‘ServiceConnect, DeviceConnect’, ‘RegistryRead, RegistryWrite, ServiceConnect’, ‘RegistryRead, RegistryWrite, DeviceConnect’, ‘RegistryRead, ServiceConnect, DeviceConnect’, ‘RegistryWrite, ServiceConnect, DeviceConnect’, ‘RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect’

Returns:

  • (AccessRights)

    The permissions assigned to the shared access



34
35
36
# File 'lib/2018-12-01-preview/generated/azure_mgmt_iot_hub/models/shared_access_signature_authorization_rule.rb', line 34

def rights
  @rights
end

#secondary_keyString

Returns The secondary key.

Returns:

  • (String)

    The secondary key.



22
23
24
# File 'lib/2018-12-01-preview/generated/azure_mgmt_iot_hub/models/shared_access_signature_authorization_rule.rb', line 22

def secondary_key
  @secondary_key
end

Class Method Details

.mapperObject

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



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
# File 'lib/2018-12-01-preview/generated/azure_mgmt_iot_hub/models/shared_access_signature_authorization_rule.rb', line 41

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'SharedAccessSignatureAuthorizationRule',
    type: {
      name: 'Composite',
      class_name: 'SharedAccessSignatureAuthorizationRule',
      model_properties: {
        key_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'keyName',
          type: {
            name: 'String'
          }
        },
        primary_key: {
          client_side_validation: true,
          required: false,
          serialized_name: 'primaryKey',
          type: {
            name: 'String'
          }
        },
        secondary_key: {
          client_side_validation: true,
          required: false,
          serialized_name: 'secondaryKey',
          type: {
            name: 'String'
          }
        },
        rights: {
          client_side_validation: true,
          required: true,
          serialized_name: 'rights',
          type: {
            name: 'Enum',
            module: 'AccessRights'
          }
        }
      }
    }
  }
end