class Azure::ServiceFabric::Mgmt::V2016_09_01::Models::Cluster

The cluster resource

Attributes

available_cluster_versions[RW]

@return [Array<ClusterVersionDetails>] The available cluster code version which the cluster can upgrade to, note that you must choose upgradeMode to manual to upgrade to

azure_active_directory[RW]

@return [AzureActiveDirectory] The settings to enable AAD authentication on the cluster

certificate[RW]

@return [CertificateDescription] This primay certificate will be used as cluster node to node security, SSL certificate for cluster management endpoint and default admin client

client_certificate_common_names[RW]

@return [Array<ClientCertificateCommonName>] List of client certificates to whitelist based on common names

client_certificate_thumbprints[RW]

@return [Array<ClientCertificateThumbprint>] The client thumbprint details ,it is used for client access for cluster operation

cluster_code_version[RW]

@return [String] The ServiceFabric code version running in your cluster

cluster_endpoint[RW]

@return [String] The endpoint for the cluster connecting to servicefabric resource provider

cluster_id[RW]

@return [String] The unique identifier for the cluster resource

cluster_state[RW]

@return [Enum] The state for the cluster. Possible values include: 'WaitingForNodes', 'Deploying', 'BaselineUpgrade', 'UpdatingUserConfiguration', 'UpdatingUserCertificate', 'UpdatingInfrastructure', 'EnforcingClusterVersion', 'UpgradeServiceUnreachable', 'AutoScale', 'Ready'

diagnostics_storage_account_config[RW]

@return [DiagnosticsStorageAccountConfig] The storage diagnostics account configuration details

fabric_settings[RW]

@return [Array<SettingsSectionDescription>] List of custom fabric settings to configure the cluster.

management_endpoint[RW]

@return [String] The http management endpoint of the cluster

node_types[RW]

@return [Array<NodeTypeDescription>] The list of nodetypes that make up the cluster

provisioning_state[RW]

@return [ProvisioningState] The provisioning state of the cluster resource. Possible values include: 'Updating', 'Succeeded', 'Failed', 'Canceled'

reliability_level[RW]

@return [Enum] Cluster reliability level indicates replica set size of system service. Possible values include: 'Bronze', 'Silver', 'Gold', 'Platinum'

reverse_proxy_certificate[RW]

@return [CertificateDescription] The server certificate used by reverse proxy

upgrade_description[RW]

@return [ClusterUpgradePolicy] The policy to use when upgrading the cluster.

upgrade_mode[RW]

@return [Enum] Cluster upgrade mode indicates if fabric upgrade is initiated automatically by the system or not. Possible values include: 'Automatic', 'Manual'

vm_image[RW]

@return [String] The name of VM image VMSS has been configured with. Generic names such as Windows or Linux can be used.

Public Class Methods

mapper() click to toggle source

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

# File lib/2016-09-01/generated/azure_mgmt_service_fabric/models/cluster.rb, line 101
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Cluster',
    type: {
      name: 'Composite',
      class_name: 'Cluster',
      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'
          }
        },
        location: {
          client_side_validation: true,
          required: true,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        available_cluster_versions: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.availableClusterVersions',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ClusterVersionDetailsElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ClusterVersionDetails'
                }
            }
          }
        },
        cluster_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.clusterId',
          type: {
            name: 'String'
          }
        },
        cluster_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.clusterState',
          type: {
            name: 'String'
          }
        },
        cluster_endpoint: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.clusterEndpoint',
          type: {
            name: 'String'
          }
        },
        cluster_code_version: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.clusterCodeVersion',
          type: {
            name: 'String'
          }
        },
        certificate: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.certificate',
          type: {
            name: 'Composite',
            class_name: 'CertificateDescription'
          }
        },
        reliability_level: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.reliabilityLevel',
          type: {
            name: 'String'
          }
        },
        upgrade_mode: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.upgradeMode',
          type: {
            name: 'String'
          }
        },
        client_certificate_thumbprints: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.clientCertificateThumbprints',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ClientCertificateThumbprintElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ClientCertificateThumbprint'
                }
            }
          }
        },
        client_certificate_common_names: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.clientCertificateCommonNames',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ClientCertificateCommonNameElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ClientCertificateCommonName'
                }
            }
          }
        },
        fabric_settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.fabricSettings',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'SettingsSectionDescriptionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'SettingsSectionDescription'
                }
            }
          }
        },
        reverse_proxy_certificate: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.reverseProxyCertificate',
          type: {
            name: 'Composite',
            class_name: 'CertificateDescription'
          }
        },
        management_endpoint: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.managementEndpoint',
          type: {
            name: 'String'
          }
        },
        node_types: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.nodeTypes',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'NodeTypeDescriptionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'NodeTypeDescription'
                }
            }
          }
        },
        azure_active_directory: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.azureActiveDirectory',
          type: {
            name: 'Composite',
            class_name: 'AzureActiveDirectory'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        vm_image: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.vmImage',
          type: {
            name: 'String'
          }
        },
        diagnostics_storage_account_config: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.diagnosticsStorageAccountConfig',
          type: {
            name: 'Composite',
            class_name: 'DiagnosticsStorageAccountConfig'
          }
        },
        upgrade_description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.upgradeDescription',
          type: {
            name: 'Composite',
            class_name: 'ClusterUpgradePolicy'
          }
        }
      }
    }
  }
end