CloudServiceExtensionProperties Class

Reference

Extension Properties.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance: azure.mgmt.compute._serialization.Model

CloudServiceExtensionProperties

Constructor

CloudServiceExtensionProperties(*, publisher: str | None = None, type: str | None = None, type_handler_version: str | None = None, auto_upgrade_minor_version: bool | None = None, settings: MutableMapping[str, Any] | None = None, protected_settings: MutableMapping[str, Any] | None = None, protected_settings_from_key_vault: _models.CloudServiceVaultAndSecretReference | None = None, force_update_tag: str | None = None, roles_applied_to: List[str] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
publisher	str The name of the extension handler publisher.
type	str Specifies the type of the extension.
type_handler_version	str Specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance.
auto_upgrade_minor_version	bool Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available.
settings	<xref:JSON> Public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension.
protected_settings	<xref:JSON> Protected settings for the extension which are encrypted before sent to the role instance.
protected_settings_from_key_vault	CloudServiceVaultAndSecretReference Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance.
force_update_tag	str Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not.
roles_applied_to	list[str] Optional list of roles to apply this extension. If property is not specified or '*' is specified, extension is applied to all roles in the cloud service.

Variables

Name	Description
publisher	str The name of the extension handler publisher.
type	str Specifies the type of the extension.
type_handler_version	str Specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance.
auto_upgrade_minor_version	bool Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available.
settings	<xref:JSON> Public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension.
protected_settings	<xref:JSON> Protected settings for the extension which are encrypted before sent to the role instance.
protected_settings_from_key_vault	CloudServiceVaultAndSecretReference Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance.
force_update_tag	str Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not.
provisioning_state	str The provisioning state, which only appears in the response.
roles_applied_to	list[str] Optional list of roles to apply this extension. If property is not specified or '*' is specified, extension is applied to all roles in the cloud service.

Share via

CloudServiceExtensionProperties Class

Constructor

Keyword-Only Parameters

Variables

Additional resources