ExtensionImage Members

The Extension Image.

The following tables list the members exposed by the ExtensionImage type.

  Name Description
  ExtensionImage Overloaded.  
Top

  Name Description
public property BlockRoleUponFailure Optional. Optional. Its value has to be 'true' or 'false' (case-sensitive) When set to 'true', the role startup will be blocked till the extension installation completes. This flag should be set to 'true' when the role cannot start without the extension being installed. If set to 'false' (default value), the role will be started without waiting for the extension installation to complete. Supported on WebRole or WorkerRole, but ignored on VmRole.
public property Certificate Optional. Optional. Parameters of the the certificate for encrypting the private configuration data. Supported on WebRole or WorkerRole, but ignored on VmRole.
public property CompanyName Optional. String property containing the name of the company/organization who publishes the extension.
public property Description Optional. Required. Detailed description of the extension.
public property DisallowMajorVersionUpgrade Optional. Optional. If this is set to 'true' the extension version cannot be upgraded to from other major versions in active deployments. If the value is 'false' or nor present, the extension version can be upgraded to from any other version. Downgrade is not supported. The value has to be 'true' or 'false' (case-sensitive) if present.
public property Eula Optional. Optional. URL string pointing to the EULA (End User License Agreement) of this version of extension. This is optionally specified by the third-party publishing the extension instead of Windows Azure. If the software requires any additional EULAs, a link to the EULA should be provided.
public property ExtensionEndpoints Optional. Optional. Declared endpoints to automatically add to each deployment with this extension added.
public property HomepageUri Optional. Optional. URL string pointing to homepage of this version of extension. This is optionally specified by the third-party publishing the extension instead of Azure. The homepage should have usage information and contact information for customer support.
public property HostingResources Optional. Required. The supported hosting resources. It must contain 'WebRole' and/or 'WorkerRole'. E.g. 'WebRole|WorkerRole' or 'WebRole|WorkerRole|VmRole'.
public property IsInternalExtension  
public property IsJsonExtension Optional. Optional. If this is set to 'true' the extension is expected to receive JSON based configuration. If this is set to 'false' the extension is expected to receive XML based configuration. Its value has to be 'true' or 'false' (case-sensitive) if present.
public property Label Optional. Required. A one line label of the extension.
public property LocalResources Optional. Declared local resources used inside guest VM by the extension. Optional.
public property MediaLink Optional. Required. URI string pointing to the ZIP package of the extension. The ZIP package has to include the extension executable and other supporting files, and the PluginManifest.xml manifest. MediaLink value must point to a URL (either Http or Https) in a Azure blob storage and is downloadable. Windows Azure will copy the extension package from this source location and replicate it to all regions. The typical time for replication to complete is 20 minutes.
public property PrivacyUri Optional. Optional. URL string pointing to privacy document of this version of extension. This is optionally specified by the third-party publishing the extension instead of Azure. If the software collects any data and transfers out the guest VM, then an additional privacy document might be needed.
public property PrivateConfigurationSchema Optional. Optional. The XSD schema of private configuration data.
public property ProviderNameSpace Required. Required. The provider namespace of the extension.
public property PublicConfigurationSchema Optional. Optional. The XSD schema of public configuration data.
public property PublishedDate Optional. Publisher can set it to any arbitrary date, and this is only for display purpose. If not specified by publisher, Azure will automatically assign the UTC time when the extension request was received.
public property PublisherName Optional. Optional. Publisher name text.
public property ReplicationCompleted Optional. Indicates whether this version of extension has been replicated to all regions or not. If true, then the given extension version can be used in creating or updating deployments. Otherwise, the given extension version might cause failure in creating or updating deployments. The typical time is 20 minutes for a newly-registered or newly-updated extension to replicate completely by Azure.
public property SampleConfig Optional. Optional. A sample configuration for the extension. It can be downloaded by users, and the user can replace with customized input parameters. The sample configuration should be sufficiently commented. If configuration data are in XML format, then the XML document-level element must be 'Configuration', and the optional public configuration data corresponds to a child element of 'PublicConfig', and the optional private configuration data corresponds to a child element of 'PrivateConfig'. The sample configuration data should be validated against public and private configuration schema by the publisher.
public property SupportedOS Optional. String property indicating the OS which the extension supports. Current values are 'Windows' or 'Linux'.
public property Type Required. Required. The type of the extension.
public property Version Required. Required. The version of the extension.
Top

(see also Protected Methods)
 NameDescription
public methodEquals  (Inherited from Object)
public methodGetHashCode  (Inherited from Object)
public methodGetType  (Inherited from Object)
public methodToString  (Inherited from Object)
Top

  Name Description
protected method Finalize  (Inherited from Object)
protected method MemberwiseClone  (Inherited from Object)
Top

Show: