class Azure::ServiceFabric::V7_0_0_42::Models::ServiceResourceDescription

This type describes a service resource.

Attributes

auto_scaling_policies[RW]

@return [Array<AutoScalingPolicy>] Auto scaling policies

code_packages[RW]

@return [Array<ContainerCodePackageProperties>] Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.).

description[RW]

@return [String] User readable description of the service.

diagnostics[RW]

@return [DiagnosticsRef] Reference to sinks in DiagnosticsDescription.

dns_name[RW]

@return [String] Dns name of the service.

execution_policy[RW]

@return [ExecutionPolicy] The execution policy of the service

health_state[RW]

@return [HealthState] Describes the health state of an application resource. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

identity_refs[RW]

@return [Array<ServiceIdentity>] The service identity list.

name[RW]

@return [String] Name of the Service resource.

network_refs[RW]

@return [Array<NetworkRef>] The names of the private networks that this service needs to be part of.

os_type[RW]

@return [OperatingSystemType] The operation system required by the code in service. Possible values include: 'Linux', 'Windows'

replica_count[RW]

@return [Integer] The number of replicas of the service to create. Defaults to 1 if not specified.

status[RW]

@return [ResourceStatus] Status of the service. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed'

status_details[RW]

@return [String] Gives additional information about the current status of the service.

unhealthy_evaluation[RW]

@return [String] When the service's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the service is marked unhealthy.

Private Class Methods

mapper() click to toggle source

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

# File lib/7.0.0.42/generated/azure_service_fabric/models/service_resource_description.rb, line 79
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ServiceResourceDescription',
    type: {
      name: 'Composite',
      class_name: 'ServiceResourceDescription',
      model_properties: {
        name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        os_type: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.osType',
          type: {
            name: 'String'
          }
        },
        code_packages: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.codePackages',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ContainerCodePackagePropertiesElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ContainerCodePackageProperties'
                }
            }
          }
        },
        network_refs: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.networkRefs',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'NetworkRefElementType',
                type: {
                  name: 'Composite',
                  class_name: 'NetworkRef'
                }
            }
          }
        },
        diagnostics: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.diagnostics',
          type: {
            name: 'Composite',
            class_name: 'DiagnosticsRef'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.description',
          type: {
            name: 'String'
          }
        },
        replica_count: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.replicaCount',
          type: {
            name: 'Number'
          }
        },
        execution_policy: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.executionPolicy',
          type: {
            name: 'Composite',
            polymorphic_discriminator: 'type',
            uber_parent: 'ExecutionPolicy',
            class_name: 'ExecutionPolicy'
          }
        },
        auto_scaling_policies: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.autoScalingPolicies',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'AutoScalingPolicyElementType',
                type: {
                  name: 'Composite',
                  class_name: 'AutoScalingPolicy'
                }
            }
          }
        },
        status: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.status',
          type: {
            name: 'String'
          }
        },
        status_details: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.statusDetails',
          type: {
            name: 'String'
          }
        },
        health_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.healthState',
          type: {
            name: 'String'
          }
        },
        unhealthy_evaluation: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.unhealthyEvaluation',
          type: {
            name: 'String'
          }
        },
        identity_refs: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.identityRefs',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ServiceIdentityElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ServiceIdentity'
                }
            }
          }
        },
        dns_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.dnsName',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end