azure.mgmt.hybridkubernetes.models module
- class azure.mgmt.hybridkubernetes.models.AadProfile(*, enable_azure_rbac: bool | None = None, admin_group_object_i_ds: List[str] | None = None, tenant_id: str | None = None, **kwargs: Any)[source]
Bases:
ModelAAD Profile specifies attributes for Azure Active Directory integration.
- Variables:
enable_azure_rbac (bool) – Whether to enable Azure RBAC for Kubernetes authorization.
admin_group_object_i_ds (list[str]) – The list of AAD group object IDs that will have admin role of the cluster.
tenant_id (str) – The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.
- Keyword Arguments:
enable_azure_rbac (bool) – Whether to enable Azure RBAC for Kubernetes authorization.
admin_group_object_i_ds (list[str]) – The list of AAD group object IDs that will have admin role of the cluster.
tenant_id (str) – The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.
- class azure.mgmt.hybridkubernetes.models.AgentError(**kwargs: Any)[source]
Bases:
ModelAgent Errors if any during agent or system component upgrade.
Variables are only populated by the server, and will be ignored when sending a request.
- class azure.mgmt.hybridkubernetes.models.ArcAgentProfile(*, desired_agent_version: str | None = None, agent_auto_upgrade: str | _models.AutoUpgradeOptions = 'Enabled', system_components: List[_models.SystemComponent] | None = None, agent_errors: List[_models.AgentError] | None = None, **kwargs: Any)[source]
Bases:
ModelDefines the Arc Agent properties for the clusters.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
desired_agent_version (str) – Version of the Arc agents to be installed on the cluster resource.
agent_auto_upgrade (str or AutoUpgradeOptions) – Indicates whether the Arc agents on the be upgraded automatically to the latest version. Defaults to Enabled. Known values are: “Enabled” and “Disabled”.
system_components (list[SystemComponent]) – List of system extensions that are installed on the cluster resource.
agent_errors (list[AgentError]) – List of arc agentry and system components errors on the cluster resource.
agent_state (str) – Represents the current state of the Arc agentry and its dependent components.
- Keyword Arguments:
desired_agent_version (str) – Version of the Arc agents to be installed on the cluster resource.
agent_auto_upgrade (str or AutoUpgradeOptions) – Indicates whether the Arc agents on the be upgraded automatically to the latest version. Defaults to Enabled. Known values are: “Enabled” and “Disabled”.
system_components (list[SystemComponent]) – List of system extensions that are installed on the cluster resource.
agent_errors (list[AgentError]) – List of arc agentry and system components errors on the cluster resource.
- class azure.mgmt.hybridkubernetes.models.ArcAgentryConfigurations(*, feature: str | None = None, settings: Dict[str, str] | None = None, protected_settings: Dict[str, str] | None = None, **kwargs: Any)[source]
Bases:
ModelArcAgentryConfigurations.
- Variables:
feature (str) – Specifies the name of the feature for the configuration setting.
settings (dict[str, str]) – The configuration settings for the feature that do not contain any sensitive or secret information.
protected_settings (dict[str, str]) – The configuration settings for the feature that contain any sensitive or secret information.
- Keyword Arguments:
feature (str) – Specifies the name of the feature for the configuration setting.
settings (dict[str, str]) – The configuration settings for the feature that do not contain any sensitive or secret information.
protected_settings (dict[str, str]) – The configuration settings for the feature that contain any sensitive or secret information.
- class azure.mgmt.hybridkubernetes.models.AuthenticationMethod(*values)[source]
-
The mode of client authentication.
- AAD = 'AAD'
- TOKEN = 'Token'
- class azure.mgmt.hybridkubernetes.models.AutoUpgradeOptions(*values)[source]
-
Indicates whether the Arc agents on the be upgraded automatically to the latest version. Defaults to Enabled.
- DISABLED = 'Disabled'
- ENABLED = 'Enabled'
- class azure.mgmt.hybridkubernetes.models.AzureHybridBenefit(*values)[source]
-
Indicates whether Azure Hybrid Benefit is opted in.
- FALSE = 'False'
- NOT_APPLICABLE = 'NotApplicable'
- TRUE = 'True'
- class azure.mgmt.hybridkubernetes.models.ConnectedCluster(*, location: str, identity: _models.ConnectedClusterIdentity, agent_public_key_certificate: str, tags: Dict[str, str] | None = None, kind: str | _models.ConnectedClusterKind | None = None, provisioning_state: str | _models.ProvisioningState | None = None, distribution: str | None = None, distribution_version: str | None = None, infrastructure: str | None = None, private_link_state: str | _models.PrivateLinkState = 'Disabled', private_link_scope_resource_id: str | None = None, azure_hybrid_benefit: str | _models.AzureHybridBenefit | None = None, aad_profile: _models.AadProfile | None = None, arc_agent_profile: _models.ArcAgentProfile | None = None, security_profile: _models.SecurityProfile | None = None, oidc_issuer_profile: _models.OidcIssuerProfile | None = None, gateway: _models.Gateway | None = None, arc_agentry_configurations: List[_models.ArcAgentryConfigurations] | None = None, **kwargs: Any)[source]
Bases:
TrackedResourceRepresents a connected 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 server.
- Variables:
id (str) – Fully qualified resource ID for the resource. Ex - /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”.
location (str) – The geo-location where the resource lives. Required.
identity (ConnectedClusterIdentity) – The identity of the connected cluster. Required.
kind (str or ConnectedClusterKind) – The kind of connected cluster. Known values are: “ProvisionedCluster” and “AWS”.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
agent_public_key_certificate (str) – Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. Required.
kubernetes_version (str) – The Kubernetes version of the connected cluster resource.
total_node_count (int) – Number of nodes present in the connected cluster resource.
total_core_count (int) – Number of CPU cores present in the connected cluster resource.
agent_version (str) – Version of the agent running on the connected cluster resource.
provisioning_state (str or ProvisioningState) – Provisioning state of the connected cluster resource. Known values are: “Succeeded”, “Failed”, “Canceled”, “Provisioning”, “Updating”, “Deleting”, and “Accepted”.
distribution (str) – The Kubernetes distribution running on this connected cluster.
distribution_version (str) – The Kubernetes distribution version on this connected cluster.
infrastructure (str) – The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on.
offering (str) – Connected cluster offering.
managed_identity_certificate_expiration_time (datetime) – Expiration time of the managed identity certificate.
last_connectivity_time (datetime) – Time representing the last instance when heart beat was received from the cluster.
connectivity_status (str or ConnectivityStatus) – Represents the connectivity status of the connected cluster. Known values are: “Connecting”, “Connected”, “Offline”, “Expired”, and “AgentNotInstalled”.
private_link_state (str or PrivateLinkState) – Property which describes the state of private link on a connected cluster resource. Known values are: “Enabled” and “Disabled”.
private_link_scope_resource_id (str) – This is populated only if privateLinkState is enabled. The resource id of the private link scope this connected cluster is assigned to, if any.
azure_hybrid_benefit (str or AzureHybridBenefit) – Indicates whether Azure Hybrid Benefit is opted in. Known values are: “True”, “False”, and “NotApplicable”.
aad_profile (AadProfile) – AAD profile for the connected cluster.
arc_agent_profile (ArcAgentProfile) – Arc agentry configuration for the provisioned cluster.
security_profile (SecurityProfile) – Security profile for the connected cluster.
oidc_issuer_profile (OidcIssuerProfile) – Open ID Connect (OIDC) Issuer Profile for the connected cluster.
gateway (Gateway) – Details of the gateway used by the Arc router for connectivity.
arc_agentry_configurations (list[ArcAgentryConfigurations]) – Configuration settings for customizing the behavior of the connected cluster.
miscellaneous_properties (dict[str, str]) – More properties related to the Connected Cluster.
- Keyword Arguments:
location (str) – The geo-location where the resource lives. Required.
identity (ConnectedClusterIdentity) – The identity of the connected cluster. Required.
kind (str or ConnectedClusterKind) – The kind of connected cluster. Known values are: “ProvisionedCluster” and “AWS”.
agent_public_key_certificate (str) – Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. Required.
provisioning_state (str or ProvisioningState) – Provisioning state of the connected cluster resource. Known values are: “Succeeded”, “Failed”, “Canceled”, “Provisioning”, “Updating”, “Deleting”, and “Accepted”.
distribution (str) – The Kubernetes distribution running on this connected cluster.
distribution_version (str) – The Kubernetes distribution version on this connected cluster.
infrastructure (str) – The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on.
private_link_state (str or PrivateLinkState) – Property which describes the state of private link on a connected cluster resource. Known values are: “Enabled” and “Disabled”.
private_link_scope_resource_id (str) – This is populated only if privateLinkState is enabled. The resource id of the private link scope this connected cluster is assigned to, if any.
azure_hybrid_benefit (str or AzureHybridBenefit) – Indicates whether Azure Hybrid Benefit is opted in. Known values are: “True”, “False”, and “NotApplicable”.
aad_profile (AadProfile) – AAD profile for the connected cluster.
arc_agent_profile (ArcAgentProfile) – Arc agentry configuration for the provisioned cluster.
security_profile (SecurityProfile) – Security profile for the connected cluster.
oidc_issuer_profile (OidcIssuerProfile) – Open ID Connect (OIDC) Issuer Profile for the connected cluster.
gateway (Gateway) – Details of the gateway used by the Arc router for connectivity.
arc_agentry_configurations (list[ArcAgentryConfigurations]) – Configuration settings for customizing the behavior of the connected cluster.
- class azure.mgmt.hybridkubernetes.models.ConnectedClusterIdentity(*, type: str | _models.ResourceIdentityType = 'SystemAssigned', **kwargs: Any)[source]
Bases:
ModelIdentity for the connected 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 server.
- Variables:
principal_id (str) – The principal id of connected cluster identity. This property will only be provided for a system assigned identity.
tenant_id (str) – The tenant id associated with the connected cluster. This property will only be provided for a system assigned identity.
type (str or ResourceIdentityType) – The type of identity used for the connected cluster. The type ‘SystemAssigned, includes a system created identity. The type ‘None’ means no identity is assigned to the connected cluster. Known values are: “None” and “SystemAssigned”.
- Keyword Arguments:
type (str or ResourceIdentityType) – The type of identity used for the connected cluster. The type ‘SystemAssigned, includes a system created identity. The type ‘None’ means no identity is assigned to the connected cluster. Known values are: “None” and “SystemAssigned”.
- class azure.mgmt.hybridkubernetes.models.ConnectedClusterKind(*values)[source]
-
Indicates the kind of Arc connected cluster based on host infrastructure.
- AWS = 'AWS'
- PROVISIONED_CLUSTER = 'ProvisionedCluster'
- class azure.mgmt.hybridkubernetes.models.ConnectedClusterList(*, value: List[_models.ConnectedCluster] | None = None, next_link: str | None = None, **kwargs: Any)[source]
Bases:
ModelThe paginated list of connected Clusters.
- Variables:
value (list[ConnectedCluster]) – The list of connected clusters.
next_link (str) – The link to fetch the next page of connected clusters.
- Keyword Arguments:
value (list[ConnectedCluster]) – The list of connected clusters.
next_link (str) – The link to fetch the next page of connected clusters.
- class azure.mgmt.hybridkubernetes.models.ConnectedClusterPatch(*, tags: Dict[str, str] | None = None, distribution: str | None = None, distribution_version: str | None = None, azure_hybrid_benefit: str | _models.AzureHybridBenefit | None = None, **kwargs: Any)[source]
Bases:
ModelObject containing updates for patch operations.
- Variables:
distribution (str) – Represents the distribution of the connected cluster.
distribution_version (str) – Represents the Kubernetes distribution version on this connected cluster.
azure_hybrid_benefit (str or AzureHybridBenefit) – Indicates whether Azure Hybrid Benefit is opted in. Known values are: “True”, “False”, and “NotApplicable”.
- Keyword Arguments:
distribution (str) – Represents the distribution of the connected cluster.
distribution_version (str) – Represents the Kubernetes distribution version on this connected cluster.
azure_hybrid_benefit (str or AzureHybridBenefit) – Indicates whether Azure Hybrid Benefit is opted in. Known values are: “True”, “False”, and “NotApplicable”.
- class azure.mgmt.hybridkubernetes.models.ConnectivityStatus(*values)[source]
-
Represents the connectivity status of the connected cluster.
- AGENT_NOT_INSTALLED = 'AgentNotInstalled'
- CONNECTED = 'Connected'
- CONNECTING = 'Connecting'
- EXPIRED = 'Expired'
- OFFLINE = 'Offline'
- class azure.mgmt.hybridkubernetes.models.CreatedByType(*values)[source]
-
The type of identity that created the resource.
- APPLICATION = 'Application'
- KEY = 'Key'
- MANAGED_IDENTITY = 'ManagedIdentity'
- USER = 'User'
- class azure.mgmt.hybridkubernetes.models.CredentialResult(**kwargs: Any)[source]
Bases:
ModelThe credential result response.
Variables are only populated by the server, and will be ignored when sending a request.
- class azure.mgmt.hybridkubernetes.models.CredentialResults(**kwargs: Any)[source]
Bases:
ModelThe list of credential result response.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
hybrid_connection_config (HybridConnectionConfig) – Contains the REP (rendezvous endpoint) and “Sender” access token.
kubeconfigs (list[CredentialResult]) – Base64-encoded Kubernetes configuration file.
- class azure.mgmt.hybridkubernetes.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.hybridkubernetes.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.hybridkubernetes.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.hybridkubernetes.models.Gateway(*, enabled: bool | None = None, resource_id: str | None = None, **kwargs: Any)[source]
Bases:
ModelGateway.
- Variables:
- Keyword Arguments:
- class azure.mgmt.hybridkubernetes.models.HybridConnectionConfig(**kwargs: Any)[source]
Bases:
ModelContains the REP (rendezvous endpoint) and “Sender” access token.
Variables are only populated by the server, and will be ignored when sending a request.
- class azure.mgmt.hybridkubernetes.models.LastModifiedByType(*values)[source]
-
The type of identity that last modified the resource.
- APPLICATION = 'Application'
- KEY = 'Key'
- MANAGED_IDENTITY = 'ManagedIdentity'
- USER = 'User'
- class azure.mgmt.hybridkubernetes.models.ListClusterUserCredentialProperties(*, authentication_method: str | _models.AuthenticationMethod, client_proxy: bool, **kwargs: Any)[source]
Bases:
ModelListClusterUserCredentialProperties.
All required parameters must be populated in order to send to server.
- Variables:
authentication_method (str or AuthenticationMethod) – The mode of client authentication. Required. Known values are: “Token” and “AAD”.
client_proxy (bool) – Boolean value to indicate whether the request is for client side proxy or not. Required.
- Keyword Arguments:
authentication_method (str or AuthenticationMethod) – The mode of client authentication. Required. Known values are: “Token” and “AAD”.
client_proxy (bool) – Boolean value to indicate whether the request is for client side proxy or not. Required.
- class azure.mgmt.hybridkubernetes.models.OidcIssuerProfile(*, enabled: bool | None = None, self_hosted_issuer_url: str | None = None, **kwargs: Any)[source]
Bases:
ModelOIDC Issuer Profile specifies attributes for workload identity integration.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
enabled (bool) – Whether to enable oidc issuer for workload identity integration.
issuer_url (str) – The issuer url for hybrid clusters connected to Arc used for the workload identity feature.
self_hosted_issuer_url (str) – The issuer url for public cloud clusters - AKS, EKS, GKE - used for the workload identity feature.
- Keyword Arguments:
- class azure.mgmt.hybridkubernetes.models.Operation(**kwargs: Any)[source]
Bases:
ModelThe Connected cluster API operation.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
name (str) – Operation name: {Microsoft.Kubernetes}/{resource}/{operation}.
display (OperationDisplay) – The object that represents the operation.
- class azure.mgmt.hybridkubernetes.models.OperationDisplay(*, provider: str | None = None, resource: str | None = None, operation: str | None = None, description: str | None = None, **kwargs: Any)[source]
Bases:
ModelThe object that represents the operation.
- Variables:
- Keyword Arguments:
- class azure.mgmt.hybridkubernetes.models.OperationList(*, next_link: str | None = None, **kwargs: Any)[source]
Bases:
ModelThe paginated list of connected cluster API operations.
Variables are only populated by the server, and will be ignored when sending a request.
- class azure.mgmt.hybridkubernetes.models.PrivateLinkState(*values)[source]
-
Property which describes the state of private link on a connected cluster resource.
- DISABLED = 'Disabled'
- ENABLED = 'Enabled'
- class azure.mgmt.hybridkubernetes.models.ProvisioningState(*values)[source]
-
The current deployment state of connectedClusters.
- ACCEPTED = 'Accepted'
- CANCELED = 'Canceled'
- DELETING = 'Deleting'
- FAILED = 'Failed'
- PROVISIONING = 'Provisioning'
- SUCCEEDED = 'Succeeded'
- UPDATING = 'Updating'
- class azure.mgmt.hybridkubernetes.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. Ex - /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”.
- class azure.mgmt.hybridkubernetes.models.ResourceIdentityType(*values)[source]
-
The type of identity used for the connected cluster. The type ‘SystemAssigned, includes a system created identity. The type ‘None’ means no identity is assigned to the connected cluster.
- NONE = 'None'
- SYSTEM_ASSIGNED = 'SystemAssigned'
- class azure.mgmt.hybridkubernetes.models.SecurityProfile(*, workload_identity: _models.SecurityProfileWorkloadIdentity | None = None, **kwargs: Any)[source]
Bases:
ModelSecurity Profile specifies attributes for cluster security features.
- Variables:
workload_identity (SecurityProfileWorkloadIdentity) – The workload identity feature webhook.
- Keyword Arguments:
workload_identity (SecurityProfileWorkloadIdentity) – The workload identity feature webhook.
- class azure.mgmt.hybridkubernetes.models.SecurityProfileWorkloadIdentity(*, enabled: bool | None = None, **kwargs: Any)[source]
Bases:
ModelThe workload identity feature webhook.
- class azure.mgmt.hybridkubernetes.models.SystemComponent(*, type: str | None = None, user_specified_version: str | None = None, major_version: int | None = None, **kwargs: Any)[source]
Bases:
ModelSystem extensions and its current versions installed on the cluster resource.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables:
type (str) – Type of the system extension.
user_specified_version (str) – Version of the system extension to be installed on the cluster resource.
major_version (int) – Major Version of the system extension that is currently installed on the cluster resource.
current_version (str) – Version of the system extension that is currently installed on the cluster resource.
- Keyword Arguments:
- class azure.mgmt.hybridkubernetes.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.LastModifiedByType | 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 LastModifiedByType) – 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 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 LastModifiedByType) – 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 modification (UTC).
- class azure.mgmt.hybridkubernetes.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. Ex - /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”.
location (str) – The geo-location where the resource lives. Required.
- Keyword Arguments: