Class: Azure::ARM::IotHub::Models::SharedAccessSignatureAuthorizationRule

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/generated/azure_mgmt_iot_hub/models/shared_access_signature_authorization_rule.rb

Overview

The properties that describe the keys to access the IotHub artifacts.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#key_nameString

Returns The name of the key.

Returns:

  • (String)

    The name of the key.



16
17
18
# File 'lib/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/generated/azure_mgmt_iot_hub/models/shared_access_signature_authorization_rule.rb', line 19

def primary_key
  @primary_key
end

#rightsAccessRights

‘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 access rights. Possible values include:



33
34
35
# File 'lib/generated/azure_mgmt_iot_hub/models/shared_access_signature_authorization_rule.rb', line 33

def rights
  @rights
end

#secondary_keyString

Returns The secondary key.

Returns:

  • (String)

    The secondary key.



22
23
24
# File 'lib/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.



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
# File 'lib/generated/azure_mgmt_iot_hub/models/shared_access_signature_authorization_rule.rb', line 40

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