class Azure::ServiceFabric::Mgmt::V2017_07_01_preview::Models::Cluster

The cluster resource

Attributes

add_on_features[RW]

@return [Array<Enum>] The list of add-on features to enable in the cluster.

available_cluster_versions[RW]

@return [Array<ClusterVersionDetails>] The Service Fabric runtime versions available for this cluster.

azure_active_directory[RW]

@return [AzureActiveDirectory] The AAD authentication settings of the cluster.

certificate[RW]

@return [CertificateDescription] The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client.

client_certificate_common_names[RW]

@return [Array<ClientCertificateCommonName>] The list of client certificates referenced by common name that are allowed to manage the cluster.

client_certificate_thumbprints[RW]

@return [Array<ClientCertificateThumbprint>] The list of client certificates referenced by thumbprint that are allowed to manage the cluster.

cluster_code_version[RW]

@return [String] The Service Fabric runtime version of the cluster. This property can only by set the user when upgradeMode is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use availableClusterVersions.

cluster_endpoint[RW]

@return [String] The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint.

cluster_id[RW]

@return [String] A service generated unique identifier for the cluster resource.

cluster_state[RW]

@return [Enum] Possible values include: 'WaitingForNodes', 'Deploying', 'BaselineUpgrade', 'UpdatingUserConfiguration', 'UpdatingUserCertificate', 'UpdatingInfrastructure', 'EnforcingClusterVersion', 'UpgradeServiceUnreachable', 'AutoScale', 'Ready'

diagnostics_storage_account_config[RW]

@return [DiagnosticsStorageAccountConfig] The storage account information for storing Service Fabric diagnostic logs.

fabric_settings[RW]

@return [Array<SettingsSectionDescription>] The 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 node types in 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] Possible values include: 'None', '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] Possible values include: 'Automatic', 'Manual'

vm_image[RW]

@return [String] The 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/2017-07-01-preview/generated/azure_mgmt_service_fabric/models/cluster.rb, line 111
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,
          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,
          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'
          }
        },
        add_on_features: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.addOnFeatures',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'enumElementType',
                type: {
                  name: 'String'
                }
            }
          }
        }
      }
    }
  }
end