class Azure::DataBoxEdge::Mgmt::V2019_08_01::Models::Share

Represents a share on the Data Box Edge/Gateway device.

Attributes

access_protocol[RW]

@return [ShareAccessProtocol] Access protocol to be used by the share. Possible values include: 'SMB', 'NFS'

azure_container_info[RW]

@return [AzureContainerInfo] Azure container mapping for the share.

client_access_rights[RW]

@return [Array<ClientAccessRight>] List of IP addresses and corresponding access rights on the share(required for NFS protocol).

data_policy[RW]

@return [DataPolicy] Data policy of the share. Possible values include: 'Cloud', 'Local'

description[RW]

@return [String] Description for the share.

monitoring_status[RW]

@return [MonitoringStatus] Current monitoring status of the share. Possible values include: 'Enabled', 'Disabled'

refresh_details[RW]

@return [RefreshDetails] Details of the refresh job on this share.

share_mappings[RW]

@return [Array<MountPointMap>] Share mount point to the role.

share_status[RW]

@return [ShareStatus] Current status of the share. Possible values include: 'Offline', 'Unknown', 'OK', 'Updating', 'NeedsAttention'

user_access_rights[RW]

@return [Array<UserAccessRight>] Mapping of users and corresponding access rights on the share (required for SMB protocol).

Private Class Methods

mapper() click to toggle source

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

# File lib/2019-08-01/generated/azure_mgmt_databoxedge/models/share.rb, line 56
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Share',
    type: {
      name: 'Composite',
      class_name: 'Share',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.description',
          type: {
            name: 'String'
          }
        },
        share_status: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.shareStatus',
          type: {
            name: 'String'
          }
        },
        monitoring_status: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.monitoringStatus',
          type: {
            name: 'String'
          }
        },
        azure_container_info: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.azureContainerInfo',
          type: {
            name: 'Composite',
            class_name: 'AzureContainerInfo'
          }
        },
        access_protocol: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.accessProtocol',
          type: {
            name: 'String'
          }
        },
        user_access_rights: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.userAccessRights',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'UserAccessRightElementType',
                type: {
                  name: 'Composite',
                  class_name: 'UserAccessRight'
                }
            }
          }
        },
        client_access_rights: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.clientAccessRights',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ClientAccessRightElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ClientAccessRight'
                }
            }
          }
        },
        refresh_details: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.refreshDetails',
          type: {
            name: 'Composite',
            class_name: 'RefreshDetails'
          }
        },
        share_mappings: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.shareMappings',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'MountPointMapElementType',
                type: {
                  name: 'Composite',
                  class_name: 'MountPointMap'
                }
            }
          }
        },
        data_policy: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.dataPolicy',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end