azure.mgmt.containerservicefleet.models module
- class azure.mgmt.containerservicefleet.models.APIServerAccessProfile(*, enable_private_cluster: bool | None = None, enable_vnet_integration: bool | None = None, subnet_id: str | None = None, **kwargs: Any)[source]
Bases:
ModelAccess profile for the Fleet hub API server.
- Variables:
enable_private_cluster (bool) – Whether to create the Fleet hub as a private cluster or not.
enable_vnet_integration (bool) – Whether to enable apiserver vnet integration for the Fleet hub or not.
subnet_id (str) – The subnet to be used when apiserver vnet integration is enabled. It is required when creating a new Fleet with BYO vnet.
- Keyword Arguments:
enable_private_cluster (bool) – Whether to create the Fleet hub as a private cluster or not.
enable_vnet_integration (bool) – Whether to enable apiserver vnet integration for the Fleet hub or not.
subnet_id (str) – The subnet to be used when apiserver vnet integration is enabled. It is required when creating a new Fleet with BYO vnet.
- class azure.mgmt.containerservicefleet.models.ActionType(*values)[source]
-
Enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs.
- INTERNAL = 'Internal'
- class azure.mgmt.containerservicefleet.models.AgentProfile(*, subnet_id: str | None = None, vm_size: str | None = None, **kwargs: Any)[source]
Bases:
ModelAgent profile for the Fleet hub.
- Variables:
- Keyword Arguments:
- class azure.mgmt.containerservicefleet.models.AutoUpgradeLastTriggerStatus(*values)[source]
-
AutoUpgradeLastTriggerStatus is the status of the last AutoUpgrade trigger (attempt to automatically create and start UpdateRun when there are new released versions) of an auto upgrade profile.
- FAILED = 'Failed'
The last AutoUpgrade trigger failed.
- SUCCEEDED = 'Succeeded'
The last AutoUpgrade trigger was succeeded.
- class azure.mgmt.containerservicefleet.models.AutoUpgradeNodeImageSelection(*, type: str | _models.AutoUpgradeNodeImageSelectionType, **kwargs: Any)[source]
Bases:
ModelThe node image upgrade to be applied to the target clusters in auto upgrade.
All required parameters must be populated in order to send to server.
- Variables:
type (str or AutoUpgradeNodeImageSelectionType) – The node image upgrade type. Required. Known values are: “Latest” and “Consistent”.
- Keyword Arguments:
type (str or AutoUpgradeNodeImageSelectionType) – The node image upgrade type. Required. Known values are: “Latest” and “Consistent”.
- class azure.mgmt.containerservicefleet.models.AutoUpgradeNodeImageSelectionType(*values)[source]
-
The node image upgrade type.
- CONSISTENT = 'Consistent'
for each node pool in managed clusters affected by the update run, the system selects the latest image version such that it is available across all other node pools (in all other clusters) of the same image type. As a result, all node pools of the same image type will be upgraded to the same image version. For example, if the latest image version for image type ‘AKSUbuntu-1804gen2containerd’ is ‘AKSUbuntu-1804gen2containerd-2021.10.12’ for a node pool in cluster A in region X, and is ‘AKSUbuntu-1804gen2containerd-2021.10.17’ for a node pool in cluster B in region Y, the system will upgrade both node pools to image version ‘AKSUbuntu-1804gen2containerd-2021.10.12’.
- Type:
The image versions to upgrade nodes to are selected as described below
- LATEST = 'Latest'
Use the latest image version when upgrading nodes. Clusters may use different image versions (e.g., ‘AKSUbuntu-1804gen2containerd-2021.10.12’ and ‘AKSUbuntu-1804gen2containerd-2021.10.19’) because, for example, the latest available version is different in different regions.
- class azure.mgmt.containerservicefleet.models.AutoUpgradeProfile(*, update_strategy_id: str | None = None, channel: str | _models.UpgradeChannel | None = None, node_image_selection: _models.AutoUpgradeNodeImageSelection | None = None, disabled: bool | None = None, auto_upgrade_profile_status: _models.AutoUpgradeProfileStatus | None = None, **kwargs: Any)[source]
Bases:
ProxyResourceThe AutoUpgradeProfile resource.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
e_tag (str) – If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
provisioning_state (str or AutoUpgradeProfileProvisioningState) – The provisioning state of the AutoUpgradeProfile resource. Known values are: “Succeeded”, “Failed”, and “Canceled”.
update_strategy_id (str) – The resource id of the UpdateStrategy resource to reference. If not specified, the auto upgrade will run on all clusters which are members of the fleet.
channel (str or UpgradeChannel) – Configures how auto-upgrade will be run. Known values are: “Stable”, “Rapid”, and “NodeImage”.
node_image_selection (AutoUpgradeNodeImageSelection) – The node image upgrade to be applied to the target clusters in auto upgrade.
disabled (bool) – If set to False: the auto upgrade has effect - target managed clusters will be upgraded on schedule. If set to True: the auto upgrade has no effect - no upgrade will be run on the target managed clusters. This is a boolean and not an enum because enabled/disabled are all available states of the auto upgrade profile. By default, this is set to False.
auto_upgrade_profile_status (AutoUpgradeProfileStatus) – The status of the auto upgrade profile.
- Keyword Arguments:
update_strategy_id (str) – The resource id of the UpdateStrategy resource to reference. If not specified, the auto upgrade will run on all clusters which are members of the fleet.
channel (str or UpgradeChannel) – Configures how auto-upgrade will be run. Known values are: “Stable”, “Rapid”, and “NodeImage”.
node_image_selection (AutoUpgradeNodeImageSelection) – The node image upgrade to be applied to the target clusters in auto upgrade.
disabled (bool) – If set to False: the auto upgrade has effect - target managed clusters will be upgraded on schedule. If set to True: the auto upgrade has no effect - no upgrade will be run on the target managed clusters. This is a boolean and not an enum because enabled/disabled are all available states of the auto upgrade profile. By default, this is set to False.
auto_upgrade_profile_status (AutoUpgradeProfileStatus) – The status of the auto upgrade profile.
- class azure.mgmt.containerservicefleet.models.AutoUpgradeProfileListResult(*, value: List[_models.AutoUpgradeProfile], next_link: str | None = None, **kwargs: Any)[source]
Bases:
ModelThe response of a AutoUpgradeProfile list operation.
All required parameters must be populated in order to send to server.
- Variables:
value (list[AutoUpgradeProfile]) – The AutoUpgradeProfile items on this page. Required.
next_link (str) – The link to the next page of items.
- Keyword Arguments:
value (list[AutoUpgradeProfile]) – The AutoUpgradeProfile items on this page. Required.
next_link (str) – The link to the next page of items.
- class azure.mgmt.containerservicefleet.models.AutoUpgradeProfileProvisioningState(*values)[source]
-
The provisioning state of the AutoUpgradeProfile resource.
- CANCELED = 'Canceled'
Resource creation was canceled.
- FAILED = 'Failed'
Resource creation failed.
- SUCCEEDED = 'Succeeded'
Resource has been created.
- class azure.mgmt.containerservicefleet.models.AutoUpgradeProfileStatus(**kwargs: Any)[source]
Bases:
ModelAutoUpgradeProfileStatus is the status of an auto upgrade profile.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
last_triggered_at (datetime) – The UTC time of the last attempt to automatically create and start an UpdateRun as triggered by the release of new versions.
last_trigger_status (str or AutoUpgradeLastTriggerStatus) – The status of the last AutoUpgrade trigger. Known values are: “Succeeded” and “Failed”.
last_trigger_error (ErrorDetail) – The error details of the last trigger.
last_trigger_upgrade_versions (list[str]) – The target Kubernetes version or node image versions of the last trigger.
- class azure.mgmt.containerservicefleet.models.CreatedByType(*values)[source]
-
The type of identity that created the resource.
- APPLICATION = 'Application'
- KEY = 'Key'
- MANAGED_IDENTITY = 'ManagedIdentity'
- USER = 'User'
- class azure.mgmt.containerservicefleet.models.ErrorAdditionalInfo(**kwargs: Any)[source]
Bases:
ModelThe resource management error additional info.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
type (str) – The additional info type.
info (JSON) – The additional info.
- class azure.mgmt.containerservicefleet.models.ErrorDetail(**kwargs: Any)[source]
Bases:
ModelThe error detail.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
code (str) – The error code.
message (str) – The error message.
target (str) – The error target.
details (list[ErrorDetail]) – The error details.
additional_info (list[ErrorAdditionalInfo]) – The error additional info.
- class azure.mgmt.containerservicefleet.models.ErrorResponse(*, error: _models.ErrorDetail | None = None, **kwargs: Any)[source]
Bases:
ModelCommon error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
- Variables:
error (ErrorDetail) – The error object.
- Keyword Arguments:
error (ErrorDetail) – The error object.
- class azure.mgmt.containerservicefleet.models.Fleet(*, location: str, tags: Dict[str, str] | None = None, identity: _models.ManagedServiceIdentity | None = None, hub_profile: _models.FleetHubProfile | None = None, **kwargs: Any)[source]
Bases:
TrackedResourceThe Fleet 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 server.
- Variables:
id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
location (str) – The geo-location where the resource lives. Required.
e_tag (str) – If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
identity (ManagedServiceIdentity) – Managed identity.
provisioning_state (str or FleetProvisioningState) – The status of the last operation. Known values are: “Succeeded”, “Failed”, “Canceled”, “Creating”, “Updating”, and “Deleting”.
hub_profile (FleetHubProfile) – The FleetHubProfile configures the Fleet’s hub.
status (FleetStatus) – Status information for the fleet.
- Keyword Arguments:
location (str) – The geo-location where the resource lives. Required.
identity (ManagedServiceIdentity) – Managed identity.
hub_profile (FleetHubProfile) – The FleetHubProfile configures the Fleet’s hub.
- class azure.mgmt.containerservicefleet.models.FleetCredentialResult(**kwargs: Any)[source]
Bases:
ModelOne credential result item.
Variables are only populated by the server, and will be ignored when sending a request.
- class azure.mgmt.containerservicefleet.models.FleetCredentialResults(**kwargs: Any)[source]
Bases:
ModelThe Credential results response.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
kubeconfigs (list[FleetCredentialResult]) – Array of base64-encoded Kubernetes configuration files.
- class azure.mgmt.containerservicefleet.models.FleetHubProfile(*, dns_prefix: str | None = None, api_server_access_profile: _models.APIServerAccessProfile | None = None, agent_profile: _models.AgentProfile | None = None, **kwargs: Any)[source]
Bases:
ModelThe FleetHubProfile configures the fleet hub.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
dns_prefix (str) – DNS prefix used to create the FQDN for the Fleet hub.
api_server_access_profile (APIServerAccessProfile) – The access profile for the Fleet hub API server.
agent_profile (AgentProfile) – The agent profile for the Fleet hub.
fqdn (str) – The FQDN of the Fleet hub.
kubernetes_version (str) – The Kubernetes version of the Fleet hub.
portal_fqdn (str) – The Azure Portal FQDN of the Fleet hub.
- Keyword Arguments:
dns_prefix (str) – DNS prefix used to create the FQDN for the Fleet hub.
api_server_access_profile (APIServerAccessProfile) – The access profile for the Fleet hub API server.
agent_profile (AgentProfile) – The agent profile for the Fleet hub.
- class azure.mgmt.containerservicefleet.models.FleetListResult(*, value: List[_models.Fleet], next_link: str | None = None, **kwargs: Any)[source]
Bases:
ModelThe response of a Fleet list operation.
All required parameters must be populated in order to send to server.
- class azure.mgmt.containerservicefleet.models.FleetMember(*, cluster_resource_id: str | None = None, group: str | None = None, **kwargs: Any)[source]
Bases:
ProxyResourceA member of the Fleet. It contains a reference to an existing Kubernetes cluster on Azure.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
e_tag (str) – If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
cluster_resource_id (str) – The ARM resource id of the cluster that joins the Fleet. Must be a valid Azure resource id. e.g.: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{clusterName}’. # pylint: disable=line-too-long
group (str) – The group this member belongs to for multi-cluster update management.
provisioning_state (str or FleetMemberProvisioningState) – The status of the last operation. Known values are: “Succeeded”, “Failed”, “Canceled”, “Joining”, “Leaving”, and “Updating”.
status (FleetMemberStatus) – Status information of the last operation for fleet member.
- Keyword Arguments:
cluster_resource_id (str) – The ARM resource id of the cluster that joins the Fleet. Must be a valid Azure resource id. e.g.: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{clusterName}’. # pylint: disable=line-too-long
group (str) – The group this member belongs to for multi-cluster update management.
- class azure.mgmt.containerservicefleet.models.FleetMemberListResult(*, value: List[_models.FleetMember], next_link: str | None = None, **kwargs: Any)[source]
Bases:
ModelThe response of a FleetMember list operation.
All required parameters must be populated in order to send to server.
- Variables:
value (list[FleetMember]) – The FleetMember items on this page. Required.
next_link (str) – The link to the next page of items.
- Keyword Arguments:
value (list[FleetMember]) – The FleetMember items on this page. Required.
next_link (str) – The link to the next page of items.
- class azure.mgmt.containerservicefleet.models.FleetMemberProvisioningState(*values)[source]
-
The provisioning state of the last accepted operation.
- CANCELED = 'Canceled'
Resource creation was canceled.
- FAILED = 'Failed'
Resource creation failed.
- JOINING = 'Joining'
The provisioning state of a member joining a fleet.
- LEAVING = 'Leaving'
The provisioning state of a member leaving a fleet.
- SUCCEEDED = 'Succeeded'
Resource has been created.
- UPDATING = 'Updating'
The provisioning state of a member being updated.
- class azure.mgmt.containerservicefleet.models.FleetMemberStatus(**kwargs: Any)[source]
Bases:
ModelStatus information for the fleet member.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
last_operation_id (str) – The last operation ID for the fleet member.
last_operation_error (ErrorDetail) – The last operation error of the fleet member.
- class azure.mgmt.containerservicefleet.models.FleetMemberUpdate(*, group: str | None = None, **kwargs: Any)[source]
Bases:
ModelThe type used for update operations of the FleetMember.
- class azure.mgmt.containerservicefleet.models.FleetPatch(*, tags: Dict[str, str] | None = None, identity: _models.ManagedServiceIdentity | None = None, **kwargs: Any)[source]
Bases:
ModelProperties of a Fleet that can be patched.
- Variables:
identity (ManagedServiceIdentity) – Managed identity.
- Keyword Arguments:
identity (ManagedServiceIdentity) – Managed identity.
- class azure.mgmt.containerservicefleet.models.FleetProvisioningState(*values)[source]
-
The provisioning state of the last accepted operation.
- CANCELED = 'Canceled'
Resource creation was canceled.
- CREATING = 'Creating'
The provisioning state of a fleet being created.
- DELETING = 'Deleting'
The provisioning state of a fleet being deleted.
- FAILED = 'Failed'
Resource creation failed.
- SUCCEEDED = 'Succeeded'
Resource has been created.
- UPDATING = 'Updating'
The provisioning state of a fleet being updated.
- class azure.mgmt.containerservicefleet.models.FleetStatus(**kwargs: Any)[source]
Bases:
ModelStatus information for the fleet.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
last_operation_id (str) – The last operation ID for the fleet.
last_operation_error (ErrorDetail) – The last operation error for the fleet.
- class azure.mgmt.containerservicefleet.models.FleetUpdateStrategy(*, strategy: _models.UpdateRunStrategy | None = None, **kwargs: Any)[source]
Bases:
ProxyResourceDefines a multi-stage process to perform update operations across members of a Fleet.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
e_tag (str) – If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
provisioning_state (str or FleetUpdateStrategyProvisioningState) – The provisioning state of the UpdateStrategy resource. Known values are: “Succeeded”, “Failed”, and “Canceled”.
strategy (UpdateRunStrategy) – Defines the update sequence of the clusters.
- Keyword Arguments:
strategy (UpdateRunStrategy) – Defines the update sequence of the clusters.
- class azure.mgmt.containerservicefleet.models.FleetUpdateStrategyListResult(*, value: List[_models.FleetUpdateStrategy], next_link: str | None = None, **kwargs: Any)[source]
Bases:
ModelThe response of a FleetUpdateStrategy list operation.
All required parameters must be populated in order to send to server.
- Variables:
value (list[FleetUpdateStrategy]) – The FleetUpdateStrategy items on this page. Required.
next_link (str) – The link to the next page of items.
- Keyword Arguments:
value (list[FleetUpdateStrategy]) – The FleetUpdateStrategy items on this page. Required.
next_link (str) – The link to the next page of items.
- class azure.mgmt.containerservicefleet.models.FleetUpdateStrategyProvisioningState(*values)[source]
-
The provisioning state of the UpdateStrategy resource.
- CANCELED = 'Canceled'
Resource creation was canceled.
- FAILED = 'Failed'
Resource creation failed.
- SUCCEEDED = 'Succeeded'
Resource has been created.
- class azure.mgmt.containerservicefleet.models.GenerateResponse(**kwargs: Any)[source]
Bases:
ModelGenerateResponse is the response of a generate request.
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 server.
- Variables:
id (str) – The ARM resource id of the generated UpdateRun. e.g.: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/updateRuns/{updateRunName}’. # pylint: disable=line-too-long Required.
- class azure.mgmt.containerservicefleet.models.ManagedClusterUpdate(*, upgrade: _models.ManagedClusterUpgradeSpec, node_image_selection: _models.NodeImageSelection | None = None, **kwargs: Any)[source]
Bases:
ModelThe update to be applied to the ManagedClusters.
All required parameters must be populated in order to send to server.
- Variables:
upgrade (ManagedClusterUpgradeSpec) – The upgrade to apply to the ManagedClusters. Required.
node_image_selection (NodeImageSelection) – The node image upgrade to be applied to the target nodes in update run.
- Keyword Arguments:
upgrade (ManagedClusterUpgradeSpec) – The upgrade to apply to the ManagedClusters. Required.
node_image_selection (NodeImageSelection) – The node image upgrade to be applied to the target nodes in update run.
- class azure.mgmt.containerservicefleet.models.ManagedClusterUpgradeSpec(*, type: str | _models.ManagedClusterUpgradeType, kubernetes_version: str | None = None, **kwargs: Any)[source]
Bases:
ModelThe upgrade to apply to a ManagedCluster.
All required parameters must be populated in order to send to server.
- Variables:
type (str or ManagedClusterUpgradeType) – ManagedClusterUpgradeType is the type of upgrade to be applied. Required. Known values are: “Full”, “NodeImageOnly”, and “ControlPlaneOnly”.
kubernetes_version (str) – The Kubernetes version to upgrade the member clusters to.
- Keyword Arguments:
type (str or ManagedClusterUpgradeType) – ManagedClusterUpgradeType is the type of upgrade to be applied. Required. Known values are: “Full”, “NodeImageOnly”, and “ControlPlaneOnly”.
kubernetes_version (str) – The Kubernetes version to upgrade the member clusters to.
- class azure.mgmt.containerservicefleet.models.ManagedClusterUpgradeType(*values)[source]
-
The type of upgrade to perform when targeting ManagedClusters.
- CONTROL_PLANE_ONLY = 'ControlPlaneOnly'
ControlPlaneOnly upgrades only targets the KubernetesVersion of the ManagedClusters and will not be applied to the AgentPool. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to be set.
- FULL = 'Full'
Full upgrades the control plane and all agent pools of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to be set.
- NODE_IMAGE_ONLY = 'NodeImageOnly'
NodeImageOnly upgrades only the node images of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to NOT be set.
- class azure.mgmt.containerservicefleet.models.ManagedServiceIdentity(*, type: str | _models.ManagedServiceIdentityType, user_assigned_identities: Dict[str, _models.UserAssignedIdentity] | None = None, **kwargs: Any)[source]
Bases:
ModelManaged service identity (system assigned and/or user assigned identities).
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 server.
- Variables:
principal_id (str) – The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenant_id (str) – The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type (str or ManagedServiceIdentityType) – Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). Required. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned, UserAssigned”.
user_assigned_identities (dict[str, UserAssignedIdentity]) – The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. # pylint: disable=line-too-long The dictionary values can be empty objects ({}) in requests.
- Keyword Arguments:
type (str or ManagedServiceIdentityType) – Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). Required. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned, UserAssigned”.
user_assigned_identities (dict[str, UserAssignedIdentity]) – The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. # pylint: disable=line-too-long The dictionary values can be empty objects ({}) in requests.
- class azure.mgmt.containerservicefleet.models.ManagedServiceIdentityType(*values)[source]
-
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
- NONE = 'None'
- SYSTEM_ASSIGNED = 'SystemAssigned'
- SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned, UserAssigned'
- USER_ASSIGNED = 'UserAssigned'
- class azure.mgmt.containerservicefleet.models.MemberUpdateStatus(**kwargs: Any)[source]
Bases:
ModelThe status of a member update operation.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
status (UpdateStatus) – The status of the MemberUpdate operation.
name (str) – The name of the FleetMember.
cluster_resource_id (str) – The Azure resource id of the target Kubernetes cluster.
operation_id (str) – The operation resource id of the latest attempt to perform the operation.
message (str) – The status message after processing the member update operation.
- class azure.mgmt.containerservicefleet.models.NodeImageSelection(*, type: str | _models.NodeImageSelectionType, custom_node_image_versions: List[_models.NodeImageVersion] | None = None, **kwargs: Any)[source]
Bases:
ModelThe node image upgrade to be applied to the target nodes in update run.
All required parameters must be populated in order to send to server.
- Variables:
type (str or NodeImageSelectionType) – The node image upgrade type. Required. Known values are: “Latest”, “Consistent”, and “Custom”.
custom_node_image_versions (list[NodeImageVersion]) – Custom node image versions to upgrade the nodes to. This field is required if node image selection type is Custom. Otherwise, it must be empty. For each node image family (e.g., ‘AKSUbuntu-1804gen2containerd’), this field can contain at most one version (e.g., only one of ‘AKSUbuntu-1804gen2containerd-2023.01.12’ or ‘AKSUbuntu-1804gen2containerd-2023.02.12’, not both). If the nodes belong to a family without a matching image version in this field, they are not upgraded.
- Keyword Arguments:
type (str or NodeImageSelectionType) – The node image upgrade type. Required. Known values are: “Latest”, “Consistent”, and “Custom”.
custom_node_image_versions (list[NodeImageVersion]) – Custom node image versions to upgrade the nodes to. This field is required if node image selection type is Custom. Otherwise, it must be empty. For each node image family (e.g., ‘AKSUbuntu-1804gen2containerd’), this field can contain at most one version (e.g., only one of ‘AKSUbuntu-1804gen2containerd-2023.01.12’ or ‘AKSUbuntu-1804gen2containerd-2023.02.12’, not both). If the nodes belong to a family without a matching image version in this field, they are not upgraded.
- class azure.mgmt.containerservicefleet.models.NodeImageSelectionStatus(**kwargs: Any)[source]
Bases:
ModelThe node image upgrade specs for the update run.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
selected_node_image_versions (list[NodeImageVersion]) – The image versions to upgrade the nodes to.
- class azure.mgmt.containerservicefleet.models.NodeImageSelectionType(*values)[source]
-
The node image upgrade type.
- CONSISTENT = 'Consistent'
for each node pool in managed clusters affected by the update run, the system selects the latest image version such that it is available across all other node pools (in all other clusters) of the same image type. As a result, all node pools of the same image type will be upgraded to the same image version. For example, if the latest image version for image type ‘AKSUbuntu-1804gen2containerd’ is ‘AKSUbuntu-1804gen2containerd-2021.10.12’ for a node pool in cluster A in region X, and is ‘AKSUbuntu-1804gen2containerd-2021.10.17’ for a node pool in cluster B in region Y, the system will upgrade both node pools to image version ‘AKSUbuntu-1804gen2containerd-2021.10.12’.
- Type:
The image versions to upgrade nodes to are selected as described below
- CUSTOM = 'Custom'
Upgrade the nodes to the custom image versions. When set, update run will use node image versions provided in customNodeImageVersions to upgrade the nodes. If set, customNodeImageVersions must not be empty.
- LATEST = 'Latest'
Use the latest image version when upgrading nodes. Clusters may use different image versions (e.g., ‘AKSUbuntu-1804gen2containerd-2021.10.12’ and ‘AKSUbuntu-1804gen2containerd-2021.10.19’) because, for example, the latest available version is different in different regions.
- class azure.mgmt.containerservicefleet.models.NodeImageVersion(**kwargs: Any)[source]
Bases:
ModelThe node upgrade image version.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
version (str) – The image version to upgrade the nodes to (e.g., ‘AKSUbuntu-1804gen2containerd-2022.12.13’).
- class azure.mgmt.containerservicefleet.models.Operation(*, display: _models.OperationDisplay | None = None, **kwargs: Any)[source]
Bases:
ModelDetails of a REST API operation, returned from the Resource Provider Operations API.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
name (str) – The name of the operation, as per Resource-Based Access Control (RBAC). Examples: “Microsoft.Compute/virtualMachines/write”, “Microsoft.Compute/virtualMachines/capture/action”.
is_data_action (bool) – Whether the operation applies to data-plane. This is “true” for data-plane operations and “false” for ARM/control-plane operations.
display (OperationDisplay) – Localized display information for this particular operation.
origin (str or Origin) – The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”. Known values are: “user”, “system”, and “user,system”.
action_type (str or ActionType) – Enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs. “Internal”
- Keyword Arguments:
display (OperationDisplay) – Localized display information for this particular operation.
- class azure.mgmt.containerservicefleet.models.OperationDisplay(**kwargs: Any)[source]
Bases:
ModelLocalized display information for this particular operation.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
provider (str) – The localized friendly form of the resource provider name, e.g. “Microsoft Monitoring Insights” or “Microsoft Compute”.
resource (str) – The localized friendly name of the resource type related to this operation. E.g. “Virtual Machines” or “Job Schedule Collections”.
operation (str) – The concise, localized friendly name for the operation; suitable for dropdowns. E.g. “Create or Update Virtual Machine”, “Restart Virtual Machine”.
description (str) – The short, localized friendly description of the operation; suitable for tool tips and detailed views.
- class azure.mgmt.containerservicefleet.models.OperationListResult(**kwargs: Any)[source]
Bases:
ModelA list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
Variables are only populated by the server, and will be ignored when sending a request.
- class azure.mgmt.containerservicefleet.models.Origin(*values)[source]
-
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”.
- SYSTEM = 'system'
- USER = 'user'
- USER_SYSTEM = 'user,system'
- class azure.mgmt.containerservicefleet.models.ProxyResource(**kwargs: Any)[source]
Bases:
ResourceThe resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
- class azure.mgmt.containerservicefleet.models.Resource(**kwargs: Any)[source]
Bases:
ModelCommon fields that are returned in the response for all Azure Resource Manager resources.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
- class azure.mgmt.containerservicefleet.models.SkipProperties(*, targets: List[_models.SkipTarget], **kwargs: Any)[source]
Bases:
ModelThe properties of a skip operation containing multiple skip requests.
All required parameters must be populated in order to send to server.
- Variables:
targets (list[SkipTarget]) – The targets to skip. Required.
- Keyword Arguments:
targets (list[SkipTarget]) – The targets to skip. Required.
- class azure.mgmt.containerservicefleet.models.SkipTarget(*, type: str | _models.TargetType, name: str, **kwargs: Any)[source]
Bases:
ModelThe definition of a single skip request.
All required parameters must be populated in order to send to server.
- Variables:
type (str or TargetType) – The skip target type. Required. Known values are: “Member”, “Group”, “Stage”, and “AfterStageWait”.
name (str) – The skip target’s name. To skip a member/group/stage, use the member/group/stage’s name; Tp skip an after stage wait, use the parent stage’s name. Required.
- Keyword Arguments:
type (str or TargetType) – The skip target type. Required. Known values are: “Member”, “Group”, “Stage”, and “AfterStageWait”.
name (str) – The skip target’s name. To skip a member/group/stage, use the member/group/stage’s name; Tp skip an after stage wait, use the parent stage’s name. Required.
- class azure.mgmt.containerservicefleet.models.SystemData(*, created_by: str | None = None, created_by_type: str | _models.CreatedByType | None = None, created_at: datetime | None = None, last_modified_by: str | None = None, last_modified_by_type: str | _models.CreatedByType | None = None, last_modified_at: datetime | None = None, **kwargs: Any)[source]
Bases:
ModelMetadata pertaining to creation and last modification of the resource.
- Variables:
created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).
- Keyword Arguments:
created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).
- class azure.mgmt.containerservicefleet.models.TargetType(*values)[source]
-
The target type of a skip request.
- AFTER_STAGE_WAIT = 'AfterStageWait'
Skip the update of the after stage wait of a certain stage.
- GROUP = 'Group'
Skip the update of a group.
- MEMBER = 'Member'
Skip the update of a member.
- STAGE = 'Stage'
Skip the update of an entire stage including the after stage wait.
- class azure.mgmt.containerservicefleet.models.TrackedResource(*, location: str, tags: Dict[str, str] | None = None, **kwargs: Any)[source]
Bases:
ResourceThe resource model definition for an Azure Resource Manager tracked top level resource which has ‘tags’ and a ‘location’.
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 server.
- Variables:
id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
location (str) – The geo-location where the resource lives. Required.
- Keyword Arguments:
- class azure.mgmt.containerservicefleet.models.UpdateGroup(*, name: str, **kwargs: Any)[source]
Bases:
ModelA group to be updated.
All required parameters must be populated in order to send to server.
- class azure.mgmt.containerservicefleet.models.UpdateGroupStatus(**kwargs: Any)[source]
Bases:
ModelThe status of a UpdateGroup.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
status (UpdateStatus) – The status of the UpdateGroup.
name (str) – The name of the UpdateGroup.
members (list[MemberUpdateStatus]) – The list of member this UpdateGroup updates.
- class azure.mgmt.containerservicefleet.models.UpdateRun(*, update_strategy_id: str | None = None, strategy: _models.UpdateRunStrategy | None = None, managed_cluster_update: _models.ManagedClusterUpdate | None = None, **kwargs: Any)[source]
Bases:
ProxyResourceA multi-stage process to perform update operations across members of a Fleet.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
e_tag (str) – If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
provisioning_state (str or UpdateRunProvisioningState) – The provisioning state of the UpdateRun resource. Known values are: “Succeeded”, “Failed”, and “Canceled”.
update_strategy_id (str) –
The resource id of the FleetUpdateStrategy resource to reference.
When creating a new run, there are three ways to define a strategy for the run:
Define a new strategy in place: Set the “strategy” field.
Use an existing strategy: Set the “updateStrategyId” field. (since 2023-08-15-preview)
#. Use the default strategy to update all the members one by one: Leave both “updateStrategyId” and “strategy” unset. (since 2023-08-15-preview)
Setting both “updateStrategyId” and “strategy” is invalid.
UpdateRuns created by “updateStrategyId” snapshot the referenced UpdateStrategy at the time of creation and store it in the “strategy” field. Subsequent changes to the referenced FleetUpdateStrategy resource do not propagate. UpdateRunStrategy changes can be made directly on the “strategy” field before launching the UpdateRun.
strategy (UpdateRunStrategy) – The strategy defines the order in which the clusters will be updated. If not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members. The strategy of the UpdateRun can be modified until the run is started.
managed_cluster_update (ManagedClusterUpdate) – The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started.
status (UpdateRunStatus) – The status of the UpdateRun.
auto_upgrade_profile_id (str) – AutoUpgradeProfileId is the id of an auto upgrade profile resource.
- Keyword Arguments:
update_strategy_id (str) –
The resource id of the FleetUpdateStrategy resource to reference.
When creating a new run, there are three ways to define a strategy for the run:
Define a new strategy in place: Set the “strategy” field.
Use an existing strategy: Set the “updateStrategyId” field. (since 2023-08-15-preview)
#. Use the default strategy to update all the members one by one: Leave both “updateStrategyId” and “strategy” unset. (since 2023-08-15-preview)
Setting both “updateStrategyId” and “strategy” is invalid.
UpdateRuns created by “updateStrategyId” snapshot the referenced UpdateStrategy at the time of creation and store it in the “strategy” field. Subsequent changes to the referenced FleetUpdateStrategy resource do not propagate. UpdateRunStrategy changes can be made directly on the “strategy” field before launching the UpdateRun.
strategy (UpdateRunStrategy) – The strategy defines the order in which the clusters will be updated. If not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members. The strategy of the UpdateRun can be modified until the run is started.
managed_cluster_update (ManagedClusterUpdate) – The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started.
- class azure.mgmt.containerservicefleet.models.UpdateRunListResult(*, value: List[_models.UpdateRun], next_link: str | None = None, **kwargs: Any)[source]
Bases:
ModelThe response of a UpdateRun list operation.
All required parameters must be populated in order to send to server.
- class azure.mgmt.containerservicefleet.models.UpdateRunProvisioningState(*values)[source]
-
The provisioning state of the UpdateRun resource.
- CANCELED = 'Canceled'
Resource creation was canceled.
- FAILED = 'Failed'
Resource creation failed.
- SUCCEEDED = 'Succeeded'
Resource has been created.
- class azure.mgmt.containerservicefleet.models.UpdateRunStatus(**kwargs: Any)[source]
Bases:
ModelThe status of a UpdateRun.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
status (UpdateStatus) – The status of the UpdateRun.
stages (list[UpdateStageStatus]) – The stages composing an update run. Stages are run sequentially withing an UpdateRun.
node_image_selection (NodeImageSelectionStatus) – The node image upgrade specs for the update run. It is only set in update run when
NodeImageSelection.typeisConsistent.
- class azure.mgmt.containerservicefleet.models.UpdateRunStrategy(*, stages: List[_models.UpdateStage], **kwargs: Any)[source]
Bases:
ModelDefines the update sequence of the clusters via stages and groups.
Stages within a run are executed sequentially one after another. Groups within a stage are executed in parallel. Member clusters within a group are updated sequentially one after another.
A valid strategy contains no duplicate groups within or across stages.
All required parameters must be populated in order to send to server.
- Variables:
stages (list[UpdateStage]) – The list of stages that compose this update run. Min size: 1. Required.
- Keyword Arguments:
stages (list[UpdateStage]) – The list of stages that compose this update run. Min size: 1. Required.
- class azure.mgmt.containerservicefleet.models.UpdateStage(*, name: str, groups: List[_models.UpdateGroup] | None = None, after_stage_wait_in_seconds: int | None = None, **kwargs: Any)[source]
Bases:
ModelDefines a stage which contains the groups to update and the steps to take (e.g., wait for a time period) before starting the next stage.
All required parameters must be populated in order to send to server.
- Variables:
name (str) – The name of the stage. Must be unique within the UpdateRun. Required.
groups (list[UpdateGroup]) – Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1.
after_stage_wait_in_seconds (int) – The time in seconds to wait at the end of this stage before starting the next one. Defaults to 0 seconds if unspecified.
- Keyword Arguments:
name (str) – The name of the stage. Must be unique within the UpdateRun. Required.
groups (list[UpdateGroup]) – Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1.
after_stage_wait_in_seconds (int) – The time in seconds to wait at the end of this stage before starting the next one. Defaults to 0 seconds if unspecified.
- class azure.mgmt.containerservicefleet.models.UpdateStageStatus(**kwargs: Any)[source]
Bases:
ModelThe status of a UpdateStage.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
status (UpdateStatus) – The status of the UpdateStage.
name (str) – The name of the UpdateStage.
groups (list[UpdateGroupStatus]) – The list of groups to be updated as part of this UpdateStage.
after_stage_wait_status (WaitStatus) – The status of the wait period configured on the UpdateStage.
- class azure.mgmt.containerservicefleet.models.UpdateState(*values)[source]
-
The state of the UpdateRun, UpdateStage, UpdateGroup, or MemberUpdate.
- COMPLETED = 'Completed'
The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed.
- FAILED = 'Failed'
The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed.
- NOT_STARTED = 'NotStarted'
The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started.
- RUNNING = 'Running'
The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running.
- SKIPPED = 'Skipped'
The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped.
- STOPPED = 'Stopped'
The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped.
- STOPPING = 'Stopping'
The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped.
- class azure.mgmt.containerservicefleet.models.UpdateStatus(**kwargs: Any)[source]
Bases:
ModelThe status for an operation or group of operations.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
start_time (datetime) – The time the operation or group was started.
completed_time (datetime) – The time the operation or group was completed.
state (str or UpdateState) – The State of the operation or group. Known values are: “NotStarted”, “Running”, “Stopping”, “Stopped”, “Skipped”, “Failed”, and “Completed”.
error (ErrorDetail) – The error details when a failure is encountered.
- class azure.mgmt.containerservicefleet.models.UpgradeChannel(*values)[source]
-
Configuration of how auto upgrade will be run.
- NODE_IMAGE = 'NodeImage'
Upgrade node image version of the clusters.
- RAPID = 'Rapid'
Upgrades the clusters kubernetes version to the latest supported patch release on the latest supported minor version.
- STABLE = 'Stable'
Upgrades the clusters kubernetes version to the latest supported patch release on minor version N-1, where N is the latest supported minor version.
For example, if a cluster runs version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1
are available, the cluster upgrades to 1.18.6.
- class azure.mgmt.containerservicefleet.models.UserAssignedIdentity(**kwargs: Any)[source]
Bases:
ModelUser assigned identity properties.
Variables are only populated by the server, and will be ignored when sending a request.
- class azure.mgmt.containerservicefleet.models.WaitStatus(**kwargs: Any)[source]
Bases:
ModelThe status of the wait duration.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
status (UpdateStatus) – The status of the wait duration.
wait_duration_in_seconds (int) – The wait duration configured in seconds.