Share via


ExtensionImageRegisterParameters Class

 

Parameters supplied to the Register Extension Image operation.

Namespace:   Microsoft.WindowsAzure.Management.Compute.Models
Assembly:  Microsoft.WindowsAzure.Management.Compute (in Microsoft.WindowsAzure.Management.Compute.dll)

Inheritance Hierarchy

System.Object
  Microsoft.WindowsAzure.Management.Compute.Models.ExtensionImage
    Microsoft.WindowsAzure.Management.Compute.Models.ExtensionImageRegisterParameters
      Microsoft.WindowsAzure.Management.Compute.Models.ExtensionImageUpdateParameters

Syntax

public class ExtensionImageRegisterParameters : ExtensionImage
public ref class ExtensionImageRegisterParameters : ExtensionImage
type ExtensionImageRegisterParameters = 
    class
        inherit ExtensionImage
    end
Public Class ExtensionImageRegisterParameters
    Inherits ExtensionImage

Constructors

Name Description
System_CAPS_pubmethod ExtensionImageRegisterParameters()

Initializes a new instance of the ExtensionImageRegisterParameters class.

System_CAPS_pubmethod ExtensionImageRegisterParameters(String, String, String)

Initializes a new instance of the ExtensionImageRegisterParameters class with required arguments.

Properties

Name Description
System_CAPS_pubproperty 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.(Inherited from ExtensionImage.)

System_CAPS_pubproperty Certificate

Optional. Optional. Parameters of the the certificate for encrypting the private configuration data. Supported on WebRole or WorkerRole, but ignored on VmRole.(Inherited from ExtensionImage.)

System_CAPS_pubproperty CompanyName

Optional. String property containing the name of the company/organization who publishes the extension.(Inherited from ExtensionImage.)

System_CAPS_pubproperty Description

Optional. Required. Detailed description of the extension.(Inherited from ExtensionImage.)

System_CAPS_pubproperty 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.(Inherited from ExtensionImage.)

System_CAPS_pubproperty 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.(Inherited from ExtensionImage.)

System_CAPS_pubproperty ExtensionEndpoints

Optional. Optional. Declared endpoints to automatically add to each deployment with this extension added.(Inherited from ExtensionImage.)

System_CAPS_pubproperty 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.(Inherited from ExtensionImage.)

System_CAPS_pubproperty HostingResources

Optional. Required. The supported hosting resources. It must contain 'WebRole' and/or 'WorkerRole'. E.g. 'WebRole|WorkerRole' or 'WebRole|WorkerRole|VmRole'.(Inherited from ExtensionImage.)

System_CAPS_pubproperty IsInternalExtension

(Inherited from ExtensionImage.)

System_CAPS_pubproperty 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.(Inherited from ExtensionImage.)

System_CAPS_pubproperty Label

Optional. Required. A one line label of the extension.(Inherited from ExtensionImage.)

System_CAPS_pubproperty LocalResources

Optional. Declared local resources used inside guest VM by the extension. Optional.(Inherited from ExtensionImage.)

System_CAPS_pubproperty 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.(Inherited from ExtensionImage.)

System_CAPS_pubproperty 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.(Inherited from ExtensionImage.)

System_CAPS_pubproperty PrivateConfigurationSchema

Optional. Optional. The XSD schema of private configuration data.(Inherited from ExtensionImage.)

System_CAPS_pubproperty ProviderNameSpace

Required. Required. The provider namespace of the extension.(Inherited from ExtensionImage.)

System_CAPS_pubproperty PublicConfigurationSchema

Optional. Optional. The XSD schema of public configuration data.(Inherited from ExtensionImage.)

System_CAPS_pubproperty 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.(Inherited from ExtensionImage.)

System_CAPS_pubproperty PublisherName

Optional. Optional. Publisher name text.(Inherited from ExtensionImage.)

System_CAPS_pubproperty 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.(Inherited from ExtensionImage.)

System_CAPS_pubproperty 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.(Inherited from ExtensionImage.)

System_CAPS_pubproperty SupportedOS

Optional. String property indicating the OS which the extension supports. Current values are 'Windows' or 'Linux'.(Inherited from ExtensionImage.)

System_CAPS_pubproperty Type

Required. Required. The type of the extension.(Inherited from ExtensionImage.)

System_CAPS_pubproperty Version

Required. Required. The version of the extension.(Inherited from ExtensionImage.)

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Microsoft.WindowsAzure.Management.Compute.Models Namespace

Return to top