# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
#
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is
# regenerated.
# --------------------------------------------------------------------------
from msrest.serialization import Model
from msrest.exceptions import HttpOperationError
[docs]class ApplicationDeltaHealthPolicy(Model):
"""Defines a delta health policy used to evaluate the health of an application
or one of its child entities when upgrading the cluster.
.
:param default_service_type_delta_health_policy: The delta health policy
used by default to evaluate the health of a service type when upgrading
the cluster.
:type default_service_type_delta_health_policy:
~azure.mgmt.servicefabric.models.ServiceTypeDeltaHealthPolicy
:param service_type_delta_health_policies: The map with service type delta
health policy per service type name. The map is empty by default.
:type service_type_delta_health_policies: dict[str,
~azure.mgmt.servicefabric.models.ServiceTypeDeltaHealthPolicy]
"""
_attribute_map = {
'default_service_type_delta_health_policy': {'key': 'defaultServiceTypeDeltaHealthPolicy', 'type': 'ServiceTypeDeltaHealthPolicy'},
'service_type_delta_health_policies': {'key': 'serviceTypeDeltaHealthPolicies', 'type': '{ServiceTypeDeltaHealthPolicy}'},
}
def __init__(self, *, default_service_type_delta_health_policy=None, service_type_delta_health_policies=None, **kwargs) -> None:
super(ApplicationDeltaHealthPolicy, self).__init__(**kwargs)
self.default_service_type_delta_health_policy = default_service_type_delta_health_policy
self.service_type_delta_health_policies = service_type_delta_health_policies
[docs]class ApplicationHealthPolicy(Model):
"""Defines a health policy used to evaluate the health of an application or
one of its children entities.
.
:param default_service_type_health_policy: The health policy used by
default to evaluate the health of a service type.
:type default_service_type_health_policy:
~azure.mgmt.servicefabric.models.ServiceTypeHealthPolicy
:param service_type_health_policies: The map with service type health
policy per service type name. The map is empty by default.
:type service_type_health_policies: dict[str,
~azure.mgmt.servicefabric.models.ServiceTypeHealthPolicy]
"""
_attribute_map = {
'default_service_type_health_policy': {'key': 'defaultServiceTypeHealthPolicy', 'type': 'ServiceTypeHealthPolicy'},
'service_type_health_policies': {'key': 'serviceTypeHealthPolicies', 'type': '{ServiceTypeHealthPolicy}'},
}
def __init__(self, *, default_service_type_health_policy=None, service_type_health_policies=None, **kwargs) -> None:
super(ApplicationHealthPolicy, self).__init__(**kwargs)
self.default_service_type_health_policy = default_service_type_health_policy
self.service_type_health_policies = service_type_health_policies
[docs]class ApplicationMetricDescription(Model):
"""Describes capacity information for a custom resource balancing metric. This
can be used to limit the total consumption of this metric by the services
of this application.
.
:param name: The name of the metric.
:type name: str
:param maximum_capacity: The maximum node capacity for Service Fabric
application.
This is the maximum Load for an instance of this application on a single
node. Even if the capacity of node is greater than this value, Service
Fabric will limit the total load of services within the application on
each node to this value.
If set to zero, capacity for this metric is unlimited on each node.
When creating a new application with application capacity defined, the
product of MaximumNodes and this value must always be smaller than or
equal to TotalApplicationCapacity.
When updating existing application with application capacity, the product
of MaximumNodes and this value must always be smaller than or equal to
TotalApplicationCapacity.
:type maximum_capacity: long
:param reservation_capacity: The node reservation capacity for Service
Fabric application.
This is the amount of load which is reserved on nodes which have instances
of this application.
If MinimumNodes is specified, then the product of these values will be the
capacity reserved in the cluster for the application.
If set to zero, no capacity is reserved for this metric.
When setting application capacity or when updating application capacity;
this value must be smaller than or equal to MaximumCapacity for each
metric.
:type reservation_capacity: long
:param total_application_capacity: The total metric capacity for Service
Fabric application.
This is the total metric capacity for this application in the cluster.
Service Fabric will try to limit the sum of loads of services within the
application to this value.
When creating a new application with application capacity defined, the
product of MaximumNodes and MaximumCapacity must always be smaller than or
equal to this value.
:type total_application_capacity: long
"""
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'maximum_capacity': {'key': 'maximumCapacity', 'type': 'long'},
'reservation_capacity': {'key': 'reservationCapacity', 'type': 'long'},
'total_application_capacity': {'key': 'totalApplicationCapacity', 'type': 'long'},
}
def __init__(self, *, name: str=None, maximum_capacity: int=None, reservation_capacity: int=None, total_application_capacity: int=None, **kwargs) -> None:
super(ApplicationMetricDescription, self).__init__(**kwargs)
self.name = name
self.maximum_capacity = maximum_capacity
self.reservation_capacity = reservation_capacity
self.total_application_capacity = total_application_capacity
[docs]class ProxyResource(Model):
"""The resource model definition for proxy-only resource.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: Azure resource identifier.
:vartype id: str
:ivar name: Azure resource name.
:vartype name: str
:ivar type: Azure resource type.
:vartype type: str
:param location: It will be deprecated in New API, resource location
depends on the parent resource.
:type location: str
:param tags: Azure resource tags.
:type tags: dict[str, str]
:ivar etag: Azure resource etag.
:vartype etag: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'etag': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'etag': {'key': 'etag', 'type': 'str'},
}
def __init__(self, *, location: str=None, tags=None, **kwargs) -> None:
super(ProxyResource, self).__init__(**kwargs)
self.id = None
self.name = None
self.type = None
self.location = location
self.tags = tags
self.etag = None
[docs]class ApplicationResource(ProxyResource):
"""The application resource.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: Azure resource identifier.
:vartype id: str
:ivar name: Azure resource name.
:vartype name: str
:ivar type: Azure resource type.
:vartype type: str
:param location: It will be deprecated in New API, resource location
depends on the parent resource.
:type location: str
:param tags: Azure resource tags.
:type tags: dict[str, str]
:ivar etag: Azure resource etag.
:vartype etag: str
:param identity: Describes the managed identities for an Azure resource.
:type identity: ~azure.mgmt.servicefabric.models.ManagedIdentity
:param type_version: The version of the application type as defined in the
application manifest.
:type type_version: str
:param parameters: List of application parameters with overridden values
from their default values specified in the application manifest.
:type parameters: dict[str, str]
:param upgrade_policy: Describes the policy for a monitored application
upgrade.
:type upgrade_policy:
~azure.mgmt.servicefabric.models.ApplicationUpgradePolicy
:param minimum_nodes: The minimum number of nodes where Service Fabric
will reserve capacity for this application. Note that this does not mean
that the services of this application will be placed on all of those
nodes. If this property is set to zero, no capacity will be reserved. The
value of this property cannot be more than the value of the MaximumNodes
property.
:type minimum_nodes: long
:param maximum_nodes: The maximum number of nodes where Service Fabric
will reserve capacity for this application. Note that this does not mean
that the services of this application will be placed on all of those
nodes. By default, the value of this property is zero and it means that
the services can be placed on any node. Default value: 0 .
:type maximum_nodes: long
:param remove_application_capacity: Remove the current application
capacity settings.
:type remove_application_capacity: bool
:param metrics: List of application capacity metric description.
:type metrics:
list[~azure.mgmt.servicefabric.models.ApplicationMetricDescription]
:param managed_identities: List of user assigned identities for the
application, each mapped to a friendly name.
:type managed_identities:
list[~azure.mgmt.servicefabric.models.ApplicationUserAssignedIdentity]
:ivar provisioning_state: The current deployment or provisioning state,
which only appears in the response
:vartype provisioning_state: str
:param type_name: The application type name as defined in the application
manifest.
:type type_name: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'etag': {'readonly': True},
'minimum_nodes': {'minimum': 0},
'maximum_nodes': {'minimum': 0},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'etag': {'key': 'etag', 'type': 'str'},
'identity': {'key': 'identity', 'type': 'ManagedIdentity'},
'type_version': {'key': 'properties.typeVersion', 'type': 'str'},
'parameters': {'key': 'properties.parameters', 'type': '{str}'},
'upgrade_policy': {'key': 'properties.upgradePolicy', 'type': 'ApplicationUpgradePolicy'},
'minimum_nodes': {'key': 'properties.minimumNodes', 'type': 'long'},
'maximum_nodes': {'key': 'properties.maximumNodes', 'type': 'long'},
'remove_application_capacity': {'key': 'properties.removeApplicationCapacity', 'type': 'bool'},
'metrics': {'key': 'properties.metrics', 'type': '[ApplicationMetricDescription]'},
'managed_identities': {'key': 'properties.managedIdentities', 'type': '[ApplicationUserAssignedIdentity]'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'type_name': {'key': 'properties.typeName', 'type': 'str'},
}
def __init__(self, *, location: str=None, tags=None, identity=None, type_version: str=None, parameters=None, upgrade_policy=None, minimum_nodes: int=None, maximum_nodes: int=0, remove_application_capacity: bool=None, metrics=None, managed_identities=None, type_name: str=None, **kwargs) -> None:
super(ApplicationResource, self).__init__(location=location, tags=tags, **kwargs)
self.identity = identity
self.type_version = type_version
self.parameters = parameters
self.upgrade_policy = upgrade_policy
self.minimum_nodes = minimum_nodes
self.maximum_nodes = maximum_nodes
self.remove_application_capacity = remove_application_capacity
self.metrics = metrics
self.managed_identities = managed_identities
self.provisioning_state = None
self.type_name = type_name
[docs]class ApplicationResourceList(Model):
"""The list of application resources.
Variables are only populated by the server, and will be ignored when
sending a request.
:param value:
:type value: list[~azure.mgmt.servicefabric.models.ApplicationResource]
:ivar next_link: URL to get the next set of application list results if
there are any.
:vartype next_link: str
"""
_validation = {
'next_link': {'readonly': True},
}
_attribute_map = {
'value': {'key': 'value', 'type': '[ApplicationResource]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(self, *, value=None, **kwargs) -> None:
super(ApplicationResourceList, self).__init__(**kwargs)
self.value = value
self.next_link = None
[docs]class ApplicationResourceUpdate(ProxyResource):
"""The application resource for patch operations.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: Azure resource identifier.
:vartype id: str
:ivar name: Azure resource name.
:vartype name: str
:ivar type: Azure resource type.
:vartype type: str
:param location: It will be deprecated in New API, resource location
depends on the parent resource.
:type location: str
:param tags: Azure resource tags.
:type tags: dict[str, str]
:ivar etag: Azure resource etag.
:vartype etag: str
:param type_version: The version of the application type as defined in the
application manifest.
:type type_version: str
:param parameters: List of application parameters with overridden values
from their default values specified in the application manifest.
:type parameters: dict[str, str]
:param upgrade_policy: Describes the policy for a monitored application
upgrade.
:type upgrade_policy:
~azure.mgmt.servicefabric.models.ApplicationUpgradePolicy
:param minimum_nodes: The minimum number of nodes where Service Fabric
will reserve capacity for this application. Note that this does not mean
that the services of this application will be placed on all of those
nodes. If this property is set to zero, no capacity will be reserved. The
value of this property cannot be more than the value of the MaximumNodes
property.
:type minimum_nodes: long
:param maximum_nodes: The maximum number of nodes where Service Fabric
will reserve capacity for this application. Note that this does not mean
that the services of this application will be placed on all of those
nodes. By default, the value of this property is zero and it means that
the services can be placed on any node. Default value: 0 .
:type maximum_nodes: long
:param remove_application_capacity: Remove the current application
capacity settings.
:type remove_application_capacity: bool
:param metrics: List of application capacity metric description.
:type metrics:
list[~azure.mgmt.servicefabric.models.ApplicationMetricDescription]
:param managed_identities: List of user assigned identities for the
application, each mapped to a friendly name.
:type managed_identities:
list[~azure.mgmt.servicefabric.models.ApplicationUserAssignedIdentity]
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'etag': {'readonly': True},
'minimum_nodes': {'minimum': 0},
'maximum_nodes': {'minimum': 0},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'etag': {'key': 'etag', 'type': 'str'},
'type_version': {'key': 'properties.typeVersion', 'type': 'str'},
'parameters': {'key': 'properties.parameters', 'type': '{str}'},
'upgrade_policy': {'key': 'properties.upgradePolicy', 'type': 'ApplicationUpgradePolicy'},
'minimum_nodes': {'key': 'properties.minimumNodes', 'type': 'long'},
'maximum_nodes': {'key': 'properties.maximumNodes', 'type': 'long'},
'remove_application_capacity': {'key': 'properties.removeApplicationCapacity', 'type': 'bool'},
'metrics': {'key': 'properties.metrics', 'type': '[ApplicationMetricDescription]'},
'managed_identities': {'key': 'properties.managedIdentities', 'type': '[ApplicationUserAssignedIdentity]'},
}
def __init__(self, *, location: str=None, tags=None, type_version: str=None, parameters=None, upgrade_policy=None, minimum_nodes: int=None, maximum_nodes: int=0, remove_application_capacity: bool=None, metrics=None, managed_identities=None, **kwargs) -> None:
super(ApplicationResourceUpdate, self).__init__(location=location, tags=tags, **kwargs)
self.type_version = type_version
self.parameters = parameters
self.upgrade_policy = upgrade_policy
self.minimum_nodes = minimum_nodes
self.maximum_nodes = maximum_nodes
self.remove_application_capacity = remove_application_capacity
self.metrics = metrics
self.managed_identities = managed_identities
[docs]class ApplicationTypeResource(ProxyResource):
"""The application type name resource.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: Azure resource identifier.
:vartype id: str
:ivar name: Azure resource name.
:vartype name: str
:ivar type: Azure resource type.
:vartype type: str
:param location: It will be deprecated in New API, resource location
depends on the parent resource.
:type location: str
:param tags: Azure resource tags.
:type tags: dict[str, str]
:ivar etag: Azure resource etag.
:vartype etag: str
:ivar provisioning_state: The current deployment or provisioning state,
which only appears in the response.
:vartype provisioning_state: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'etag': {'readonly': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'etag': {'key': 'etag', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
}
def __init__(self, *, location: str=None, tags=None, **kwargs) -> None:
super(ApplicationTypeResource, self).__init__(location=location, tags=tags, **kwargs)
self.provisioning_state = None
[docs]class ApplicationTypeResourceList(Model):
"""The list of application type names.
Variables are only populated by the server, and will be ignored when
sending a request.
:param value:
:type value:
list[~azure.mgmt.servicefabric.models.ApplicationTypeResource]
:ivar next_link: URL to get the next set of application type list results
if there are any.
:vartype next_link: str
"""
_validation = {
'next_link': {'readonly': True},
}
_attribute_map = {
'value': {'key': 'value', 'type': '[ApplicationTypeResource]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(self, *, value=None, **kwargs) -> None:
super(ApplicationTypeResourceList, self).__init__(**kwargs)
self.value = value
self.next_link = None
[docs]class ApplicationTypeVersionResource(ProxyResource):
"""An application type version resource for the specified application type
name resource.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: Azure resource identifier.
:vartype id: str
:ivar name: Azure resource name.
:vartype name: str
:ivar type: Azure resource type.
:vartype type: str
:param location: It will be deprecated in New API, resource location
depends on the parent resource.
:type location: str
:param tags: Azure resource tags.
:type tags: dict[str, str]
:ivar etag: Azure resource etag.
:vartype etag: str
:ivar provisioning_state: The current deployment or provisioning state,
which only appears in the response
:vartype provisioning_state: str
:param app_package_url: Required. The URL to the application package
:type app_package_url: str
:ivar default_parameter_list: List of application type parameters that can
be overridden when creating or updating the application.
:vartype default_parameter_list: dict[str, str]
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'etag': {'readonly': True},
'provisioning_state': {'readonly': True},
'app_package_url': {'required': True},
'default_parameter_list': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'etag': {'key': 'etag', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'app_package_url': {'key': 'properties.appPackageUrl', 'type': 'str'},
'default_parameter_list': {'key': 'properties.defaultParameterList', 'type': '{str}'},
}
def __init__(self, *, app_package_url: str, location: str=None, tags=None, **kwargs) -> None:
super(ApplicationTypeVersionResource, self).__init__(location=location, tags=tags, **kwargs)
self.provisioning_state = None
self.app_package_url = app_package_url
self.default_parameter_list = None
[docs]class ApplicationTypeVersionResourceList(Model):
"""The list of application type version resources for the specified
application type name resource.
Variables are only populated by the server, and will be ignored when
sending a request.
:param value:
:type value:
list[~azure.mgmt.servicefabric.models.ApplicationTypeVersionResource]
:ivar next_link: URL to get the next set of application type version list
results if there are any.
:vartype next_link: str
"""
_validation = {
'next_link': {'readonly': True},
}
_attribute_map = {
'value': {'key': 'value', 'type': '[ApplicationTypeVersionResource]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(self, *, value=None, **kwargs) -> None:
super(ApplicationTypeVersionResourceList, self).__init__(**kwargs)
self.value = value
self.next_link = None
[docs]class ApplicationTypeVersionsCleanupPolicy(Model):
"""ApplicationTypeVersionsCleanupPolicy.
All required parameters must be populated in order to send to Azure.
:param max_unused_versions_to_keep: Required. Number of unused versions
per application type to keep.
:type max_unused_versions_to_keep: int
"""
_validation = {
'max_unused_versions_to_keep': {'required': True, 'minimum': 0},
}
_attribute_map = {
'max_unused_versions_to_keep': {'key': 'maxUnusedVersionsToKeep', 'type': 'int'},
}
def __init__(self, *, max_unused_versions_to_keep: int, **kwargs) -> None:
super(ApplicationTypeVersionsCleanupPolicy, self).__init__(**kwargs)
self.max_unused_versions_to_keep = max_unused_versions_to_keep
[docs]class ApplicationUpgradePolicy(Model):
"""Describes the policy for a monitored application upgrade.
:param upgrade_replica_set_check_timeout: The maximum amount of time to
block processing of an upgrade domain and prevent loss of availability
when there are unexpected issues. When this timeout expires, processing of
the upgrade domain will proceed regardless of availability loss issues.
The timeout is reset at the start of each upgrade domain. Valid values are
between 0 and 42949672925 inclusive. (unsigned 32-bit integer).
:type upgrade_replica_set_check_timeout: str
:param force_restart: If true, then processes are forcefully restarted
during upgrade even when the code version has not changed (the upgrade
only changes configuration or data).
:type force_restart: bool
:param rolling_upgrade_monitoring_policy: The policy used for monitoring
the application upgrade
:type rolling_upgrade_monitoring_policy:
~azure.mgmt.servicefabric.models.ArmRollingUpgradeMonitoringPolicy
:param application_health_policy: Defines a health policy used to evaluate
the health of an application or one of its children entities.
:type application_health_policy:
~azure.mgmt.servicefabric.models.ArmApplicationHealthPolicy
:param upgrade_mode: The mode used to monitor health during a rolling
upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored.
Possible values include: 'Invalid', 'UnmonitoredAuto',
'UnmonitoredManual', 'Monitored'. Default value: "Monitored" .
:type upgrade_mode: str or
~azure.mgmt.servicefabric.models.RollingUpgradeMode
"""
_attribute_map = {
'upgrade_replica_set_check_timeout': {'key': 'upgradeReplicaSetCheckTimeout', 'type': 'str'},
'force_restart': {'key': 'forceRestart', 'type': 'bool'},
'rolling_upgrade_monitoring_policy': {'key': 'rollingUpgradeMonitoringPolicy', 'type': 'ArmRollingUpgradeMonitoringPolicy'},
'application_health_policy': {'key': 'applicationHealthPolicy', 'type': 'ArmApplicationHealthPolicy'},
'upgrade_mode': {'key': 'upgradeMode', 'type': 'str'},
}
def __init__(self, *, upgrade_replica_set_check_timeout: str=None, force_restart: bool=None, rolling_upgrade_monitoring_policy=None, application_health_policy=None, upgrade_mode="Monitored", **kwargs) -> None:
super(ApplicationUpgradePolicy, self).__init__(**kwargs)
self.upgrade_replica_set_check_timeout = upgrade_replica_set_check_timeout
self.force_restart = force_restart
self.rolling_upgrade_monitoring_policy = rolling_upgrade_monitoring_policy
self.application_health_policy = application_health_policy
self.upgrade_mode = upgrade_mode
[docs]class ApplicationUserAssignedIdentity(Model):
"""ApplicationUserAssignedIdentity.
All required parameters must be populated in order to send to Azure.
:param name: Required. The friendly name of user assigned identity.
:type name: str
:param principal_id: Required. The principal id of user assigned identity.
:type principal_id: str
"""
_validation = {
'name': {'required': True},
'principal_id': {'required': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'principal_id': {'key': 'principalId', 'type': 'str'},
}
def __init__(self, *, name: str, principal_id: str, **kwargs) -> None:
super(ApplicationUserAssignedIdentity, self).__init__(**kwargs)
self.name = name
self.principal_id = principal_id
[docs]class ArmApplicationHealthPolicy(Model):
"""Defines a health policy used to evaluate the health of an application or
one of its children entities.
.
:param consider_warning_as_error: Indicates whether warnings are treated
with the same severity as errors. Default value: False .
:type consider_warning_as_error: bool
:param max_percent_unhealthy_deployed_applications: The maximum allowed
percentage of unhealthy deployed applications. Allowed values are Byte
values from zero to 100.
The percentage represents the maximum tolerated percentage of deployed
applications that can be unhealthy before the application is considered in
error.
This is calculated by dividing the number of unhealthy deployed
applications over the number of nodes where the application is currently
deployed on in the cluster.
The computation rounds up to tolerate one failure on small numbers of
nodes. Default percentage is zero.
. Default value: 0 .
:type max_percent_unhealthy_deployed_applications: int
:param default_service_type_health_policy: The health policy used by
default to evaluate the health of a service type.
:type default_service_type_health_policy:
~azure.mgmt.servicefabric.models.ArmServiceTypeHealthPolicy
:param service_type_health_policy_map: The map with service type health
policy per service type name. The map is empty by default.
:type service_type_health_policy_map: dict[str,
~azure.mgmt.servicefabric.models.ArmServiceTypeHealthPolicy]
"""
_attribute_map = {
'consider_warning_as_error': {'key': 'considerWarningAsError', 'type': 'bool'},
'max_percent_unhealthy_deployed_applications': {'key': 'maxPercentUnhealthyDeployedApplications', 'type': 'int'},
'default_service_type_health_policy': {'key': 'defaultServiceTypeHealthPolicy', 'type': 'ArmServiceTypeHealthPolicy'},
'service_type_health_policy_map': {'key': 'serviceTypeHealthPolicyMap', 'type': '{ArmServiceTypeHealthPolicy}'},
}
def __init__(self, *, consider_warning_as_error: bool=False, max_percent_unhealthy_deployed_applications: int=0, default_service_type_health_policy=None, service_type_health_policy_map=None, **kwargs) -> None:
super(ArmApplicationHealthPolicy, self).__init__(**kwargs)
self.consider_warning_as_error = consider_warning_as_error
self.max_percent_unhealthy_deployed_applications = max_percent_unhealthy_deployed_applications
self.default_service_type_health_policy = default_service_type_health_policy
self.service_type_health_policy_map = service_type_health_policy_map
[docs]class ArmRollingUpgradeMonitoringPolicy(Model):
"""The policy used for monitoring the application upgrade.
:param failure_action: The activation Mode of the service package.
Possible values include: 'Rollback', 'Manual'
:type failure_action: str or
~azure.mgmt.servicefabric.models.ArmUpgradeFailureAction
:param health_check_wait_duration: The amount of time to wait after
completing an upgrade domain before applying health policies. It is first
interpreted as a string representing an ISO 8601 duration. If that fails,
then it is interpreted as a number representing the total number of
milliseconds.
:type health_check_wait_duration: str
:param health_check_stable_duration: The amount of time that the
application or cluster must remain healthy before the upgrade proceeds to
the next upgrade domain. It is first interpreted as a string representing
an ISO 8601 duration. If that fails, then it is interpreted as a number
representing the total number of milliseconds.
:type health_check_stable_duration: str
:param health_check_retry_timeout: The amount of time to retry health
evaluation when the application or cluster is unhealthy before
FailureAction is executed. It is first interpreted as a string
representing an ISO 8601 duration. If that fails, then it is interpreted
as a number representing the total number of milliseconds.
:type health_check_retry_timeout: str
:param upgrade_timeout: The amount of time the overall upgrade has to
complete before FailureAction is executed. It is first interpreted as a
string representing an ISO 8601 duration. If that fails, then it is
interpreted as a number representing the total number of milliseconds.
:type upgrade_timeout: str
:param upgrade_domain_timeout: The amount of time each upgrade domain has
to complete before FailureAction is executed. It is first interpreted as a
string representing an ISO 8601 duration. If that fails, then it is
interpreted as a number representing the total number of milliseconds.
:type upgrade_domain_timeout: str
"""
_attribute_map = {
'failure_action': {'key': 'failureAction', 'type': 'str'},
'health_check_wait_duration': {'key': 'healthCheckWaitDuration', 'type': 'str'},
'health_check_stable_duration': {'key': 'healthCheckStableDuration', 'type': 'str'},
'health_check_retry_timeout': {'key': 'healthCheckRetryTimeout', 'type': 'str'},
'upgrade_timeout': {'key': 'upgradeTimeout', 'type': 'str'},
'upgrade_domain_timeout': {'key': 'upgradeDomainTimeout', 'type': 'str'},
}
def __init__(self, *, failure_action=None, health_check_wait_duration: str=None, health_check_stable_duration: str=None, health_check_retry_timeout: str=None, upgrade_timeout: str=None, upgrade_domain_timeout: str=None, **kwargs) -> None:
super(ArmRollingUpgradeMonitoringPolicy, self).__init__(**kwargs)
self.failure_action = failure_action
self.health_check_wait_duration = health_check_wait_duration
self.health_check_stable_duration = health_check_stable_duration
self.health_check_retry_timeout = health_check_retry_timeout
self.upgrade_timeout = upgrade_timeout
self.upgrade_domain_timeout = upgrade_domain_timeout
[docs]class ArmServiceTypeHealthPolicy(Model):
"""Represents the health policy used to evaluate the health of services
belonging to a service type.
.
:param max_percent_unhealthy_services: The maximum percentage of services
allowed to be unhealthy before your application is considered in error.
. Default value: 0 .
:type max_percent_unhealthy_services: int
:param max_percent_unhealthy_partitions_per_service: The maximum
percentage of partitions per service allowed to be unhealthy before your
application is considered in error.
. Default value: 0 .
:type max_percent_unhealthy_partitions_per_service: int
:param max_percent_unhealthy_replicas_per_partition: The maximum
percentage of replicas per partition allowed to be unhealthy before your
application is considered in error.
. Default value: 0 .
:type max_percent_unhealthy_replicas_per_partition: int
"""
_validation = {
'max_percent_unhealthy_services': {'maximum': 100, 'minimum': 0},
'max_percent_unhealthy_partitions_per_service': {'maximum': 100, 'minimum': 0},
'max_percent_unhealthy_replicas_per_partition': {'maximum': 100, 'minimum': 0},
}
_attribute_map = {
'max_percent_unhealthy_services': {'key': 'maxPercentUnhealthyServices', 'type': 'int'},
'max_percent_unhealthy_partitions_per_service': {'key': 'maxPercentUnhealthyPartitionsPerService', 'type': 'int'},
'max_percent_unhealthy_replicas_per_partition': {'key': 'maxPercentUnhealthyReplicasPerPartition', 'type': 'int'},
}
def __init__(self, *, max_percent_unhealthy_services: int=0, max_percent_unhealthy_partitions_per_service: int=0, max_percent_unhealthy_replicas_per_partition: int=0, **kwargs) -> None:
super(ArmServiceTypeHealthPolicy, self).__init__(**kwargs)
self.max_percent_unhealthy_services = max_percent_unhealthy_services
self.max_percent_unhealthy_partitions_per_service = max_percent_unhealthy_partitions_per_service
self.max_percent_unhealthy_replicas_per_partition = max_percent_unhealthy_replicas_per_partition
[docs]class AvailableOperationDisplay(Model):
"""Operation supported by the Service Fabric resource provider.
:param provider: The name of the provider.
:type provider: str
:param resource: The resource on which the operation is performed
:type resource: str
:param operation: The operation that can be performed.
:type operation: str
:param description: Operation description
:type description: str
"""
_attribute_map = {
'provider': {'key': 'provider', 'type': 'str'},
'resource': {'key': 'resource', 'type': 'str'},
'operation': {'key': 'operation', 'type': 'str'},
'description': {'key': 'description', 'type': 'str'},
}
def __init__(self, *, provider: str=None, resource: str=None, operation: str=None, description: str=None, **kwargs) -> None:
super(AvailableOperationDisplay, self).__init__(**kwargs)
self.provider = provider
self.resource = resource
self.operation = operation
self.description = description
[docs]class AzureActiveDirectory(Model):
"""The settings to enable AAD authentication on the cluster.
:param tenant_id: Azure active directory tenant id.
:type tenant_id: str
:param cluster_application: Azure active directory cluster application id.
:type cluster_application: str
:param client_application: Azure active directory client application id.
:type client_application: str
"""
_attribute_map = {
'tenant_id': {'key': 'tenantId', 'type': 'str'},
'cluster_application': {'key': 'clusterApplication', 'type': 'str'},
'client_application': {'key': 'clientApplication', 'type': 'str'},
}
def __init__(self, *, tenant_id: str=None, cluster_application: str=None, client_application: str=None, **kwargs) -> None:
super(AzureActiveDirectory, self).__init__(**kwargs)
self.tenant_id = tenant_id
self.cluster_application = cluster_application
self.client_application = client_application
[docs]class CertificateDescription(Model):
"""Describes the certificate details.
All required parameters must be populated in order to send to Azure.
:param thumbprint: Required. Thumbprint of the primary certificate.
:type thumbprint: str
:param thumbprint_secondary: Thumbprint of the secondary certificate.
:type thumbprint_secondary: str
:param x509_store_name: The local certificate store location. Possible
values include: 'AddressBook', 'AuthRoot', 'CertificateAuthority',
'Disallowed', 'My', 'Root', 'TrustedPeople', 'TrustedPublisher'
:type x509_store_name: str or ~azure.mgmt.servicefabric.models.enum
"""
_validation = {
'thumbprint': {'required': True},
}
_attribute_map = {
'thumbprint': {'key': 'thumbprint', 'type': 'str'},
'thumbprint_secondary': {'key': 'thumbprintSecondary', 'type': 'str'},
'x509_store_name': {'key': 'x509StoreName', 'type': 'str'},
}
def __init__(self, *, thumbprint: str, thumbprint_secondary: str=None, x509_store_name=None, **kwargs) -> None:
super(CertificateDescription, self).__init__(**kwargs)
self.thumbprint = thumbprint
self.thumbprint_secondary = thumbprint_secondary
self.x509_store_name = x509_store_name
[docs]class ClientCertificate(Model):
"""Client Certificate definition.
All required parameters must be populated in order to send to Azure.
:param is_admin: Required. Whether the certificate is admin or not.
:type is_admin: bool
:param thumbprint: Certificate Thumbprint.
:type thumbprint: str
:param common_name: Certificate Common name.
:type common_name: str
:param issuer_thumbprint: Issuer thumbprint for the certificate. Its only
use ehn CommonName is used.
:type issuer_thumbprint: str
"""
_validation = {
'is_admin': {'required': True},
}
_attribute_map = {
'is_admin': {'key': 'isAdmin', 'type': 'bool'},
'thumbprint': {'key': 'thumbprint', 'type': 'str'},
'common_name': {'key': 'commonName', 'type': 'str'},
'issuer_thumbprint': {'key': 'issuerThumbprint', 'type': 'str'},
}
def __init__(self, *, is_admin: bool, thumbprint: str=None, common_name: str=None, issuer_thumbprint: str=None, **kwargs) -> None:
super(ClientCertificate, self).__init__(**kwargs)
self.is_admin = is_admin
self.thumbprint = thumbprint
self.common_name = common_name
self.issuer_thumbprint = issuer_thumbprint
[docs]class ClientCertificateCommonName(Model):
"""Describes the client certificate details using common name.
All required parameters must be populated in order to send to Azure.
:param is_admin: Required. Indicates if the client certificate has admin
access to the cluster. Non admin clients can perform only read only
operations on the cluster.
:type is_admin: bool
:param certificate_common_name: Required. The common name of the client
certificate.
:type certificate_common_name: str
:param certificate_issuer_thumbprint: Required. The issuer thumbprint of
the client certificate.
:type certificate_issuer_thumbprint: str
"""
_validation = {
'is_admin': {'required': True},
'certificate_common_name': {'required': True},
'certificate_issuer_thumbprint': {'required': True},
}
_attribute_map = {
'is_admin': {'key': 'isAdmin', 'type': 'bool'},
'certificate_common_name': {'key': 'certificateCommonName', 'type': 'str'},
'certificate_issuer_thumbprint': {'key': 'certificateIssuerThumbprint', 'type': 'str'},
}
def __init__(self, *, is_admin: bool, certificate_common_name: str, certificate_issuer_thumbprint: str, **kwargs) -> None:
super(ClientCertificateCommonName, self).__init__(**kwargs)
self.is_admin = is_admin
self.certificate_common_name = certificate_common_name
self.certificate_issuer_thumbprint = certificate_issuer_thumbprint
[docs]class ClientCertificateThumbprint(Model):
"""Describes the client certificate details using thumbprint.
All required parameters must be populated in order to send to Azure.
:param is_admin: Required. Indicates if the client certificate has admin
access to the cluster. Non admin clients can perform only read only
operations on the cluster.
:type is_admin: bool
:param certificate_thumbprint: Required. The thumbprint of the client
certificate.
:type certificate_thumbprint: str
"""
_validation = {
'is_admin': {'required': True},
'certificate_thumbprint': {'required': True},
}
_attribute_map = {
'is_admin': {'key': 'isAdmin', 'type': 'bool'},
'certificate_thumbprint': {'key': 'certificateThumbprint', 'type': 'str'},
}
def __init__(self, *, is_admin: bool, certificate_thumbprint: str, **kwargs) -> None:
super(ClientCertificateThumbprint, self).__init__(**kwargs)
self.is_admin = is_admin
self.certificate_thumbprint = certificate_thumbprint
class CloudError(Model):
"""CloudError.
"""
_attribute_map = {
}
[docs]class Resource(Model):
"""The resource model definition.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: Azure resource identifier.
:vartype id: str
:ivar name: Azure resource name.
:vartype name: str
:ivar type: Azure resource type.
:vartype type: str
:param location: Required. Azure resource location.
:type location: str
:param tags: Azure resource tags.
:type tags: dict[str, str]
:ivar etag: Azure resource etag.
:vartype etag: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'location': {'required': True},
'etag': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'etag': {'key': 'etag', 'type': 'str'},
}
def __init__(self, *, location: str, tags=None, **kwargs) -> None:
super(Resource, self).__init__(**kwargs)
self.id = None
self.name = None
self.type = None
self.location = location
self.tags = tags
self.etag = None
[docs]class Cluster(Resource):
"""The cluster resource
.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: Azure resource identifier.
:vartype id: str
:ivar name: Azure resource name.
:vartype name: str
:ivar type: Azure resource type.
:vartype type: str
:param location: Required. Azure resource location.
:type location: str
:param tags: Azure resource tags.
:type tags: dict[str, str]
:ivar etag: Azure resource etag.
:vartype etag: str
:param add_on_features: The list of add-on features to enable in the
cluster.
:type add_on_features: list[str]
:ivar available_cluster_versions: The Service Fabric runtime versions
available for this cluster.
:vartype available_cluster_versions:
list[~azure.mgmt.servicefabric.models.ClusterVersionDetails]
:param azure_active_directory: The AAD authentication settings of the
cluster.
:type azure_active_directory:
~azure.mgmt.servicefabric.models.AzureActiveDirectory
:param certificate: The certificate to use for securing the cluster. The
certificate provided will be used for node to node security within the
cluster, SSL certificate for cluster management endpoint and default admin
client.
:type certificate: ~azure.mgmt.servicefabric.models.CertificateDescription
:param certificate_common_names: Describes a list of server certificates
referenced by common name that are used to secure the cluster.
:type certificate_common_names:
~azure.mgmt.servicefabric.models.ServerCertificateCommonNames
:param client_certificate_common_names: The list of client certificates
referenced by common name that are allowed to manage the cluster.
:type client_certificate_common_names:
list[~azure.mgmt.servicefabric.models.ClientCertificateCommonName]
:param client_certificate_thumbprints: The list of client certificates
referenced by thumbprint that are allowed to manage the cluster.
:type client_certificate_thumbprints:
list[~azure.mgmt.servicefabric.models.ClientCertificateThumbprint]
:param cluster_code_version: The Service Fabric runtime version of the
cluster. This property can only by set the user when **upgradeMode** is
set to 'Manual'. To get list of available Service Fabric versions for new
clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of
available version for existing clusters use **availableClusterVersions**.
:type cluster_code_version: str
:ivar cluster_endpoint: The Azure Resource Provider endpoint. A system
service in the cluster connects to this endpoint.
:vartype cluster_endpoint: str
:ivar cluster_id: A service generated unique identifier for the cluster
resource.
:vartype cluster_id: str
:ivar cluster_state: The current state of the cluster.
- WaitingForNodes - Indicates that the cluster resource is created and the
resource provider is waiting for Service Fabric VM extension to boot up
and report to it.
- Deploying - Indicates that the Service Fabric runtime is being installed
on the VMs. Cluster resource will be in this state until the cluster boots
up and system services are up.
- BaselineUpgrade - Indicates that the cluster is upgrading to establishes
the cluster version. This upgrade is automatically initiated when the
cluster boots up for the first time.
- UpdatingUserConfiguration - Indicates that the cluster is being upgraded
with the user provided configuration.
- UpdatingUserCertificate - Indicates that the cluster is being upgraded
with the user provided certificate.
- UpdatingInfrastructure - Indicates that the cluster is being upgraded
with the latest Service Fabric runtime version. This happens only when the
**upgradeMode** is set to 'Automatic'.
- EnforcingClusterVersion - Indicates that cluster is on a different
version than expected and the cluster is being upgraded to the expected
version.
- UpgradeServiceUnreachable - Indicates that the system service in the
cluster is no longer polling the Resource Provider. Clusters in this state
cannot be managed by the Resource Provider.
- AutoScale - Indicates that the ReliabilityLevel of the cluster is being
adjusted.
- Ready - Indicates that the cluster is in a stable state.
. Possible values include: 'WaitingForNodes', 'Deploying',
'BaselineUpgrade', 'UpdatingUserConfiguration', 'UpdatingUserCertificate',
'UpdatingInfrastructure', 'EnforcingClusterVersion',
'UpgradeServiceUnreachable', 'AutoScale', 'Ready'
:vartype cluster_state: str or ~azure.mgmt.servicefabric.models.enum
:param diagnostics_storage_account_config: The storage account information
for storing Service Fabric diagnostic logs.
:type diagnostics_storage_account_config:
~azure.mgmt.servicefabric.models.DiagnosticsStorageAccountConfig
:param event_store_service_enabled: Indicates if the event store service
is enabled.
:type event_store_service_enabled: bool
:param fabric_settings: The list of custom fabric settings to configure
the cluster.
:type fabric_settings:
list[~azure.mgmt.servicefabric.models.SettingsSectionDescription]
:param management_endpoint: Required. The http management endpoint of the
cluster.
:type management_endpoint: str
:param node_types: Required. The list of node types in the cluster.
:type node_types:
list[~azure.mgmt.servicefabric.models.NodeTypeDescription]
:ivar provisioning_state: The provisioning state of the cluster resource.
Possible values include: 'Updating', 'Succeeded', 'Failed', 'Canceled'
:vartype provisioning_state: str or
~azure.mgmt.servicefabric.models.ProvisioningState
:param reliability_level: The reliability level sets the replica set size
of system services. Learn about
[ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity).
- None - Run the System services with a target replica set count of 1.
This should only be used for test clusters.
- Bronze - Run the System services with a target replica set count of 3.
This should only be used for test clusters.
- Silver - Run the System services with a target replica set count of 5.
- Gold - Run the System services with a target replica set count of 7.
- Platinum - Run the System services with a target replica set count of 9.
. Possible values include: 'None', 'Bronze', 'Silver', 'Gold', 'Platinum'
:type reliability_level: str or ~azure.mgmt.servicefabric.models.enum
:param reverse_proxy_certificate: The server certificate used by reverse
proxy.
:type reverse_proxy_certificate:
~azure.mgmt.servicefabric.models.CertificateDescription
:param reverse_proxy_certificate_common_names: Describes a list of server
certificates referenced by common name that are used to secure the
cluster.
:type reverse_proxy_certificate_common_names:
~azure.mgmt.servicefabric.models.ServerCertificateCommonNames
:param upgrade_description: The policy to use when upgrading the cluster.
:type upgrade_description:
~azure.mgmt.servicefabric.models.ClusterUpgradePolicy
:param upgrade_mode: The upgrade mode of the cluster when new Service
Fabric runtime version is available.
- Automatic - The cluster will be automatically upgraded to the latest
Service Fabric runtime version as soon as it is available.
- Manual - The cluster will not be automatically upgraded to the latest
Service Fabric runtime version. The cluster is upgraded by setting the
**clusterCodeVersion** property in the cluster resource.
. Possible values include: 'Automatic', 'Manual'
:type upgrade_mode: str or ~azure.mgmt.servicefabric.models.enum
:param application_type_versions_cleanup_policy: The policy used to clean
up unused versions.
:type application_type_versions_cleanup_policy:
~azure.mgmt.servicefabric.models.ApplicationTypeVersionsCleanupPolicy
:param vm_image: The VM image VMSS has been configured with. Generic names
such as Windows or Linux can be used.
:type vm_image: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'location': {'required': True},
'etag': {'readonly': True},
'available_cluster_versions': {'readonly': True},
'cluster_endpoint': {'readonly': True},
'cluster_id': {'readonly': True},
'cluster_state': {'readonly': True},
'management_endpoint': {'required': True},
'node_types': {'required': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'etag': {'key': 'etag', 'type': 'str'},
'add_on_features': {'key': 'properties.addOnFeatures', 'type': '[str]'},
'available_cluster_versions': {'key': 'properties.availableClusterVersions', 'type': '[ClusterVersionDetails]'},
'azure_active_directory': {'key': 'properties.azureActiveDirectory', 'type': 'AzureActiveDirectory'},
'certificate': {'key': 'properties.certificate', 'type': 'CertificateDescription'},
'certificate_common_names': {'key': 'properties.certificateCommonNames', 'type': 'ServerCertificateCommonNames'},
'client_certificate_common_names': {'key': 'properties.clientCertificateCommonNames', 'type': '[ClientCertificateCommonName]'},
'client_certificate_thumbprints': {'key': 'properties.clientCertificateThumbprints', 'type': '[ClientCertificateThumbprint]'},
'cluster_code_version': {'key': 'properties.clusterCodeVersion', 'type': 'str'},
'cluster_endpoint': {'key': 'properties.clusterEndpoint', 'type': 'str'},
'cluster_id': {'key': 'properties.clusterId', 'type': 'str'},
'cluster_state': {'key': 'properties.clusterState', 'type': 'str'},
'diagnostics_storage_account_config': {'key': 'properties.diagnosticsStorageAccountConfig', 'type': 'DiagnosticsStorageAccountConfig'},
'event_store_service_enabled': {'key': 'properties.eventStoreServiceEnabled', 'type': 'bool'},
'fabric_settings': {'key': 'properties.fabricSettings', 'type': '[SettingsSectionDescription]'},
'management_endpoint': {'key': 'properties.managementEndpoint', 'type': 'str'},
'node_types': {'key': 'properties.nodeTypes', 'type': '[NodeTypeDescription]'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'reliability_level': {'key': 'properties.reliabilityLevel', 'type': 'str'},
'reverse_proxy_certificate': {'key': 'properties.reverseProxyCertificate', 'type': 'CertificateDescription'},
'reverse_proxy_certificate_common_names': {'key': 'properties.reverseProxyCertificateCommonNames', 'type': 'ServerCertificateCommonNames'},
'upgrade_description': {'key': 'properties.upgradeDescription', 'type': 'ClusterUpgradePolicy'},
'upgrade_mode': {'key': 'properties.upgradeMode', 'type': 'str'},
'application_type_versions_cleanup_policy': {'key': 'properties.applicationTypeVersionsCleanupPolicy', 'type': 'ApplicationTypeVersionsCleanupPolicy'},
'vm_image': {'key': 'properties.vmImage', 'type': 'str'},
}
def __init__(self, *, location: str, management_endpoint: str, node_types, tags=None, add_on_features=None, azure_active_directory=None, certificate=None, certificate_common_names=None, client_certificate_common_names=None, client_certificate_thumbprints=None, cluster_code_version: str=None, diagnostics_storage_account_config=None, event_store_service_enabled: bool=None, fabric_settings=None, reliability_level=None, reverse_proxy_certificate=None, reverse_proxy_certificate_common_names=None, upgrade_description=None, upgrade_mode=None, application_type_versions_cleanup_policy=None, vm_image: str=None, **kwargs) -> None:
super(Cluster, self).__init__(location=location, tags=tags, **kwargs)
self.add_on_features = add_on_features
self.available_cluster_versions = None
self.azure_active_directory = azure_active_directory
self.certificate = certificate
self.certificate_common_names = certificate_common_names
self.client_certificate_common_names = client_certificate_common_names
self.client_certificate_thumbprints = client_certificate_thumbprints
self.cluster_code_version = cluster_code_version
self.cluster_endpoint = None
self.cluster_id = None
self.cluster_state = None
self.diagnostics_storage_account_config = diagnostics_storage_account_config
self.event_store_service_enabled = event_store_service_enabled
self.fabric_settings = fabric_settings
self.management_endpoint = management_endpoint
self.node_types = node_types
self.provisioning_state = None
self.reliability_level = reliability_level
self.reverse_proxy_certificate = reverse_proxy_certificate
self.reverse_proxy_certificate_common_names = reverse_proxy_certificate_common_names
self.upgrade_description = upgrade_description
self.upgrade_mode = upgrade_mode
self.application_type_versions_cleanup_policy = application_type_versions_cleanup_policy
self.vm_image = vm_image
[docs]class ClusterCodeVersionsListResult(Model):
"""The list results of the Service Fabric runtime versions.
:param value:
:type value:
list[~azure.mgmt.servicefabric.models.ClusterCodeVersionsResult]
:param next_link: The URL to use for getting the next set of results.
:type next_link: str
"""
_attribute_map = {
'value': {'key': 'value', 'type': '[ClusterCodeVersionsResult]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(self, *, value=None, next_link: str=None, **kwargs) -> None:
super(ClusterCodeVersionsListResult, self).__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class ClusterCodeVersionsResult(Model):
"""The result of the Service Fabric runtime versions.
:param id: The identification of the result
:type id: str
:param name: The name of the result
:type name: str
:param type: The result resource type
:type type: str
:param code_version: The Service Fabric runtime version of the cluster.
:type code_version: str
:param support_expiry_utc: The date of expiry of support of the version.
:type support_expiry_utc: str
:param environment: Indicates if this version is for Windows or Linux
operating system. Possible values include: 'Windows', 'Linux'
:type environment: str or ~azure.mgmt.servicefabric.models.enum
"""
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'code_version': {'key': 'properties.codeVersion', 'type': 'str'},
'support_expiry_utc': {'key': 'properties.supportExpiryUtc', 'type': 'str'},
'environment': {'key': 'properties.environment', 'type': 'str'},
}
def __init__(self, *, id: str=None, name: str=None, type: str=None, code_version: str=None, support_expiry_utc: str=None, environment=None, **kwargs) -> None:
super(ClusterCodeVersionsResult, self).__init__(**kwargs)
self.id = id
self.name = name
self.type = type
self.code_version = code_version
self.support_expiry_utc = support_expiry_utc
self.environment = environment
[docs]class ClusterHealthPolicy(Model):
"""Defines a health policy used to evaluate the health of the cluster or of a
cluster node.
.
:param max_percent_unhealthy_nodes: The maximum allowed percentage of
unhealthy nodes before reporting an error. For example, to allow 10% of
nodes to be unhealthy, this value would be 10.
The percentage represents the maximum tolerated percentage of nodes that
can be unhealthy before the cluster is considered in error.
If the percentage is respected but there is at least one unhealthy node,
the health is evaluated as Warning.
The percentage is calculated by dividing the number of unhealthy nodes
over the total number of nodes in the cluster.
The computation rounds up to tolerate one failure on small numbers of
nodes. Default percentage is zero.
In large clusters, some nodes will always be down or out for repairs, so
this percentage should be configured to tolerate that.
. Default value: 0 .
:type max_percent_unhealthy_nodes: int
:param max_percent_unhealthy_applications: The maximum allowed percentage
of unhealthy applications before reporting an error. For example, to allow
10% of applications to be unhealthy, this value would be 10.
The percentage represents the maximum tolerated percentage of applications
that can be unhealthy before the cluster is considered in error.
If the percentage is respected but there is at least one unhealthy
application, the health is evaluated as Warning.
This is calculated by dividing the number of unhealthy applications over
the total number of application instances in the cluster, excluding
applications of application types that are included in the
ApplicationTypeHealthPolicyMap.
The computation rounds up to tolerate one failure on small numbers of
applications. Default percentage is zero.
. Default value: 0 .
:type max_percent_unhealthy_applications: int
:param application_health_policies: Defines the application health policy
map used to evaluate the health of an application or one of its children
entities.
:type application_health_policies: dict[str,
~azure.mgmt.servicefabric.models.ApplicationHealthPolicy]
"""
_validation = {
'max_percent_unhealthy_nodes': {'maximum': 100, 'minimum': 0},
'max_percent_unhealthy_applications': {'maximum': 100, 'minimum': 0},
}
_attribute_map = {
'max_percent_unhealthy_nodes': {'key': 'maxPercentUnhealthyNodes', 'type': 'int'},
'max_percent_unhealthy_applications': {'key': 'maxPercentUnhealthyApplications', 'type': 'int'},
'application_health_policies': {'key': 'applicationHealthPolicies', 'type': '{ApplicationHealthPolicy}'},
}
def __init__(self, *, max_percent_unhealthy_nodes: int=0, max_percent_unhealthy_applications: int=0, application_health_policies=None, **kwargs) -> None:
super(ClusterHealthPolicy, self).__init__(**kwargs)
self.max_percent_unhealthy_nodes = max_percent_unhealthy_nodes
self.max_percent_unhealthy_applications = max_percent_unhealthy_applications
self.application_health_policies = application_health_policies
[docs]class ClusterListResult(Model):
"""Cluster list results.
:param value:
:type value: list[~azure.mgmt.servicefabric.models.Cluster]
:param next_link: The URL to use for getting the next set of results.
:type next_link: str
"""
_attribute_map = {
'value': {'key': 'value', 'type': '[Cluster]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(self, *, value=None, next_link: str=None, **kwargs) -> None:
super(ClusterListResult, self).__init__(**kwargs)
self.value = value
self.next_link = next_link
[docs]class ClusterUpdateParameters(Model):
"""Cluster update request.
:param add_on_features: The list of add-on features to enable in the
cluster.
:type add_on_features: list[str]
:param certificate: The certificate to use for securing the cluster. The
certificate provided will be used for node to node security within the
cluster, SSL certificate for cluster management endpoint and default
admin client.
:type certificate: ~azure.mgmt.servicefabric.models.CertificateDescription
:param certificate_common_names: Describes a list of server certificates
referenced by common name that are used to secure the cluster.
:type certificate_common_names:
~azure.mgmt.servicefabric.models.ServerCertificateCommonNames
:param client_certificate_common_names: The list of client certificates
referenced by common name that are allowed to manage the cluster. This
will overwrite the existing list.
:type client_certificate_common_names:
list[~azure.mgmt.servicefabric.models.ClientCertificateCommonName]
:param client_certificate_thumbprints: The list of client certificates
referenced by thumbprint that are allowed to manage the cluster. This will
overwrite the existing list.
:type client_certificate_thumbprints:
list[~azure.mgmt.servicefabric.models.ClientCertificateThumbprint]
:param cluster_code_version: The Service Fabric runtime version of the
cluster. This property can only by set the user when **upgradeMode** is
set to 'Manual'. To get list of available Service Fabric versions for new
clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of
available version for existing clusters use **availableClusterVersions**.
:type cluster_code_version: str
:param event_store_service_enabled: Indicates if the event store service
is enabled.
:type event_store_service_enabled: bool
:param fabric_settings: The list of custom fabric settings to configure
the cluster. This will overwrite the existing list.
:type fabric_settings:
list[~azure.mgmt.servicefabric.models.SettingsSectionDescription]
:param node_types: The list of node types in the cluster. This will
overwrite the existing list.
:type node_types:
list[~azure.mgmt.servicefabric.models.NodeTypeDescription]
:param reliability_level: The reliability level sets the replica set size
of system services. Learn about
[ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity).
- None - Run the System services with a target replica set count of 1.
This should only be used for test clusters.
- Bronze - Run the System services with a target replica set count of 3.
This should only be used for test clusters.
- Silver - Run the System services with a target replica set count of 5.
- Gold - Run the System services with a target replica set count of 7.
- Platinum - Run the System services with a target replica set count of 9.
. Possible values include: 'None', 'Bronze', 'Silver', 'Gold', 'Platinum'
:type reliability_level: str or ~azure.mgmt.servicefabric.models.enum
:param reverse_proxy_certificate: The server certificate used by reverse
proxy.
:type reverse_proxy_certificate:
~azure.mgmt.servicefabric.models.CertificateDescription
:param upgrade_description: The policy to use when upgrading the cluster.
:type upgrade_description:
~azure.mgmt.servicefabric.models.ClusterUpgradePolicy
:param upgrade_mode: The upgrade mode of the cluster when new Service
Fabric runtime version is available.
- Automatic - The cluster will be automatically upgraded to the latest
Service Fabric runtime version as soon as it is available.
- Manual - The cluster will not be automatically upgraded to the latest
Service Fabric runtime version. The cluster is upgraded by setting the
**clusterCodeVersion** property in the cluster resource.
. Possible values include: 'Automatic', 'Manual'
:type upgrade_mode: str or ~azure.mgmt.servicefabric.models.enum
:param application_type_versions_cleanup_policy: The policy used to clean
up unused versions.
:type application_type_versions_cleanup_policy:
~azure.mgmt.servicefabric.models.ApplicationTypeVersionsCleanupPolicy
:param tags: Cluster update parameters
:type tags: dict[str, str]
"""
_attribute_map = {
'add_on_features': {'key': 'properties.addOnFeatures', 'type': '[str]'},
'certificate': {'key': 'properties.certificate', 'type': 'CertificateDescription'},
'certificate_common_names': {'key': 'properties.certificateCommonNames', 'type': 'ServerCertificateCommonNames'},
'client_certificate_common_names': {'key': 'properties.clientCertificateCommonNames', 'type': '[ClientCertificateCommonName]'},
'client_certificate_thumbprints': {'key': 'properties.clientCertificateThumbprints', 'type': '[ClientCertificateThumbprint]'},
'cluster_code_version': {'key': 'properties.clusterCodeVersion', 'type': 'str'},
'event_store_service_enabled': {'key': 'properties.eventStoreServiceEnabled', 'type': 'bool'},
'fabric_settings': {'key': 'properties.fabricSettings', 'type': '[SettingsSectionDescription]'},
'node_types': {'key': 'properties.nodeTypes', 'type': '[NodeTypeDescription]'},
'reliability_level': {'key': 'properties.reliabilityLevel', 'type': 'str'},
'reverse_proxy_certificate': {'key': 'properties.reverseProxyCertificate', 'type': 'CertificateDescription'},
'upgrade_description': {'key': 'properties.upgradeDescription', 'type': 'ClusterUpgradePolicy'},
'upgrade_mode': {'key': 'properties.upgradeMode', 'type': 'str'},
'application_type_versions_cleanup_policy': {'key': 'properties.applicationTypeVersionsCleanupPolicy', 'type': 'ApplicationTypeVersionsCleanupPolicy'},
'tags': {'key': 'tags', 'type': '{str}'},
}
def __init__(self, *, add_on_features=None, certificate=None, certificate_common_names=None, client_certificate_common_names=None, client_certificate_thumbprints=None, cluster_code_version: str=None, event_store_service_enabled: bool=None, fabric_settings=None, node_types=None, reliability_level=None, reverse_proxy_certificate=None, upgrade_description=None, upgrade_mode=None, application_type_versions_cleanup_policy=None, tags=None, **kwargs) -> None:
super(ClusterUpdateParameters, self).__init__(**kwargs)
self.add_on_features = add_on_features
self.certificate = certificate
self.certificate_common_names = certificate_common_names
self.client_certificate_common_names = client_certificate_common_names
self.client_certificate_thumbprints = client_certificate_thumbprints
self.cluster_code_version = cluster_code_version
self.event_store_service_enabled = event_store_service_enabled
self.fabric_settings = fabric_settings
self.node_types = node_types
self.reliability_level = reliability_level
self.reverse_proxy_certificate = reverse_proxy_certificate
self.upgrade_description = upgrade_description
self.upgrade_mode = upgrade_mode
self.application_type_versions_cleanup_policy = application_type_versions_cleanup_policy
self.tags = tags
[docs]class ClusterUpgradeDeltaHealthPolicy(Model):
"""Describes the delta health policies for the cluster upgrade.
All required parameters must be populated in order to send to Azure.
:param max_percent_delta_unhealthy_nodes: Required. The maximum allowed
percentage of nodes health degradation allowed during cluster upgrades.
The delta is measured between the state of the nodes at the beginning of
upgrade and the state of the nodes at the time of the health evaluation.
The check is performed after every upgrade domain upgrade completion to
make sure the global state of the cluster is within tolerated limits.
:type max_percent_delta_unhealthy_nodes: int
:param max_percent_upgrade_domain_delta_unhealthy_nodes: Required. The
maximum allowed percentage of upgrade domain nodes health degradation
allowed during cluster upgrades.
The delta is measured between the state of the upgrade domain nodes at the
beginning of upgrade and the state of the upgrade domain nodes at the time
of the health evaluation.
The check is performed after every upgrade domain upgrade completion for
all completed upgrade domains to make sure the state of the upgrade
domains is within tolerated limits.
:type max_percent_upgrade_domain_delta_unhealthy_nodes: int
:param max_percent_delta_unhealthy_applications: Required. The maximum
allowed percentage of applications health degradation allowed during
cluster upgrades.
The delta is measured between the state of the applications at the
beginning of upgrade and the state of the applications at the time of the
health evaluation.
The check is performed after every upgrade domain upgrade completion to
make sure the global state of the cluster is within tolerated limits.
System services are not included in this.
:type max_percent_delta_unhealthy_applications: int
:param application_delta_health_policies: Defines the application delta
health policy map used to evaluate the health of an application or one of
its child entities when upgrading the cluster.
:type application_delta_health_policies: dict[str,
~azure.mgmt.servicefabric.models.ApplicationDeltaHealthPolicy]
"""
_validation = {
'max_percent_delta_unhealthy_nodes': {'required': True, 'maximum': 100, 'minimum': 0},
'max_percent_upgrade_domain_delta_unhealthy_nodes': {'required': True, 'maximum': 100, 'minimum': 0},
'max_percent_delta_unhealthy_applications': {'required': True, 'maximum': 100, 'minimum': 0},
}
_attribute_map = {
'max_percent_delta_unhealthy_nodes': {'key': 'maxPercentDeltaUnhealthyNodes', 'type': 'int'},
'max_percent_upgrade_domain_delta_unhealthy_nodes': {'key': 'maxPercentUpgradeDomainDeltaUnhealthyNodes', 'type': 'int'},
'max_percent_delta_unhealthy_applications': {'key': 'maxPercentDeltaUnhealthyApplications', 'type': 'int'},
'application_delta_health_policies': {'key': 'applicationDeltaHealthPolicies', 'type': '{ApplicationDeltaHealthPolicy}'},
}
def __init__(self, *, max_percent_delta_unhealthy_nodes: int, max_percent_upgrade_domain_delta_unhealthy_nodes: int, max_percent_delta_unhealthy_applications: int, application_delta_health_policies=None, **kwargs) -> None:
super(ClusterUpgradeDeltaHealthPolicy, self).__init__(**kwargs)
self.max_percent_delta_unhealthy_nodes = max_percent_delta_unhealthy_nodes
self.max_percent_upgrade_domain_delta_unhealthy_nodes = max_percent_upgrade_domain_delta_unhealthy_nodes
self.max_percent_delta_unhealthy_applications = max_percent_delta_unhealthy_applications
self.application_delta_health_policies = application_delta_health_policies
[docs]class ClusterUpgradePolicy(Model):
"""Describes the policy used when upgrading the cluster.
All required parameters must be populated in order to send to Azure.
:param force_restart: If true, then processes are forcefully restarted
during upgrade even when the code version has not changed (the upgrade
only changes configuration or data).
:type force_restart: bool
:param upgrade_replica_set_check_timeout: Required. The maximum amount of
time to block processing of an upgrade domain and prevent loss of
availability when there are unexpected issues. When this timeout expires,
processing of the upgrade domain will proceed regardless of availability
loss issues. The timeout is reset at the start of each upgrade domain. The
timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
:type upgrade_replica_set_check_timeout: str
:param health_check_wait_duration: Required. The length of time to wait
after completing an upgrade domain before performing health checks. The
duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
:type health_check_wait_duration: str
:param health_check_stable_duration: Required. The amount of time that the
application or cluster must remain healthy before the upgrade proceeds to
the next upgrade domain. The duration can be in either hh:mm:ss or in
d.hh:mm:ss.ms format.
:type health_check_stable_duration: str
:param health_check_retry_timeout: Required. The amount of time to retry
health evaluation when the application or cluster is unhealthy before the
upgrade rolls back. The timeout can be in either hh:mm:ss or in
d.hh:mm:ss.ms format.
:type health_check_retry_timeout: str
:param upgrade_timeout: Required. The amount of time the overall upgrade
has to complete before the upgrade rolls back. The timeout can be in
either hh:mm:ss or in d.hh:mm:ss.ms format.
:type upgrade_timeout: str
:param upgrade_domain_timeout: Required. The amount of time each upgrade
domain has to complete before the upgrade rolls back. The timeout can be
in either hh:mm:ss or in d.hh:mm:ss.ms format.
:type upgrade_domain_timeout: str
:param health_policy: Required. The cluster health policy used when
upgrading the cluster.
:type health_policy: ~azure.mgmt.servicefabric.models.ClusterHealthPolicy
:param delta_health_policy: The cluster delta health policy used when
upgrading the cluster.
:type delta_health_policy:
~azure.mgmt.servicefabric.models.ClusterUpgradeDeltaHealthPolicy
"""
_validation = {
'upgrade_replica_set_check_timeout': {'required': True},
'health_check_wait_duration': {'required': True},
'health_check_stable_duration': {'required': True},
'health_check_retry_timeout': {'required': True},
'upgrade_timeout': {'required': True},
'upgrade_domain_timeout': {'required': True},
'health_policy': {'required': True},
}
_attribute_map = {
'force_restart': {'key': 'forceRestart', 'type': 'bool'},
'upgrade_replica_set_check_timeout': {'key': 'upgradeReplicaSetCheckTimeout', 'type': 'str'},
'health_check_wait_duration': {'key': 'healthCheckWaitDuration', 'type': 'str'},
'health_check_stable_duration': {'key': 'healthCheckStableDuration', 'type': 'str'},
'health_check_retry_timeout': {'key': 'healthCheckRetryTimeout', 'type': 'str'},
'upgrade_timeout': {'key': 'upgradeTimeout', 'type': 'str'},
'upgrade_domain_timeout': {'key': 'upgradeDomainTimeout', 'type': 'str'},
'health_policy': {'key': 'healthPolicy', 'type': 'ClusterHealthPolicy'},
'delta_health_policy': {'key': 'deltaHealthPolicy', 'type': 'ClusterUpgradeDeltaHealthPolicy'},
}
def __init__(self, *, upgrade_replica_set_check_timeout: str, health_check_wait_duration: str, health_check_stable_duration: str, health_check_retry_timeout: str, upgrade_timeout: str, upgrade_domain_timeout: str, health_policy, force_restart: bool=None, delta_health_policy=None, **kwargs) -> None:
super(ClusterUpgradePolicy, self).__init__(**kwargs)
self.force_restart = force_restart
self.upgrade_replica_set_check_timeout = upgrade_replica_set_check_timeout
self.health_check_wait_duration = health_check_wait_duration
self.health_check_stable_duration = health_check_stable_duration
self.health_check_retry_timeout = health_check_retry_timeout
self.upgrade_timeout = upgrade_timeout
self.upgrade_domain_timeout = upgrade_domain_timeout
self.health_policy = health_policy
self.delta_health_policy = delta_health_policy
[docs]class ClusterVersionDetails(Model):
"""The detail of the Service Fabric runtime version result.
:param code_version: The Service Fabric runtime version of the cluster.
:type code_version: str
:param support_expiry_utc: The date of expiry of support of the version.
:type support_expiry_utc: str
:param environment: Indicates if this version is for Windows or Linux
operating system. Possible values include: 'Windows', 'Linux'
:type environment: str or ~azure.mgmt.servicefabric.models.enum
"""
_attribute_map = {
'code_version': {'key': 'codeVersion', 'type': 'str'},
'support_expiry_utc': {'key': 'supportExpiryUtc', 'type': 'str'},
'environment': {'key': 'environment', 'type': 'str'},
}
def __init__(self, *, code_version: str=None, support_expiry_utc: str=None, environment=None, **kwargs) -> None:
super(ClusterVersionDetails, self).__init__(**kwargs)
self.code_version = code_version
self.support_expiry_utc = support_expiry_utc
self.environment = environment
[docs]class DiagnosticsStorageAccountConfig(Model):
"""The storage account information for storing Service Fabric diagnostic logs.
All required parameters must be populated in order to send to Azure.
:param storage_account_name: Required. The Azure storage account name.
:type storage_account_name: str
:param protected_account_key_name: Required. The protected diagnostics
storage key name.
:type protected_account_key_name: str
:param protected_account_key_name2: The secondary protected diagnostics
storage key name. If one of the storage account keys is rotated the
cluster will fallback to using the other.
:type protected_account_key_name2: str
:param blob_endpoint: Required. The blob endpoint of the azure storage
account.
:type blob_endpoint: str
:param queue_endpoint: Required. The queue endpoint of the azure storage
account.
:type queue_endpoint: str
:param table_endpoint: Required. The table endpoint of the azure storage
account.
:type table_endpoint: str
"""
_validation = {
'storage_account_name': {'required': True},
'protected_account_key_name': {'required': True},
'blob_endpoint': {'required': True},
'queue_endpoint': {'required': True},
'table_endpoint': {'required': True},
}
_attribute_map = {
'storage_account_name': {'key': 'storageAccountName', 'type': 'str'},
'protected_account_key_name': {'key': 'protectedAccountKeyName', 'type': 'str'},
'protected_account_key_name2': {'key': 'protectedAccountKeyName2', 'type': 'str'},
'blob_endpoint': {'key': 'blobEndpoint', 'type': 'str'},
'queue_endpoint': {'key': 'queueEndpoint', 'type': 'str'},
'table_endpoint': {'key': 'tableEndpoint', 'type': 'str'},
}
def __init__(self, *, storage_account_name: str, protected_account_key_name: str, blob_endpoint: str, queue_endpoint: str, table_endpoint: str, protected_account_key_name2: str=None, **kwargs) -> None:
super(DiagnosticsStorageAccountConfig, self).__init__(**kwargs)
self.storage_account_name = storage_account_name
self.protected_account_key_name = protected_account_key_name
self.protected_account_key_name2 = protected_account_key_name2
self.blob_endpoint = blob_endpoint
self.queue_endpoint = queue_endpoint
self.table_endpoint = table_endpoint
[docs]class EndpointRangeDescription(Model):
"""Port range details.
All required parameters must be populated in order to send to Azure.
:param start_port: Required. Starting port of a range of ports
:type start_port: int
:param end_port: Required. End port of a range of ports
:type end_port: int
"""
_validation = {
'start_port': {'required': True},
'end_port': {'required': True},
}
_attribute_map = {
'start_port': {'key': 'startPort', 'type': 'int'},
'end_port': {'key': 'endPort', 'type': 'int'},
}
def __init__(self, *, start_port: int, end_port: int, **kwargs) -> None:
super(EndpointRangeDescription, self).__init__(**kwargs)
self.start_port = start_port
self.end_port = end_port
[docs]class ErrorModel(Model):
"""The structure of the error.
:param error: The error details.
:type error: ~azure.mgmt.servicefabric.models.ErrorModelError
"""
_attribute_map = {
'error': {'key': 'error', 'type': 'ErrorModelError'},
}
def __init__(self, *, error=None, **kwargs) -> None:
super(ErrorModel, self).__init__(**kwargs)
self.error = error
[docs]class ErrorModelException(HttpOperationError):
"""Server responsed with exception of type: 'ErrorModel'.
:param deserialize: A deserializer
:param response: Server response to be deserialized.
"""
def __init__(self, deserialize, response, *args):
super(ErrorModelException, self).__init__(deserialize, response, 'ErrorModel', *args)
[docs]class ErrorModelError(Model):
"""The error details.
:param code: The error code.
:type code: str
:param message: The error message.
:type message: str
"""
_attribute_map = {
'code': {'key': 'code', 'type': 'str'},
'message': {'key': 'message', 'type': 'str'},
}
def __init__(self, *, code: str=None, message: str=None, **kwargs) -> None:
super(ErrorModelError, self).__init__(**kwargs)
self.code = code
self.message = message
[docs]class LoadBalancingRule(Model):
"""Describes a load balancing rule.
All required parameters must be populated in order to send to Azure.
:param frontend_port: Required. The port for the external endpoint. Port
numbers for each rule must be unique within the Load Balancer. Acceptable
values are between 1 and 65534.
:type frontend_port: int
:param backend_port: Required. The port used for internal connections on
the endpoint. Acceptable values are between 1 and 65535.
:type backend_port: int
:param protocol: Required. The reference to the transport protocol used by
the load balancing rule. Possible values include: 'tcp', 'udp'
:type protocol: str or ~azure.mgmt.servicefabric.models.Protocol
:param probe_protocol: Required. the reference to the load balancer probe
used by the load balancing rule. Possible values include: 'tcp', 'http',
'https'
:type probe_protocol: str or
~azure.mgmt.servicefabric.models.ProbeProtocol
:param probe_request_path: The probe request path. Only supported for
HTTP/HTTPS probes.
:type probe_request_path: str
"""
_validation = {
'frontend_port': {'required': True, 'maximum': 65534, 'minimum': 1},
'backend_port': {'required': True, 'maximum': 65534, 'minimum': 1},
'protocol': {'required': True},
'probe_protocol': {'required': True},
}
_attribute_map = {
'frontend_port': {'key': 'frontendPort', 'type': 'int'},
'backend_port': {'key': 'backendPort', 'type': 'int'},
'protocol': {'key': 'protocol', 'type': 'str'},
'probe_protocol': {'key': 'probeProtocol', 'type': 'str'},
'probe_request_path': {'key': 'probeRequestPath', 'type': 'str'},
}
def __init__(self, *, frontend_port: int, backend_port: int, protocol, probe_protocol, probe_request_path: str=None, **kwargs) -> None:
super(LoadBalancingRule, self).__init__(**kwargs)
self.frontend_port = frontend_port
self.backend_port = backend_port
self.protocol = protocol
self.probe_protocol = probe_protocol
self.probe_request_path = probe_request_path
[docs]class ManagedCluster(Resource):
"""The manged cluster resource
.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: Azure resource identifier.
:vartype id: str
:ivar name: Azure resource name.
:vartype name: str
:ivar type: Azure resource type.
:vartype type: str
:param location: Required. Azure resource location.
:type location: str
:param tags: Azure resource tags.
:type tags: dict[str, str]
:ivar etag: Azure resource etag.
:vartype etag: str
:param dns_name: Required. The cluster dns name.
:type dns_name: str
:ivar fqdn: the cluster Fully qualified domain name.
:vartype fqdn: str
:ivar cluster_id: A service generated unique identifier for the cluster
resource.
:vartype cluster_id: str
:ivar cluster_state: The current state of the cluster.
- WaitingForNodes - Indicates that the cluster resource is created and the
resource provider is waiting for Service Fabric VM extension to boot up
and report to it.
- Deploying - Indicates that the Service Fabric runtime is being installed
on the VMs. Cluster resource will be in this state until the cluster boots
up and system services are up.
- BaselineUpgrade - Indicates that the cluster is upgrading to establishes
the cluster version. This upgrade is automatically initiated when the
cluster boots up for the first time.
- UpdatingUserConfiguration - Indicates that the cluster is being upgraded
with the user provided configuration.
- UpdatingUserCertificate - Indicates that the cluster is being upgraded
with the user provided certificate.
- UpdatingInfrastructure - Indicates that the cluster is being upgraded
with the latest Service Fabric runtime version. This happens only when the
**upgradeMode** is set to 'Automatic'.
- EnforcingClusterVersion - Indicates that cluster is on a different
version than expected and the cluster is being upgraded to the expected
version.
- UpgradeServiceUnreachable - Indicates that the system service in the
cluster is no longer polling the Resource Provider. Clusters in this state
cannot be managed by the Resource Provider.
- AutoScale - Indicates that the ReliabilityLevel of the cluster is being
adjusted.
- Ready - Indicates that the cluster is in a stable state.
. Possible values include: 'WaitingForNodes', 'Deploying',
'BaselineUpgrade', 'UpdatingUserConfiguration', 'UpdatingUserCertificate',
'UpdatingInfrastructure', 'EnforcingClusterVersion',
'UpgradeServiceUnreachable', 'AutoScale', 'Ready'
:vartype cluster_state: str or ~azure.mgmt.servicefabric.models.enum
:ivar cluster_certificate_thumbprint: The cluster certificate thumbprint
used node to node communication.
:vartype cluster_certificate_thumbprint: str
:param client_connection_port: The port used for client connections to the
cluster. Default value: 19000 .
:type client_connection_port: int
:param http_gateway_connection_port: The port used for http connections to
the cluster. Default value: 19080 .
:type http_gateway_connection_port: int
:param admin_user_name: Required. vm admin user name.
:type admin_user_name: str
:param admin_password: vm admin user password.
:type admin_password: str
:param load_balancing_rules: Describes load balancing rules.
:type load_balancing_rules:
list[~azure.mgmt.servicefabric.models.LoadBalancingRule]
:param clients: client certificates for the cluster.
:type clients: list[~azure.mgmt.servicefabric.models.ClientCertificate]
:param azure_active_directory: Azure active directory.
:type azure_active_directory:
~azure.mgmt.servicefabric.models.AzureActiveDirectory
:param fabric_settings: The list of custom fabric settings to configure
the cluster.
:type fabric_settings:
list[~azure.mgmt.servicefabric.models.SettingsSectionDescription]
:param use_test_extension: Use service fabric test vm extension, by
default it's false.
:type use_test_extension: bool
:ivar provisioning_state: The provisioning state of the managed cluster
resource. Possible values include: 'None', 'Creating', 'Created',
'Updating', 'Succeeded', 'Failed', 'Canceled', 'Deleting', 'Deleted',
'Other'
:vartype provisioning_state: str or ~azure.mgmt.servicefabric.models.enum
:param cluster_code_version: The Service Fabric runtime version of the
cluster. This property can only by set the user when **upgradeMode** is
set to 'Manual'. To get list of available Service Fabric versions for new
clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of
available version for existing clusters use **availableClusterVersions**.
:type cluster_code_version: str
:param cluster_upgrade_mode: The upgrade mode of the cluster when new
Service Fabric runtime version is available.
- Automatic - The cluster will be automatically upgraded to the latest
Service Fabric runtime version as soon as it is available.
- Manual - The cluster will not be automatically upgraded to the latest
Service Fabric runtime version. The cluster is upgraded by setting the
**clusterCodeVersion** property in the cluster resource.
. Possible values include: 'Automatic', 'Manual'
:type cluster_upgrade_mode: str or ~azure.mgmt.servicefabric.models.enum
:param cluster_upgrade_description: Describes the policy used when
upgrading the cluster.
:type cluster_upgrade_description:
~azure.mgmt.servicefabric.models.ClusterUpgradePolicy
:param reverse_proxy_endpoint_port: The endpoint used by reverse proxy.
:type reverse_proxy_endpoint_port: int
:param sku: The sku of the managed cluster
:type sku: ~azure.mgmt.servicefabric.models.Sku
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'location': {'required': True},
'etag': {'readonly': True},
'dns_name': {'required': True},
'fqdn': {'readonly': True},
'cluster_id': {'readonly': True},
'cluster_state': {'readonly': True},
'cluster_certificate_thumbprint': {'readonly': True},
'admin_user_name': {'required': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'etag': {'key': 'etag', 'type': 'str'},
'dns_name': {'key': 'properties.dnsName', 'type': 'str'},
'fqdn': {'key': 'properties.fqdn', 'type': 'str'},
'cluster_id': {'key': 'properties.clusterId', 'type': 'str'},
'cluster_state': {'key': 'properties.clusterState', 'type': 'str'},
'cluster_certificate_thumbprint': {'key': 'properties.clusterCertificateThumbprint', 'type': 'str'},
'client_connection_port': {'key': 'properties.clientConnectionPort', 'type': 'int'},
'http_gateway_connection_port': {'key': 'properties.httpGatewayConnectionPort', 'type': 'int'},
'admin_user_name': {'key': 'properties.adminUserName', 'type': 'str'},
'admin_password': {'key': 'properties.adminPassword', 'type': 'str'},
'load_balancing_rules': {'key': 'properties.loadBalancingRules', 'type': '[LoadBalancingRule]'},
'clients': {'key': 'properties.clients', 'type': '[ClientCertificate]'},
'azure_active_directory': {'key': 'properties.azureActiveDirectory', 'type': 'AzureActiveDirectory'},
'fabric_settings': {'key': 'properties.fabricSettings', 'type': '[SettingsSectionDescription]'},
'use_test_extension': {'key': 'properties.useTestExtension', 'type': 'bool'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'cluster_code_version': {'key': 'properties.clusterCodeVersion', 'type': 'str'},
'cluster_upgrade_mode': {'key': 'properties.clusterUpgradeMode', 'type': 'str'},
'cluster_upgrade_description': {'key': 'properties.clusterUpgradeDescription', 'type': 'ClusterUpgradePolicy'},
'reverse_proxy_endpoint_port': {'key': 'properties.reverseProxyEndpointPort', 'type': 'int'},
'sku': {'key': 'sku', 'type': 'Sku'},
}
def __init__(self, *, location: str, dns_name: str, admin_user_name: str, tags=None, client_connection_port: int=19000, http_gateway_connection_port: int=19080, admin_password: str=None, load_balancing_rules=None, clients=None, azure_active_directory=None, fabric_settings=None, use_test_extension: bool=None, cluster_code_version: str=None, cluster_upgrade_mode=None, cluster_upgrade_description=None, reverse_proxy_endpoint_port: int=None, sku=None, **kwargs) -> None:
super(ManagedCluster, self).__init__(location=location, tags=tags, **kwargs)
self.dns_name = dns_name
self.fqdn = None
self.cluster_id = None
self.cluster_state = None
self.cluster_certificate_thumbprint = None
self.client_connection_port = client_connection_port
self.http_gateway_connection_port = http_gateway_connection_port
self.admin_user_name = admin_user_name
self.admin_password = admin_password
self.load_balancing_rules = load_balancing_rules
self.clients = clients
self.azure_active_directory = azure_active_directory
self.fabric_settings = fabric_settings
self.use_test_extension = use_test_extension
self.provisioning_state = None
self.cluster_code_version = cluster_code_version
self.cluster_upgrade_mode = cluster_upgrade_mode
self.cluster_upgrade_description = cluster_upgrade_description
self.reverse_proxy_endpoint_port = reverse_proxy_endpoint_port
self.sku = sku
[docs]class ManagedClusterUpdateParameters(Model):
"""Managed cluster update request.
:param client_connection_port: The port used for client connections to the
cluster.
:type client_connection_port: int
:param http_gateway_connection_port: The port used for http connections to
the cluster.
:type http_gateway_connection_port: int
:param load_balancing_rules: Describes a load balancing rule.
:type load_balancing_rules:
list[~azure.mgmt.servicefabric.models.LoadBalancingRule]
:param clients: client certificates for the cluster.
:type clients: list[~azure.mgmt.servicefabric.models.ClientCertificate]
:param azure_active_directory: Azure active directory.
:type azure_active_directory:
~azure.mgmt.servicefabric.models.AzureActiveDirectory
:param fabric_settings: The list of custom fabric settings to configure
the cluster.
:type fabric_settings:
list[~azure.mgmt.servicefabric.models.SettingsSectionDescription]
:param cluster_code_version: The Service Fabric runtime version of the
cluster. This property can only by set the user when **upgradeMode** is
set to 'Manual'. To get list of available Service Fabric versions for new
clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of
available version for existing clusters use **availableClusterVersions**.
:type cluster_code_version: str
:param cluster_upgrade_mode: The upgrade mode of the cluster when new
Service Fabric runtime version is available.
- Automatic - The cluster will be automatically upgraded to the latest
Service Fabric runtime version as soon as it is available.
- Manual - The cluster will not be automatically upgraded to the latest
Service Fabric runtime version. The cluster is upgraded by setting the
**clusterCodeVersion** property in the cluster resource.
. Possible values include: 'Automatic', 'Manual'
:type cluster_upgrade_mode: str or ~azure.mgmt.servicefabric.models.enum
:param cluster_upgrade_description: Describes the policy used when
upgrading the cluster.
:type cluster_upgrade_description:
~azure.mgmt.servicefabric.models.ClusterUpgradePolicy
:param reverse_proxy_endpoint_port: The endpoint used by reverse proxy.
:type reverse_proxy_endpoint_port: int
:param tags: Managed cluster update parameters
:type tags: dict[str, str]
"""
_attribute_map = {
'client_connection_port': {'key': 'properties.clientConnectionPort', 'type': 'int'},
'http_gateway_connection_port': {'key': 'properties.httpGatewayConnectionPort', 'type': 'int'},
'load_balancing_rules': {'key': 'properties.loadBalancingRules', 'type': '[LoadBalancingRule]'},
'clients': {'key': 'properties.clients', 'type': '[ClientCertificate]'},
'azure_active_directory': {'key': 'properties.azureActiveDirectory', 'type': 'AzureActiveDirectory'},
'fabric_settings': {'key': 'properties.fabricSettings', 'type': '[SettingsSectionDescription]'},
'cluster_code_version': {'key': 'properties.clusterCodeVersion', 'type': 'str'},
'cluster_upgrade_mode': {'key': 'properties.clusterUpgradeMode', 'type': 'str'},
'cluster_upgrade_description': {'key': 'properties.clusterUpgradeDescription', 'type': 'ClusterUpgradePolicy'},
'reverse_proxy_endpoint_port': {'key': 'properties.reverseProxyEndpointPort', 'type': 'int'},
'tags': {'key': 'tags', 'type': '{str}'},
}
def __init__(self, *, client_connection_port: int=None, http_gateway_connection_port: int=None, load_balancing_rules=None, clients=None, azure_active_directory=None, fabric_settings=None, cluster_code_version: str=None, cluster_upgrade_mode=None, cluster_upgrade_description=None, reverse_proxy_endpoint_port: int=None, tags=None, **kwargs) -> None:
super(ManagedClusterUpdateParameters, self).__init__(**kwargs)
self.client_connection_port = client_connection_port
self.http_gateway_connection_port = http_gateway_connection_port
self.load_balancing_rules = load_balancing_rules
self.clients = clients
self.azure_active_directory = azure_active_directory
self.fabric_settings = fabric_settings
self.cluster_code_version = cluster_code_version
self.cluster_upgrade_mode = cluster_upgrade_mode
self.cluster_upgrade_description = cluster_upgrade_description
self.reverse_proxy_endpoint_port = reverse_proxy_endpoint_port
self.tags = tags
[docs]class ManagedClusterVersionDetails(Model):
"""The detail of the Service Fabric runtime version.
:param msi_version: The Service Fabric runtime version of the cluster.
:type msi_version: str
:param support_expiry_utc: The date of expiry of support of the version.
:type support_expiry_utc: str
:param os_type: Indicates the operating system of the cluster. Possible
values include: 'Windows', 'Ubuntu', 'RedHat', 'Ubuntu18_04'
:type os_type: str or ~azure.mgmt.servicefabric.models.enum
"""
_attribute_map = {
'msi_version': {'key': 'msiVersion', 'type': 'str'},
'support_expiry_utc': {'key': 'supportExpiryUtc', 'type': 'str'},
'os_type': {'key': 'osType', 'type': 'str'},
}
def __init__(self, *, msi_version: str=None, support_expiry_utc: str=None, os_type=None, **kwargs) -> None:
super(ManagedClusterVersionDetails, self).__init__(**kwargs)
self.msi_version = msi_version
self.support_expiry_utc = support_expiry_utc
self.os_type = os_type
[docs]class ManagedIdentity(Model):
"""Describes the managed identities for an Azure resource.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar principal_id: The principal id of the managed identity. This
property will only be provided for a system assigned identity.
:vartype principal_id: str
:ivar tenant_id: The tenant id of the managed identity. This property will
only be provided for a system assigned identity.
:vartype tenant_id: str
:param type: The type of managed identity for the resource. Possible
values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned,
UserAssigned', 'None'
:type type: str or ~azure.mgmt.servicefabric.models.ManagedIdentityType
:param user_assigned_identities: The list of user identities associated
with the resource. The user identity dictionary key references will be ARM
resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
:type user_assigned_identities: dict[str,
~azure.mgmt.servicefabric.models.UserAssignedIdentity]
"""
_validation = {
'principal_id': {'readonly': True},
'tenant_id': {'readonly': True},
}
_attribute_map = {
'principal_id': {'key': 'principalId', 'type': 'str'},
'tenant_id': {'key': 'tenantId', 'type': 'str'},
'type': {'key': 'type', 'type': 'ManagedIdentityType'},
'user_assigned_identities': {'key': 'userAssignedIdentities', 'type': '{UserAssignedIdentity}'},
}
def __init__(self, *, type=None, user_assigned_identities=None, **kwargs) -> None:
super(ManagedIdentity, self).__init__(**kwargs)
self.principal_id = None
self.tenant_id = None
self.type = type
self.user_assigned_identities = user_assigned_identities
[docs]class ManagedProxyResource(Model):
"""The resource model definition for proxy-only resource.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: Azure resource identifier.
:vartype id: str
:ivar name: Azure resource name.
:vartype name: str
:ivar type: Azure resource type.
:vartype type: str
:param tags: Azure resource tags.
:type tags: dict[str, str]
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
}
def __init__(self, *, tags=None, **kwargs) -> None:
super(ManagedProxyResource, self).__init__(**kwargs)
self.id = None
self.name = None
self.type = None
self.tags = tags
[docs]class PartitionSchemeDescription(Model):
"""Describes how the service is partitioned.
You probably want to use the sub-classes and not this class directly. Known
sub-classes are: NamedPartitionSchemeDescription,
SingletonPartitionSchemeDescription,
UniformInt64RangePartitionSchemeDescription
All required parameters must be populated in order to send to Azure.
:param partition_scheme: Required. Constant filled by server.
:type partition_scheme: str
"""
_validation = {
'partition_scheme': {'required': True},
}
_attribute_map = {
'partition_scheme': {'key': 'partitionScheme', 'type': 'str'},
}
_subtype_map = {
'partition_scheme': {'Named': 'NamedPartitionSchemeDescription', 'Singleton': 'SingletonPartitionSchemeDescription', 'UniformInt64Range': 'UniformInt64RangePartitionSchemeDescription'}
}
def __init__(self, **kwargs) -> None:
super(PartitionSchemeDescription, self).__init__(**kwargs)
self.partition_scheme = None
[docs]class NamedPartitionSchemeDescription(PartitionSchemeDescription):
"""Describes the named partition scheme of the service.
All required parameters must be populated in order to send to Azure.
:param partition_scheme: Required. Constant filled by server.
:type partition_scheme: str
:param count: Required. The number of partitions.
:type count: int
:param names: Required. Array of size specified by the ‘count’ parameter,
for the names of the partitions.
:type names: list[str]
"""
_validation = {
'partition_scheme': {'required': True},
'count': {'required': True},
'names': {'required': True},
}
_attribute_map = {
'partition_scheme': {'key': 'partitionScheme', 'type': 'str'},
'count': {'key': 'count', 'type': 'int'},
'names': {'key': 'names', 'type': '[str]'},
}
def __init__(self, *, count: int, names, **kwargs) -> None:
super(NamedPartitionSchemeDescription, self).__init__(**kwargs)
self.count = count
self.names = names
self.partition_scheme = 'Named'
[docs]class NodeType(ManagedProxyResource):
"""Describes a node type in the cluster, each node type represents sub set of
nodes in the cluster.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: Azure resource identifier.
:vartype id: str
:ivar name: Azure resource name.
:vartype name: str
:ivar type: Azure resource type.
:vartype type: str
:param tags: Azure resource tags.
:type tags: dict[str, str]
:param is_primary: Required. The node type on which system services will
run. Only one node type should be marked as primary. Primary node type
cannot be deleted or changed for existing clusters.
:type is_primary: bool
:param vm_instance_count: Required. The number of nodes in the node type.
This count should match the capacity property in the corresponding
VirtualMachineScaleSet resource.
:type vm_instance_count: int
:param data_disk_size_gb: Required. Disk size for each vm in the node type
in GBs.
:type data_disk_size_gb: int
:param placement_properties: The placement tags applied to nodes in the
node type, which can be used to indicate where certain services (workload)
should run.
:type placement_properties: dict[str, str]
:param capacities: The capacity tags applied to the nodes in the node
type, the cluster resource manager uses these tags to understand how much
resource a node has.
:type capacities: dict[str, str]
:param application_ports: The range of ports from which cluster assigned
port to Service Fabric applications.
:type application_ports:
~azure.mgmt.servicefabric.models.EndpointRangeDescription
:param ephemeral_ports: The range of ephemeral ports that nodes in this
node type should be configured with.
:type ephemeral_ports:
~azure.mgmt.servicefabric.models.EndpointRangeDescription
:param vm_size: The size of virtual machines in the pool. All virtual
machines in a pool are the same size. For example, Standard_D3.
:type vm_size: str
:param vm_image_publisher: The publisher of the Azure Virtual Machines
Marketplace image. For example, Canonical or MicrosoftWindowsServer.
:type vm_image_publisher: str
:param vm_image_offer: The offer type of the Azure Virtual Machines
Marketplace image. For example, UbuntuServer or WindowsServer.
:type vm_image_offer: str
:param vm_image_sku: The SKU of the Azure Virtual Machines Marketplace
image. For example, 14.04.0-LTS or 2012-R2-Datacenter.
:type vm_image_sku: str
:param vm_image_version: The version of the Azure Virtual Machines
Marketplace image. A value of 'latest' can be specified to select the
latest version of an image. If omitted, the default is 'latest'.
:type vm_image_version: str
:param vm_secrets: virtual machine secretes. The secrets to install in the
virtual machines.
:type vm_secrets: list[~azure.mgmt.servicefabric.models.VaultSecretGroup]
:param vm_extensions: virtual machine extensions. Set of extensions that
should be installed onto the virtual machines.
:type vm_extensions: list[~azure.mgmt.servicefabric.models.VMSSExtension]
:ivar provisioning_state: The provisioning state of the managed cluster
resource. Possible values include: 'None', 'Creating', 'Created',
'Updating', 'Succeeded', 'Failed', 'Canceled', 'Deleting', 'Deleted',
'Other'
:vartype provisioning_state: str or ~azure.mgmt.servicefabric.models.enum
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'is_primary': {'required': True},
'vm_instance_count': {'required': True, 'maximum': 2147483647, 'minimum': 1},
'data_disk_size_gb': {'required': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'is_primary': {'key': 'properties.isPrimary', 'type': 'bool'},
'vm_instance_count': {'key': 'properties.vmInstanceCount', 'type': 'int'},
'data_disk_size_gb': {'key': 'properties.dataDiskSizeGB', 'type': 'int'},
'placement_properties': {'key': 'properties.placementProperties', 'type': '{str}'},
'capacities': {'key': 'properties.capacities', 'type': '{str}'},
'application_ports': {'key': 'properties.applicationPorts', 'type': 'EndpointRangeDescription'},
'ephemeral_ports': {'key': 'properties.ephemeralPorts', 'type': 'EndpointRangeDescription'},
'vm_size': {'key': 'properties.vmSize', 'type': 'str'},
'vm_image_publisher': {'key': 'properties.vmImagePublisher', 'type': 'str'},
'vm_image_offer': {'key': 'properties.vmImageOffer', 'type': 'str'},
'vm_image_sku': {'key': 'properties.vmImageSku', 'type': 'str'},
'vm_image_version': {'key': 'properties.vmImageVersion', 'type': 'str'},
'vm_secrets': {'key': 'properties.vmSecrets', 'type': '[VaultSecretGroup]'},
'vm_extensions': {'key': 'properties.vmExtensions', 'type': '[VMSSExtension]'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
}
def __init__(self, *, is_primary: bool, vm_instance_count: int, data_disk_size_gb: int, tags=None, placement_properties=None, capacities=None, application_ports=None, ephemeral_ports=None, vm_size: str=None, vm_image_publisher: str=None, vm_image_offer: str=None, vm_image_sku: str=None, vm_image_version: str=None, vm_secrets=None, vm_extensions=None, **kwargs) -> None:
super(NodeType, self).__init__(tags=tags, **kwargs)
self.is_primary = is_primary
self.vm_instance_count = vm_instance_count
self.data_disk_size_gb = data_disk_size_gb
self.placement_properties = placement_properties
self.capacities = capacities
self.application_ports = application_ports
self.ephemeral_ports = ephemeral_ports
self.vm_size = vm_size
self.vm_image_publisher = vm_image_publisher
self.vm_image_offer = vm_image_offer
self.vm_image_sku = vm_image_sku
self.vm_image_version = vm_image_version
self.vm_secrets = vm_secrets
self.vm_extensions = vm_extensions
self.provisioning_state = None
[docs]class NodeTypeActionParameters(Model):
"""Parameters for Node type action.
All required parameters must be populated in order to send to Azure.
:param nodes: Required. List of node names from the node type.
:type nodes: list[str]
:param force: Force the action to go through.
:type force: bool
"""
_validation = {
'nodes': {'required': True},
}
_attribute_map = {
'nodes': {'key': 'nodes', 'type': '[str]'},
'force': {'key': 'force', 'type': 'bool'},
}
def __init__(self, *, nodes, force: bool=None, **kwargs) -> None:
super(NodeTypeActionParameters, self).__init__(**kwargs)
self.nodes = nodes
self.force = force
[docs]class NodeTypeDescription(Model):
"""Describes a node type in the cluster, each node type represents sub set of
nodes in the cluster.
All required parameters must be populated in order to send to Azure.
:param name: Required. The name of the node type.
:type name: str
:param placement_properties: The placement tags applied to nodes in the
node type, which can be used to indicate where certain services (workload)
should run.
:type placement_properties: dict[str, str]
:param capacities: The capacity tags applied to the nodes in the node
type, the cluster resource manager uses these tags to understand how much
resource a node has.
:type capacities: dict[str, str]
:param client_connection_endpoint_port: Required. The TCP cluster
management endpoint port.
:type client_connection_endpoint_port: int
:param http_gateway_endpoint_port: Required. The HTTP cluster management
endpoint port.
:type http_gateway_endpoint_port: int
:param durability_level: The durability level of the node type. Learn
about
[DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity).
- Bronze - No privileges. This is the default.
- Silver - The infrastructure jobs can be paused for a duration of 10
minutes per UD.
- Gold - The infrastructure jobs can be paused for a duration of 2 hours
per UD. Gold durability can be enabled only on full node VM skus like
D15_V2, G5 etc.
. Possible values include: 'Bronze', 'Silver', 'Gold'
:type durability_level: str or ~azure.mgmt.servicefabric.models.enum
:param application_ports: The range of ports from which cluster assigned
port to Service Fabric applications.
:type application_ports:
~azure.mgmt.servicefabric.models.EndpointRangeDescription
:param ephemeral_ports: The range of ephemeral ports that nodes in this
node type should be configured with.
:type ephemeral_ports:
~azure.mgmt.servicefabric.models.EndpointRangeDescription
:param is_primary: Required. The node type on which system services will
run. Only one node type should be marked as primary. Primary node type
cannot be deleted or changed for existing clusters.
:type is_primary: bool
:param vm_instance_count: Required. The number of nodes in the node type.
This count should match the capacity property in the corresponding
VirtualMachineScaleSet resource.
:type vm_instance_count: int
:param reverse_proxy_endpoint_port: The endpoint used by reverse proxy.
:type reverse_proxy_endpoint_port: int
"""
_validation = {
'name': {'required': True},
'client_connection_endpoint_port': {'required': True},
'http_gateway_endpoint_port': {'required': True},
'is_primary': {'required': True},
'vm_instance_count': {'required': True, 'maximum': 2147483647, 'minimum': 1},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'placement_properties': {'key': 'placementProperties', 'type': '{str}'},
'capacities': {'key': 'capacities', 'type': '{str}'},
'client_connection_endpoint_port': {'key': 'clientConnectionEndpointPort', 'type': 'int'},
'http_gateway_endpoint_port': {'key': 'httpGatewayEndpointPort', 'type': 'int'},
'durability_level': {'key': 'durabilityLevel', 'type': 'str'},
'application_ports': {'key': 'applicationPorts', 'type': 'EndpointRangeDescription'},
'ephemeral_ports': {'key': 'ephemeralPorts', 'type': 'EndpointRangeDescription'},
'is_primary': {'key': 'isPrimary', 'type': 'bool'},
'vm_instance_count': {'key': 'vmInstanceCount', 'type': 'int'},
'reverse_proxy_endpoint_port': {'key': 'reverseProxyEndpointPort', 'type': 'int'},
}
def __init__(self, *, name: str, client_connection_endpoint_port: int, http_gateway_endpoint_port: int, is_primary: bool, vm_instance_count: int, placement_properties=None, capacities=None, durability_level=None, application_ports=None, ephemeral_ports=None, reverse_proxy_endpoint_port: int=None, **kwargs) -> None:
super(NodeTypeDescription, self).__init__(**kwargs)
self.name = name
self.placement_properties = placement_properties
self.capacities = capacities
self.client_connection_endpoint_port = client_connection_endpoint_port
self.http_gateway_endpoint_port = http_gateway_endpoint_port
self.durability_level = durability_level
self.application_ports = application_ports
self.ephemeral_ports = ephemeral_ports
self.is_primary = is_primary
self.vm_instance_count = vm_instance_count
self.reverse_proxy_endpoint_port = reverse_proxy_endpoint_port
[docs]class NodeTypeUpdateParameters(Model):
"""Node type update request.
:param vm_instance_count: The number of nodes in the node type. This count
should match the capacity property in the corresponding
VirtualMachineScaleSet resource.
:type vm_instance_count: int
:param placement_properties: The placement tags applied to nodes in the
node type, which can be used to indicate where certain services (workload)
should run.
:type placement_properties: dict[str, str]
:param capacities: The capacity tags applied to the nodes in the node
type, the cluster resource manager uses these tags to understand how much
resource a node has.
:type capacities: dict[str, str]
:param application_ports: The range of ports from which cluster assigned
port to Service Fabric applications.
:type application_ports:
~azure.mgmt.servicefabric.models.EndpointRangeDescription
:param ephemeral_ports: The range of ephemeral ports that nodes in this
node type should be configured with.
:type ephemeral_ports:
~azure.mgmt.servicefabric.models.EndpointRangeDescription
:param vm_secrets: virtual machine secretes. The secrets to install in the
virtual machines.
:type vm_secrets: list[~azure.mgmt.servicefabric.models.VaultSecretGroup]
:param vm_extensions: virtual machine extensions. Set of extensions that
should be installed onto the virtual machines.
:type vm_extensions: list[~azure.mgmt.servicefabric.models.VMSSExtension]
:param tags: Node type update parameters
:type tags: dict[str, str]
"""
_validation = {
'vm_instance_count': {'maximum': 2147483647, 'minimum': 1},
}
_attribute_map = {
'vm_instance_count': {'key': 'properties.vmInstanceCount', 'type': 'int'},
'placement_properties': {'key': 'properties.placementProperties', 'type': '{str}'},
'capacities': {'key': 'properties.capacities', 'type': '{str}'},
'application_ports': {'key': 'properties.applicationPorts', 'type': 'EndpointRangeDescription'},
'ephemeral_ports': {'key': 'properties.ephemeralPorts', 'type': 'EndpointRangeDescription'},
'vm_secrets': {'key': 'properties.vmSecrets', 'type': '[VaultSecretGroup]'},
'vm_extensions': {'key': 'properties.vmExtensions', 'type': '[VMSSExtension]'},
'tags': {'key': 'tags', 'type': '{str}'},
}
def __init__(self, *, vm_instance_count: int=None, placement_properties=None, capacities=None, application_ports=None, ephemeral_ports=None, vm_secrets=None, vm_extensions=None, tags=None, **kwargs) -> None:
super(NodeTypeUpdateParameters, self).__init__(**kwargs)
self.vm_instance_count = vm_instance_count
self.placement_properties = placement_properties
self.capacities = capacities
self.application_ports = application_ports
self.ephemeral_ports = ephemeral_ports
self.vm_secrets = vm_secrets
self.vm_extensions = vm_extensions
self.tags = tags
[docs]class OperationResult(Model):
"""Available operation list result.
:param name: The name of the operation.
:type name: str
:param display: The object that represents the operation.
:type display: ~azure.mgmt.servicefabric.models.AvailableOperationDisplay
:param origin: Origin result
:type origin: str
:param next_link: The URL to use for getting the next set of results.
:type next_link: str
"""
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'display': {'key': 'display', 'type': 'AvailableOperationDisplay'},
'origin': {'key': 'origin', 'type': 'str'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(self, *, name: str=None, display=None, origin: str=None, next_link: str=None, **kwargs) -> None:
super(OperationResult, self).__init__(**kwargs)
self.name = name
self.display = display
self.origin = origin
self.next_link = next_link
[docs]class ServerCertificateCommonName(Model):
"""Describes the server certificate details using common name.
All required parameters must be populated in order to send to Azure.
:param certificate_common_name: Required. The common name of the server
certificate.
:type certificate_common_name: str
:param certificate_issuer_thumbprint: Required. The issuer thumbprint of
the server certificate.
:type certificate_issuer_thumbprint: str
"""
_validation = {
'certificate_common_name': {'required': True},
'certificate_issuer_thumbprint': {'required': True},
}
_attribute_map = {
'certificate_common_name': {'key': 'certificateCommonName', 'type': 'str'},
'certificate_issuer_thumbprint': {'key': 'certificateIssuerThumbprint', 'type': 'str'},
}
def __init__(self, *, certificate_common_name: str, certificate_issuer_thumbprint: str, **kwargs) -> None:
super(ServerCertificateCommonName, self).__init__(**kwargs)
self.certificate_common_name = certificate_common_name
self.certificate_issuer_thumbprint = certificate_issuer_thumbprint
[docs]class ServerCertificateCommonNames(Model):
"""Describes a list of server certificates referenced by common name that are
used to secure the cluster.
:param common_names: The list of server certificates referenced by common
name that are used to secure the cluster.
:type common_names:
list[~azure.mgmt.servicefabric.models.ServerCertificateCommonName]
:param x509_store_name: The local certificate store location. Possible
values include: 'AddressBook', 'AuthRoot', 'CertificateAuthority',
'Disallowed', 'My', 'Root', 'TrustedPeople', 'TrustedPublisher'
:type x509_store_name: str or ~azure.mgmt.servicefabric.models.enum
"""
_attribute_map = {
'common_names': {'key': 'commonNames', 'type': '[ServerCertificateCommonName]'},
'x509_store_name': {'key': 'x509StoreName', 'type': 'str'},
}
def __init__(self, *, common_names=None, x509_store_name=None, **kwargs) -> None:
super(ServerCertificateCommonNames, self).__init__(**kwargs)
self.common_names = common_names
self.x509_store_name = x509_store_name
[docs]class ServiceCorrelationDescription(Model):
"""Creates a particular correlation between services.
All required parameters must be populated in order to send to Azure.
:param scheme: Required. The ServiceCorrelationScheme which describes the
relationship between this service and the service specified via
ServiceName. Possible values include: 'Invalid', 'Affinity',
'AlignedAffinity', 'NonAlignedAffinity'
:type scheme: str or
~azure.mgmt.servicefabric.models.ServiceCorrelationScheme
:param service_name: Required. The name of the service that the
correlation relationship is established with.
:type service_name: str
"""
_validation = {
'scheme': {'required': True},
'service_name': {'required': True},
}
_attribute_map = {
'scheme': {'key': 'scheme', 'type': 'str'},
'service_name': {'key': 'serviceName', 'type': 'str'},
}
def __init__(self, *, scheme, service_name: str, **kwargs) -> None:
super(ServiceCorrelationDescription, self).__init__(**kwargs)
self.scheme = scheme
self.service_name = service_name
[docs]class ServiceLoadMetricDescription(Model):
"""Specifies a metric to load balance a service during runtime.
All required parameters must be populated in order to send to Azure.
:param name: Required. The name of the metric. If the service chooses to
report load during runtime, the load metric name should match the name
that is specified in Name exactly. Note that metric names are case
sensitive.
:type name: str
:param weight: The service load metric relative weight, compared to other
metrics configured for this service, as a number. Possible values include:
'Zero', 'Low', 'Medium', 'High'
:type weight: str or
~azure.mgmt.servicefabric.models.ServiceLoadMetricWeight
:param primary_default_load: Used only for Stateful services. The default
amount of load, as a number, that this service creates for this metric
when it is a Primary replica.
:type primary_default_load: int
:param secondary_default_load: Used only for Stateful services. The
default amount of load, as a number, that this service creates for this
metric when it is a Secondary replica.
:type secondary_default_load: int
:param default_load: Used only for Stateless services. The default amount
of load, as a number, that this service creates for this metric.
:type default_load: int
"""
_validation = {
'name': {'required': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'weight': {'key': 'weight', 'type': 'str'},
'primary_default_load': {'key': 'primaryDefaultLoad', 'type': 'int'},
'secondary_default_load': {'key': 'secondaryDefaultLoad', 'type': 'int'},
'default_load': {'key': 'defaultLoad', 'type': 'int'},
}
def __init__(self, *, name: str, weight=None, primary_default_load: int=None, secondary_default_load: int=None, default_load: int=None, **kwargs) -> None:
super(ServiceLoadMetricDescription, self).__init__(**kwargs)
self.name = name
self.weight = weight
self.primary_default_load = primary_default_load
self.secondary_default_load = secondary_default_load
self.default_load = default_load
[docs]class ServicePlacementPolicyDescription(Model):
"""Describes the policy to be used for placement of a Service Fabric service.
All required parameters must be populated in order to send to Azure.
:param type: Required. Constant filled by server.
:type type: str
"""
_validation = {
'type': {'required': True},
}
_attribute_map = {
'type': {'key': 'type', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(ServicePlacementPolicyDescription, self).__init__(**kwargs)
self.type = None
[docs]class ServiceResource(ProxyResource):
"""The service resource.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: Azure resource identifier.
:vartype id: str
:ivar name: Azure resource name.
:vartype name: str
:ivar type: Azure resource type.
:vartype type: str
:param location: It will be deprecated in New API, resource location
depends on the parent resource.
:type location: str
:param tags: Azure resource tags.
:type tags: dict[str, str]
:ivar etag: Azure resource etag.
:vartype etag: str
:param placement_constraints: The placement constraints as a string.
Placement constraints are boolean expressions on node properties and allow
for restricting a service to particular nodes based on the service
requirements. For example, to place a service on nodes where NodeType is
blue specify the following: "NodeColor == blue)".
:type placement_constraints: str
:param correlation_scheme: A list that describes the correlation of the
service with other services.
:type correlation_scheme:
list[~azure.mgmt.servicefabric.models.ServiceCorrelationDescription]
:param service_load_metrics: The service load metrics is given as an array
of ServiceLoadMetricDescription objects.
:type service_load_metrics:
list[~azure.mgmt.servicefabric.models.ServiceLoadMetricDescription]
:param service_placement_policies: A list that describes the correlation
of the service with other services.
:type service_placement_policies:
list[~azure.mgmt.servicefabric.models.ServicePlacementPolicyDescription]
:param default_move_cost: Specifies the move cost for the service.
Possible values include: 'Zero', 'Low', 'Medium', 'High'
:type default_move_cost: str or ~azure.mgmt.servicefabric.models.MoveCost
:ivar provisioning_state: The current deployment or provisioning state,
which only appears in the response
:vartype provisioning_state: str
:param service_type_name: The name of the service type
:type service_type_name: str
:param partition_description: Describes how the service is partitioned.
:type partition_description:
~azure.mgmt.servicefabric.models.PartitionSchemeDescription
:param service_package_activation_mode: The activation Mode of the service
package. Possible values include: 'SharedProcess', 'ExclusiveProcess'
:type service_package_activation_mode: str or
~azure.mgmt.servicefabric.models.ArmServicePackageActivationMode
:param service_dns_name: Dns name used for the service. If this is
specified, then the service can be accessed via its DNS name instead of
service name.
:type service_dns_name: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'etag': {'readonly': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'etag': {'key': 'etag', 'type': 'str'},
'placement_constraints': {'key': 'properties.placementConstraints', 'type': 'str'},
'correlation_scheme': {'key': 'properties.correlationScheme', 'type': '[ServiceCorrelationDescription]'},
'service_load_metrics': {'key': 'properties.serviceLoadMetrics', 'type': '[ServiceLoadMetricDescription]'},
'service_placement_policies': {'key': 'properties.servicePlacementPolicies', 'type': '[ServicePlacementPolicyDescription]'},
'default_move_cost': {'key': 'properties.defaultMoveCost', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'service_type_name': {'key': 'properties.serviceTypeName', 'type': 'str'},
'partition_description': {'key': 'properties.partitionDescription', 'type': 'PartitionSchemeDescription'},
'service_package_activation_mode': {'key': 'properties.servicePackageActivationMode', 'type': 'str'},
'service_dns_name': {'key': 'properties.serviceDnsName', 'type': 'str'},
}
def __init__(self, *, location: str=None, tags=None, placement_constraints: str=None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, service_type_name: str=None, partition_description=None, service_package_activation_mode=None, service_dns_name: str=None, **kwargs) -> None:
super(ServiceResource, self).__init__(location=location, tags=tags, **kwargs)
self.placement_constraints = placement_constraints
self.correlation_scheme = correlation_scheme
self.service_load_metrics = service_load_metrics
self.service_placement_policies = service_placement_policies
self.default_move_cost = default_move_cost
self.provisioning_state = None
self.service_type_name = service_type_name
self.partition_description = partition_description
self.service_package_activation_mode = service_package_activation_mode
self.service_dns_name = service_dns_name
[docs]class ServiceResourceList(Model):
"""The list of service resources.
Variables are only populated by the server, and will be ignored when
sending a request.
:param value:
:type value: list[~azure.mgmt.servicefabric.models.ServiceResource]
:ivar next_link: URL to get the next set of service list results if there
are any.
:vartype next_link: str
"""
_validation = {
'next_link': {'readonly': True},
}
_attribute_map = {
'value': {'key': 'value', 'type': '[ServiceResource]'},
'next_link': {'key': 'nextLink', 'type': 'str'},
}
def __init__(self, *, value=None, **kwargs) -> None:
super(ServiceResourceList, self).__init__(**kwargs)
self.value = value
self.next_link = None
[docs]class ServiceResourcePropertiesBase(Model):
"""The common service resource properties.
:param placement_constraints: The placement constraints as a string.
Placement constraints are boolean expressions on node properties and allow
for restricting a service to particular nodes based on the service
requirements. For example, to place a service on nodes where NodeType is
blue specify the following: "NodeColor == blue)".
:type placement_constraints: str
:param correlation_scheme: A list that describes the correlation of the
service with other services.
:type correlation_scheme:
list[~azure.mgmt.servicefabric.models.ServiceCorrelationDescription]
:param service_load_metrics: The service load metrics is given as an array
of ServiceLoadMetricDescription objects.
:type service_load_metrics:
list[~azure.mgmt.servicefabric.models.ServiceLoadMetricDescription]
:param service_placement_policies: A list that describes the correlation
of the service with other services.
:type service_placement_policies:
list[~azure.mgmt.servicefabric.models.ServicePlacementPolicyDescription]
:param default_move_cost: Specifies the move cost for the service.
Possible values include: 'Zero', 'Low', 'Medium', 'High'
:type default_move_cost: str or ~azure.mgmt.servicefabric.models.MoveCost
"""
_attribute_map = {
'placement_constraints': {'key': 'placementConstraints', 'type': 'str'},
'correlation_scheme': {'key': 'correlationScheme', 'type': '[ServiceCorrelationDescription]'},
'service_load_metrics': {'key': 'serviceLoadMetrics', 'type': '[ServiceLoadMetricDescription]'},
'service_placement_policies': {'key': 'servicePlacementPolicies', 'type': '[ServicePlacementPolicyDescription]'},
'default_move_cost': {'key': 'defaultMoveCost', 'type': 'str'},
}
def __init__(self, *, placement_constraints: str=None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, **kwargs) -> None:
super(ServiceResourcePropertiesBase, self).__init__(**kwargs)
self.placement_constraints = placement_constraints
self.correlation_scheme = correlation_scheme
self.service_load_metrics = service_load_metrics
self.service_placement_policies = service_placement_policies
self.default_move_cost = default_move_cost
[docs]class ServiceResourceProperties(ServiceResourcePropertiesBase):
"""The service resource properties.
You probably want to use the sub-classes and not this class directly. Known
sub-classes are: StatefulServiceProperties, StatelessServiceProperties
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:param placement_constraints: The placement constraints as a string.
Placement constraints are boolean expressions on node properties and allow
for restricting a service to particular nodes based on the service
requirements. For example, to place a service on nodes where NodeType is
blue specify the following: "NodeColor == blue)".
:type placement_constraints: str
:param correlation_scheme: A list that describes the correlation of the
service with other services.
:type correlation_scheme:
list[~azure.mgmt.servicefabric.models.ServiceCorrelationDescription]
:param service_load_metrics: The service load metrics is given as an array
of ServiceLoadMetricDescription objects.
:type service_load_metrics:
list[~azure.mgmt.servicefabric.models.ServiceLoadMetricDescription]
:param service_placement_policies: A list that describes the correlation
of the service with other services.
:type service_placement_policies:
list[~azure.mgmt.servicefabric.models.ServicePlacementPolicyDescription]
:param default_move_cost: Specifies the move cost for the service.
Possible values include: 'Zero', 'Low', 'Medium', 'High'
:type default_move_cost: str or ~azure.mgmt.servicefabric.models.MoveCost
:ivar provisioning_state: The current deployment or provisioning state,
which only appears in the response
:vartype provisioning_state: str
:param service_type_name: The name of the service type
:type service_type_name: str
:param partition_description: Describes how the service is partitioned.
:type partition_description:
~azure.mgmt.servicefabric.models.PartitionSchemeDescription
:param service_package_activation_mode: The activation Mode of the service
package. Possible values include: 'SharedProcess', 'ExclusiveProcess'
:type service_package_activation_mode: str or
~azure.mgmt.servicefabric.models.ArmServicePackageActivationMode
:param service_dns_name: Dns name used for the service. If this is
specified, then the service can be accessed via its DNS name instead of
service name.
:type service_dns_name: str
:param service_kind: Required. Constant filled by server.
:type service_kind: str
"""
_validation = {
'provisioning_state': {'readonly': True},
'service_kind': {'required': True},
}
_attribute_map = {
'placement_constraints': {'key': 'placementConstraints', 'type': 'str'},
'correlation_scheme': {'key': 'correlationScheme', 'type': '[ServiceCorrelationDescription]'},
'service_load_metrics': {'key': 'serviceLoadMetrics', 'type': '[ServiceLoadMetricDescription]'},
'service_placement_policies': {'key': 'servicePlacementPolicies', 'type': '[ServicePlacementPolicyDescription]'},
'default_move_cost': {'key': 'defaultMoveCost', 'type': 'str'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
'service_type_name': {'key': 'serviceTypeName', 'type': 'str'},
'partition_description': {'key': 'partitionDescription', 'type': 'PartitionSchemeDescription'},
'service_package_activation_mode': {'key': 'servicePackageActivationMode', 'type': 'str'},
'service_dns_name': {'key': 'serviceDnsName', 'type': 'str'},
'service_kind': {'key': 'serviceKind', 'type': 'str'},
}
_subtype_map = {
'service_kind': {'Stateful': 'StatefulServiceProperties', 'Stateless': 'StatelessServiceProperties'}
}
def __init__(self, *, placement_constraints: str=None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, service_type_name: str=None, partition_description=None, service_package_activation_mode=None, service_dns_name: str=None, **kwargs) -> None:
super(ServiceResourceProperties, self).__init__(placement_constraints=placement_constraints, correlation_scheme=correlation_scheme, service_load_metrics=service_load_metrics, service_placement_policies=service_placement_policies, default_move_cost=default_move_cost, **kwargs)
self.provisioning_state = None
self.service_type_name = service_type_name
self.partition_description = partition_description
self.service_package_activation_mode = service_package_activation_mode
self.service_dns_name = service_dns_name
self.service_kind = None
self.service_kind = 'ServiceResourceProperties'
[docs]class ServiceResourceUpdate(ProxyResource):
"""The service resource for patch operations.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: Azure resource identifier.
:vartype id: str
:ivar name: Azure resource name.
:vartype name: str
:ivar type: Azure resource type.
:vartype type: str
:param location: It will be deprecated in New API, resource location
depends on the parent resource.
:type location: str
:param tags: Azure resource tags.
:type tags: dict[str, str]
:ivar etag: Azure resource etag.
:vartype etag: str
:param placement_constraints: The placement constraints as a string.
Placement constraints are boolean expressions on node properties and allow
for restricting a service to particular nodes based on the service
requirements. For example, to place a service on nodes where NodeType is
blue specify the following: "NodeColor == blue)".
:type placement_constraints: str
:param correlation_scheme: A list that describes the correlation of the
service with other services.
:type correlation_scheme:
list[~azure.mgmt.servicefabric.models.ServiceCorrelationDescription]
:param service_load_metrics: The service load metrics is given as an array
of ServiceLoadMetricDescription objects.
:type service_load_metrics:
list[~azure.mgmt.servicefabric.models.ServiceLoadMetricDescription]
:param service_placement_policies: A list that describes the correlation
of the service with other services.
:type service_placement_policies:
list[~azure.mgmt.servicefabric.models.ServicePlacementPolicyDescription]
:param default_move_cost: Specifies the move cost for the service.
Possible values include: 'Zero', 'Low', 'Medium', 'High'
:type default_move_cost: str or ~azure.mgmt.servicefabric.models.MoveCost
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'etag': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'etag': {'key': 'etag', 'type': 'str'},
'placement_constraints': {'key': 'properties.placementConstraints', 'type': 'str'},
'correlation_scheme': {'key': 'properties.correlationScheme', 'type': '[ServiceCorrelationDescription]'},
'service_load_metrics': {'key': 'properties.serviceLoadMetrics', 'type': '[ServiceLoadMetricDescription]'},
'service_placement_policies': {'key': 'properties.servicePlacementPolicies', 'type': '[ServicePlacementPolicyDescription]'},
'default_move_cost': {'key': 'properties.defaultMoveCost', 'type': 'str'},
}
def __init__(self, *, location: str=None, tags=None, placement_constraints: str=None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, **kwargs) -> None:
super(ServiceResourceUpdate, self).__init__(location=location, tags=tags, **kwargs)
self.placement_constraints = placement_constraints
self.correlation_scheme = correlation_scheme
self.service_load_metrics = service_load_metrics
self.service_placement_policies = service_placement_policies
self.default_move_cost = default_move_cost
[docs]class ServiceResourceUpdateProperties(ServiceResourcePropertiesBase):
"""The service resource properties for patch operations.
You probably want to use the sub-classes and not this class directly. Known
sub-classes are: StatefulServiceUpdateProperties,
StatelessServiceUpdateProperties
All required parameters must be populated in order to send to Azure.
:param placement_constraints: The placement constraints as a string.
Placement constraints are boolean expressions on node properties and allow
for restricting a service to particular nodes based on the service
requirements. For example, to place a service on nodes where NodeType is
blue specify the following: "NodeColor == blue)".
:type placement_constraints: str
:param correlation_scheme: A list that describes the correlation of the
service with other services.
:type correlation_scheme:
list[~azure.mgmt.servicefabric.models.ServiceCorrelationDescription]
:param service_load_metrics: The service load metrics is given as an array
of ServiceLoadMetricDescription objects.
:type service_load_metrics:
list[~azure.mgmt.servicefabric.models.ServiceLoadMetricDescription]
:param service_placement_policies: A list that describes the correlation
of the service with other services.
:type service_placement_policies:
list[~azure.mgmt.servicefabric.models.ServicePlacementPolicyDescription]
:param default_move_cost: Specifies the move cost for the service.
Possible values include: 'Zero', 'Low', 'Medium', 'High'
:type default_move_cost: str or ~azure.mgmt.servicefabric.models.MoveCost
:param service_kind: Required. Constant filled by server.
:type service_kind: str
"""
_validation = {
'service_kind': {'required': True},
}
_attribute_map = {
'placement_constraints': {'key': 'placementConstraints', 'type': 'str'},
'correlation_scheme': {'key': 'correlationScheme', 'type': '[ServiceCorrelationDescription]'},
'service_load_metrics': {'key': 'serviceLoadMetrics', 'type': '[ServiceLoadMetricDescription]'},
'service_placement_policies': {'key': 'servicePlacementPolicies', 'type': '[ServicePlacementPolicyDescription]'},
'default_move_cost': {'key': 'defaultMoveCost', 'type': 'str'},
'service_kind': {'key': 'serviceKind', 'type': 'str'},
}
_subtype_map = {
'service_kind': {'Stateful': 'StatefulServiceUpdateProperties', 'Stateless': 'StatelessServiceUpdateProperties'}
}
def __init__(self, *, placement_constraints: str=None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, **kwargs) -> None:
super(ServiceResourceUpdateProperties, self).__init__(placement_constraints=placement_constraints, correlation_scheme=correlation_scheme, service_load_metrics=service_load_metrics, service_placement_policies=service_placement_policies, default_move_cost=default_move_cost, **kwargs)
self.service_kind = None
self.service_kind = 'ServiceResourceUpdateProperties'
[docs]class ServiceTypeDeltaHealthPolicy(Model):
"""Represents the delta health policy used to evaluate the health of services
belonging to a service type when upgrading the cluster.
.
:param max_percent_delta_unhealthy_services: The maximum allowed
percentage of services health degradation allowed during cluster upgrades.
The delta is measured between the state of the services at the beginning
of upgrade and the state of the services at the time of the health
evaluation.
The check is performed after every upgrade domain upgrade completion to
make sure the global state of the cluster is within tolerated limits.
. Default value: 0 .
:type max_percent_delta_unhealthy_services: int
"""
_validation = {
'max_percent_delta_unhealthy_services': {'maximum': 100, 'minimum': 0},
}
_attribute_map = {
'max_percent_delta_unhealthy_services': {'key': 'maxPercentDeltaUnhealthyServices', 'type': 'int'},
}
def __init__(self, *, max_percent_delta_unhealthy_services: int=0, **kwargs) -> None:
super(ServiceTypeDeltaHealthPolicy, self).__init__(**kwargs)
self.max_percent_delta_unhealthy_services = max_percent_delta_unhealthy_services
[docs]class ServiceTypeHealthPolicy(Model):
"""Represents the health policy used to evaluate the health of services
belonging to a service type.
.
:param max_percent_unhealthy_services: The maximum percentage of services
allowed to be unhealthy before your application is considered in error.
. Default value: 0 .
:type max_percent_unhealthy_services: int
"""
_validation = {
'max_percent_unhealthy_services': {'maximum': 100, 'minimum': 0},
}
_attribute_map = {
'max_percent_unhealthy_services': {'key': 'maxPercentUnhealthyServices', 'type': 'int'},
}
def __init__(self, *, max_percent_unhealthy_services: int=0, **kwargs) -> None:
super(ServiceTypeHealthPolicy, self).__init__(**kwargs)
self.max_percent_unhealthy_services = max_percent_unhealthy_services
[docs]class SettingsParameterDescription(Model):
"""Describes a parameter in fabric settings of the cluster.
All required parameters must be populated in order to send to Azure.
:param name: Required. The parameter name of fabric setting.
:type name: str
:param value: Required. The parameter value of fabric setting.
:type value: str
"""
_validation = {
'name': {'required': True},
'value': {'required': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'value': {'key': 'value', 'type': 'str'},
}
def __init__(self, *, name: str, value: str, **kwargs) -> None:
super(SettingsParameterDescription, self).__init__(**kwargs)
self.name = name
self.value = value
[docs]class SettingsSectionDescription(Model):
"""Describes a section in the fabric settings of the cluster.
All required parameters must be populated in order to send to Azure.
:param name: Required. The section name of the fabric settings.
:type name: str
:param parameters: Required. The collection of parameters in the section.
:type parameters:
list[~azure.mgmt.servicefabric.models.SettingsParameterDescription]
"""
_validation = {
'name': {'required': True},
'parameters': {'required': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'parameters': {'key': 'parameters', 'type': '[SettingsParameterDescription]'},
}
def __init__(self, *, name: str, parameters, **kwargs) -> None:
super(SettingsSectionDescription, self).__init__(**kwargs)
self.name = name
self.parameters = parameters
[docs]class SingletonPartitionSchemeDescription(PartitionSchemeDescription):
"""Describes the partition scheme of a singleton-partitioned, or
non-partitioned service.
All required parameters must be populated in order to send to Azure.
:param partition_scheme: Required. Constant filled by server.
:type partition_scheme: str
"""
_validation = {
'partition_scheme': {'required': True},
}
_attribute_map = {
'partition_scheme': {'key': 'partitionScheme', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(SingletonPartitionSchemeDescription, self).__init__(**kwargs)
self.partition_scheme = 'Singleton'
[docs]class Sku(Model):
"""Sku definition.
All required parameters must be populated in order to send to Azure.
:param name: Required. Sku Name. Basic will hav a minimum of 3 seed nodes
and Standard a minimum of 5. Basic only allows 1 node type. Possible
values include: 'Basic', 'Standard'
:type name: str or ~azure.mgmt.servicefabric.models.enum
"""
_validation = {
'name': {'required': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
}
def __init__(self, *, name, **kwargs) -> None:
super(Sku, self).__init__(**kwargs)
self.name = name
[docs]class StatefulServiceProperties(ServiceResourceProperties):
"""The properties of a stateful service resource.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:param placement_constraints: The placement constraints as a string.
Placement constraints are boolean expressions on node properties and allow
for restricting a service to particular nodes based on the service
requirements. For example, to place a service on nodes where NodeType is
blue specify the following: "NodeColor == blue)".
:type placement_constraints: str
:param correlation_scheme: A list that describes the correlation of the
service with other services.
:type correlation_scheme:
list[~azure.mgmt.servicefabric.models.ServiceCorrelationDescription]
:param service_load_metrics: The service load metrics is given as an array
of ServiceLoadMetricDescription objects.
:type service_load_metrics:
list[~azure.mgmt.servicefabric.models.ServiceLoadMetricDescription]
:param service_placement_policies: A list that describes the correlation
of the service with other services.
:type service_placement_policies:
list[~azure.mgmt.servicefabric.models.ServicePlacementPolicyDescription]
:param default_move_cost: Specifies the move cost for the service.
Possible values include: 'Zero', 'Low', 'Medium', 'High'
:type default_move_cost: str or ~azure.mgmt.servicefabric.models.MoveCost
:ivar provisioning_state: The current deployment or provisioning state,
which only appears in the response
:vartype provisioning_state: str
:param service_type_name: The name of the service type
:type service_type_name: str
:param partition_description: Describes how the service is partitioned.
:type partition_description:
~azure.mgmt.servicefabric.models.PartitionSchemeDescription
:param service_package_activation_mode: The activation Mode of the service
package. Possible values include: 'SharedProcess', 'ExclusiveProcess'
:type service_package_activation_mode: str or
~azure.mgmt.servicefabric.models.ArmServicePackageActivationMode
:param service_dns_name: Dns name used for the service. If this is
specified, then the service can be accessed via its DNS name instead of
service name.
:type service_dns_name: str
:param service_kind: Required. Constant filled by server.
:type service_kind: str
:param has_persisted_state: A flag indicating whether this is a persistent
service which stores states on the local disk. If it is then the value of
this property is true, if not it is false.
:type has_persisted_state: bool
:param target_replica_set_size: The target replica set size as a number.
:type target_replica_set_size: int
:param min_replica_set_size: The minimum replica set size as a number.
:type min_replica_set_size: int
:param replica_restart_wait_duration: The duration between when a replica
goes down and when a new replica is created, represented in ISO 8601
format (hh:mm:ss.s).
:type replica_restart_wait_duration: datetime
:param quorum_loss_wait_duration: The maximum duration for which a
partition is allowed to be in a state of quorum loss, represented in ISO
8601 format (hh:mm:ss.s).
:type quorum_loss_wait_duration: datetime
:param stand_by_replica_keep_duration: The definition on how long StandBy
replicas should be maintained before being removed, represented in ISO
8601 format (hh:mm:ss.s).
:type stand_by_replica_keep_duration: datetime
"""
_validation = {
'provisioning_state': {'readonly': True},
'service_kind': {'required': True},
'target_replica_set_size': {'minimum': 1},
'min_replica_set_size': {'minimum': 1},
}
_attribute_map = {
'placement_constraints': {'key': 'placementConstraints', 'type': 'str'},
'correlation_scheme': {'key': 'correlationScheme', 'type': '[ServiceCorrelationDescription]'},
'service_load_metrics': {'key': 'serviceLoadMetrics', 'type': '[ServiceLoadMetricDescription]'},
'service_placement_policies': {'key': 'servicePlacementPolicies', 'type': '[ServicePlacementPolicyDescription]'},
'default_move_cost': {'key': 'defaultMoveCost', 'type': 'str'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
'service_type_name': {'key': 'serviceTypeName', 'type': 'str'},
'partition_description': {'key': 'partitionDescription', 'type': 'PartitionSchemeDescription'},
'service_package_activation_mode': {'key': 'servicePackageActivationMode', 'type': 'str'},
'service_dns_name': {'key': 'serviceDnsName', 'type': 'str'},
'service_kind': {'key': 'serviceKind', 'type': 'str'},
'has_persisted_state': {'key': 'hasPersistedState', 'type': 'bool'},
'target_replica_set_size': {'key': 'targetReplicaSetSize', 'type': 'int'},
'min_replica_set_size': {'key': 'minReplicaSetSize', 'type': 'int'},
'replica_restart_wait_duration': {'key': 'replicaRestartWaitDuration', 'type': 'iso-8601'},
'quorum_loss_wait_duration': {'key': 'quorumLossWaitDuration', 'type': 'iso-8601'},
'stand_by_replica_keep_duration': {'key': 'standByReplicaKeepDuration', 'type': 'iso-8601'},
}
def __init__(self, *, placement_constraints: str=None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, service_type_name: str=None, partition_description=None, service_package_activation_mode=None, service_dns_name: str=None, has_persisted_state: bool=None, target_replica_set_size: int=None, min_replica_set_size: int=None, replica_restart_wait_duration=None, quorum_loss_wait_duration=None, stand_by_replica_keep_duration=None, **kwargs) -> None:
super(StatefulServiceProperties, self).__init__(placement_constraints=placement_constraints, correlation_scheme=correlation_scheme, service_load_metrics=service_load_metrics, service_placement_policies=service_placement_policies, default_move_cost=default_move_cost, service_type_name=service_type_name, partition_description=partition_description, service_package_activation_mode=service_package_activation_mode, service_dns_name=service_dns_name, **kwargs)
self.has_persisted_state = has_persisted_state
self.target_replica_set_size = target_replica_set_size
self.min_replica_set_size = min_replica_set_size
self.replica_restart_wait_duration = replica_restart_wait_duration
self.quorum_loss_wait_duration = quorum_loss_wait_duration
self.stand_by_replica_keep_duration = stand_by_replica_keep_duration
self.service_kind = 'Stateful'
[docs]class StatefulServiceUpdateProperties(ServiceResourceUpdateProperties):
"""The properties of a stateful service resource for patch operations.
All required parameters must be populated in order to send to Azure.
:param placement_constraints: The placement constraints as a string.
Placement constraints are boolean expressions on node properties and allow
for restricting a service to particular nodes based on the service
requirements. For example, to place a service on nodes where NodeType is
blue specify the following: "NodeColor == blue)".
:type placement_constraints: str
:param correlation_scheme: A list that describes the correlation of the
service with other services.
:type correlation_scheme:
list[~azure.mgmt.servicefabric.models.ServiceCorrelationDescription]
:param service_load_metrics: The service load metrics is given as an array
of ServiceLoadMetricDescription objects.
:type service_load_metrics:
list[~azure.mgmt.servicefabric.models.ServiceLoadMetricDescription]
:param service_placement_policies: A list that describes the correlation
of the service with other services.
:type service_placement_policies:
list[~azure.mgmt.servicefabric.models.ServicePlacementPolicyDescription]
:param default_move_cost: Specifies the move cost for the service.
Possible values include: 'Zero', 'Low', 'Medium', 'High'
:type default_move_cost: str or ~azure.mgmt.servicefabric.models.MoveCost
:param service_kind: Required. Constant filled by server.
:type service_kind: str
:param target_replica_set_size: The target replica set size as a number.
:type target_replica_set_size: int
:param min_replica_set_size: The minimum replica set size as a number.
:type min_replica_set_size: int
:param replica_restart_wait_duration: The duration between when a replica
goes down and when a new replica is created, represented in ISO 8601
format (hh:mm:ss.s).
:type replica_restart_wait_duration: datetime
:param quorum_loss_wait_duration: The maximum duration for which a
partition is allowed to be in a state of quorum loss, represented in ISO
8601 format (hh:mm:ss.s).
:type quorum_loss_wait_duration: datetime
:param stand_by_replica_keep_duration: The definition on how long StandBy
replicas should be maintained before being removed, represented in ISO
8601 format (hh:mm:ss.s).
:type stand_by_replica_keep_duration: datetime
"""
_validation = {
'service_kind': {'required': True},
'target_replica_set_size': {'minimum': 1},
'min_replica_set_size': {'minimum': 1},
}
_attribute_map = {
'placement_constraints': {'key': 'placementConstraints', 'type': 'str'},
'correlation_scheme': {'key': 'correlationScheme', 'type': '[ServiceCorrelationDescription]'},
'service_load_metrics': {'key': 'serviceLoadMetrics', 'type': '[ServiceLoadMetricDescription]'},
'service_placement_policies': {'key': 'servicePlacementPolicies', 'type': '[ServicePlacementPolicyDescription]'},
'default_move_cost': {'key': 'defaultMoveCost', 'type': 'str'},
'service_kind': {'key': 'serviceKind', 'type': 'str'},
'target_replica_set_size': {'key': 'targetReplicaSetSize', 'type': 'int'},
'min_replica_set_size': {'key': 'minReplicaSetSize', 'type': 'int'},
'replica_restart_wait_duration': {'key': 'replicaRestartWaitDuration', 'type': 'iso-8601'},
'quorum_loss_wait_duration': {'key': 'quorumLossWaitDuration', 'type': 'iso-8601'},
'stand_by_replica_keep_duration': {'key': 'standByReplicaKeepDuration', 'type': 'iso-8601'},
}
def __init__(self, *, placement_constraints: str=None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, target_replica_set_size: int=None, min_replica_set_size: int=None, replica_restart_wait_duration=None, quorum_loss_wait_duration=None, stand_by_replica_keep_duration=None, **kwargs) -> None:
super(StatefulServiceUpdateProperties, self).__init__(placement_constraints=placement_constraints, correlation_scheme=correlation_scheme, service_load_metrics=service_load_metrics, service_placement_policies=service_placement_policies, default_move_cost=default_move_cost, **kwargs)
self.target_replica_set_size = target_replica_set_size
self.min_replica_set_size = min_replica_set_size
self.replica_restart_wait_duration = replica_restart_wait_duration
self.quorum_loss_wait_duration = quorum_loss_wait_duration
self.stand_by_replica_keep_duration = stand_by_replica_keep_duration
self.service_kind = 'Stateful'
[docs]class StatelessServiceProperties(ServiceResourceProperties):
"""The properties of a stateless service resource.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:param placement_constraints: The placement constraints as a string.
Placement constraints are boolean expressions on node properties and allow
for restricting a service to particular nodes based on the service
requirements. For example, to place a service on nodes where NodeType is
blue specify the following: "NodeColor == blue)".
:type placement_constraints: str
:param correlation_scheme: A list that describes the correlation of the
service with other services.
:type correlation_scheme:
list[~azure.mgmt.servicefabric.models.ServiceCorrelationDescription]
:param service_load_metrics: The service load metrics is given as an array
of ServiceLoadMetricDescription objects.
:type service_load_metrics:
list[~azure.mgmt.servicefabric.models.ServiceLoadMetricDescription]
:param service_placement_policies: A list that describes the correlation
of the service with other services.
:type service_placement_policies:
list[~azure.mgmt.servicefabric.models.ServicePlacementPolicyDescription]
:param default_move_cost: Specifies the move cost for the service.
Possible values include: 'Zero', 'Low', 'Medium', 'High'
:type default_move_cost: str or ~azure.mgmt.servicefabric.models.MoveCost
:ivar provisioning_state: The current deployment or provisioning state,
which only appears in the response
:vartype provisioning_state: str
:param service_type_name: The name of the service type
:type service_type_name: str
:param partition_description: Describes how the service is partitioned.
:type partition_description:
~azure.mgmt.servicefabric.models.PartitionSchemeDescription
:param service_package_activation_mode: The activation Mode of the service
package. Possible values include: 'SharedProcess', 'ExclusiveProcess'
:type service_package_activation_mode: str or
~azure.mgmt.servicefabric.models.ArmServicePackageActivationMode
:param service_dns_name: Dns name used for the service. If this is
specified, then the service can be accessed via its DNS name instead of
service name.
:type service_dns_name: str
:param service_kind: Required. Constant filled by server.
:type service_kind: str
:param instance_count: The instance count.
:type instance_count: int
:param instance_close_delay_duration: Delay duration for RequestDrain
feature to ensures that the endpoint advertised by the stateless instance
is removed before the delay starts prior to closing the instance. This
delay enables existing requests to drain gracefully before the instance
actually goes down
(https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-application-upgrade-advanced#avoid-connection-drops-during-stateless-service-planned-downtime-preview).
It is first interpreted as a string representing an ISO 8601 duration. If
that fails, then it is interpreted as a number representing the total
number of milliseconds.
:type instance_close_delay_duration: str
"""
_validation = {
'provisioning_state': {'readonly': True},
'service_kind': {'required': True},
'instance_count': {'minimum': -1},
}
_attribute_map = {
'placement_constraints': {'key': 'placementConstraints', 'type': 'str'},
'correlation_scheme': {'key': 'correlationScheme', 'type': '[ServiceCorrelationDescription]'},
'service_load_metrics': {'key': 'serviceLoadMetrics', 'type': '[ServiceLoadMetricDescription]'},
'service_placement_policies': {'key': 'servicePlacementPolicies', 'type': '[ServicePlacementPolicyDescription]'},
'default_move_cost': {'key': 'defaultMoveCost', 'type': 'str'},
'provisioning_state': {'key': 'provisioningState', 'type': 'str'},
'service_type_name': {'key': 'serviceTypeName', 'type': 'str'},
'partition_description': {'key': 'partitionDescription', 'type': 'PartitionSchemeDescription'},
'service_package_activation_mode': {'key': 'servicePackageActivationMode', 'type': 'str'},
'service_dns_name': {'key': 'serviceDnsName', 'type': 'str'},
'service_kind': {'key': 'serviceKind', 'type': 'str'},
'instance_count': {'key': 'instanceCount', 'type': 'int'},
'instance_close_delay_duration': {'key': 'instanceCloseDelayDuration', 'type': 'str'},
}
def __init__(self, *, placement_constraints: str=None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, service_type_name: str=None, partition_description=None, service_package_activation_mode=None, service_dns_name: str=None, instance_count: int=None, instance_close_delay_duration: str=None, **kwargs) -> None:
super(StatelessServiceProperties, self).__init__(placement_constraints=placement_constraints, correlation_scheme=correlation_scheme, service_load_metrics=service_load_metrics, service_placement_policies=service_placement_policies, default_move_cost=default_move_cost, service_type_name=service_type_name, partition_description=partition_description, service_package_activation_mode=service_package_activation_mode, service_dns_name=service_dns_name, **kwargs)
self.instance_count = instance_count
self.instance_close_delay_duration = instance_close_delay_duration
self.service_kind = 'Stateless'
[docs]class StatelessServiceUpdateProperties(ServiceResourceUpdateProperties):
"""The properties of a stateless service resource for patch operations.
All required parameters must be populated in order to send to Azure.
:param placement_constraints: The placement constraints as a string.
Placement constraints are boolean expressions on node properties and allow
for restricting a service to particular nodes based on the service
requirements. For example, to place a service on nodes where NodeType is
blue specify the following: "NodeColor == blue)".
:type placement_constraints: str
:param correlation_scheme: A list that describes the correlation of the
service with other services.
:type correlation_scheme:
list[~azure.mgmt.servicefabric.models.ServiceCorrelationDescription]
:param service_load_metrics: The service load metrics is given as an array
of ServiceLoadMetricDescription objects.
:type service_load_metrics:
list[~azure.mgmt.servicefabric.models.ServiceLoadMetricDescription]
:param service_placement_policies: A list that describes the correlation
of the service with other services.
:type service_placement_policies:
list[~azure.mgmt.servicefabric.models.ServicePlacementPolicyDescription]
:param default_move_cost: Specifies the move cost for the service.
Possible values include: 'Zero', 'Low', 'Medium', 'High'
:type default_move_cost: str or ~azure.mgmt.servicefabric.models.MoveCost
:param service_kind: Required. Constant filled by server.
:type service_kind: str
:param instance_count: The instance count.
:type instance_count: int
:param instance_close_delay_duration: Delay duration for RequestDrain
feature to ensures that the endpoint advertised by the stateless instance
is removed before the delay starts prior to closing the instance. This
delay enables existing requests to drain gracefully before the instance
actually goes down
(https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-application-upgrade-advanced#avoid-connection-drops-during-stateless-service-planned-downtime-preview).
It is first interpreted as a string representing an ISO 8601 duration. If
that fails, then it is interpreted as a number representing the total
number of milliseconds.
:type instance_close_delay_duration: str
"""
_validation = {
'service_kind': {'required': True},
'instance_count': {'minimum': -1},
}
_attribute_map = {
'placement_constraints': {'key': 'placementConstraints', 'type': 'str'},
'correlation_scheme': {'key': 'correlationScheme', 'type': '[ServiceCorrelationDescription]'},
'service_load_metrics': {'key': 'serviceLoadMetrics', 'type': '[ServiceLoadMetricDescription]'},
'service_placement_policies': {'key': 'servicePlacementPolicies', 'type': '[ServicePlacementPolicyDescription]'},
'default_move_cost': {'key': 'defaultMoveCost', 'type': 'str'},
'service_kind': {'key': 'serviceKind', 'type': 'str'},
'instance_count': {'key': 'instanceCount', 'type': 'int'},
'instance_close_delay_duration': {'key': 'instanceCloseDelayDuration', 'type': 'str'},
}
def __init__(self, *, placement_constraints: str=None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, instance_count: int=None, instance_close_delay_duration: str=None, **kwargs) -> None:
super(StatelessServiceUpdateProperties, self).__init__(placement_constraints=placement_constraints, correlation_scheme=correlation_scheme, service_load_metrics=service_load_metrics, service_placement_policies=service_placement_policies, default_move_cost=default_move_cost, **kwargs)
self.instance_count = instance_count
self.instance_close_delay_duration = instance_close_delay_duration
self.service_kind = 'Stateless'
[docs]class SubResource(Model):
"""Azure resource identifier.
:param id: Azure resource identifier.
:type id: str
"""
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
}
def __init__(self, *, id: str=None, **kwargs) -> None:
super(SubResource, self).__init__(**kwargs)
self.id = id
[docs]class UserAssignedIdentity(Model):
"""UserAssignedIdentity.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar principal_id: The principal id of user assigned identity.
:vartype principal_id: str
:ivar client_id: The client id of user assigned identity.
:vartype client_id: str
"""
_validation = {
'principal_id': {'readonly': True},
'client_id': {'readonly': True},
}
_attribute_map = {
'principal_id': {'key': 'principalId', 'type': 'str'},
'client_id': {'key': 'clientId', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(UserAssignedIdentity, self).__init__(**kwargs)
self.principal_id = None
self.client_id = None
[docs]class VaultCertificate(Model):
"""Describes a single certificate reference in a Key Vault, and where the
certificate should reside on the VM.
All required parameters must be populated in order to send to Azure.
:param certificate_url: Required. This is the URL of a certificate that
has been uploaded to Key Vault as a secret. For adding a secret to the Key
Vault, see [Add a key or secret to the key
vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add).
In this case, your certificate needs to be It is the Base64 encoding of
the following JSON Object which is encoded in UTF-8: <br><br> {<br>
"data":"<Base64-encoded-certificate>",<br> "dataType":"pfx",<br>
"password":"<pfx-file-password>"<br>}
:type certificate_url: str
:param certificate_store: Required. For Windows VMs, specifies the
certificate store on the Virtual Machine to which the certificate should
be added. The specified certificate store is implicitly in the
LocalMachine account. <br><br>For Linux VMs, the certificate file is
placed under the /var/lib/waagent directory, with the file name
<UppercaseThumbprint>.crt for the X509 certificate file and
<UppercaseThumbprint>.prv for private key. Both of these files are .pem
formatted.
:type certificate_store: str
"""
_validation = {
'certificate_url': {'required': True},
'certificate_store': {'required': True},
}
_attribute_map = {
'certificate_url': {'key': 'certificateUrl', 'type': 'str'},
'certificate_store': {'key': 'certificateStore', 'type': 'str'},
}
def __init__(self, *, certificate_url: str, certificate_store: str, **kwargs) -> None:
super(VaultCertificate, self).__init__(**kwargs)
self.certificate_url = certificate_url
self.certificate_store = certificate_store
[docs]class VaultSecretGroup(Model):
"""Specifies set of certificates that should be installed onto the virtual
machines.
All required parameters must be populated in order to send to Azure.
:param source_vault: Required. The relative URL of the Key Vault
containing all of the certificates in VaultCertificates.
:type source_vault: ~azure.mgmt.servicefabric.models.SubResource
:param vault_certificates: Required. The list of key vault references in
SourceVault which contain certificates.
:type vault_certificates:
list[~azure.mgmt.servicefabric.models.VaultCertificate]
"""
_validation = {
'source_vault': {'required': True},
'vault_certificates': {'required': True},
}
_attribute_map = {
'source_vault': {'key': 'sourceVault', 'type': 'SubResource'},
'vault_certificates': {'key': 'vaultCertificates', 'type': '[VaultCertificate]'},
}
def __init__(self, *, source_vault, vault_certificates, **kwargs) -> None:
super(VaultSecretGroup, self).__init__(**kwargs)
self.source_vault = source_vault
self.vault_certificates = vault_certificates
[docs]class VMSSExtension(Model):
"""Specifies set of extensions that should be installed onto the virtual
machines.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:param name: Required. The name of the extension.
:type name: str
:param force_update_tag: If a value is provided and is different from the
previous value, the extension handler will be forced to update even if the
extension configuration has not changed.
:type force_update_tag: str
:param publisher: Required. The name of the extension handler publisher.
:type publisher: str
:param type: Required. Specifies the type of the extension; an example is
"CustomScriptExtension".
:type type: str
:param type_handler_version: Required. Specifies the version of the script
handler.
:type type_handler_version: str
:param auto_upgrade_minor_version: Indicates whether the extension should
use a newer minor version if one is available at deployment time. Once
deployed, however, the extension will not upgrade minor versions unless
redeployed, even with this property set to true.
:type auto_upgrade_minor_version: bool
:param settings: Json formatted public settings for the extension.
:type settings: object
:param protected_settings: The extension can contain either
protectedSettings or protectedSettingsFromKeyVault or no protected
settings at all.
:type protected_settings: object
:ivar provisioning_state: The provisioning state, which only appears in
the response.
:vartype provisioning_state: str
:param provision_after_extensions: Collection of extension names after
which this extension needs to be provisioned.
:type provision_after_extensions: list[str]
"""
_validation = {
'name': {'required': True},
'publisher': {'required': True},
'type': {'required': True},
'type_handler_version': {'required': True},
'provisioning_state': {'readonly': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'force_update_tag': {'key': 'properties.forceUpdateTag', 'type': 'str'},
'publisher': {'key': 'properties.publisher', 'type': 'str'},
'type': {'key': 'properties.type', 'type': 'str'},
'type_handler_version': {'key': 'properties.typeHandlerVersion', 'type': 'str'},
'auto_upgrade_minor_version': {'key': 'properties.autoUpgradeMinorVersion', 'type': 'bool'},
'settings': {'key': 'properties.settings', 'type': 'object'},
'protected_settings': {'key': 'properties.protectedSettings', 'type': 'object'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'provision_after_extensions': {'key': 'properties.provisionAfterExtensions', 'type': '[str]'},
}
def __init__(self, *, name: str, publisher: str, type: str, type_handler_version: str, force_update_tag: str=None, auto_upgrade_minor_version: bool=None, settings=None, protected_settings=None, provision_after_extensions=None, **kwargs) -> None:
super(VMSSExtension, self).__init__(**kwargs)
self.name = name
self.force_update_tag = force_update_tag
self.publisher = publisher
self.type = type
self.type_handler_version = type_handler_version
self.auto_upgrade_minor_version = auto_upgrade_minor_version
self.settings = settings
self.protected_settings = protected_settings
self.provisioning_state = None
self.provision_after_extensions = provision_after_extensions