PublishedServiceComponent Data Type

A component in published service.

Namespace
(Default)
Properties
name data type type namespace min/max occurs description
availabilitySet string element 0/1 Gets the availability set.
capabilities string element 0/1 AWS CloudFormation capabilities such as CAPABILITY_IAM that are needed to provision the CFT
capabilitiesReason string element 0/1 The capabilities reason found within the template.
cloudTemplateBody string element 0/1 For AWS CloudFormation or Azure ARM Templates - the actual content of the template. If this is specified, don't provide the URL.
cloudTemplateParameters list of CloudTemplateParameter element 0/unbounded For AWS CloudFormation or Azure ARM Templates - parameters that may be provided as input to the template deployment. This describes what the requirements are for each parameter (e.g. allowed values)
cloudTemplateUrl string element 0/1 For AWS CloudFormation or Azure ARM Templates - URL that hosts the body of the template. If this is specified, don't provide the body.
completionWorkflow ManagedObjectReference element 0/1 Return the completion workflow that component is configured to use.
componentNics list of PublishedServiceComponentNIC element 0/unbounded Gets the component nics.
componentType CustomComponentType element 0/1 Gets the component type.
cost double element 0/1 Gets the cost.
customizationSpecName string element 0/1 Gets the customization spec name.
description string element 0/1 Gets the description.
endpoints list of VMEndpoint element 0/unbounded Gets the endpoints. This method is now deprecated. Please use getPortMappings()
group int element 0/1 Gets the group.
iamRole string element 0/1 Get the IAM Role, will return the Role Name
id long element 1/1 Gets the id.
instanceTypes list of string element 0/unbounded Gets the instance types.
linkedClone string element 0/1 Checks if is linked clone.
name string element 0/1 Gets the name.
namingFormat string element 0/1 Gets the naming format.
portMappings list of PortMapping element 0/unbounded Gets the port mappings.
pushMemoryMetrics string element 0/1 Gets the Push Memory Metrics flag. Applicable for AWS VMs. Configure guest OS to push memory utilization to CloudWatch.
ref ManagedObjectReference element 0/1 Gets the ref.
service ManagedObjectReference element 0/1 Gets the service.
serviceComponentSettings PublishedServiceComponentSettings element 0/1 Get the service component settings.
serviceProperties element 0/1 Gets the service properties.
snapshot ManagedObjectReference element 0/1 Gets the snapshot.
targetType ManagedObjectType element 0/1 What is the target type of this service? This corresponds with what type of service this is: WSManagedObjectType.CUSTOM_COMPONENT - a custom component WSManagedObjectType.VIRTUALMACHINE - a component based on a VM (this also means ref() should be non-null) WSManagedObjectType.ARM_TEMPLATE - a component based on an ARM template WSManagedObjectType.GOOGLE_DEPLOYMENT_CONFIGURATION - a component based on an Google Deployment Configuration WSManagedObjectType.CLOUD_FORMATION - a component based on a cloud formation template
template string element 0/1 Checks if is template.
useDefaultNamingFormat string element 0/1 Checks if is use default naming format.
Properties inherited from supportTemplating
xsitype string attribute 0/1  

Example

<PublishedServiceComponent xsitype="...">
  <id>...</id>
  <cost>...</cost>
  <namingFormat>...</namingFormat>
  <useDefaultNamingFormat>...</useDefaultNamingFormat>
  <service xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </service>
  <linkedClone>...</linkedClone>
  <template>...</template>
  <group>...</group>
  <name>...</name>
  <description>...</description>
  <componentType xsitype="...">
    <id>...</id>
    <name>...</name>
    <description>...</description>
    <cost>...</cost>
  </componentType>
  <ref xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </ref>
  <serviceProperties>...</serviceProperties>
  <customizationSpecName>...</customizationSpecName>
  <instanceTypes>...</instanceTypes>
  <snapshot xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </snapshot>
  <availabilitySet>...</availabilitySet>
  <iamRole>...</iamRole>
  <pushMemoryMetrics>...</pushMemoryMetrics>
  <portMappings xsitype="...">
    <name>...</name>
    <publicProtocol>...</publicProtocol>
    <privateProtocol>...</privateProtocol>
    <publicPort>...</publicPort>
    <privatePort>...</privatePort>
  </portMappings>
  <componentNics xsitype="...">
    <id>...</id>
    <accessMode>...</accessMode>
    <addressMode>...</addressMode>
    <staticIp>...</staticIp>
    <mac>...</mac>
    <hostName>...</hostName>
    <portForwardPairs>
      <publicPort>...</publicPort>
      <privatePort>...</privatePort>
    </portForwardPairs>
  </componentNics>
  <serviceComponentSettings xsitype="...">
    <id>...</id>
    <requestAttributes>
      <attributeName>...</attributeName>
      <value>...</value>
    </requestAttributes>
    <groups>
      <groupType>...</groupType>
      <permanent>...</permanent>
    </groups>
    <formElements>
      <label>...</label>
      <mandatory>...</mandatory>
      <formType>...</formType>
      <value>...</value>
    </formElements>
    <resources>
      <resourceType>...</resourceType>
      <managementServerType>...</managementServerType>
    </resources>
  </serviceComponentSettings>
  <completionWorkflow xsitype="...">
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </completionWorkflow>
  <cloudTemplateUrl>...</cloudTemplateUrl>
  <cloudTemplateBody>...</cloudTemplateBody>
  <cloudTemplateParameters>
    <name>...</name>
    <description>...</description>
    <defaultValue>...</defaultValue>
    <noEcho>...</noEcho>
    <value>...</value>
    <id>...</id>
    <type>...</type>
    <allowedValues>...</allowedValues>
  </cloudTemplateParameters>
  <targetType>...</targetType>
  <capabilities>...</capabilities>
  <capabilitiesReason>...</capabilitiesReason>
</PublishedServiceComponent>