From 2b9970b0d391025a2cd980c7617e42c412da25d4 Mon Sep 17 00:00:00 2001 From: SDKAuto Date: Wed, 23 Jun 2021 03:37:46 +0000 Subject: [PATCH] CodeGen from PR 14934 in Azure/azure-rest-api-specs Improve AKS Swagger documentation (#14934) * Improve AKS Swagger documentation * PR feedback * Undo "breaking" changes --- .../azure-mgmt-containerservice/_meta.json | 6 +- .../aio/operations/_agent_pools_operations.py | 32 +- .../_maintenance_configurations_operations.py | 14 +- .../_managed_clusters_operations.py | 92 +- .../v2021_05_01/aio/operations/_operations.py | 4 +- ...private_endpoint_connections_operations.py | 15 +- .../_private_link_resources_operations.py | 4 +- ...olve_private_link_service_id_operations.py | 5 +- .../models/_container_service_client_enums.py | 164 +++- .../v2021_05_01/models/_models.py | 831 ++++++++++-------- .../v2021_05_01/models/_models_py3.py | 831 ++++++++++-------- .../operations/_agent_pools_operations.py | 32 +- .../_maintenance_configurations_operations.py | 14 +- .../_managed_clusters_operations.py | 92 +- .../v2021_05_01/operations/_operations.py | 4 +- ...private_endpoint_connections_operations.py | 15 +- .../_private_link_resources_operations.py | 4 +- ...olve_private_link_service_id_operations.py | 5 +- 18 files changed, 1240 insertions(+), 924 deletions(-) diff --git a/sdk/containerservice/azure-mgmt-containerservice/_meta.json b/sdk/containerservice/azure-mgmt-containerservice/_meta.json index 239763438918..4368ec284b11 100644 --- a/sdk/containerservice/azure-mgmt-containerservice/_meta.json +++ b/sdk/containerservice/azure-mgmt-containerservice/_meta.json @@ -1,11 +1,11 @@ { "autorest": "3.4.2", "use": [ - "@autorest/python@5.8.0", + "@autorest/python@5.8.1", "@autorest/modelerfour@4.19.2" ], - "commit": "1f0bb3f63b1664ace42cfdf646d8b2382d7b7b22", + "commit": "b1d61ca939032ef60605f98e1bfda15df146c3ab", "repository_url": "https://github.com/Azure/azure-rest-api-specs", - "autorest_command": "autorest specification/containerservice/resource-manager/readme.md --multiapi --python --python-mode=update --python-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-python/sdk --track2 --use=@autorest/python@5.8.0 --use=@autorest/modelerfour@4.19.2 --version=3.4.2", + "autorest_command": "autorest specification/containerservice/resource-manager/readme.md --multiapi --python --python-mode=update --python-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-python/sdk --track2 --use=@autorest/python@5.8.1 --use=@autorest/modelerfour@4.19.2 --version=3.4.2", "readme": "specification/containerservice/resource-manager/readme.md" } \ No newline at end of file diff --git a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_agent_pools_operations.py b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_agent_pools_operations.py index 0509972712f3..e3aa21c489dc 100644 --- a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_agent_pools_operations.py +++ b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_agent_pools_operations.py @@ -51,8 +51,7 @@ def list( ) -> AsyncIterable["_models.AgentPoolListResult"]: """Gets a list of agent pools in the specified managed cluster. - Gets a list of agent pools in the specified managed cluster. The operation returns properties - of each agent pool. + Gets a list of agent pools in the specified managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -127,9 +126,9 @@ async def get( agent_pool_name: str, **kwargs: Any ) -> "_models.AgentPool": - """Gets the agent pool. + """Gets the specified managed cluster agent pool. - Gets the details of the agent pool by managed cluster and resource group. + Gets the specified managed cluster agent pool. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -251,7 +250,7 @@ async def begin_create_or_update( parameters: "_models.AgentPool", **kwargs: Any ) -> AsyncLROPoller["_models.AgentPool"]: - """Creates or updates an agent pool. + """Creates or updates an agent pool in the specified managed cluster. Creates or updates an agent pool in the specified managed cluster. @@ -261,7 +260,7 @@ async def begin_create_or_update( :type resource_name: str :param agent_pool_name: The name of the agent pool. :type agent_pool_name: str - :param parameters: Parameters supplied to the Create or Update an agent pool operation. + :param parameters: The agent pool to create or update. :type parameters: ~azure.mgmt.containerservice.v2021_05_01.models.AgentPool :keyword callable cls: A custom type or function that will be passed the direct response :keyword str continuation_token: A continuation token to restart a poller from a saved state. @@ -374,9 +373,9 @@ async def begin_delete( agent_pool_name: str, **kwargs: Any ) -> AsyncLROPoller[None]: - """Deletes an agent pool. + """Deletes an agent pool in the specified managed cluster. - Deletes the agent pool in the specified managed cluster. + Deletes an agent pool in the specified managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -445,10 +444,9 @@ async def get_upgrade_profile( agent_pool_name: str, **kwargs: Any ) -> "_models.AgentPoolUpgradeProfile": - """Gets upgrade profile for an agent pool. + """Gets the upgrade profile for an agent pool. - Gets the details of the upgrade profile for an agent pool with a specified resource group and - managed cluster name. + Gets the upgrade profile for an agent pool. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -509,9 +507,11 @@ async def get_available_agent_pool_versions( resource_name: str, **kwargs: Any ) -> "_models.AgentPoolAvailableVersions": - """Gets a list of supported versions for the specified agent pool. + """Gets a list of supported Kubernetes versions for the specified agent pool. - Gets a list of supported versions for the specified agent pool. + See `supported Kubernetes versions + `_ for more details about + the version lifecycle. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -621,9 +621,11 @@ async def begin_upgrade_node_image_version( agent_pool_name: str, **kwargs: Any ) -> AsyncLROPoller["_models.AgentPool"]: - """Upgrade node image version of an agent pool to the latest. + """Upgrades the node image version of an agent pool to the latest. - Upgrade node image version of an agent pool to the latest. + Upgrading the node image version of an agent pool applies the newest OS and runtime updates to + the nodes. AKS provides one new image per week with the latest updates. For more details on + node image versions, see: https://docs.microsoft.com/azure/aks/node-image-upgrade. :param resource_group_name: The name of the resource group. :type resource_group_name: str diff --git a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_maintenance_configurations_operations.py b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_maintenance_configurations_operations.py index b10621f7b93f..e8c0d7389557 100644 --- a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_maintenance_configurations_operations.py +++ b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_maintenance_configurations_operations.py @@ -49,8 +49,7 @@ def list_by_managed_cluster( ) -> AsyncIterable["_models.MaintenanceConfigurationListResult"]: """Gets a list of maintenance configurations in the specified managed cluster. - Gets a list of maintenance configurations in the specified managed cluster. The operation - returns properties of each maintenance configuration. + Gets a list of maintenance configurations in the specified managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -125,9 +124,9 @@ async def get( config_name: str, **kwargs: Any ) -> "_models.MaintenanceConfiguration": - """Gets the maintenance configuration. + """Gets the specified maintenance configuration of a managed cluster. - Gets the details of maintenance configurations by managed cluster and resource group. + Gets the specified maintenance configuration of a managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -190,7 +189,7 @@ async def create_or_update( parameters: "_models.MaintenanceConfiguration", **kwargs: Any ) -> "_models.MaintenanceConfiguration": - """Creates or updates a maintenance configurations. + """Creates or updates a maintenance configuration in the specified managed cluster. Creates or updates a maintenance configuration in the specified managed cluster. @@ -200,8 +199,7 @@ async def create_or_update( :type resource_name: str :param config_name: The name of the maintenance configuration. :type config_name: str - :param parameters: Parameters supplied to the Create or Update a default maintenance - configuration. + :param parameters: The maintenance configuration to create or update. :type parameters: ~azure.mgmt.containerservice.v2021_05_01.models.MaintenanceConfiguration :keyword callable cls: A custom type or function that will be passed the direct response :return: MaintenanceConfiguration, or the result of cls(response) @@ -264,7 +262,7 @@ async def delete( ) -> None: """Deletes a maintenance configuration. - Deletes the maintenance configuration in the specified managed cluster. + Deletes a maintenance configuration. :param resource_group_name: The name of the resource group. :type resource_group_name: str diff --git a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_managed_clusters_operations.py b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_managed_clusters_operations.py index 4fc5b8a65492..2d4702b66e1c 100644 --- a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_managed_clusters_operations.py +++ b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_managed_clusters_operations.py @@ -55,7 +55,7 @@ async def get_os_options( :param location: The name of a supported Azure region. :type location: str - :param resource_type: resource type for which the OS options needs to be returned. + :param resource_type: The resource type for which the OS options needs to be returned. :type resource_type: str :keyword callable cls: A custom type or function that will be passed the direct response :return: OSOptionProfile, or the result of cls(response) @@ -110,8 +110,7 @@ def list( ) -> AsyncIterable["_models.ManagedClusterListResult"]: """Gets a list of managed clusters in the specified subscription. - Gets a list of managed clusters in the specified subscription. The operation returns properties - of each managed cluster. + Gets a list of managed clusters in the specified subscription. :keyword callable cls: A custom type or function that will be passed the direct response :return: An iterator like instance of either ManagedClusterListResult or the result of cls(response) @@ -180,8 +179,7 @@ def list_by_resource_group( ) -> AsyncIterable["_models.ManagedClusterListResult"]: """Lists managed clusters in the specified subscription and resource group. - Lists managed clusters in the specified subscription and resource group. The operation returns - properties of each managed cluster. + Lists managed clusters in the specified subscription and resource group. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -252,10 +250,9 @@ async def get_upgrade_profile( resource_name: str, **kwargs: Any ) -> "_models.ManagedClusterUpgradeProfile": - """Gets upgrade profile for a managed cluster. + """Gets the upgrade profile of a managed cluster. - Gets the details of the upgrade profile for a managed cluster with a specified resource group - and name. + Gets the upgrade profile of a managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -316,12 +313,10 @@ async def get_access_profile( ) -> "_models.ManagedClusterAccessProfile": """Gets an access profile of a managed cluster. - Gets the accessProfile for the specified role name of the managed cluster with a specified - resource group and name. **WARNING**\ : This API will be deprecated. Instead use - `ListClusterUserCredentials - `_ or + **WARNING**\ : This API will be deprecated. Instead use `ListClusterUserCredentials + `_ or `ListClusterAdminCredentials - `_ . + `_ . :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -383,9 +378,9 @@ async def list_cluster_admin_credentials( server_fqdn: Optional[str] = None, **kwargs: Any ) -> "_models.CredentialResults": - """Gets cluster admin credential of a managed cluster. + """Lists the admin credentials of a managed cluster. - Gets cluster admin credential of the managed cluster with a specified resource group and name. + Lists the admin credentials of a managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -448,9 +443,9 @@ async def list_cluster_user_credentials( server_fqdn: Optional[str] = None, **kwargs: Any ) -> "_models.CredentialResults": - """Gets cluster user credential of a managed cluster. + """Lists the user credentials of a managed cluster. - Gets cluster user credential of the managed cluster with a specified resource group and name. + Lists the user credentials of a managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -513,10 +508,9 @@ async def list_cluster_monitoring_user_credentials( server_fqdn: Optional[str] = None, **kwargs: Any ) -> "_models.CredentialResults": - """Gets cluster monitoring user credential of a managed cluster. + """Lists the cluster monitoring user credentials of a managed cluster. - Gets cluster monitoring user credential of the managed cluster with a specified resource group - and name. + Lists the cluster monitoring user credentials of a managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -580,7 +574,7 @@ async def get( ) -> "_models.ManagedCluster": """Gets a managed cluster. - Gets the details of the managed cluster with a specified resource group and name. + Gets a managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -698,14 +692,13 @@ async def begin_create_or_update( ) -> AsyncLROPoller["_models.ManagedCluster"]: """Creates or updates a managed cluster. - Creates or updates a managed cluster with the specified configuration for agents and Kubernetes - version. + Creates or updates a managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str :param resource_name: The name of the managed cluster resource. :type resource_name: str - :param parameters: Parameters supplied to the Create or Update a Managed Cluster operation. + :param parameters: The managed cluster to create or update. :type parameters: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedCluster :keyword callable cls: A custom type or function that will be passed the direct response :keyword str continuation_token: A continuation token to restart a poller from a saved state. @@ -825,7 +818,7 @@ async def begin_update_tags( ) -> AsyncLROPoller["_models.ManagedCluster"]: """Updates tags on a managed cluster. - Updates a managed cluster with the specified tags. + Updates tags on a managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -941,7 +934,7 @@ async def begin_delete( ) -> AsyncLROPoller[None]: """Deletes a managed cluster. - Deletes the managed cluster with a specified resource group and name. + Deletes a managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -1056,16 +1049,15 @@ async def begin_reset_service_principal_profile( parameters: "_models.ManagedClusterServicePrincipalProfile", **kwargs: Any ) -> AsyncLROPoller[None]: - """Reset Service Principal Profile of a managed cluster. + """Reset the Service Principal Profile of a managed cluster. - Update the service principal Profile for a managed cluster. + This action cannot be performed on a cluster that is not using a service principal. :param resource_group_name: The name of the resource group. :type resource_group_name: str :param resource_name: The name of the managed cluster resource. :type resource_name: str - :param parameters: Parameters supplied to the Reset Service Principal Profile operation for a - Managed Cluster. + :param parameters: The service principal profile to set on the managed cluster. :type parameters: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterServicePrincipalProfile :keyword callable cls: A custom type or function that will be passed the direct response :keyword str continuation_token: A continuation token to restart a poller from a saved state. @@ -1177,16 +1169,15 @@ async def begin_reset_aad_profile( parameters: "_models.ManagedClusterAADProfile", **kwargs: Any ) -> AsyncLROPoller[None]: - """Reset AAD Profile of a managed cluster. + """Reset the AAD Profile of a managed cluster. - Update the AAD Profile for a managed cluster. + Reset the AAD Profile of a managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str :param resource_name: The name of the managed cluster resource. :type resource_name: str - :param parameters: Parameters supplied to the Reset AAD Profile operation for a Managed - Cluster. + :param parameters: The AAD profile to set on the Managed Cluster. :type parameters: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterAADProfile :keyword callable cls: A custom type or function that will be passed the direct response :keyword str continuation_token: A continuation token to restart a poller from a saved state. @@ -1291,9 +1282,10 @@ async def begin_rotate_cluster_certificates( resource_name: str, **kwargs: Any ) -> AsyncLROPoller[None]: - """Rotate certificates of a managed cluster. + """Rotates the certificates of a managed cluster. - Rotate certificates of a managed cluster. + See `Certificate rotation `_ for + more details about rotating managed cluster certificates. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -1401,9 +1393,13 @@ async def begin_stop( resource_name: str, **kwargs: Any ) -> AsyncLROPoller[None]: - """Stop Managed Cluster. + """Stops a Managed Cluster. - Stops a Running Managed Cluster. + This can only be performed on Azure Virtual Machine Scale set backed clusters. Stopping a + cluster stops the control plane and agent nodes entirely, while maintaining all object and + cluster state. A cluster does not accrue charges while it is stopped. See `stopping a cluster + `_ for more details about stopping a + cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -1511,9 +1507,10 @@ async def begin_start( resource_name: str, **kwargs: Any ) -> AsyncLROPoller[None]: - """Start Managed Cluster. + """Starts a previously stopped Managed Cluster. - Starts a Stopped Managed Cluster. + See `starting a cluster `_ for more + details about starting a cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -1633,16 +1630,17 @@ async def begin_run_command( request_payload: "_models.RunCommandRequest", **kwargs: Any ) -> AsyncLROPoller["_models.RunCommandResult"]: - """Run Command against Managed Kubernetes Service. + """Submits a command to run against the Managed Cluster. - Submit a command to run against managed kubernetes service, it will create a pod to run the - command. + AKS will create a pod to run the command. This is primarily useful for private clusters. For + more information see `AKS Run Command + `_. :param resource_group_name: The name of the resource group. :type resource_group_name: str :param resource_name: The name of the managed cluster resource. :type resource_name: str - :param request_payload: Parameters supplied to the RunCommand operation. + :param request_payload: The run command request. :type request_payload: ~azure.mgmt.containerservice.v2021_05_01.models.RunCommandRequest :keyword callable cls: A custom type or function that will be passed the direct response :keyword str continuation_token: A continuation token to restart a poller from a saved state. @@ -1707,15 +1705,15 @@ async def get_command_result( command_id: str, **kwargs: Any ) -> Optional["_models.RunCommandResult"]: - """Get command result. + """Gets the results of a command which has been run on the Managed Cluster. - Get command result from previous runCommand invoke. + Gets the results of a command which has been run on the Managed Cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str :param resource_name: The name of the managed cluster resource. :type resource_name: str - :param command_id: Id of the command request. + :param command_id: Id of the command. :type command_id: str :keyword callable cls: A custom type or function that will be passed the direct response :return: RunCommandResult, or the result of cls(response) diff --git a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_operations.py b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_operations.py index 5bb49c542c2a..fd64291b851e 100644 --- a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_operations.py +++ b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_operations.py @@ -45,7 +45,9 @@ def list( self, **kwargs: Any ) -> AsyncIterable["_models.OperationListResult"]: - """Gets a list of compute operations. + """Gets a list of operations. + + Gets a list of operations. :keyword callable cls: A custom type or function that will be passed the direct response :return: An iterator like instance of either OperationListResult or the result of cls(response) diff --git a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_private_endpoint_connections_operations.py b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_private_endpoint_connections_operations.py index 5881a84458da..8c5611dd5adf 100644 --- a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_private_endpoint_connections_operations.py +++ b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_private_endpoint_connections_operations.py @@ -50,8 +50,8 @@ async def list( ) -> "_models.PrivateEndpointConnectionListResult": """Gets a list of private endpoint connections in the specified managed cluster. - Gets a list of private endpoint connections in the specified managed cluster. The operation - returns properties of each private endpoint connection. + To learn more about private clusters, see: + https://docs.microsoft.com/azure/aks/private-clusters. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -110,9 +110,10 @@ async def get( private_endpoint_connection_name: str, **kwargs: Any ) -> "_models.PrivateEndpointConnection": - """Gets the private endpoint connection. + """Gets the specified private endpoint connection. - Gets the details of the private endpoint connection by managed cluster and resource group. + To learn more about private clusters, see: + https://docs.microsoft.com/azure/aks/private-clusters. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -177,7 +178,7 @@ async def update( ) -> "_models.PrivateEndpointConnection": """Updates a private endpoint connection. - Updates a private endpoint connection in the specified managed cluster. + Updates a private endpoint connection. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -185,7 +186,7 @@ async def update( :type resource_name: str :param private_endpoint_connection_name: The name of the private endpoint connection. :type private_endpoint_connection_name: str - :param parameters: Parameters supplied to the Update a private endpoint connection operation. + :param parameters: The updated private endpoint connection. :type parameters: ~azure.mgmt.containerservice.v2021_05_01.models.PrivateEndpointConnection :keyword callable cls: A custom type or function that will be passed the direct response :return: PrivateEndpointConnection, or the result of cls(response) @@ -294,7 +295,7 @@ async def begin_delete( ) -> AsyncLROPoller[None]: """Deletes a private endpoint connection. - Deletes the private endpoint connection in the specified managed cluster. + Deletes a private endpoint connection. :param resource_group_name: The name of the resource group. :type resource_group_name: str diff --git a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_private_link_resources_operations.py b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_private_link_resources_operations.py index dd9f79796f64..b8283cdfee17 100644 --- a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_private_link_resources_operations.py +++ b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_private_link_resources_operations.py @@ -48,8 +48,8 @@ async def list( ) -> "_models.PrivateLinkResourcesListResult": """Gets a list of private link resources in the specified managed cluster. - Gets a list of private link resources in the specified managed cluster. The operation returns - properties of each private link resource. + To learn more about private clusters, see: + https://docs.microsoft.com/azure/aks/private-clusters. :param resource_group_name: The name of the resource group. :type resource_group_name: str diff --git a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_resolve_private_link_service_id_operations.py b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_resolve_private_link_service_id_operations.py index 930df4ecfc50..55150ba5ee1c 100644 --- a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_resolve_private_link_service_id_operations.py +++ b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/aio/operations/_resolve_private_link_service_id_operations.py @@ -49,14 +49,13 @@ async def post( ) -> "_models.PrivateLinkResource": """Gets the private link service ID for the specified managed cluster. - Gets the private link service ID the specified managed cluster. + Gets the private link service ID for the specified managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str :param resource_name: The name of the managed cluster resource. :type resource_name: str - :param parameters: Parameters (name, groupId) supplied in order to resolve a private link - service ID. + :param parameters: Parameters required in order to resolve a private link service ID. :type parameters: ~azure.mgmt.containerservice.v2021_05_01.models.PrivateLinkResource :keyword callable cls: A custom type or function that will be passed the direct response :return: PrivateLinkResource, or the result of cls(response) diff --git a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/models/_container_service_client_enums.py b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/models/_container_service_client_enums.py index bdf1668dad13..5590a8b36cfb 100644 --- a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/models/_container_service_client_enums.py +++ b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/models/_container_service_client_enums.py @@ -27,24 +27,34 @@ def __getattr__(cls, name): class AgentPoolMode(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): - """AgentPoolMode represents mode of an agent pool. + """A cluster must have at least one 'System' Agent Pool at all times. For additional information + on agent pool restrictions and best practices, see: + https://docs.microsoft.com/azure/aks/use-system-pools """ + #: System agent pools are primarily for hosting critical system pods such as CoreDNS and + #: metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at + #: least 2vCPUs and 4GB of memory. SYSTEM = "System" + #: User agent pools are primarily for hosting your application pods. USER = "User" class AgentPoolType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): - """AgentPoolType represents types of an agent pool. + """The type of Agent Pool. """ + #: Create an Agent Pool backed by a Virtual Machine Scale Set. VIRTUAL_MACHINE_SCALE_SETS = "VirtualMachineScaleSets" + #: Use of this is strongly discouraged. AVAILABILITY_SET = "AvailabilitySet" class Code(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): """Tells whether the cluster is Running or Stopped """ + #: The cluster is running. RUNNING = "Running" + #: The cluster is stopped. STOPPED = "Stopped" class ConnectionStatus(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): @@ -57,15 +67,15 @@ class ConnectionStatus(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): DISCONNECTED = "Disconnected" class ContainerServiceStorageProfileTypes(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): - """Storage profile specifies what kind of storage used. Choose from StorageAccount and - ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice. + """Specifies what kind of storage to use. If omitted, the default will be chosen on your behalf + based on the choice of orchestrator. """ STORAGE_ACCOUNT = "StorageAccount" MANAGED_DISKS = "ManagedDisks" class ContainerServiceVMSizeTypes(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): - """Size of agent VMs. + """Size of agent VMs. Note: This is no longer maintained. """ STANDARD_A1 = "Standard_A1" @@ -262,10 +272,26 @@ class CreatedByType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): KEY = "Key" class Expander(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): + """If not specified, the default is 'random'. See `expanders + `_ + for more information. + """ + #: Selects the node group that will have the least idle CPU (if tied, unused memory) after + #: scale-up. This is useful when you have different classes of nodes, for example, high CPU or + #: high memory nodes, and only want to expand those when there are pending pods that need a lot of + #: those resources. LEAST_WASTE = "least-waste" + #: Selects the node group that would be able to schedule the most pods when scaling up. This is + #: useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note + #: that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple + #: smaller nodes at once. MOST_PODS = "most-pods" + #: Selects the node group that has the highest priority assigned by the user. It's configuration + #: is described in more details `here + #: `_. PRIORITY = "priority" + #: Used when you don't have a particular need for the node groups to scale differently. RANDOM = "random" class ExtendedLocationTypes(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): @@ -276,7 +302,6 @@ class ExtendedLocationTypes(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)) class GPUInstanceProfile(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): """GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. - Supported values are MIG1g, MIG2g, MIG3g, MIG4g and MIG7g. """ MIG1_G = "MIG1g" @@ -286,26 +311,36 @@ class GPUInstanceProfile(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): MIG7_G = "MIG7g" class KubeletDiskType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): - """KubeletDiskType determines the placement of emptyDir volumes, container runtime data root, and - Kubelet ephemeral storage. Allowed values: 'OS', 'Temporary' (preview). + """Determines the placement of emptyDir volumes, container runtime data root, and Kubelet + ephemeral storage. """ + #: Kubelet will use the OS disk for its data. OS = "OS" + #: Kubelet will use the temporary disk for its data. TEMPORARY = "Temporary" class LicenseType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): - """The licenseType to use for Windows VMs. Windows_Server is used to enable Azure Hybrid User - Benefits for Windows VMs. + """The license type to use for Windows VMs. See `Azure Hybrid User Benefits + `_ for more details. """ + #: No additional licensing is applied. NONE = "None" + #: Enables Azure Hybrid User Benefits for Windows VMs. WINDOWS_SERVER = "Windows_Server" class LoadBalancerSku(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): - """The load balancer sku for the managed cluster. + """The default is 'standard'. See `Azure Load Balancer SKUs + `_ for more information about the + differences between load balancer SKUs. """ + #: Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information + #: about on working with the load balancer in the managed cluster, see the `standard Load Balancer + #: `_ article. STANDARD = "standard" + #: Use a basic Load Balancer with limited functionality. BASIC = "basic" class ManagedClusterPodIdentityProvisioningState(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): @@ -318,66 +353,104 @@ class ManagedClusterPodIdentityProvisioningState(with_metaclass(_CaseInsensitive FAILED = "Failed" class ManagedClusterSKUName(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): - """Name of a managed cluster SKU. + """The name of a managed cluster SKU. """ BASIC = "Basic" class ManagedClusterSKUTier(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): - """Tier of a managed cluster SKU. + """If not specified, the default is 'Free'. See `uptime SLA + `_ for more details. """ + #: Guarantees 99.95% availability of the Kubernetes API server endpoint for clusters that use + #: Availability Zones and 99.9% of availability for clusters that don't use Availability Zones. PAID = "Paid" + #: No guaranteed SLA, no additional charges. Free tier clusters have an SLO of 99.5%. FREE = "Free" class NetworkMode(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): - """Network mode used for building Kubernetes network. + """This cannot be specified if networkPlugin is anything other than 'azure'. """ + #: No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure + #: CNI. See `Transparent Mode `_ for + #: more information. TRANSPARENT = "transparent" + #: This is no longer supported. BRIDGE = "bridge" class NetworkPlugin(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): - """Network plugin used for building Kubernetes network. + """Network plugin used for building the Kubernetes network. """ + #: Use the Azure CNI network plugin. See `Azure CNI (advanced) networking + #: `_ for + #: more information. AZURE = "azure" + #: Use the Kubenet network plugin. See `Kubenet (basic) networking + #: `_ for more + #: information. KUBENET = "kubenet" class NetworkPolicy(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): - """Network policy used for building Kubernetes network. + """Network policy used for building the Kubernetes network. """ + #: Use Calico network policies. See `differences between Azure and Calico policies + #: `_ + #: for more information. CALICO = "calico" + #: Use Azure network policies. See `differences between Azure and Calico policies + #: `_ + #: for more information. AZURE = "azure" class OSDiskType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): - """OSDiskType represents the type of an OS disk on an agent pool. + """The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested + OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more + information see `Ephemeral OS + `_. """ + #: Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data + #: loss should the VM need to be relocated to another host. Since containers aren't designed to + #: have local state persisted, this behavior offers limited value while providing some drawbacks, + #: including slower node provisioning and higher read/write latency. MANAGED = "Managed" + #: Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This + #: provides lower read/write latency, along with faster node scaling and cluster upgrades. EPHEMERAL = "Ephemeral" class OSSKU(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): - """OsSKU to be used to specify os sku. Choose from Ubuntu(default) and CBLMariner for Linux - OSType. Not applicable to Windows OSType. + """Specifies an OS SKU. This value must not be specified if OSType is Windows. """ UBUNTU = "Ubuntu" CBL_MARINER = "CBLMariner" class OSType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): - """OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. + """The operating system type. The default is Linux. """ + #: Use Linux. LINUX = "Linux" + #: Use Windows. WINDOWS = "Windows" class OutboundType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): - """The outbound (egress) routing method. + """This can only be set at cluster creation time and cannot be changed later. For more information + see `egress outbound type `_. """ + #: The load balancer is used for egress through an AKS assigned public IP. This supports + #: Kubernetes services of type 'loadBalancer'. For more information see `outbound type + #: loadbalancer + #: `_. LOAD_BALANCER = "loadBalancer" + #: Egress paths must be defined by the user. This is an advanced scenario and requires proper + #: network configuration. For more information see `outbound type userDefinedRouting + #: `_. USER_DEFINED_ROUTING = "userDefinedRouting" class PrivateEndpointConnectionProvisioningState(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): @@ -390,39 +463,72 @@ class PrivateEndpointConnectionProvisioningState(with_metaclass(_CaseInsensitive FAILED = "Failed" class ResourceIdentityType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): - """The type of identity used for the managed cluster. Type 'SystemAssigned' will use an implicitly - created identity in master components and an auto-created user assigned identity in MC_ - resource group in agent nodes. Type 'None' will not use MSI for the managed cluster, service - principal will be used instead. + """For more information see `use managed identities in AKS + `_. """ + #: Use an implicitly created system assigned managed identity to manage cluster resources. Master + #: components in the control plane such as kube-controller-manager will use the system assigned + #: managed identity to manipulate Azure resources. SYSTEM_ASSIGNED = "SystemAssigned" + #: Use a user-specified identity to manage cluster resources. Master components in the control + #: plane such as kube-controller-manager will use the specified user assigned managed identity to + #: manipulate Azure resources. USER_ASSIGNED = "UserAssigned" + #: Do not use a managed identity for the Managed Cluster, service principal will be used instead. NONE = "None" class ScaleSetEvictionPolicy(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): - """ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale - set. Default to Delete. + """The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. + For more information about eviction see `spot VMs + `_ """ + #: Nodes in the underlying Scale Set of the node pool are deleted when they're evicted. DELETE = "Delete" + #: Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state + #: upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can + #: cause issues with cluster scaling or upgrading. DEALLOCATE = "Deallocate" class ScaleSetPriority(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): - """ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. + """The Virtual Machine Scale Set priority. """ + #: Spot priority VMs will be used. There is no SLA for spot nodes. See `spot on AKS + #: `_ for more information. SPOT = "Spot" + #: Regular VMs will be used. REGULAR = "Regular" class UpgradeChannel(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): - """upgrade channel for auto upgrade. + """For more information see `setting the AKS cluster auto-upgrade channel + `_. """ + #: Automatically upgrade the cluster to the latest supported patch release on the latest supported + #: minor version. In cases where the cluster is at a version of Kubernetes that is at an N-2 minor + #: version where N is the latest supported minor version, the cluster first upgrades to the latest + #: supported patch version on N-1 minor version. For example, if a cluster is running version + #: 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster first is + #: upgraded to 1.18.6, then is upgraded to 1.19.1. RAPID = "rapid" + #: Automatically upgrade the cluster to the latest supported patch release on minor version N-1, + #: where N is the latest supported minor version. For example, if a cluster is running version + #: 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded + #: to 1.18.6. STABLE = "stable" + #: Automatically upgrade the cluster to the latest supported patch version when it becomes + #: available while keeping the minor version the same. For example, if a cluster is running + #: version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is + #: upgraded to 1.17.9. PATCH = "patch" + #: Automatically upgrade the node image to the latest version available. Microsoft provides + #: patches and new images for image nodes frequently (usually weekly), but your running nodes + #: won't get the new images unless you do a node image upgrade. Turning on the node-image channel + #: will automatically update your node images whenever a new version is available. NODE_IMAGE = "node-image" + #: Disables auto-upgrades and keeps the cluster at its current version of Kubernetes. NONE = "none" class WeekDay(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)): diff --git a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/models/_models.py b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/models/_models.py index 0df038e3e8e0..8c35ea60a386 100644 --- a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/models/_models.py +++ b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/models/_models.py @@ -61,107 +61,123 @@ class AgentPool(SubResource): range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. :type count: int - :param vm_size: Size of agent VMs. + :param vm_size: VM size availability varies by region. If a node contains insufficient compute + resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted + VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions. :type vm_size: str :param os_disk_size_gb: OS Disk Size in GB to be used to specify the disk size for every - machine in this master/agent pool. If you specify 0, it will apply the default osDisk size + machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. :type os_disk_size_gb: int - :param os_disk_type: OS disk type to be used for machines in a given agent pool. Allowed values - are 'Ephemeral' and 'Managed'. If unspecified, defaults to 'Ephemeral' when the VM supports - ephemeral OS and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults - to 'Managed'. May not be changed after creation. Possible values include: "Managed", - "Ephemeral". + :param os_disk_type: The default is 'Ephemeral' if the VM supports it and has a cache disk + larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed + after creation. For more information see `Ephemeral OS + `_. Possible values + include: "Managed", "Ephemeral". :type os_disk_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.OSDiskType - :param kubelet_disk_type: KubeletDiskType determines the placement of emptyDir volumes, - container runtime data root, and Kubelet ephemeral storage. Currently allows one value, OS, - resulting in Kubelet using the OS disk for data. Possible values include: "OS", "Temporary". + :param kubelet_disk_type: Determines the placement of emptyDir volumes, container runtime data + root, and Kubelet ephemeral storage. Possible values include: "OS", "Temporary". :type kubelet_disk_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.KubeletDiskType - :param vnet_subnet_id: VNet SubnetID specifies the VNet's subnet identifier for nodes and maybe - pods. + :param vnet_subnet_id: If this is not specified, a VNET and subnet will be generated and used. + If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just + nodes. This is of the form: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. :type vnet_subnet_id: str - :param pod_subnet_id: Pod SubnetID specifies the VNet's subnet identifier for pods. + :param pod_subnet_id: If omitted, pod IPs are statically assigned on the node subnet (see + vnetSubnetID for more details). This is of the form: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. :type pod_subnet_id: str - :param max_pods: Maximum number of pods that can run on a node. + :param max_pods: The maximum number of pods that can run on a node. :type max_pods: int - :param os_type: OsType to be used to specify os type. Choose from Linux and Windows. Default to - Linux. Possible values include: "Linux", "Windows". Default value: "Linux". + :param os_type: The operating system type. The default is Linux. Possible values include: + "Linux", "Windows". Default value: "Linux". :type os_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.OSType - :param os_sku: OsSKU to be used to specify os sku. Choose from Ubuntu(default) and CBLMariner - for Linux OSType. Not applicable to Windows OSType. Possible values include: "Ubuntu", - "CBLMariner". + :param os_sku: Specifies an OS SKU. This value must not be specified if OSType is Windows. + Possible values include: "Ubuntu", "CBLMariner". :type os_sku: str or ~azure.mgmt.containerservice.v2021_05_01.models.OSSKU - :param max_count: Maximum number of nodes for auto-scaling. + :param max_count: The maximum number of nodes for auto-scaling. :type max_count: int - :param min_count: Minimum number of nodes for auto-scaling. + :param min_count: The minimum number of nodes for auto-scaling. :type min_count: int :param enable_auto_scaling: Whether to enable auto-scaler. :type enable_auto_scaling: bool - :param type_properties_type: AgentPoolType represents types of an agent pool. Possible values - include: "VirtualMachineScaleSets", "AvailabilitySet". + :param type_properties_type: The type of Agent Pool. Possible values include: + "VirtualMachineScaleSets", "AvailabilitySet". :type type_properties_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.AgentPoolType - :param mode: AgentPoolMode represents mode of an agent pool. Possible values include: "System", + :param mode: A cluster must have at least one 'System' Agent Pool at all times. For additional + information on agent pool restrictions and best practices, see: + https://docs.microsoft.com/azure/aks/use-system-pools. Possible values include: "System", "User". :type mode: str or ~azure.mgmt.containerservice.v2021_05_01.models.AgentPoolMode - :param orchestrator_version: Version of orchestrator specified when creating the managed - cluster. + :param orchestrator_version: As a best practice, you should upgrade all node pools in an AKS + cluster to the same Kubernetes version. The node pool version must have the same major version + as the control plane. The node pool minor version must be within two minor versions of the + control plane version. The node pool version cannot be greater than the control plane version. + For more information see `upgrading a node pool + `_. :type orchestrator_version: str - :ivar node_image_version: Version of node image. + :ivar node_image_version: The version of node image. :vartype node_image_version: str :param upgrade_settings: Settings for upgrading the agentpool. :type upgrade_settings: ~azure.mgmt.containerservice.v2021_05_01.models.AgentPoolUpgradeSettings - :ivar provisioning_state: The current deployment or provisioning state, which only appears in - the response. + :ivar provisioning_state: The current deployment or provisioning state. :vartype provisioning_state: str :ivar power_state: Describes whether the Agent Pool is Running or Stopped. :vartype power_state: ~azure.mgmt.containerservice.v2021_05_01.models.PowerState - :param availability_zones: Availability zones for nodes. Must use VirtualMachineScaleSets - AgentPoolType. + :param availability_zones: The list of Availability zones to use for nodes. This can only be + specified if the AgentPoolType property is 'VirtualMachineScaleSets'. :type availability_zones: list[str] - :param enable_node_public_ip: Enable public IP for nodes. + :param enable_node_public_ip: Some scenarios may require nodes in a node pool to receive their + own dedicated public IP addresses. A common scenario is for gaming workloads, where a console + needs to make a direct connection to a cloud virtual machine to minimize hops. For more + information see `assigning a public IP per node + `_. + The default is false. :type enable_node_public_ip: bool - :param node_public_ip_prefix_id: Public IP Prefix ID. VM nodes use IPs assigned from this - Public IP Prefix. + :param node_public_ip_prefix_id: This is of the form: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}. :type node_public_ip_prefix_id: str - :param scale_set_priority: ScaleSetPriority to be used to specify virtual machine scale set - priority. Default to regular. Possible values include: "Spot", "Regular". Default value: - "Regular". + :param scale_set_priority: The Virtual Machine Scale Set priority. If not specified, the + default is 'Regular'. Possible values include: "Spot", "Regular". Default value: "Regular". :type scale_set_priority: str or ~azure.mgmt.containerservice.v2021_05_01.models.ScaleSetPriority - :param scale_set_eviction_policy: ScaleSetEvictionPolicy to be used to specify eviction policy - for Spot virtual machine scale set. Default to Delete. Possible values include: "Delete", + :param scale_set_eviction_policy: This cannot be specified unless the scaleSetPriority is + 'Spot'. If not specified, the default is 'Delete'. Possible values include: "Delete", "Deallocate". Default value: "Delete". :type scale_set_eviction_policy: str or ~azure.mgmt.containerservice.v2021_05_01.models.ScaleSetEvictionPolicy - :param spot_max_price: SpotMaxPrice to be used to specify the maximum price you are willing to - pay in US Dollars. Possible values are any decimal value greater than zero or -1 which - indicates default price to be up-to on-demand. + :param spot_max_price: Possible values are any decimal value greater than zero or -1 which + indicates the willingness to pay any on-demand price. For more details on spot pricing, see + `spot VMs pricing `_. :type spot_max_price: float - :param tags: A set of tags. Agent pool tags to be persisted on the agent pool virtual machine - scale set. + :param tags: A set of tags. The tags to be persisted on the agent pool virtual machine scale + set. :type tags: dict[str, str] - :param node_labels: Agent pool node labels to be persisted across all nodes in agent pool. + :param node_labels: The node labels to be persisted across all nodes in agent pool. :type node_labels: dict[str, str] - :param node_taints: Taints added to new nodes during node pool create and scale. For example, - key=value:NoSchedule. + :param node_taints: The taints added to new nodes during node pool create and scale. For + example, key=value:NoSchedule. :type node_taints: list[str] :param proximity_placement_group_id: The ID for Proximity Placement Group. :type proximity_placement_group_id: str - :param kubelet_config: KubeletConfig specifies the configuration of kubelet on agent nodes. + :param kubelet_config: The Kubelet configuration on the agent pool nodes. :type kubelet_config: ~azure.mgmt.containerservice.v2021_05_01.models.KubeletConfig - :param linux_os_config: LinuxOSConfig specifies the OS configuration of linux agent nodes. + :param linux_os_config: The OS configuration of Linux agent nodes. :type linux_os_config: ~azure.mgmt.containerservice.v2021_05_01.models.LinuxOSConfig - :param enable_encryption_at_host: Whether to enable EncryptionAtHost. + :param enable_encryption_at_host: This is only supported on certain VM sizes and in certain + Azure regions. For more information, see: + https://docs.microsoft.com/azure/aks/enable-host-encryption. :type enable_encryption_at_host: bool :param enable_ultra_ssd: Whether to enable UltraSSD. :type enable_ultra_ssd: bool - :param enable_fips: Whether to use FIPS enabled OS. + :param enable_fips: See `Add a FIPS-enabled node pool + `_ + for more details. :type enable_fips: bool :param gpu_instance_profile: GPUInstanceProfile to be used to specify GPU MIG instance profile - for supported GPU VM SKU. Supported values are MIG1g, MIG2g, MIG3g, MIG4g and MIG7g. Possible - values include: "MIG1g", "MIG2g", "MIG3g", "MIG4g", "MIG7g". + for supported GPU VM SKU. Possible values include: "MIG1g", "MIG2g", "MIG3g", "MIG4g", "MIG7g". :type gpu_instance_profile: str or ~azure.mgmt.containerservice.v2021_05_01.models.GPUInstanceProfile """ @@ -266,11 +282,11 @@ class AgentPoolAvailableVersions(msrest.serialization.Model): Variables are only populated by the server, and will be ignored when sending a request. - :ivar id: Id of the agent pool available versions. + :ivar id: The ID of the agent pool version list. :vartype id: str - :ivar name: Name of the agent pool available versions. + :ivar name: The name of the agent pool version list. :vartype name: str - :ivar type: Type of the agent pool available versions. + :ivar type: Type of the agent pool version list. :vartype type: str :param agent_pool_versions: List of versions available for agent pool. :type agent_pool_versions: @@ -306,7 +322,7 @@ class AgentPoolAvailableVersionsPropertiesAgentPoolVersionsItem(msrest.serializa :param default: Whether this version is the default agent pool version. :type default: bool - :param kubernetes_version: Kubernetes version (major, minor, patch). + :param kubernetes_version: The Kubernetes version (major.minor.patch). :type kubernetes_version: str :param is_preview: Whether Kubernetes version is currently in preview. :type is_preview: bool @@ -364,22 +380,21 @@ class AgentPoolUpgradeProfile(msrest.serialization.Model): All required parameters must be populated in order to send to Azure. - :ivar id: Id of the agent pool upgrade profile. + :ivar id: The ID of the agent pool upgrade profile. :vartype id: str - :ivar name: Name of the agent pool upgrade profile. + :ivar name: The name of the agent pool upgrade profile. :vartype name: str - :ivar type: Type of the agent pool upgrade profile. + :ivar type: The type of the agent pool upgrade profile. :vartype type: str - :param kubernetes_version: Required. Kubernetes version (major, minor, patch). + :param kubernetes_version: Required. The Kubernetes version (major.minor.patch). :type kubernetes_version: str - :param os_type: Required. OsType to be used to specify os type. Choose from Linux and Windows. - Default to Linux. Possible values include: "Linux", "Windows". Default value: "Linux". + :param os_type: Required. The operating system type. The default is Linux. Possible values + include: "Linux", "Windows". Default value: "Linux". :type os_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.OSType :param upgrades: List of orchestrator types and versions available for upgrade. :type upgrades: list[~azure.mgmt.containerservice.v2021_05_01.models.AgentPoolUpgradeProfilePropertiesUpgradesItem] - :param latest_node_image_version: LatestNodeImageVersion is the latest AKS supported node image - version. + :param latest_node_image_version: The latest AKS supported node image version. :type latest_node_image_version: str """ @@ -418,9 +433,9 @@ def __init__( class AgentPoolUpgradeProfilePropertiesUpgradesItem(msrest.serialization.Model): """AgentPoolUpgradeProfilePropertiesUpgradesItem. - :param kubernetes_version: Kubernetes version (major, minor, patch). + :param kubernetes_version: The Kubernetes version (major.minor.patch). :type kubernetes_version: str - :param is_preview: Whether Kubernetes version is currently in preview. + :param is_preview: Whether the Kubernetes version is currently in preview. :type is_preview: bool """ @@ -441,8 +456,11 @@ def __init__( class AgentPoolUpgradeSettings(msrest.serialization.Model): """Settings for upgrading an agentpool. - :param max_surge: Count or percentage of additional nodes to be added during upgrade. If empty - uses AKS default. + :param max_surge: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). + If a percentage is specified, it is the percentage of the total agent pool size at the time of + the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is + 1. For more information, including best practices, see: + https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade. :type max_surge: str """ @@ -518,46 +536,52 @@ class Components1Q1Og48SchemasManagedclusterAllof1(msrest.serialization.Model): :param identity: The identity of the managed cluster, if configured. :type identity: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterIdentity - :ivar provisioning_state: The current deployment or provisioning state, which only appears in - the response. + :ivar provisioning_state: The current provisioning state. :vartype provisioning_state: str - :ivar power_state: Represents the Power State of the cluster. + :ivar power_state: The Power State of the cluster. :vartype power_state: ~azure.mgmt.containerservice.v2021_05_01.models.PowerState :ivar max_agent_pools: The max number of agent pools for the managed cluster. :vartype max_agent_pools: int - :param kubernetes_version: Version of Kubernetes specified when creating the managed cluster. + :param kubernetes_version: When you upgrade a supported AKS cluster, Kubernetes minor versions + cannot be skipped. All upgrades must be performed sequentially by major version number. For + example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> + 1.16.x is not allowed. See `upgrading an AKS cluster + `_ for more details. :type kubernetes_version: str - :param dns_prefix: DNS prefix specified when creating the managed cluster. + :param dns_prefix: This cannot be updated once the Managed Cluster has been created. :type dns_prefix: str - :param fqdn_subdomain: FQDN subdomain specified when creating private cluster with custom - private dns zone. + :param fqdn_subdomain: This cannot be updated once the Managed Cluster has been created. :type fqdn_subdomain: str - :ivar fqdn: FQDN for the master pool. + :ivar fqdn: The FQDN of the master pool. :vartype fqdn: str - :ivar private_fqdn: FQDN of private cluster. + :ivar private_fqdn: The FQDN of private cluster. :vartype private_fqdn: str - :ivar azure_portal_fqdn: FQDN for the master pool which used by proxy config. + :ivar azure_portal_fqdn: The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) + headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. + This special FQDN supports CORS, allowing the Azure Portal to function properly. :vartype azure_portal_fqdn: str - :param agent_pool_profiles: Properties of the agent pool. + :param agent_pool_profiles: The agent pool properties. :type agent_pool_profiles: list[~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterAgentPoolProfile] - :param linux_profile: Profile for Linux VMs in the container service cluster. + :param linux_profile: The profile for Linux VMs in the Managed Cluster. :type linux_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ContainerServiceLinuxProfile - :param windows_profile: Profile for Windows VMs in the container service cluster. + :param windows_profile: The profile for Windows VMs in the Managed Cluster. :type windows_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterWindowsProfile :param service_principal_profile: Information about a service principal identity for the cluster to use for manipulating Azure APIs. :type service_principal_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterServicePrincipalProfile - :param addon_profiles: Profile of managed cluster add-on. + :param addon_profiles: The profile of managed cluster add-on. :type addon_profiles: dict[str, ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterAddonProfile] - :param pod_identity_profile: Profile of managed cluster pod identity. + :param pod_identity_profile: See `use AAD pod identity + `_ for more details on AAD pod + identity integration. :type pod_identity_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterPodIdentityProfile - :param node_resource_group: Name of the resource group containing agent pool nodes. + :param node_resource_group: The name of the resource group containing agent pool nodes. :type node_resource_group: str :param enable_rbac: Whether to enable Kubernetes Role-Based Access Control. :type enable_rbac: bool @@ -565,22 +589,22 @@ class Components1Q1Og48SchemasManagedclusterAllof1(msrest.serialization.Model): policy (preview). This feature is set for removal on October 15th, 2020. Learn more at aka.ms/aks/azpodpolicy. :type enable_pod_security_policy: bool - :param network_profile: Profile of network configuration. + :param network_profile: The network configuration profile. :type network_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ContainerServiceNetworkProfile - :param aad_profile: Profile of Azure Active Directory configuration. + :param aad_profile: The Azure Active Directory configuration. :type aad_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterAADProfile - :param auto_upgrade_profile: Profile of auto upgrade configuration. + :param auto_upgrade_profile: The auto upgrade configuration. :type auto_upgrade_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterAutoUpgradeProfile :param auto_scaler_profile: Parameters to be applied to the cluster-autoscaler when enabled. :type auto_scaler_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterPropertiesAutoScalerProfile - :param api_server_access_profile: Access profile for managed cluster API server. + :param api_server_access_profile: The access profile for managed cluster API server. :type api_server_access_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterAPIServerAccessProfile - :param disk_encryption_set_id: ResourceId of the disk encryption set to use for enabling - encryption at rest. + :param disk_encryption_set_id: This is of the form: + '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'. :type disk_encryption_set_id: str :param identity_profile: Identities associated with the cluster. :type identity_profile: dict[str, @@ -588,8 +612,10 @@ class Components1Q1Og48SchemasManagedclusterAllof1(msrest.serialization.Model): :param private_link_resources: Private link resources associated with the cluster. :type private_link_resources: list[~azure.mgmt.containerservice.v2021_05_01.models.PrivateLinkResource] - :param disable_local_accounts: If set to true, getting static credential will be disabled for - this cluster. Expected to only be used for AAD clusters. + :param disable_local_accounts: If set to true, getting static credentials will be disabled for + this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details + see `disable local accounts + `_. :type disable_local_accounts: bool :param http_proxy_config: Configurations for provisioning the cluster with HTTP proxy servers. :type http_proxy_config: @@ -704,13 +730,13 @@ def __init__( class UserAssignedIdentity(msrest.serialization.Model): - """UserAssignedIdentity. + """Details about a user assigned identity. - :param resource_id: The resource id of the user assigned identity. + :param resource_id: The resource ID of the user assigned identity. :type resource_id: str - :param client_id: The client id of the user assigned identity. + :param client_id: The client ID of the user assigned identity. :type client_id: str - :param object_id: The object id of the user assigned identity. + :param object_id: The object ID of the user assigned identity. :type object_id: str """ @@ -733,11 +759,11 @@ def __init__( class ComponentsQit0EtSchemasManagedclusterpropertiesPropertiesIdentityprofileAdditionalproperties(UserAssignedIdentity): """ComponentsQit0EtSchemasManagedclusterpropertiesPropertiesIdentityprofileAdditionalproperties. - :param resource_id: The resource id of the user assigned identity. + :param resource_id: The resource ID of the user assigned identity. :type resource_id: str - :param client_id: The client id of the user assigned identity. + :param client_id: The client ID of the user assigned identity. :type client_id: str - :param object_id: The object id of the user assigned identity. + :param object_id: The object ID of the user assigned identity. :type object_id: str """ @@ -787,7 +813,7 @@ class ContainerServiceLinuxProfile(msrest.serialization.Model): :param admin_username: Required. The administrator username to use for Linux VMs. :type admin_username: str - :param ssh: Required. SSH configuration for Linux-based VMs running on Azure. + :param ssh: Required. The SSH configuration for Linux-based VMs running on Azure. :type ssh: ~azure.mgmt.containerservice.v2021_05_01.models.ContainerServiceSshConfiguration """ @@ -916,14 +942,14 @@ def __init__( class ContainerServiceNetworkProfile(msrest.serialization.Model): """Profile of network configuration. - :param network_plugin: Network plugin used for building Kubernetes network. Possible values + :param network_plugin: Network plugin used for building the Kubernetes network. Possible values include: "azure", "kubenet". Default value: "kubenet". :type network_plugin: str or ~azure.mgmt.containerservice.v2021_05_01.models.NetworkPlugin - :param network_policy: Network policy used for building Kubernetes network. Possible values + :param network_policy: Network policy used for building the Kubernetes network. Possible values include: "calico", "azure". :type network_policy: str or ~azure.mgmt.containerservice.v2021_05_01.models.NetworkPolicy - :param network_mode: Network mode used for building Kubernetes network. Possible values - include: "transparent", "bridge". + :param network_mode: This cannot be specified if networkPlugin is anything other than 'azure'. + Possible values include: "transparent", "bridge". :type network_mode: str or ~azure.mgmt.containerservice.v2021_05_01.models.NetworkMode :param pod_cidr: A CIDR notation IP range from which to assign pod IPs when kubenet is used. :type pod_cidr: str @@ -936,11 +962,14 @@ class ContainerServiceNetworkProfile(msrest.serialization.Model): :param docker_bridge_cidr: A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range. :type docker_bridge_cidr: str - :param outbound_type: The outbound (egress) routing method. Possible values include: + :param outbound_type: This can only be set at cluster creation time and cannot be changed + later. For more information see `egress outbound type + `_. Possible values include: "loadBalancer", "userDefinedRouting". Default value: "loadBalancer". :type outbound_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.OutboundType - :param load_balancer_sku: The load balancer sku for the managed cluster. Possible values - include: "standard", "basic". + :param load_balancer_sku: The default is 'standard'. See `Azure Load Balancer SKUs + `_ for more information about the + differences between load balancer SKUs. Possible values include: "standard", "basic". :type load_balancer_sku: str or ~azure.mgmt.containerservice.v2021_05_01.models.LoadBalancerSku :param load_balancer_profile: Profile of the cluster load balancer. :type load_balancer_profile: @@ -990,7 +1019,7 @@ class ContainerServiceSshConfiguration(msrest.serialization.Model): All required parameters must be populated in order to send to Azure. :param public_keys: Required. The list of SSH public keys used to authenticate with Linux-based - VMs. Only expect one key specified. + VMs. A maximum of 1 key may be specified. :type public_keys: list[~azure.mgmt.containerservice.v2021_05_01.models.ContainerServiceSshPublicKey] """ @@ -1100,7 +1129,7 @@ def __init__( class CredentialResults(msrest.serialization.Model): - """The list of credential result response. + """The list credential result response. Variables are only populated by the server, and will be ignored when sending a request. @@ -1202,24 +1231,30 @@ def __init__( class KubeletConfig(msrest.serialization.Model): - """Kubelet configurations of agent nodes. + """See `AKS custom node configuration `_ for more details. - :param cpu_manager_policy: CPU Manager policy to use. + :param cpu_manager_policy: The default is 'none'. See `Kubernetes CPU management policies + `_ + for more information. Allowed values are 'none' and 'static'. :type cpu_manager_policy: str - :param cpu_cfs_quota: Enable CPU CFS quota enforcement for containers that specify CPU limits. + :param cpu_cfs_quota: The default is true. :type cpu_cfs_quota: bool - :param cpu_cfs_quota_period: Sets CPU CFS quota period value. + :param cpu_cfs_quota_period: The default is '100ms.' Valid values are a sequence of decimal + numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported + units are 'ns', 'us', 'ms', 's', 'm', and 'h'. :type cpu_cfs_quota_period: str - :param image_gc_high_threshold: The percent of disk usage after which image garbage collection - is always run. + :param image_gc_high_threshold: To disable image garbage collection, set to 100. The default is + 85%. :type image_gc_high_threshold: int - :param image_gc_low_threshold: The percent of disk usage before which image garbage collection - is never run. + :param image_gc_low_threshold: This cannot be set higher than imageGcHighThreshold. The default + is 80%. :type image_gc_low_threshold: int - :param topology_manager_policy: Topology Manager policy to use. + :param topology_manager_policy: For more information see `Kubernetes Topology Manager + `_. The default is + 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. :type topology_manager_policy: str - :param allowed_unsafe_sysctls: Allowlist of unsafe sysctls or unsafe sysctl patterns (ending in - ``*``\ ). + :param allowed_unsafe_sysctls: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending + in ``*``\ ). :type allowed_unsafe_sysctls: list[str] :param fail_swap_on: If set to true it will make the Kubelet fail to start if swap is enabled on the node. @@ -1271,16 +1306,20 @@ def __init__( class LinuxOSConfig(msrest.serialization.Model): - """OS configurations of Linux agent nodes. + """See `AKS custom node configuration `_ for more details. :param sysctls: Sysctl settings for Linux agent nodes. :type sysctls: ~azure.mgmt.containerservice.v2021_05_01.models.SysctlConfig - :param transparent_huge_page_enabled: Transparent Huge Page enabled configuration. + :param transparent_huge_page_enabled: Valid values are 'always', 'madvise', and 'never'. The + default is 'always'. For more information see `Transparent Hugepages + `_. :type transparent_huge_page_enabled: str - :param transparent_huge_page_defrag: Transparent Huge Page defrag configuration. + :param transparent_huge_page_defrag: Valid values are 'always', 'defer', 'defer+madvise', + 'madvise' and 'never'. The default is 'madvise'. For more information see `Transparent + Hugepages + `_. :type transparent_huge_page_defrag: str - :param swap_file_size_mb: SwapFileSizeMB specifies size in MB of a swap file will be created on - each node. + :param swap_file_size_mb: The size in MB of a swap file that will be created on each node. :type swap_file_size_mb: int """ @@ -1303,7 +1342,7 @@ def __init__( class MaintenanceConfiguration(SubResource): - """maintenance configuration. + """See `planned maintenance `_ for more information about planned maintenance. Variables are only populated by the server, and will be ignored when sending a request. @@ -1314,9 +1353,10 @@ class MaintenanceConfiguration(SubResource): :vartype name: str :ivar type: Resource type. :vartype type: str - :ivar system_data: The system meta data relating to this resource. + :ivar system_data: The system metadata relating to this resource. :vartype system_data: ~azure.mgmt.containerservice.v2021_05_01.models.SystemData - :param time_in_week: Weekday time slots allowed to upgrade. + :param time_in_week: If two array entries specify the same day of the week, the applied + configuration is the union of times in both entries. :type time_in_week: list[~azure.mgmt.containerservice.v2021_05_01.models.TimeInWeek] :param not_allowed_time: Time slots on which upgrade is not allowed. :type not_allowed_time: list[~azure.mgmt.containerservice.v2021_05_01.models.TimeSpan] @@ -1432,46 +1472,52 @@ class ManagedCluster(Resource, Components1Q1Og48SchemasManagedclusterAllof1): :param identity: The identity of the managed cluster, if configured. :type identity: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterIdentity - :ivar provisioning_state: The current deployment or provisioning state, which only appears in - the response. + :ivar provisioning_state: The current provisioning state. :vartype provisioning_state: str - :ivar power_state: Represents the Power State of the cluster. + :ivar power_state: The Power State of the cluster. :vartype power_state: ~azure.mgmt.containerservice.v2021_05_01.models.PowerState :ivar max_agent_pools: The max number of agent pools for the managed cluster. :vartype max_agent_pools: int - :param kubernetes_version: Version of Kubernetes specified when creating the managed cluster. + :param kubernetes_version: When you upgrade a supported AKS cluster, Kubernetes minor versions + cannot be skipped. All upgrades must be performed sequentially by major version number. For + example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> + 1.16.x is not allowed. See `upgrading an AKS cluster + `_ for more details. :type kubernetes_version: str - :param dns_prefix: DNS prefix specified when creating the managed cluster. + :param dns_prefix: This cannot be updated once the Managed Cluster has been created. :type dns_prefix: str - :param fqdn_subdomain: FQDN subdomain specified when creating private cluster with custom - private dns zone. + :param fqdn_subdomain: This cannot be updated once the Managed Cluster has been created. :type fqdn_subdomain: str - :ivar fqdn: FQDN for the master pool. + :ivar fqdn: The FQDN of the master pool. :vartype fqdn: str - :ivar private_fqdn: FQDN of private cluster. + :ivar private_fqdn: The FQDN of private cluster. :vartype private_fqdn: str - :ivar azure_portal_fqdn: FQDN for the master pool which used by proxy config. + :ivar azure_portal_fqdn: The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) + headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. + This special FQDN supports CORS, allowing the Azure Portal to function properly. :vartype azure_portal_fqdn: str - :param agent_pool_profiles: Properties of the agent pool. + :param agent_pool_profiles: The agent pool properties. :type agent_pool_profiles: list[~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterAgentPoolProfile] - :param linux_profile: Profile for Linux VMs in the container service cluster. + :param linux_profile: The profile for Linux VMs in the Managed Cluster. :type linux_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ContainerServiceLinuxProfile - :param windows_profile: Profile for Windows VMs in the container service cluster. + :param windows_profile: The profile for Windows VMs in the Managed Cluster. :type windows_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterWindowsProfile :param service_principal_profile: Information about a service principal identity for the cluster to use for manipulating Azure APIs. :type service_principal_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterServicePrincipalProfile - :param addon_profiles: Profile of managed cluster add-on. + :param addon_profiles: The profile of managed cluster add-on. :type addon_profiles: dict[str, ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterAddonProfile] - :param pod_identity_profile: Profile of managed cluster pod identity. + :param pod_identity_profile: See `use AAD pod identity + `_ for more details on AAD pod + identity integration. :type pod_identity_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterPodIdentityProfile - :param node_resource_group: Name of the resource group containing agent pool nodes. + :param node_resource_group: The name of the resource group containing agent pool nodes. :type node_resource_group: str :param enable_rbac: Whether to enable Kubernetes Role-Based Access Control. :type enable_rbac: bool @@ -1479,22 +1525,22 @@ class ManagedCluster(Resource, Components1Q1Og48SchemasManagedclusterAllof1): policy (preview). This feature is set for removal on October 15th, 2020. Learn more at aka.ms/aks/azpodpolicy. :type enable_pod_security_policy: bool - :param network_profile: Profile of network configuration. + :param network_profile: The network configuration profile. :type network_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ContainerServiceNetworkProfile - :param aad_profile: Profile of Azure Active Directory configuration. + :param aad_profile: The Azure Active Directory configuration. :type aad_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterAADProfile - :param auto_upgrade_profile: Profile of auto upgrade configuration. + :param auto_upgrade_profile: The auto upgrade configuration. :type auto_upgrade_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterAutoUpgradeProfile :param auto_scaler_profile: Parameters to be applied to the cluster-autoscaler when enabled. :type auto_scaler_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterPropertiesAutoScalerProfile - :param api_server_access_profile: Access profile for managed cluster API server. + :param api_server_access_profile: The access profile for managed cluster API server. :type api_server_access_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterAPIServerAccessProfile - :param disk_encryption_set_id: ResourceId of the disk encryption set to use for enabling - encryption at rest. + :param disk_encryption_set_id: This is of the form: + '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'. :type disk_encryption_set_id: str :param identity_profile: Identities associated with the cluster. :type identity_profile: dict[str, @@ -1502,8 +1548,10 @@ class ManagedCluster(Resource, Components1Q1Og48SchemasManagedclusterAllof1): :param private_link_resources: Private link resources associated with the cluster. :type private_link_resources: list[~azure.mgmt.containerservice.v2021_05_01.models.PrivateLinkResource] - :param disable_local_accounts: If set to true, getting static credential will be disabled for - this cluster. Expected to only be used for AAD clusters. + :param disable_local_accounts: If set to true, getting static credentials will be disabled for + this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details + see `disable local accounts + `_. :type disable_local_accounts: bool :param http_proxy_config: Configurations for provisioning the cluster with HTTP proxy servers. :type http_proxy_config: @@ -1622,13 +1670,14 @@ def __init__( class ManagedClusterAADProfile(msrest.serialization.Model): - """AADProfile specifies attributes for Azure Active Directory integration. + """For more details see `managed AAD on AKS `_. :param managed: Whether to enable managed AAD. :type managed: bool :param enable_azure_rbac: Whether to enable Azure RBAC for Kubernetes authorization. :type enable_azure_rbac: bool - :param admin_group_object_i_ds: AAD group object IDs that will have admin role of the cluster. + :param admin_group_object_i_ds: The list of AAD group object IDs that will have admin role of + the cluster. :type admin_group_object_i_ds: list[str] :param client_app_id: The client AAD application ID. :type client_app_id: str @@ -1750,11 +1799,11 @@ def __init__( class ManagedClusterAddonProfileIdentity(UserAssignedIdentity): """Information of user assigned identity used by this add-on. - :param resource_id: The resource id of the user assigned identity. + :param resource_id: The resource ID of the user assigned identity. :type resource_id: str - :param client_id: The client id of the user assigned identity. + :param client_id: The client ID of the user assigned identity. :type client_id: str - :param object_id: The object id of the user assigned identity. + :param object_id: The object ID of the user assigned identity. :type object_id: str """ @@ -1780,106 +1829,122 @@ class ManagedClusterAgentPoolProfileProperties(msrest.serialization.Model): range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. :type count: int - :param vm_size: Size of agent VMs. + :param vm_size: VM size availability varies by region. If a node contains insufficient compute + resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted + VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions. :type vm_size: str :param os_disk_size_gb: OS Disk Size in GB to be used to specify the disk size for every - machine in this master/agent pool. If you specify 0, it will apply the default osDisk size + machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. :type os_disk_size_gb: int - :param os_disk_type: OS disk type to be used for machines in a given agent pool. Allowed values - are 'Ephemeral' and 'Managed'. If unspecified, defaults to 'Ephemeral' when the VM supports - ephemeral OS and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults - to 'Managed'. May not be changed after creation. Possible values include: "Managed", - "Ephemeral". + :param os_disk_type: The default is 'Ephemeral' if the VM supports it and has a cache disk + larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed + after creation. For more information see `Ephemeral OS + `_. Possible values + include: "Managed", "Ephemeral". :type os_disk_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.OSDiskType - :param kubelet_disk_type: KubeletDiskType determines the placement of emptyDir volumes, - container runtime data root, and Kubelet ephemeral storage. Currently allows one value, OS, - resulting in Kubelet using the OS disk for data. Possible values include: "OS", "Temporary". + :param kubelet_disk_type: Determines the placement of emptyDir volumes, container runtime data + root, and Kubelet ephemeral storage. Possible values include: "OS", "Temporary". :type kubelet_disk_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.KubeletDiskType - :param vnet_subnet_id: VNet SubnetID specifies the VNet's subnet identifier for nodes and maybe - pods. + :param vnet_subnet_id: If this is not specified, a VNET and subnet will be generated and used. + If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just + nodes. This is of the form: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. :type vnet_subnet_id: str - :param pod_subnet_id: Pod SubnetID specifies the VNet's subnet identifier for pods. + :param pod_subnet_id: If omitted, pod IPs are statically assigned on the node subnet (see + vnetSubnetID for more details). This is of the form: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. :type pod_subnet_id: str - :param max_pods: Maximum number of pods that can run on a node. + :param max_pods: The maximum number of pods that can run on a node. :type max_pods: int - :param os_type: OsType to be used to specify os type. Choose from Linux and Windows. Default to - Linux. Possible values include: "Linux", "Windows". Default value: "Linux". + :param os_type: The operating system type. The default is Linux. Possible values include: + "Linux", "Windows". Default value: "Linux". :type os_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.OSType - :param os_sku: OsSKU to be used to specify os sku. Choose from Ubuntu(default) and CBLMariner - for Linux OSType. Not applicable to Windows OSType. Possible values include: "Ubuntu", - "CBLMariner". + :param os_sku: Specifies an OS SKU. This value must not be specified if OSType is Windows. + Possible values include: "Ubuntu", "CBLMariner". :type os_sku: str or ~azure.mgmt.containerservice.v2021_05_01.models.OSSKU - :param max_count: Maximum number of nodes for auto-scaling. + :param max_count: The maximum number of nodes for auto-scaling. :type max_count: int - :param min_count: Minimum number of nodes for auto-scaling. + :param min_count: The minimum number of nodes for auto-scaling. :type min_count: int :param enable_auto_scaling: Whether to enable auto-scaler. :type enable_auto_scaling: bool - :param type: AgentPoolType represents types of an agent pool. Possible values include: - "VirtualMachineScaleSets", "AvailabilitySet". + :param type: The type of Agent Pool. Possible values include: "VirtualMachineScaleSets", + "AvailabilitySet". :type type: str or ~azure.mgmt.containerservice.v2021_05_01.models.AgentPoolType - :param mode: AgentPoolMode represents mode of an agent pool. Possible values include: "System", + :param mode: A cluster must have at least one 'System' Agent Pool at all times. For additional + information on agent pool restrictions and best practices, see: + https://docs.microsoft.com/azure/aks/use-system-pools. Possible values include: "System", "User". :type mode: str or ~azure.mgmt.containerservice.v2021_05_01.models.AgentPoolMode - :param orchestrator_version: Version of orchestrator specified when creating the managed - cluster. + :param orchestrator_version: As a best practice, you should upgrade all node pools in an AKS + cluster to the same Kubernetes version. The node pool version must have the same major version + as the control plane. The node pool minor version must be within two minor versions of the + control plane version. The node pool version cannot be greater than the control plane version. + For more information see `upgrading a node pool + `_. :type orchestrator_version: str - :ivar node_image_version: Version of node image. + :ivar node_image_version: The version of node image. :vartype node_image_version: str :param upgrade_settings: Settings for upgrading the agentpool. :type upgrade_settings: ~azure.mgmt.containerservice.v2021_05_01.models.AgentPoolUpgradeSettings - :ivar provisioning_state: The current deployment or provisioning state, which only appears in - the response. + :ivar provisioning_state: The current deployment or provisioning state. :vartype provisioning_state: str :ivar power_state: Describes whether the Agent Pool is Running or Stopped. :vartype power_state: ~azure.mgmt.containerservice.v2021_05_01.models.PowerState - :param availability_zones: Availability zones for nodes. Must use VirtualMachineScaleSets - AgentPoolType. + :param availability_zones: The list of Availability zones to use for nodes. This can only be + specified if the AgentPoolType property is 'VirtualMachineScaleSets'. :type availability_zones: list[str] - :param enable_node_public_ip: Enable public IP for nodes. + :param enable_node_public_ip: Some scenarios may require nodes in a node pool to receive their + own dedicated public IP addresses. A common scenario is for gaming workloads, where a console + needs to make a direct connection to a cloud virtual machine to minimize hops. For more + information see `assigning a public IP per node + `_. + The default is false. :type enable_node_public_ip: bool - :param node_public_ip_prefix_id: Public IP Prefix ID. VM nodes use IPs assigned from this - Public IP Prefix. + :param node_public_ip_prefix_id: This is of the form: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}. :type node_public_ip_prefix_id: str - :param scale_set_priority: ScaleSetPriority to be used to specify virtual machine scale set - priority. Default to regular. Possible values include: "Spot", "Regular". Default value: - "Regular". + :param scale_set_priority: The Virtual Machine Scale Set priority. If not specified, the + default is 'Regular'. Possible values include: "Spot", "Regular". Default value: "Regular". :type scale_set_priority: str or ~azure.mgmt.containerservice.v2021_05_01.models.ScaleSetPriority - :param scale_set_eviction_policy: ScaleSetEvictionPolicy to be used to specify eviction policy - for Spot virtual machine scale set. Default to Delete. Possible values include: "Delete", + :param scale_set_eviction_policy: This cannot be specified unless the scaleSetPriority is + 'Spot'. If not specified, the default is 'Delete'. Possible values include: "Delete", "Deallocate". Default value: "Delete". :type scale_set_eviction_policy: str or ~azure.mgmt.containerservice.v2021_05_01.models.ScaleSetEvictionPolicy - :param spot_max_price: SpotMaxPrice to be used to specify the maximum price you are willing to - pay in US Dollars. Possible values are any decimal value greater than zero or -1 which - indicates default price to be up-to on-demand. + :param spot_max_price: Possible values are any decimal value greater than zero or -1 which + indicates the willingness to pay any on-demand price. For more details on spot pricing, see + `spot VMs pricing `_. :type spot_max_price: float - :param tags: A set of tags. Agent pool tags to be persisted on the agent pool virtual machine - scale set. + :param tags: A set of tags. The tags to be persisted on the agent pool virtual machine scale + set. :type tags: dict[str, str] - :param node_labels: Agent pool node labels to be persisted across all nodes in agent pool. + :param node_labels: The node labels to be persisted across all nodes in agent pool. :type node_labels: dict[str, str] - :param node_taints: Taints added to new nodes during node pool create and scale. For example, - key=value:NoSchedule. + :param node_taints: The taints added to new nodes during node pool create and scale. For + example, key=value:NoSchedule. :type node_taints: list[str] :param proximity_placement_group_id: The ID for Proximity Placement Group. :type proximity_placement_group_id: str - :param kubelet_config: KubeletConfig specifies the configuration of kubelet on agent nodes. + :param kubelet_config: The Kubelet configuration on the agent pool nodes. :type kubelet_config: ~azure.mgmt.containerservice.v2021_05_01.models.KubeletConfig - :param linux_os_config: LinuxOSConfig specifies the OS configuration of linux agent nodes. + :param linux_os_config: The OS configuration of Linux agent nodes. :type linux_os_config: ~azure.mgmt.containerservice.v2021_05_01.models.LinuxOSConfig - :param enable_encryption_at_host: Whether to enable EncryptionAtHost. + :param enable_encryption_at_host: This is only supported on certain VM sizes and in certain + Azure regions. For more information, see: + https://docs.microsoft.com/azure/aks/enable-host-encryption. :type enable_encryption_at_host: bool :param enable_ultra_ssd: Whether to enable UltraSSD. :type enable_ultra_ssd: bool - :param enable_fips: Whether to use FIPS enabled OS. + :param enable_fips: See `Add a FIPS-enabled node pool + `_ + for more details. :type enable_fips: bool :param gpu_instance_profile: GPUInstanceProfile to be used to specify GPU MIG instance profile - for supported GPU VM SKU. Supported values are MIG1g, MIG2g, MIG3g, MIG4g and MIG7g. Possible - values include: "MIG1g", "MIG2g", "MIG3g", "MIG4g", "MIG7g". + for supported GPU VM SKU. Possible values include: "MIG1g", "MIG2g", "MIG3g", "MIG4g", "MIG7g". :type gpu_instance_profile: str or ~azure.mgmt.containerservice.v2021_05_01.models.GPUInstanceProfile """ @@ -1984,110 +2049,125 @@ class ManagedClusterAgentPoolProfile(ManagedClusterAgentPoolProfileProperties): range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. :type count: int - :param vm_size: Size of agent VMs. + :param vm_size: VM size availability varies by region. If a node contains insufficient compute + resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted + VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions. :type vm_size: str :param os_disk_size_gb: OS Disk Size in GB to be used to specify the disk size for every - machine in this master/agent pool. If you specify 0, it will apply the default osDisk size + machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. :type os_disk_size_gb: int - :param os_disk_type: OS disk type to be used for machines in a given agent pool. Allowed values - are 'Ephemeral' and 'Managed'. If unspecified, defaults to 'Ephemeral' when the VM supports - ephemeral OS and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults - to 'Managed'. May not be changed after creation. Possible values include: "Managed", - "Ephemeral". + :param os_disk_type: The default is 'Ephemeral' if the VM supports it and has a cache disk + larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed + after creation. For more information see `Ephemeral OS + `_. Possible values + include: "Managed", "Ephemeral". :type os_disk_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.OSDiskType - :param kubelet_disk_type: KubeletDiskType determines the placement of emptyDir volumes, - container runtime data root, and Kubelet ephemeral storage. Currently allows one value, OS, - resulting in Kubelet using the OS disk for data. Possible values include: "OS", "Temporary". + :param kubelet_disk_type: Determines the placement of emptyDir volumes, container runtime data + root, and Kubelet ephemeral storage. Possible values include: "OS", "Temporary". :type kubelet_disk_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.KubeletDiskType - :param vnet_subnet_id: VNet SubnetID specifies the VNet's subnet identifier for nodes and maybe - pods. + :param vnet_subnet_id: If this is not specified, a VNET and subnet will be generated and used. + If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just + nodes. This is of the form: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. :type vnet_subnet_id: str - :param pod_subnet_id: Pod SubnetID specifies the VNet's subnet identifier for pods. + :param pod_subnet_id: If omitted, pod IPs are statically assigned on the node subnet (see + vnetSubnetID for more details). This is of the form: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. :type pod_subnet_id: str - :param max_pods: Maximum number of pods that can run on a node. + :param max_pods: The maximum number of pods that can run on a node. :type max_pods: int - :param os_type: OsType to be used to specify os type. Choose from Linux and Windows. Default to - Linux. Possible values include: "Linux", "Windows". Default value: "Linux". + :param os_type: The operating system type. The default is Linux. Possible values include: + "Linux", "Windows". Default value: "Linux". :type os_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.OSType - :param os_sku: OsSKU to be used to specify os sku. Choose from Ubuntu(default) and CBLMariner - for Linux OSType. Not applicable to Windows OSType. Possible values include: "Ubuntu", - "CBLMariner". + :param os_sku: Specifies an OS SKU. This value must not be specified if OSType is Windows. + Possible values include: "Ubuntu", "CBLMariner". :type os_sku: str or ~azure.mgmt.containerservice.v2021_05_01.models.OSSKU - :param max_count: Maximum number of nodes for auto-scaling. + :param max_count: The maximum number of nodes for auto-scaling. :type max_count: int - :param min_count: Minimum number of nodes for auto-scaling. + :param min_count: The minimum number of nodes for auto-scaling. :type min_count: int :param enable_auto_scaling: Whether to enable auto-scaler. :type enable_auto_scaling: bool - :param type: AgentPoolType represents types of an agent pool. Possible values include: - "VirtualMachineScaleSets", "AvailabilitySet". + :param type: The type of Agent Pool. Possible values include: "VirtualMachineScaleSets", + "AvailabilitySet". :type type: str or ~azure.mgmt.containerservice.v2021_05_01.models.AgentPoolType - :param mode: AgentPoolMode represents mode of an agent pool. Possible values include: "System", + :param mode: A cluster must have at least one 'System' Agent Pool at all times. For additional + information on agent pool restrictions and best practices, see: + https://docs.microsoft.com/azure/aks/use-system-pools. Possible values include: "System", "User". :type mode: str or ~azure.mgmt.containerservice.v2021_05_01.models.AgentPoolMode - :param orchestrator_version: Version of orchestrator specified when creating the managed - cluster. + :param orchestrator_version: As a best practice, you should upgrade all node pools in an AKS + cluster to the same Kubernetes version. The node pool version must have the same major version + as the control plane. The node pool minor version must be within two minor versions of the + control plane version. The node pool version cannot be greater than the control plane version. + For more information see `upgrading a node pool + `_. :type orchestrator_version: str - :ivar node_image_version: Version of node image. + :ivar node_image_version: The version of node image. :vartype node_image_version: str :param upgrade_settings: Settings for upgrading the agentpool. :type upgrade_settings: ~azure.mgmt.containerservice.v2021_05_01.models.AgentPoolUpgradeSettings - :ivar provisioning_state: The current deployment or provisioning state, which only appears in - the response. + :ivar provisioning_state: The current deployment or provisioning state. :vartype provisioning_state: str :ivar power_state: Describes whether the Agent Pool is Running or Stopped. :vartype power_state: ~azure.mgmt.containerservice.v2021_05_01.models.PowerState - :param availability_zones: Availability zones for nodes. Must use VirtualMachineScaleSets - AgentPoolType. + :param availability_zones: The list of Availability zones to use for nodes. This can only be + specified if the AgentPoolType property is 'VirtualMachineScaleSets'. :type availability_zones: list[str] - :param enable_node_public_ip: Enable public IP for nodes. + :param enable_node_public_ip: Some scenarios may require nodes in a node pool to receive their + own dedicated public IP addresses. A common scenario is for gaming workloads, where a console + needs to make a direct connection to a cloud virtual machine to minimize hops. For more + information see `assigning a public IP per node + `_. + The default is false. :type enable_node_public_ip: bool - :param node_public_ip_prefix_id: Public IP Prefix ID. VM nodes use IPs assigned from this - Public IP Prefix. + :param node_public_ip_prefix_id: This is of the form: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}. :type node_public_ip_prefix_id: str - :param scale_set_priority: ScaleSetPriority to be used to specify virtual machine scale set - priority. Default to regular. Possible values include: "Spot", "Regular". Default value: - "Regular". + :param scale_set_priority: The Virtual Machine Scale Set priority. If not specified, the + default is 'Regular'. Possible values include: "Spot", "Regular". Default value: "Regular". :type scale_set_priority: str or ~azure.mgmt.containerservice.v2021_05_01.models.ScaleSetPriority - :param scale_set_eviction_policy: ScaleSetEvictionPolicy to be used to specify eviction policy - for Spot virtual machine scale set. Default to Delete. Possible values include: "Delete", + :param scale_set_eviction_policy: This cannot be specified unless the scaleSetPriority is + 'Spot'. If not specified, the default is 'Delete'. Possible values include: "Delete", "Deallocate". Default value: "Delete". :type scale_set_eviction_policy: str or ~azure.mgmt.containerservice.v2021_05_01.models.ScaleSetEvictionPolicy - :param spot_max_price: SpotMaxPrice to be used to specify the maximum price you are willing to - pay in US Dollars. Possible values are any decimal value greater than zero or -1 which - indicates default price to be up-to on-demand. + :param spot_max_price: Possible values are any decimal value greater than zero or -1 which + indicates the willingness to pay any on-demand price. For more details on spot pricing, see + `spot VMs pricing `_. :type spot_max_price: float - :param tags: A set of tags. Agent pool tags to be persisted on the agent pool virtual machine - scale set. + :param tags: A set of tags. The tags to be persisted on the agent pool virtual machine scale + set. :type tags: dict[str, str] - :param node_labels: Agent pool node labels to be persisted across all nodes in agent pool. + :param node_labels: The node labels to be persisted across all nodes in agent pool. :type node_labels: dict[str, str] - :param node_taints: Taints added to new nodes during node pool create and scale. For example, - key=value:NoSchedule. + :param node_taints: The taints added to new nodes during node pool create and scale. For + example, key=value:NoSchedule. :type node_taints: list[str] :param proximity_placement_group_id: The ID for Proximity Placement Group. :type proximity_placement_group_id: str - :param kubelet_config: KubeletConfig specifies the configuration of kubelet on agent nodes. + :param kubelet_config: The Kubelet configuration on the agent pool nodes. :type kubelet_config: ~azure.mgmt.containerservice.v2021_05_01.models.KubeletConfig - :param linux_os_config: LinuxOSConfig specifies the OS configuration of linux agent nodes. + :param linux_os_config: The OS configuration of Linux agent nodes. :type linux_os_config: ~azure.mgmt.containerservice.v2021_05_01.models.LinuxOSConfig - :param enable_encryption_at_host: Whether to enable EncryptionAtHost. + :param enable_encryption_at_host: This is only supported on certain VM sizes and in certain + Azure regions. For more information, see: + https://docs.microsoft.com/azure/aks/enable-host-encryption. :type enable_encryption_at_host: bool :param enable_ultra_ssd: Whether to enable UltraSSD. :type enable_ultra_ssd: bool - :param enable_fips: Whether to use FIPS enabled OS. + :param enable_fips: See `Add a FIPS-enabled node pool + `_ + for more details. :type enable_fips: bool :param gpu_instance_profile: GPUInstanceProfile to be used to specify GPU MIG instance profile - for supported GPU VM SKU. Supported values are MIG1g, MIG2g, MIG3g, MIG4g and MIG7g. Possible - values include: "MIG1g", "MIG2g", "MIG3g", "MIG4g", "MIG7g". + for supported GPU VM SKU. Possible values include: "MIG1g", "MIG2g", "MIG3g", "MIG4g", "MIG7g". :type gpu_instance_profile: str or ~azure.mgmt.containerservice.v2021_05_01.models.GPUInstanceProfile - :param name: Required. Unique name of the agent pool profile in the context of the subscription - and resource group. + :param name: Required. Windows agent pool names must be 6 characters or less. :type name: str """ @@ -2150,11 +2230,17 @@ def __init__( class ManagedClusterAPIServerAccessProfile(msrest.serialization.Model): """Access profile for managed cluster API server. - :param authorized_ip_ranges: Authorized IP Ranges to kubernetes API server. + :param authorized_ip_ranges: IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. + This feature is not compatible with clusters that use Public IP Per Node, or clusters that are + using a Basic Load Balancer. For more information see `API server authorized IP ranges + `_. :type authorized_ip_ranges: list[str] - :param enable_private_cluster: Whether to create the cluster as a private cluster or not. + :param enable_private_cluster: For more details, see `Creating a private AKS cluster + `_. :type enable_private_cluster: bool - :param private_dns_zone: Private dns zone mode for private cluster. + :param private_dns_zone: The default is System. For more details see `configure private DNS + zone `_. + Allowed values are 'system' and 'none'. :type private_dns_zone: str :param enable_private_cluster_public_fqdn: Whether to create additional public FQDN for private cluster or not. @@ -2182,8 +2268,9 @@ def __init__( class ManagedClusterAutoUpgradeProfile(msrest.serialization.Model): """Auto upgrade profile for a managed cluster. - :param upgrade_channel: upgrade channel for auto upgrade. Possible values include: "rapid", - "stable", "patch", "node-image", "none". + :param upgrade_channel: For more information see `setting the AKS cluster auto-upgrade channel + `_. Possible + values include: "rapid", "stable", "patch", "node-image", "none". :type upgrade_channel: str or ~azure.mgmt.containerservice.v2021_05_01.models.UpgradeChannel """ @@ -2200,13 +2287,13 @@ def __init__( class ManagedClusterHTTPProxyConfig(msrest.serialization.Model): - """Configurations for provisioning the cluster with HTTP proxy servers. + """Cluster HTTP proxy configuration. - :param http_proxy: HTTP proxy server endpoint to use. + :param http_proxy: The HTTP proxy server endpoint to use. :type http_proxy: str - :param https_proxy: HTTPS proxy server endpoint to use. + :param https_proxy: The HTTPS proxy server endpoint to use. :type https_proxy: str - :param no_proxy: Endpoints that should not go through proxy. + :param no_proxy: The endpoints that should not go through proxy. :type no_proxy: list[str] :param trusted_ca: Alternative CA cert to use for connecting to proxy servers. :type trusted_ca: str @@ -2241,15 +2328,11 @@ class ManagedClusterIdentity(msrest.serialization.Model): :ivar tenant_id: The tenant id of the system assigned identity which is used by master components. :vartype tenant_id: str - :param type: The type of identity used for the managed cluster. Type 'SystemAssigned' will use - an implicitly created identity in master components and an auto-created user assigned identity - in MC_ resource group in agent nodes. Type 'None' will not use MSI for the managed cluster, - service principal will be used instead. Possible values include: "SystemAssigned", - "UserAssigned", "None". + :param type: For more information see `use managed identities in AKS + `_. Possible values include: + "SystemAssigned", "UserAssigned", "None". :type type: str or ~azure.mgmt.containerservice.v2021_05_01.models.ResourceIdentityType - :param user_assigned_identities: The user identity associated with the managed cluster. This - identity will be used in control plane and only one user assigned identity is allowed. The user - identity dictionary key references will be ARM resource ids in the form: + :param user_assigned_identities: The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. :type user_assigned_identities: dict[str, ~azure.mgmt.containerservice.v2021_05_01.models.Components1Umhcm8SchemasManagedclusteridentityPropertiesUserassignedidentitiesAdditionalproperties] @@ -2324,12 +2407,12 @@ class ManagedClusterLoadBalancerProfile(msrest.serialization.Model): balancer. :type effective_outbound_i_ps: list[~azure.mgmt.containerservice.v2021_05_01.models.ResourceReference] - :param allocated_outbound_ports: Desired number of allocated SNAT ports per VM. Allowed values - must be in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure - dynamically allocating ports. + :param allocated_outbound_ports: The desired number of allocated SNAT ports per VM. Allowed + values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in + Azure dynamically allocating ports. :type allocated_outbound_ports: int :param idle_timeout_in_minutes: Desired outbound flow idle timeout in minutes. Allowed values - must be in the range of 4 to 120 (inclusive). The default value is 30 minutes. + are in the range of 4 to 120 (inclusive). The default value is 30 minutes. :type idle_timeout_in_minutes: int """ @@ -2363,7 +2446,7 @@ def __init__( class ManagedClusterLoadBalancerProfileManagedOutboundIPs(msrest.serialization.Model): """Desired managed outbound IPs for the cluster load balancer. - :param count: Desired number of outbound IP created/managed by Azure for the cluster load + :param count: The desired number of outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. :type count: int """ @@ -2424,19 +2507,19 @@ def __init__( class ManagedClusterPodIdentity(msrest.serialization.Model): - """ManagedClusterPodIdentity. + """Details about the pod identity assigned to the Managed 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. - :param name: Required. Name of the pod identity. + :param name: Required. The name of the pod identity. :type name: str - :param namespace: Required. Namespace of the pod identity. + :param namespace: Required. The namespace of the pod identity. :type namespace: str - :param binding_selector: Binding selector to use for the AzureIdentityBinding resource. + :param binding_selector: The binding selector to use for the AzureIdentityBinding resource. :type binding_selector: str - :param identity: Required. Information of the user assigned identity. + :param identity: Required. The user assigned identity details. :type identity: ~azure.mgmt.containerservice.v2021_05_01.models.UserAssignedIdentity :ivar provisioning_state: The current provisioning state of the pod identity. Possible values include: "Assigned", "Updating", "Deleting", "Failed". @@ -2478,15 +2561,15 @@ def __init__( class ManagedClusterPodIdentityException(msrest.serialization.Model): - """ManagedClusterPodIdentityException. + """See `disable AAD Pod Identity for a specific Pod/Application `_ for more details. All required parameters must be populated in order to send to Azure. - :param name: Required. Name of the pod identity exception. + :param name: Required. The name of the pod identity exception. :type name: str - :param namespace: Required. Namespace of the pod identity exception. + :param namespace: Required. The namespace of the pod identity exception. :type namespace: str - :param pod_labels: Required. Pod labels to match. + :param pod_labels: Required. The pod labels to match. :type pod_labels: dict[str, str] """ @@ -2513,17 +2596,20 @@ def __init__( class ManagedClusterPodIdentityProfile(msrest.serialization.Model): - """ManagedClusterPodIdentityProfile. + """See `use AAD pod identity `_ for more details on pod identity integration. :param enabled: Whether the pod identity addon is enabled. :type enabled: bool - :param allow_network_plugin_kubenet: Customer consent for enabling AAD pod identity addon in - cluster using Kubenet network plugin. + :param allow_network_plugin_kubenet: Running in Kubenet is disabled by default due to the + security related nature of AAD Pod Identity and the risks of IP spoofing. See `using Kubenet + network plugin with AAD Pod Identity + `_ + for more information. :type allow_network_plugin_kubenet: bool - :param user_assigned_identities: User assigned pod identity settings. + :param user_assigned_identities: The pod identities to use in the cluster. :type user_assigned_identities: list[~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterPodIdentity] - :param user_assigned_identity_exceptions: User assigned pod identity exception settings. + :param user_assigned_identity_exceptions: The pod identity exceptions to allow. :type user_assigned_identity_exceptions: list[~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterPodIdentityException] """ @@ -2570,12 +2656,12 @@ class ManagedClusterPoolUpgradeProfile(msrest.serialization.Model): All required parameters must be populated in order to send to Azure. - :param kubernetes_version: Required. Kubernetes version (major, minor, patch). + :param kubernetes_version: Required. The Kubernetes version (major.minor.patch). :type kubernetes_version: str - :param name: Pool name. + :param name: The Agent Pool name. :type name: str - :param os_type: Required. OsType to be used to specify os type. Choose from Linux and Windows. - Default to Linux. Possible values include: "Linux", "Windows". Default value: "Linux". + :param os_type: Required. The operating system type. The default is Linux. Possible values + include: "Linux", "Windows". Default value: "Linux". :type os_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.OSType :param upgrades: List of orchestrator types and versions available for upgrade. :type upgrades: @@ -2608,9 +2694,9 @@ def __init__( class ManagedClusterPoolUpgradeProfileUpgradesItem(msrest.serialization.Model): """ManagedClusterPoolUpgradeProfileUpgradesItem. - :param kubernetes_version: Kubernetes version (major, minor, patch). + :param kubernetes_version: The Kubernetes version (major.minor.patch). :type kubernetes_version: str - :param is_preview: Whether Kubernetes version is currently in preview. + :param is_preview: Whether the Kubernetes version is currently in preview. :type is_preview: bool """ @@ -2631,39 +2717,52 @@ def __init__( class ManagedClusterPropertiesAutoScalerProfile(msrest.serialization.Model): """Parameters to be applied to the cluster-autoscaler when enabled. - :param balance_similar_node_groups: + :param balance_similar_node_groups: Valid values are 'true' and 'false'. :type balance_similar_node_groups: str - :param expander: Possible values include: "least-waste", "most-pods", "priority", "random". + :param expander: If not specified, the default is 'random'. See `expanders + `_ + for more information. Possible values include: "least-waste", "most-pods", "priority", + "random". :type expander: str or ~azure.mgmt.containerservice.v2021_05_01.models.Expander - :param max_empty_bulk_delete: + :param max_empty_bulk_delete: The default is 10. :type max_empty_bulk_delete: str - :param max_graceful_termination_sec: + :param max_graceful_termination_sec: The default is 600. :type max_graceful_termination_sec: str - :param max_node_provision_time: + :param max_node_provision_time: The default is '15m'. Values must be an integer followed by an + 'm'. No unit of time other than minutes (m) is supported. :type max_node_provision_time: str - :param max_total_unready_percentage: + :param max_total_unready_percentage: The default is 45. The maximum is 100 and the minimum is + 0. :type max_total_unready_percentage: str - :param new_pod_scale_up_delay: + :param new_pod_scale_up_delay: For scenarios like burst/batch scale where you don't want CA to + act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore + unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer + followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). :type new_pod_scale_up_delay: str - :param ok_total_unready_count: + :param ok_total_unready_count: This must be an integer. The default is 3. :type ok_total_unready_count: str - :param scan_interval: + :param scan_interval: The default is '10'. Values must be an integer number of seconds. :type scan_interval: str - :param scale_down_delay_after_add: + :param scale_down_delay_after_add: The default is '10m'. Values must be an integer followed by + an 'm'. No unit of time other than minutes (m) is supported. :type scale_down_delay_after_add: str - :param scale_down_delay_after_delete: + :param scale_down_delay_after_delete: The default is the scan-interval. Values must be an + integer followed by an 'm'. No unit of time other than minutes (m) is supported. :type scale_down_delay_after_delete: str - :param scale_down_delay_after_failure: + :param scale_down_delay_after_failure: The default is '3m'. Values must be an integer followed + by an 'm'. No unit of time other than minutes (m) is supported. :type scale_down_delay_after_failure: str - :param scale_down_unneeded_time: + :param scale_down_unneeded_time: The default is '10m'. Values must be an integer followed by an + 'm'. No unit of time other than minutes (m) is supported. :type scale_down_unneeded_time: str - :param scale_down_unready_time: + :param scale_down_unready_time: The default is '20m'. Values must be an integer followed by an + 'm'. No unit of time other than minutes (m) is supported. :type scale_down_unready_time: str - :param scale_down_utilization_threshold: + :param scale_down_utilization_threshold: The default is '0.5'. :type scale_down_utilization_threshold: str - :param skip_nodes_with_local_storage: + :param skip_nodes_with_local_storage: The default is true. :type skip_nodes_with_local_storage: str - :param skip_nodes_with_system_pods: + :param skip_nodes_with_system_pods: The default is true. :type skip_nodes_with_system_pods: str """ @@ -2741,11 +2840,13 @@ def __init__( class ManagedClusterSKU(msrest.serialization.Model): - """ManagedClusterSKU. + """The SKU of a Managed Cluster. - :param name: Name of a managed cluster SKU. Possible values include: "Basic". + :param name: The name of a managed cluster SKU. Possible values include: "Basic". :type name: str or ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterSKUName - :param tier: Tier of a managed cluster SKU. Possible values include: "Paid", "Free". + :param tier: If not specified, the default is 'Free'. See `uptime SLA + `_ for more details. Possible values include: + "Paid", "Free". :type tier: str or ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterSKUTier """ @@ -2770,11 +2871,11 @@ class ManagedClusterUpgradeProfile(msrest.serialization.Model): All required parameters must be populated in order to send to Azure. - :ivar id: Id of upgrade profile. + :ivar id: The ID of the upgrade profile. :vartype id: str - :ivar name: Name of upgrade profile. + :ivar name: The name of the upgrade profile. :vartype name: str - :ivar type: Type of upgrade profile. + :ivar type: The type of the upgrade profile. :vartype type: str :param control_plane_profile: Required. The list of available upgrade versions for the control plane. @@ -2814,12 +2915,12 @@ def __init__( class ManagedClusterWindowsProfile(msrest.serialization.Model): - """Profile for Windows VMs in the container service cluster. + """Profile for Windows VMs in the managed cluster. All required parameters must be populated in order to send to Azure. :param admin_username: Required. Specifies the name of the administrator account. - :code:`
`:code:`
` **restriction:** Cannot end in "." :code:`
`:code:`
` + :code:`
`:code:`
` **Restriction:** Cannot end in "." :code:`
`:code:`
` **Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", @@ -2834,10 +2935,12 @@ class ManagedClusterWindowsProfile(msrest.serialization.Model): :code:`
`:code:`
` **Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!". :type admin_password: str - :param license_type: The licenseType to use for Windows VMs. Windows_Server is used to enable - Azure Hybrid User Benefits for Windows VMs. Possible values include: "None", "Windows_Server". + :param license_type: The license type to use for Windows VMs. See `Azure Hybrid User Benefits + `_ for more details. Possible values + include: "None", "Windows_Server". :type license_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.LicenseType - :param enable_csi_proxy: Whether to enable CSI proxy. + :param enable_csi_proxy: For more details on CSI proxy, see the `CSI proxy GitHub repo + `_. :type enable_csi_proxy: bool """ @@ -2864,11 +2967,11 @@ def __init__( class OperationListResult(msrest.serialization.Model): - """The List Compute Operation operation response. + """The List Operation response. Variables are only populated by the server, and will be ignored when sending a request. - :ivar value: The list of compute operations. + :ivar value: The list of operations. :vartype value: list[~azure.mgmt.containerservice.v2021_05_01.models.OperationValue] """ @@ -2889,15 +2992,15 @@ def __init__( class OperationValue(msrest.serialization.Model): - """Describes the properties of a Compute Operation value. + """Describes the properties of a Operation value. Variables are only populated by the server, and will be ignored when sending a request. - :ivar origin: The origin of the compute operation. + :ivar origin: The origin of the operation. :vartype origin: str - :ivar name: The name of the compute operation. + :ivar name: The name of the operation. :vartype name: str - :ivar operation: The display name of the compute operation. + :ivar operation: The display name of the operation. :vartype operation: str :ivar resource: The display name of the resource the operation applies to. :vartype resource: str @@ -2945,13 +3048,13 @@ class OSOptionProfile(msrest.serialization.Model): All required parameters must be populated in order to send to Azure. - :ivar id: Id of the OS option profile. + :ivar id: The ID of the OS option resource. :vartype id: str - :ivar name: Name of the OS option profile. + :ivar name: The name of the OS option resource. :vartype name: str - :ivar type: Type of the OS option profile. + :ivar type: The type of the OS option resource. :vartype type: str - :param os_option_property_list: Required. The list of OS option properties. + :param os_option_property_list: Required. The list of OS options. :type os_option_property_list: list[~azure.mgmt.containerservice.v2021_05_01.models.OSOptionProperty] """ @@ -2986,9 +3089,9 @@ class OSOptionProperty(msrest.serialization.Model): All required parameters must be populated in order to send to Azure. - :param os_type: Required. OS type. + :param os_type: Required. The OS type. :type os_type: str - :param enable_fips_image: Required. Whether FIPS image is enabled. + :param enable_fips_image: Required. Whether the image is FIPS-enabled. :type enable_fips_image: bool """ @@ -3090,7 +3193,7 @@ def __init__( class PrivateEndpoint(msrest.serialization.Model): """Private endpoint which a connection belongs to. - :param id: The resource Id for private endpoint. + :param id: The resource ID of the private endpoint. :type id: str """ @@ -3190,7 +3293,7 @@ class PrivateLinkResource(msrest.serialization.Model): :type type: str :param group_id: The group ID of the resource. :type group_id: str - :param required_members: RequiredMembers of the resource. + :param required_members: The RequiredMembers of the resource. :type required_members: list[str] :ivar private_link_service_id: The private link service ID of the resource, this field is exposed only to NRP internally. @@ -3286,13 +3389,13 @@ def __init__( class RunCommandRequest(msrest.serialization.Model): - """run command request. + """A run command request. All required parameters must be populated in order to send to Azure. - :param command: Required. command to run. + :param command: Required. The command to run. :type command: str - :param context: base64 encoded zip file, contains files required by the command. + :param context: A base64 encoded zip file containing the files required by the command. :type context: str :param cluster_token: AuthToken issued for AKS AAD Server App. :type cluster_token: str @@ -3323,19 +3426,19 @@ class RunCommandResult(msrest.serialization.Model): Variables are only populated by the server, and will be ignored when sending a request. - :ivar id: command id. + :ivar id: The command id. :vartype id: str :ivar provisioning_state: provisioning State. :vartype provisioning_state: str - :ivar exit_code: exit code of the command. + :ivar exit_code: The exit code of the command. :vartype exit_code: int - :ivar started_at: time when the command started. + :ivar started_at: The time when the command started. :vartype started_at: ~datetime.datetime - :ivar finished_at: time when the command finished. + :ivar finished_at: The time when the command finished. :vartype finished_at: ~datetime.datetime - :ivar logs: command output. + :ivar logs: The command output. :vartype logs: str - :ivar reason: explain why provisioningState is set to failed (if so). + :ivar reason: An explanation of why provisioningState is set to failed (if so). :vartype reason: str """ @@ -3508,7 +3611,7 @@ class SystemData(msrest.serialization.Model): :param created_by_type: The type of identity that created the resource. Possible values include: "User", "Application", "ManagedIdentity", "Key". :type created_by_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.CreatedByType - :param created_at: The timestamp of resource creation (UTC). + :param created_at: The UTC timestamp of resource creation. :type created_at: ~datetime.datetime :param last_modified_by: The identity that last modified the resource. :type last_modified_by: str @@ -3564,10 +3667,12 @@ def __init__( class TimeInWeek(msrest.serialization.Model): """Time in a week. - :param day: A day in a week. Possible values include: "Sunday", "Monday", "Tuesday", + :param day: The day of the week. Possible values include: "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday". :type day: str or ~azure.mgmt.containerservice.v2021_05_01.models.WeekDay - :param hour_slots: hour slots in a day. + :param hour_slots: Each integer hour represents a time range beginning at 0m after the hour + ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 + UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. :type hour_slots: list[int] """ @@ -3586,7 +3691,7 @@ def __init__( class TimeSpan(msrest.serialization.Model): - """The time span with start and end properties. + """For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z. :param start: The start of a time span. :type start: ~datetime.datetime diff --git a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/models/_models_py3.py b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/models/_models_py3.py index db1b9190e9b4..646107c611d4 100644 --- a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/models/_models_py3.py +++ b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/models/_models_py3.py @@ -66,107 +66,123 @@ class AgentPool(SubResource): range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. :type count: int - :param vm_size: Size of agent VMs. + :param vm_size: VM size availability varies by region. If a node contains insufficient compute + resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted + VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions. :type vm_size: str :param os_disk_size_gb: OS Disk Size in GB to be used to specify the disk size for every - machine in this master/agent pool. If you specify 0, it will apply the default osDisk size + machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. :type os_disk_size_gb: int - :param os_disk_type: OS disk type to be used for machines in a given agent pool. Allowed values - are 'Ephemeral' and 'Managed'. If unspecified, defaults to 'Ephemeral' when the VM supports - ephemeral OS and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults - to 'Managed'. May not be changed after creation. Possible values include: "Managed", - "Ephemeral". + :param os_disk_type: The default is 'Ephemeral' if the VM supports it and has a cache disk + larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed + after creation. For more information see `Ephemeral OS + `_. Possible values + include: "Managed", "Ephemeral". :type os_disk_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.OSDiskType - :param kubelet_disk_type: KubeletDiskType determines the placement of emptyDir volumes, - container runtime data root, and Kubelet ephemeral storage. Currently allows one value, OS, - resulting in Kubelet using the OS disk for data. Possible values include: "OS", "Temporary". + :param kubelet_disk_type: Determines the placement of emptyDir volumes, container runtime data + root, and Kubelet ephemeral storage. Possible values include: "OS", "Temporary". :type kubelet_disk_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.KubeletDiskType - :param vnet_subnet_id: VNet SubnetID specifies the VNet's subnet identifier for nodes and maybe - pods. + :param vnet_subnet_id: If this is not specified, a VNET and subnet will be generated and used. + If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just + nodes. This is of the form: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. :type vnet_subnet_id: str - :param pod_subnet_id: Pod SubnetID specifies the VNet's subnet identifier for pods. + :param pod_subnet_id: If omitted, pod IPs are statically assigned on the node subnet (see + vnetSubnetID for more details). This is of the form: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. :type pod_subnet_id: str - :param max_pods: Maximum number of pods that can run on a node. + :param max_pods: The maximum number of pods that can run on a node. :type max_pods: int - :param os_type: OsType to be used to specify os type. Choose from Linux and Windows. Default to - Linux. Possible values include: "Linux", "Windows". Default value: "Linux". + :param os_type: The operating system type. The default is Linux. Possible values include: + "Linux", "Windows". Default value: "Linux". :type os_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.OSType - :param os_sku: OsSKU to be used to specify os sku. Choose from Ubuntu(default) and CBLMariner - for Linux OSType. Not applicable to Windows OSType. Possible values include: "Ubuntu", - "CBLMariner". + :param os_sku: Specifies an OS SKU. This value must not be specified if OSType is Windows. + Possible values include: "Ubuntu", "CBLMariner". :type os_sku: str or ~azure.mgmt.containerservice.v2021_05_01.models.OSSKU - :param max_count: Maximum number of nodes for auto-scaling. + :param max_count: The maximum number of nodes for auto-scaling. :type max_count: int - :param min_count: Minimum number of nodes for auto-scaling. + :param min_count: The minimum number of nodes for auto-scaling. :type min_count: int :param enable_auto_scaling: Whether to enable auto-scaler. :type enable_auto_scaling: bool - :param type_properties_type: AgentPoolType represents types of an agent pool. Possible values - include: "VirtualMachineScaleSets", "AvailabilitySet". + :param type_properties_type: The type of Agent Pool. Possible values include: + "VirtualMachineScaleSets", "AvailabilitySet". :type type_properties_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.AgentPoolType - :param mode: AgentPoolMode represents mode of an agent pool. Possible values include: "System", + :param mode: A cluster must have at least one 'System' Agent Pool at all times. For additional + information on agent pool restrictions and best practices, see: + https://docs.microsoft.com/azure/aks/use-system-pools. Possible values include: "System", "User". :type mode: str or ~azure.mgmt.containerservice.v2021_05_01.models.AgentPoolMode - :param orchestrator_version: Version of orchestrator specified when creating the managed - cluster. + :param orchestrator_version: As a best practice, you should upgrade all node pools in an AKS + cluster to the same Kubernetes version. The node pool version must have the same major version + as the control plane. The node pool minor version must be within two minor versions of the + control plane version. The node pool version cannot be greater than the control plane version. + For more information see `upgrading a node pool + `_. :type orchestrator_version: str - :ivar node_image_version: Version of node image. + :ivar node_image_version: The version of node image. :vartype node_image_version: str :param upgrade_settings: Settings for upgrading the agentpool. :type upgrade_settings: ~azure.mgmt.containerservice.v2021_05_01.models.AgentPoolUpgradeSettings - :ivar provisioning_state: The current deployment or provisioning state, which only appears in - the response. + :ivar provisioning_state: The current deployment or provisioning state. :vartype provisioning_state: str :ivar power_state: Describes whether the Agent Pool is Running or Stopped. :vartype power_state: ~azure.mgmt.containerservice.v2021_05_01.models.PowerState - :param availability_zones: Availability zones for nodes. Must use VirtualMachineScaleSets - AgentPoolType. + :param availability_zones: The list of Availability zones to use for nodes. This can only be + specified if the AgentPoolType property is 'VirtualMachineScaleSets'. :type availability_zones: list[str] - :param enable_node_public_ip: Enable public IP for nodes. + :param enable_node_public_ip: Some scenarios may require nodes in a node pool to receive their + own dedicated public IP addresses. A common scenario is for gaming workloads, where a console + needs to make a direct connection to a cloud virtual machine to minimize hops. For more + information see `assigning a public IP per node + `_. + The default is false. :type enable_node_public_ip: bool - :param node_public_ip_prefix_id: Public IP Prefix ID. VM nodes use IPs assigned from this - Public IP Prefix. + :param node_public_ip_prefix_id: This is of the form: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}. :type node_public_ip_prefix_id: str - :param scale_set_priority: ScaleSetPriority to be used to specify virtual machine scale set - priority. Default to regular. Possible values include: "Spot", "Regular". Default value: - "Regular". + :param scale_set_priority: The Virtual Machine Scale Set priority. If not specified, the + default is 'Regular'. Possible values include: "Spot", "Regular". Default value: "Regular". :type scale_set_priority: str or ~azure.mgmt.containerservice.v2021_05_01.models.ScaleSetPriority - :param scale_set_eviction_policy: ScaleSetEvictionPolicy to be used to specify eviction policy - for Spot virtual machine scale set. Default to Delete. Possible values include: "Delete", + :param scale_set_eviction_policy: This cannot be specified unless the scaleSetPriority is + 'Spot'. If not specified, the default is 'Delete'. Possible values include: "Delete", "Deallocate". Default value: "Delete". :type scale_set_eviction_policy: str or ~azure.mgmt.containerservice.v2021_05_01.models.ScaleSetEvictionPolicy - :param spot_max_price: SpotMaxPrice to be used to specify the maximum price you are willing to - pay in US Dollars. Possible values are any decimal value greater than zero or -1 which - indicates default price to be up-to on-demand. + :param spot_max_price: Possible values are any decimal value greater than zero or -1 which + indicates the willingness to pay any on-demand price. For more details on spot pricing, see + `spot VMs pricing `_. :type spot_max_price: float - :param tags: A set of tags. Agent pool tags to be persisted on the agent pool virtual machine - scale set. + :param tags: A set of tags. The tags to be persisted on the agent pool virtual machine scale + set. :type tags: dict[str, str] - :param node_labels: Agent pool node labels to be persisted across all nodes in agent pool. + :param node_labels: The node labels to be persisted across all nodes in agent pool. :type node_labels: dict[str, str] - :param node_taints: Taints added to new nodes during node pool create and scale. For example, - key=value:NoSchedule. + :param node_taints: The taints added to new nodes during node pool create and scale. For + example, key=value:NoSchedule. :type node_taints: list[str] :param proximity_placement_group_id: The ID for Proximity Placement Group. :type proximity_placement_group_id: str - :param kubelet_config: KubeletConfig specifies the configuration of kubelet on agent nodes. + :param kubelet_config: The Kubelet configuration on the agent pool nodes. :type kubelet_config: ~azure.mgmt.containerservice.v2021_05_01.models.KubeletConfig - :param linux_os_config: LinuxOSConfig specifies the OS configuration of linux agent nodes. + :param linux_os_config: The OS configuration of Linux agent nodes. :type linux_os_config: ~azure.mgmt.containerservice.v2021_05_01.models.LinuxOSConfig - :param enable_encryption_at_host: Whether to enable EncryptionAtHost. + :param enable_encryption_at_host: This is only supported on certain VM sizes and in certain + Azure regions. For more information, see: + https://docs.microsoft.com/azure/aks/enable-host-encryption. :type enable_encryption_at_host: bool :param enable_ultra_ssd: Whether to enable UltraSSD. :type enable_ultra_ssd: bool - :param enable_fips: Whether to use FIPS enabled OS. + :param enable_fips: See `Add a FIPS-enabled node pool + `_ + for more details. :type enable_fips: bool :param gpu_instance_profile: GPUInstanceProfile to be used to specify GPU MIG instance profile - for supported GPU VM SKU. Supported values are MIG1g, MIG2g, MIG3g, MIG4g and MIG7g. Possible - values include: "MIG1g", "MIG2g", "MIG3g", "MIG4g", "MIG7g". + for supported GPU VM SKU. Possible values include: "MIG1g", "MIG2g", "MIG3g", "MIG4g", "MIG7g". :type gpu_instance_profile: str or ~azure.mgmt.containerservice.v2021_05_01.models.GPUInstanceProfile """ @@ -305,11 +321,11 @@ class AgentPoolAvailableVersions(msrest.serialization.Model): Variables are only populated by the server, and will be ignored when sending a request. - :ivar id: Id of the agent pool available versions. + :ivar id: The ID of the agent pool version list. :vartype id: str - :ivar name: Name of the agent pool available versions. + :ivar name: The name of the agent pool version list. :vartype name: str - :ivar type: Type of the agent pool available versions. + :ivar type: Type of the agent pool version list. :vartype type: str :param agent_pool_versions: List of versions available for agent pool. :type agent_pool_versions: @@ -347,7 +363,7 @@ class AgentPoolAvailableVersionsPropertiesAgentPoolVersionsItem(msrest.serializa :param default: Whether this version is the default agent pool version. :type default: bool - :param kubernetes_version: Kubernetes version (major, minor, patch). + :param kubernetes_version: The Kubernetes version (major.minor.patch). :type kubernetes_version: str :param is_preview: Whether Kubernetes version is currently in preview. :type is_preview: bool @@ -411,22 +427,21 @@ class AgentPoolUpgradeProfile(msrest.serialization.Model): All required parameters must be populated in order to send to Azure. - :ivar id: Id of the agent pool upgrade profile. + :ivar id: The ID of the agent pool upgrade profile. :vartype id: str - :ivar name: Name of the agent pool upgrade profile. + :ivar name: The name of the agent pool upgrade profile. :vartype name: str - :ivar type: Type of the agent pool upgrade profile. + :ivar type: The type of the agent pool upgrade profile. :vartype type: str - :param kubernetes_version: Required. Kubernetes version (major, minor, patch). + :param kubernetes_version: Required. The Kubernetes version (major.minor.patch). :type kubernetes_version: str - :param os_type: Required. OsType to be used to specify os type. Choose from Linux and Windows. - Default to Linux. Possible values include: "Linux", "Windows". Default value: "Linux". + :param os_type: Required. The operating system type. The default is Linux. Possible values + include: "Linux", "Windows". Default value: "Linux". :type os_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.OSType :param upgrades: List of orchestrator types and versions available for upgrade. :type upgrades: list[~azure.mgmt.containerservice.v2021_05_01.models.AgentPoolUpgradeProfilePropertiesUpgradesItem] - :param latest_node_image_version: LatestNodeImageVersion is the latest AKS supported node image - version. + :param latest_node_image_version: The latest AKS supported node image version. :type latest_node_image_version: str """ @@ -470,9 +485,9 @@ def __init__( class AgentPoolUpgradeProfilePropertiesUpgradesItem(msrest.serialization.Model): """AgentPoolUpgradeProfilePropertiesUpgradesItem. - :param kubernetes_version: Kubernetes version (major, minor, patch). + :param kubernetes_version: The Kubernetes version (major.minor.patch). :type kubernetes_version: str - :param is_preview: Whether Kubernetes version is currently in preview. + :param is_preview: Whether the Kubernetes version is currently in preview. :type is_preview: bool """ @@ -496,8 +511,11 @@ def __init__( class AgentPoolUpgradeSettings(msrest.serialization.Model): """Settings for upgrading an agentpool. - :param max_surge: Count or percentage of additional nodes to be added during upgrade. If empty - uses AKS default. + :param max_surge: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). + If a percentage is specified, it is the percentage of the total agent pool size at the time of + the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is + 1. For more information, including best practices, see: + https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade. :type max_surge: str """ @@ -582,46 +600,52 @@ class Components1Q1Og48SchemasManagedclusterAllof1(msrest.serialization.Model): :param identity: The identity of the managed cluster, if configured. :type identity: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterIdentity - :ivar provisioning_state: The current deployment or provisioning state, which only appears in - the response. + :ivar provisioning_state: The current provisioning state. :vartype provisioning_state: str - :ivar power_state: Represents the Power State of the cluster. + :ivar power_state: The Power State of the cluster. :vartype power_state: ~azure.mgmt.containerservice.v2021_05_01.models.PowerState :ivar max_agent_pools: The max number of agent pools for the managed cluster. :vartype max_agent_pools: int - :param kubernetes_version: Version of Kubernetes specified when creating the managed cluster. + :param kubernetes_version: When you upgrade a supported AKS cluster, Kubernetes minor versions + cannot be skipped. All upgrades must be performed sequentially by major version number. For + example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> + 1.16.x is not allowed. See `upgrading an AKS cluster + `_ for more details. :type kubernetes_version: str - :param dns_prefix: DNS prefix specified when creating the managed cluster. + :param dns_prefix: This cannot be updated once the Managed Cluster has been created. :type dns_prefix: str - :param fqdn_subdomain: FQDN subdomain specified when creating private cluster with custom - private dns zone. + :param fqdn_subdomain: This cannot be updated once the Managed Cluster has been created. :type fqdn_subdomain: str - :ivar fqdn: FQDN for the master pool. + :ivar fqdn: The FQDN of the master pool. :vartype fqdn: str - :ivar private_fqdn: FQDN of private cluster. + :ivar private_fqdn: The FQDN of private cluster. :vartype private_fqdn: str - :ivar azure_portal_fqdn: FQDN for the master pool which used by proxy config. + :ivar azure_portal_fqdn: The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) + headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. + This special FQDN supports CORS, allowing the Azure Portal to function properly. :vartype azure_portal_fqdn: str - :param agent_pool_profiles: Properties of the agent pool. + :param agent_pool_profiles: The agent pool properties. :type agent_pool_profiles: list[~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterAgentPoolProfile] - :param linux_profile: Profile for Linux VMs in the container service cluster. + :param linux_profile: The profile for Linux VMs in the Managed Cluster. :type linux_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ContainerServiceLinuxProfile - :param windows_profile: Profile for Windows VMs in the container service cluster. + :param windows_profile: The profile for Windows VMs in the Managed Cluster. :type windows_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterWindowsProfile :param service_principal_profile: Information about a service principal identity for the cluster to use for manipulating Azure APIs. :type service_principal_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterServicePrincipalProfile - :param addon_profiles: Profile of managed cluster add-on. + :param addon_profiles: The profile of managed cluster add-on. :type addon_profiles: dict[str, ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterAddonProfile] - :param pod_identity_profile: Profile of managed cluster pod identity. + :param pod_identity_profile: See `use AAD pod identity + `_ for more details on AAD pod + identity integration. :type pod_identity_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterPodIdentityProfile - :param node_resource_group: Name of the resource group containing agent pool nodes. + :param node_resource_group: The name of the resource group containing agent pool nodes. :type node_resource_group: str :param enable_rbac: Whether to enable Kubernetes Role-Based Access Control. :type enable_rbac: bool @@ -629,22 +653,22 @@ class Components1Q1Og48SchemasManagedclusterAllof1(msrest.serialization.Model): policy (preview). This feature is set for removal on October 15th, 2020. Learn more at aka.ms/aks/azpodpolicy. :type enable_pod_security_policy: bool - :param network_profile: Profile of network configuration. + :param network_profile: The network configuration profile. :type network_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ContainerServiceNetworkProfile - :param aad_profile: Profile of Azure Active Directory configuration. + :param aad_profile: The Azure Active Directory configuration. :type aad_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterAADProfile - :param auto_upgrade_profile: Profile of auto upgrade configuration. + :param auto_upgrade_profile: The auto upgrade configuration. :type auto_upgrade_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterAutoUpgradeProfile :param auto_scaler_profile: Parameters to be applied to the cluster-autoscaler when enabled. :type auto_scaler_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterPropertiesAutoScalerProfile - :param api_server_access_profile: Access profile for managed cluster API server. + :param api_server_access_profile: The access profile for managed cluster API server. :type api_server_access_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterAPIServerAccessProfile - :param disk_encryption_set_id: ResourceId of the disk encryption set to use for enabling - encryption at rest. + :param disk_encryption_set_id: This is of the form: + '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'. :type disk_encryption_set_id: str :param identity_profile: Identities associated with the cluster. :type identity_profile: dict[str, @@ -652,8 +676,10 @@ class Components1Q1Og48SchemasManagedclusterAllof1(msrest.serialization.Model): :param private_link_resources: Private link resources associated with the cluster. :type private_link_resources: list[~azure.mgmt.containerservice.v2021_05_01.models.PrivateLinkResource] - :param disable_local_accounts: If set to true, getting static credential will be disabled for - this cluster. Expected to only be used for AAD clusters. + :param disable_local_accounts: If set to true, getting static credentials will be disabled for + this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details + see `disable local accounts + `_. :type disable_local_accounts: bool :param http_proxy_config: Configurations for provisioning the cluster with HTTP proxy servers. :type http_proxy_config: @@ -792,13 +818,13 @@ def __init__( class UserAssignedIdentity(msrest.serialization.Model): - """UserAssignedIdentity. + """Details about a user assigned identity. - :param resource_id: The resource id of the user assigned identity. + :param resource_id: The resource ID of the user assigned identity. :type resource_id: str - :param client_id: The client id of the user assigned identity. + :param client_id: The client ID of the user assigned identity. :type client_id: str - :param object_id: The object id of the user assigned identity. + :param object_id: The object ID of the user assigned identity. :type object_id: str """ @@ -825,11 +851,11 @@ def __init__( class ComponentsQit0EtSchemasManagedclusterpropertiesPropertiesIdentityprofileAdditionalproperties(UserAssignedIdentity): """ComponentsQit0EtSchemasManagedclusterpropertiesPropertiesIdentityprofileAdditionalproperties. - :param resource_id: The resource id of the user assigned identity. + :param resource_id: The resource ID of the user assigned identity. :type resource_id: str - :param client_id: The client id of the user assigned identity. + :param client_id: The client ID of the user assigned identity. :type client_id: str - :param object_id: The object id of the user assigned identity. + :param object_id: The object ID of the user assigned identity. :type object_id: str """ @@ -885,7 +911,7 @@ class ContainerServiceLinuxProfile(msrest.serialization.Model): :param admin_username: Required. The administrator username to use for Linux VMs. :type admin_username: str - :param ssh: Required. SSH configuration for Linux-based VMs running on Azure. + :param ssh: Required. The SSH configuration for Linux-based VMs running on Azure. :type ssh: ~azure.mgmt.containerservice.v2021_05_01.models.ContainerServiceSshConfiguration """ @@ -1025,14 +1051,14 @@ def __init__( class ContainerServiceNetworkProfile(msrest.serialization.Model): """Profile of network configuration. - :param network_plugin: Network plugin used for building Kubernetes network. Possible values + :param network_plugin: Network plugin used for building the Kubernetes network. Possible values include: "azure", "kubenet". Default value: "kubenet". :type network_plugin: str or ~azure.mgmt.containerservice.v2021_05_01.models.NetworkPlugin - :param network_policy: Network policy used for building Kubernetes network. Possible values + :param network_policy: Network policy used for building the Kubernetes network. Possible values include: "calico", "azure". :type network_policy: str or ~azure.mgmt.containerservice.v2021_05_01.models.NetworkPolicy - :param network_mode: Network mode used for building Kubernetes network. Possible values - include: "transparent", "bridge". + :param network_mode: This cannot be specified if networkPlugin is anything other than 'azure'. + Possible values include: "transparent", "bridge". :type network_mode: str or ~azure.mgmt.containerservice.v2021_05_01.models.NetworkMode :param pod_cidr: A CIDR notation IP range from which to assign pod IPs when kubenet is used. :type pod_cidr: str @@ -1045,11 +1071,14 @@ class ContainerServiceNetworkProfile(msrest.serialization.Model): :param docker_bridge_cidr: A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range. :type docker_bridge_cidr: str - :param outbound_type: The outbound (egress) routing method. Possible values include: + :param outbound_type: This can only be set at cluster creation time and cannot be changed + later. For more information see `egress outbound type + `_. Possible values include: "loadBalancer", "userDefinedRouting". Default value: "loadBalancer". :type outbound_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.OutboundType - :param load_balancer_sku: The load balancer sku for the managed cluster. Possible values - include: "standard", "basic". + :param load_balancer_sku: The default is 'standard'. See `Azure Load Balancer SKUs + `_ for more information about the + differences between load balancer SKUs. Possible values include: "standard", "basic". :type load_balancer_sku: str or ~azure.mgmt.containerservice.v2021_05_01.models.LoadBalancerSku :param load_balancer_profile: Profile of the cluster load balancer. :type load_balancer_profile: @@ -1110,7 +1139,7 @@ class ContainerServiceSshConfiguration(msrest.serialization.Model): All required parameters must be populated in order to send to Azure. :param public_keys: Required. The list of SSH public keys used to authenticate with Linux-based - VMs. Only expect one key specified. + VMs. A maximum of 1 key may be specified. :type public_keys: list[~azure.mgmt.containerservice.v2021_05_01.models.ContainerServiceSshPublicKey] """ @@ -1226,7 +1255,7 @@ def __init__( class CredentialResults(msrest.serialization.Model): - """The list of credential result response. + """The list credential result response. Variables are only populated by the server, and will be ignored when sending a request. @@ -1339,24 +1368,30 @@ def __init__( class KubeletConfig(msrest.serialization.Model): - """Kubelet configurations of agent nodes. + """See `AKS custom node configuration `_ for more details. - :param cpu_manager_policy: CPU Manager policy to use. + :param cpu_manager_policy: The default is 'none'. See `Kubernetes CPU management policies + `_ + for more information. Allowed values are 'none' and 'static'. :type cpu_manager_policy: str - :param cpu_cfs_quota: Enable CPU CFS quota enforcement for containers that specify CPU limits. + :param cpu_cfs_quota: The default is true. :type cpu_cfs_quota: bool - :param cpu_cfs_quota_period: Sets CPU CFS quota period value. + :param cpu_cfs_quota_period: The default is '100ms.' Valid values are a sequence of decimal + numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported + units are 'ns', 'us', 'ms', 's', 'm', and 'h'. :type cpu_cfs_quota_period: str - :param image_gc_high_threshold: The percent of disk usage after which image garbage collection - is always run. + :param image_gc_high_threshold: To disable image garbage collection, set to 100. The default is + 85%. :type image_gc_high_threshold: int - :param image_gc_low_threshold: The percent of disk usage before which image garbage collection - is never run. + :param image_gc_low_threshold: This cannot be set higher than imageGcHighThreshold. The default + is 80%. :type image_gc_low_threshold: int - :param topology_manager_policy: Topology Manager policy to use. + :param topology_manager_policy: For more information see `Kubernetes Topology Manager + `_. The default is + 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. :type topology_manager_policy: str - :param allowed_unsafe_sysctls: Allowlist of unsafe sysctls or unsafe sysctl patterns (ending in - ``*``\ ). + :param allowed_unsafe_sysctls: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending + in ``*``\ ). :type allowed_unsafe_sysctls: list[str] :param fail_swap_on: If set to true it will make the Kubelet fail to start if swap is enabled on the node. @@ -1420,16 +1455,20 @@ def __init__( class LinuxOSConfig(msrest.serialization.Model): - """OS configurations of Linux agent nodes. + """See `AKS custom node configuration `_ for more details. :param sysctls: Sysctl settings for Linux agent nodes. :type sysctls: ~azure.mgmt.containerservice.v2021_05_01.models.SysctlConfig - :param transparent_huge_page_enabled: Transparent Huge Page enabled configuration. + :param transparent_huge_page_enabled: Valid values are 'always', 'madvise', and 'never'. The + default is 'always'. For more information see `Transparent Hugepages + `_. :type transparent_huge_page_enabled: str - :param transparent_huge_page_defrag: Transparent Huge Page defrag configuration. + :param transparent_huge_page_defrag: Valid values are 'always', 'defer', 'defer+madvise', + 'madvise' and 'never'. The default is 'madvise'. For more information see `Transparent + Hugepages + `_. :type transparent_huge_page_defrag: str - :param swap_file_size_mb: SwapFileSizeMB specifies size in MB of a swap file will be created on - each node. + :param swap_file_size_mb: The size in MB of a swap file that will be created on each node. :type swap_file_size_mb: int """ @@ -1457,7 +1496,7 @@ def __init__( class MaintenanceConfiguration(SubResource): - """maintenance configuration. + """See `planned maintenance `_ for more information about planned maintenance. Variables are only populated by the server, and will be ignored when sending a request. @@ -1468,9 +1507,10 @@ class MaintenanceConfiguration(SubResource): :vartype name: str :ivar type: Resource type. :vartype type: str - :ivar system_data: The system meta data relating to this resource. + :ivar system_data: The system metadata relating to this resource. :vartype system_data: ~azure.mgmt.containerservice.v2021_05_01.models.SystemData - :param time_in_week: Weekday time slots allowed to upgrade. + :param time_in_week: If two array entries specify the same day of the week, the applied + configuration is the union of times in both entries. :type time_in_week: list[~azure.mgmt.containerservice.v2021_05_01.models.TimeInWeek] :param not_allowed_time: Time slots on which upgrade is not allowed. :type not_allowed_time: list[~azure.mgmt.containerservice.v2021_05_01.models.TimeSpan] @@ -1594,46 +1634,52 @@ class ManagedCluster(Resource, Components1Q1Og48SchemasManagedclusterAllof1): :param identity: The identity of the managed cluster, if configured. :type identity: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterIdentity - :ivar provisioning_state: The current deployment or provisioning state, which only appears in - the response. + :ivar provisioning_state: The current provisioning state. :vartype provisioning_state: str - :ivar power_state: Represents the Power State of the cluster. + :ivar power_state: The Power State of the cluster. :vartype power_state: ~azure.mgmt.containerservice.v2021_05_01.models.PowerState :ivar max_agent_pools: The max number of agent pools for the managed cluster. :vartype max_agent_pools: int - :param kubernetes_version: Version of Kubernetes specified when creating the managed cluster. + :param kubernetes_version: When you upgrade a supported AKS cluster, Kubernetes minor versions + cannot be skipped. All upgrades must be performed sequentially by major version number. For + example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> + 1.16.x is not allowed. See `upgrading an AKS cluster + `_ for more details. :type kubernetes_version: str - :param dns_prefix: DNS prefix specified when creating the managed cluster. + :param dns_prefix: This cannot be updated once the Managed Cluster has been created. :type dns_prefix: str - :param fqdn_subdomain: FQDN subdomain specified when creating private cluster with custom - private dns zone. + :param fqdn_subdomain: This cannot be updated once the Managed Cluster has been created. :type fqdn_subdomain: str - :ivar fqdn: FQDN for the master pool. + :ivar fqdn: The FQDN of the master pool. :vartype fqdn: str - :ivar private_fqdn: FQDN of private cluster. + :ivar private_fqdn: The FQDN of private cluster. :vartype private_fqdn: str - :ivar azure_portal_fqdn: FQDN for the master pool which used by proxy config. + :ivar azure_portal_fqdn: The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) + headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. + This special FQDN supports CORS, allowing the Azure Portal to function properly. :vartype azure_portal_fqdn: str - :param agent_pool_profiles: Properties of the agent pool. + :param agent_pool_profiles: The agent pool properties. :type agent_pool_profiles: list[~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterAgentPoolProfile] - :param linux_profile: Profile for Linux VMs in the container service cluster. + :param linux_profile: The profile for Linux VMs in the Managed Cluster. :type linux_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ContainerServiceLinuxProfile - :param windows_profile: Profile for Windows VMs in the container service cluster. + :param windows_profile: The profile for Windows VMs in the Managed Cluster. :type windows_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterWindowsProfile :param service_principal_profile: Information about a service principal identity for the cluster to use for manipulating Azure APIs. :type service_principal_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterServicePrincipalProfile - :param addon_profiles: Profile of managed cluster add-on. + :param addon_profiles: The profile of managed cluster add-on. :type addon_profiles: dict[str, ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterAddonProfile] - :param pod_identity_profile: Profile of managed cluster pod identity. + :param pod_identity_profile: See `use AAD pod identity + `_ for more details on AAD pod + identity integration. :type pod_identity_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterPodIdentityProfile - :param node_resource_group: Name of the resource group containing agent pool nodes. + :param node_resource_group: The name of the resource group containing agent pool nodes. :type node_resource_group: str :param enable_rbac: Whether to enable Kubernetes Role-Based Access Control. :type enable_rbac: bool @@ -1641,22 +1687,22 @@ class ManagedCluster(Resource, Components1Q1Og48SchemasManagedclusterAllof1): policy (preview). This feature is set for removal on October 15th, 2020. Learn more at aka.ms/aks/azpodpolicy. :type enable_pod_security_policy: bool - :param network_profile: Profile of network configuration. + :param network_profile: The network configuration profile. :type network_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ContainerServiceNetworkProfile - :param aad_profile: Profile of Azure Active Directory configuration. + :param aad_profile: The Azure Active Directory configuration. :type aad_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterAADProfile - :param auto_upgrade_profile: Profile of auto upgrade configuration. + :param auto_upgrade_profile: The auto upgrade configuration. :type auto_upgrade_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterAutoUpgradeProfile :param auto_scaler_profile: Parameters to be applied to the cluster-autoscaler when enabled. :type auto_scaler_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterPropertiesAutoScalerProfile - :param api_server_access_profile: Access profile for managed cluster API server. + :param api_server_access_profile: The access profile for managed cluster API server. :type api_server_access_profile: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterAPIServerAccessProfile - :param disk_encryption_set_id: ResourceId of the disk encryption set to use for enabling - encryption at rest. + :param disk_encryption_set_id: This is of the form: + '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'. :type disk_encryption_set_id: str :param identity_profile: Identities associated with the cluster. :type identity_profile: dict[str, @@ -1664,8 +1710,10 @@ class ManagedCluster(Resource, Components1Q1Og48SchemasManagedclusterAllof1): :param private_link_resources: Private link resources associated with the cluster. :type private_link_resources: list[~azure.mgmt.containerservice.v2021_05_01.models.PrivateLinkResource] - :param disable_local_accounts: If set to true, getting static credential will be disabled for - this cluster. Expected to only be used for AAD clusters. + :param disable_local_accounts: If set to true, getting static credentials will be disabled for + this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details + see `disable local accounts + `_. :type disable_local_accounts: bool :param http_proxy_config: Configurations for provisioning the cluster with HTTP proxy servers. :type http_proxy_config: @@ -1812,13 +1860,14 @@ def __init__( class ManagedClusterAADProfile(msrest.serialization.Model): - """AADProfile specifies attributes for Azure Active Directory integration. + """For more details see `managed AAD on AKS `_. :param managed: Whether to enable managed AAD. :type managed: bool :param enable_azure_rbac: Whether to enable Azure RBAC for Kubernetes authorization. :type enable_azure_rbac: bool - :param admin_group_object_i_ds: AAD group object IDs that will have admin role of the cluster. + :param admin_group_object_i_ds: The list of AAD group object IDs that will have admin role of + the cluster. :type admin_group_object_i_ds: list[str] :param client_app_id: The client AAD application ID. :type client_app_id: str @@ -1955,11 +2004,11 @@ def __init__( class ManagedClusterAddonProfileIdentity(UserAssignedIdentity): """Information of user assigned identity used by this add-on. - :param resource_id: The resource id of the user assigned identity. + :param resource_id: The resource ID of the user assigned identity. :type resource_id: str - :param client_id: The client id of the user assigned identity. + :param client_id: The client ID of the user assigned identity. :type client_id: str - :param object_id: The object id of the user assigned identity. + :param object_id: The object ID of the user assigned identity. :type object_id: str """ @@ -1989,106 +2038,122 @@ class ManagedClusterAgentPoolProfileProperties(msrest.serialization.Model): range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. :type count: int - :param vm_size: Size of agent VMs. + :param vm_size: VM size availability varies by region. If a node contains insufficient compute + resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted + VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions. :type vm_size: str :param os_disk_size_gb: OS Disk Size in GB to be used to specify the disk size for every - machine in this master/agent pool. If you specify 0, it will apply the default osDisk size + machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. :type os_disk_size_gb: int - :param os_disk_type: OS disk type to be used for machines in a given agent pool. Allowed values - are 'Ephemeral' and 'Managed'. If unspecified, defaults to 'Ephemeral' when the VM supports - ephemeral OS and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults - to 'Managed'. May not be changed after creation. Possible values include: "Managed", - "Ephemeral". + :param os_disk_type: The default is 'Ephemeral' if the VM supports it and has a cache disk + larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed + after creation. For more information see `Ephemeral OS + `_. Possible values + include: "Managed", "Ephemeral". :type os_disk_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.OSDiskType - :param kubelet_disk_type: KubeletDiskType determines the placement of emptyDir volumes, - container runtime data root, and Kubelet ephemeral storage. Currently allows one value, OS, - resulting in Kubelet using the OS disk for data. Possible values include: "OS", "Temporary". + :param kubelet_disk_type: Determines the placement of emptyDir volumes, container runtime data + root, and Kubelet ephemeral storage. Possible values include: "OS", "Temporary". :type kubelet_disk_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.KubeletDiskType - :param vnet_subnet_id: VNet SubnetID specifies the VNet's subnet identifier for nodes and maybe - pods. + :param vnet_subnet_id: If this is not specified, a VNET and subnet will be generated and used. + If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just + nodes. This is of the form: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. :type vnet_subnet_id: str - :param pod_subnet_id: Pod SubnetID specifies the VNet's subnet identifier for pods. + :param pod_subnet_id: If omitted, pod IPs are statically assigned on the node subnet (see + vnetSubnetID for more details). This is of the form: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. :type pod_subnet_id: str - :param max_pods: Maximum number of pods that can run on a node. + :param max_pods: The maximum number of pods that can run on a node. :type max_pods: int - :param os_type: OsType to be used to specify os type. Choose from Linux and Windows. Default to - Linux. Possible values include: "Linux", "Windows". Default value: "Linux". + :param os_type: The operating system type. The default is Linux. Possible values include: + "Linux", "Windows". Default value: "Linux". :type os_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.OSType - :param os_sku: OsSKU to be used to specify os sku. Choose from Ubuntu(default) and CBLMariner - for Linux OSType. Not applicable to Windows OSType. Possible values include: "Ubuntu", - "CBLMariner". + :param os_sku: Specifies an OS SKU. This value must not be specified if OSType is Windows. + Possible values include: "Ubuntu", "CBLMariner". :type os_sku: str or ~azure.mgmt.containerservice.v2021_05_01.models.OSSKU - :param max_count: Maximum number of nodes for auto-scaling. + :param max_count: The maximum number of nodes for auto-scaling. :type max_count: int - :param min_count: Minimum number of nodes for auto-scaling. + :param min_count: The minimum number of nodes for auto-scaling. :type min_count: int :param enable_auto_scaling: Whether to enable auto-scaler. :type enable_auto_scaling: bool - :param type: AgentPoolType represents types of an agent pool. Possible values include: - "VirtualMachineScaleSets", "AvailabilitySet". + :param type: The type of Agent Pool. Possible values include: "VirtualMachineScaleSets", + "AvailabilitySet". :type type: str or ~azure.mgmt.containerservice.v2021_05_01.models.AgentPoolType - :param mode: AgentPoolMode represents mode of an agent pool. Possible values include: "System", + :param mode: A cluster must have at least one 'System' Agent Pool at all times. For additional + information on agent pool restrictions and best practices, see: + https://docs.microsoft.com/azure/aks/use-system-pools. Possible values include: "System", "User". :type mode: str or ~azure.mgmt.containerservice.v2021_05_01.models.AgentPoolMode - :param orchestrator_version: Version of orchestrator specified when creating the managed - cluster. + :param orchestrator_version: As a best practice, you should upgrade all node pools in an AKS + cluster to the same Kubernetes version. The node pool version must have the same major version + as the control plane. The node pool minor version must be within two minor versions of the + control plane version. The node pool version cannot be greater than the control plane version. + For more information see `upgrading a node pool + `_. :type orchestrator_version: str - :ivar node_image_version: Version of node image. + :ivar node_image_version: The version of node image. :vartype node_image_version: str :param upgrade_settings: Settings for upgrading the agentpool. :type upgrade_settings: ~azure.mgmt.containerservice.v2021_05_01.models.AgentPoolUpgradeSettings - :ivar provisioning_state: The current deployment or provisioning state, which only appears in - the response. + :ivar provisioning_state: The current deployment or provisioning state. :vartype provisioning_state: str :ivar power_state: Describes whether the Agent Pool is Running or Stopped. :vartype power_state: ~azure.mgmt.containerservice.v2021_05_01.models.PowerState - :param availability_zones: Availability zones for nodes. Must use VirtualMachineScaleSets - AgentPoolType. + :param availability_zones: The list of Availability zones to use for nodes. This can only be + specified if the AgentPoolType property is 'VirtualMachineScaleSets'. :type availability_zones: list[str] - :param enable_node_public_ip: Enable public IP for nodes. + :param enable_node_public_ip: Some scenarios may require nodes in a node pool to receive their + own dedicated public IP addresses. A common scenario is for gaming workloads, where a console + needs to make a direct connection to a cloud virtual machine to minimize hops. For more + information see `assigning a public IP per node + `_. + The default is false. :type enable_node_public_ip: bool - :param node_public_ip_prefix_id: Public IP Prefix ID. VM nodes use IPs assigned from this - Public IP Prefix. + :param node_public_ip_prefix_id: This is of the form: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}. :type node_public_ip_prefix_id: str - :param scale_set_priority: ScaleSetPriority to be used to specify virtual machine scale set - priority. Default to regular. Possible values include: "Spot", "Regular". Default value: - "Regular". + :param scale_set_priority: The Virtual Machine Scale Set priority. If not specified, the + default is 'Regular'. Possible values include: "Spot", "Regular". Default value: "Regular". :type scale_set_priority: str or ~azure.mgmt.containerservice.v2021_05_01.models.ScaleSetPriority - :param scale_set_eviction_policy: ScaleSetEvictionPolicy to be used to specify eviction policy - for Spot virtual machine scale set. Default to Delete. Possible values include: "Delete", + :param scale_set_eviction_policy: This cannot be specified unless the scaleSetPriority is + 'Spot'. If not specified, the default is 'Delete'. Possible values include: "Delete", "Deallocate". Default value: "Delete". :type scale_set_eviction_policy: str or ~azure.mgmt.containerservice.v2021_05_01.models.ScaleSetEvictionPolicy - :param spot_max_price: SpotMaxPrice to be used to specify the maximum price you are willing to - pay in US Dollars. Possible values are any decimal value greater than zero or -1 which - indicates default price to be up-to on-demand. + :param spot_max_price: Possible values are any decimal value greater than zero or -1 which + indicates the willingness to pay any on-demand price. For more details on spot pricing, see + `spot VMs pricing `_. :type spot_max_price: float - :param tags: A set of tags. Agent pool tags to be persisted on the agent pool virtual machine - scale set. + :param tags: A set of tags. The tags to be persisted on the agent pool virtual machine scale + set. :type tags: dict[str, str] - :param node_labels: Agent pool node labels to be persisted across all nodes in agent pool. + :param node_labels: The node labels to be persisted across all nodes in agent pool. :type node_labels: dict[str, str] - :param node_taints: Taints added to new nodes during node pool create and scale. For example, - key=value:NoSchedule. + :param node_taints: The taints added to new nodes during node pool create and scale. For + example, key=value:NoSchedule. :type node_taints: list[str] :param proximity_placement_group_id: The ID for Proximity Placement Group. :type proximity_placement_group_id: str - :param kubelet_config: KubeletConfig specifies the configuration of kubelet on agent nodes. + :param kubelet_config: The Kubelet configuration on the agent pool nodes. :type kubelet_config: ~azure.mgmt.containerservice.v2021_05_01.models.KubeletConfig - :param linux_os_config: LinuxOSConfig specifies the OS configuration of linux agent nodes. + :param linux_os_config: The OS configuration of Linux agent nodes. :type linux_os_config: ~azure.mgmt.containerservice.v2021_05_01.models.LinuxOSConfig - :param enable_encryption_at_host: Whether to enable EncryptionAtHost. + :param enable_encryption_at_host: This is only supported on certain VM sizes and in certain + Azure regions. For more information, see: + https://docs.microsoft.com/azure/aks/enable-host-encryption. :type enable_encryption_at_host: bool :param enable_ultra_ssd: Whether to enable UltraSSD. :type enable_ultra_ssd: bool - :param enable_fips: Whether to use FIPS enabled OS. + :param enable_fips: See `Add a FIPS-enabled node pool + `_ + for more details. :type enable_fips: bool :param gpu_instance_profile: GPUInstanceProfile to be used to specify GPU MIG instance profile - for supported GPU VM SKU. Supported values are MIG1g, MIG2g, MIG3g, MIG4g and MIG7g. Possible - values include: "MIG1g", "MIG2g", "MIG3g", "MIG4g", "MIG7g". + for supported GPU VM SKU. Possible values include: "MIG1g", "MIG2g", "MIG3g", "MIG4g", "MIG7g". :type gpu_instance_profile: str or ~azure.mgmt.containerservice.v2021_05_01.models.GPUInstanceProfile """ @@ -2227,110 +2292,125 @@ class ManagedClusterAgentPoolProfile(ManagedClusterAgentPoolProfileProperties): range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. :type count: int - :param vm_size: Size of agent VMs. + :param vm_size: VM size availability varies by region. If a node contains insufficient compute + resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted + VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions. :type vm_size: str :param os_disk_size_gb: OS Disk Size in GB to be used to specify the disk size for every - machine in this master/agent pool. If you specify 0, it will apply the default osDisk size + machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. :type os_disk_size_gb: int - :param os_disk_type: OS disk type to be used for machines in a given agent pool. Allowed values - are 'Ephemeral' and 'Managed'. If unspecified, defaults to 'Ephemeral' when the VM supports - ephemeral OS and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults - to 'Managed'. May not be changed after creation. Possible values include: "Managed", - "Ephemeral". + :param os_disk_type: The default is 'Ephemeral' if the VM supports it and has a cache disk + larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed + after creation. For more information see `Ephemeral OS + `_. Possible values + include: "Managed", "Ephemeral". :type os_disk_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.OSDiskType - :param kubelet_disk_type: KubeletDiskType determines the placement of emptyDir volumes, - container runtime data root, and Kubelet ephemeral storage. Currently allows one value, OS, - resulting in Kubelet using the OS disk for data. Possible values include: "OS", "Temporary". + :param kubelet_disk_type: Determines the placement of emptyDir volumes, container runtime data + root, and Kubelet ephemeral storage. Possible values include: "OS", "Temporary". :type kubelet_disk_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.KubeletDiskType - :param vnet_subnet_id: VNet SubnetID specifies the VNet's subnet identifier for nodes and maybe - pods. + :param vnet_subnet_id: If this is not specified, a VNET and subnet will be generated and used. + If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just + nodes. This is of the form: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. :type vnet_subnet_id: str - :param pod_subnet_id: Pod SubnetID specifies the VNet's subnet identifier for pods. + :param pod_subnet_id: If omitted, pod IPs are statically assigned on the node subnet (see + vnetSubnetID for more details). This is of the form: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. :type pod_subnet_id: str - :param max_pods: Maximum number of pods that can run on a node. + :param max_pods: The maximum number of pods that can run on a node. :type max_pods: int - :param os_type: OsType to be used to specify os type. Choose from Linux and Windows. Default to - Linux. Possible values include: "Linux", "Windows". Default value: "Linux". + :param os_type: The operating system type. The default is Linux. Possible values include: + "Linux", "Windows". Default value: "Linux". :type os_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.OSType - :param os_sku: OsSKU to be used to specify os sku. Choose from Ubuntu(default) and CBLMariner - for Linux OSType. Not applicable to Windows OSType. Possible values include: "Ubuntu", - "CBLMariner". + :param os_sku: Specifies an OS SKU. This value must not be specified if OSType is Windows. + Possible values include: "Ubuntu", "CBLMariner". :type os_sku: str or ~azure.mgmt.containerservice.v2021_05_01.models.OSSKU - :param max_count: Maximum number of nodes for auto-scaling. + :param max_count: The maximum number of nodes for auto-scaling. :type max_count: int - :param min_count: Minimum number of nodes for auto-scaling. + :param min_count: The minimum number of nodes for auto-scaling. :type min_count: int :param enable_auto_scaling: Whether to enable auto-scaler. :type enable_auto_scaling: bool - :param type: AgentPoolType represents types of an agent pool. Possible values include: - "VirtualMachineScaleSets", "AvailabilitySet". + :param type: The type of Agent Pool. Possible values include: "VirtualMachineScaleSets", + "AvailabilitySet". :type type: str or ~azure.mgmt.containerservice.v2021_05_01.models.AgentPoolType - :param mode: AgentPoolMode represents mode of an agent pool. Possible values include: "System", + :param mode: A cluster must have at least one 'System' Agent Pool at all times. For additional + information on agent pool restrictions and best practices, see: + https://docs.microsoft.com/azure/aks/use-system-pools. Possible values include: "System", "User". :type mode: str or ~azure.mgmt.containerservice.v2021_05_01.models.AgentPoolMode - :param orchestrator_version: Version of orchestrator specified when creating the managed - cluster. + :param orchestrator_version: As a best practice, you should upgrade all node pools in an AKS + cluster to the same Kubernetes version. The node pool version must have the same major version + as the control plane. The node pool minor version must be within two minor versions of the + control plane version. The node pool version cannot be greater than the control plane version. + For more information see `upgrading a node pool + `_. :type orchestrator_version: str - :ivar node_image_version: Version of node image. + :ivar node_image_version: The version of node image. :vartype node_image_version: str :param upgrade_settings: Settings for upgrading the agentpool. :type upgrade_settings: ~azure.mgmt.containerservice.v2021_05_01.models.AgentPoolUpgradeSettings - :ivar provisioning_state: The current deployment or provisioning state, which only appears in - the response. + :ivar provisioning_state: The current deployment or provisioning state. :vartype provisioning_state: str :ivar power_state: Describes whether the Agent Pool is Running or Stopped. :vartype power_state: ~azure.mgmt.containerservice.v2021_05_01.models.PowerState - :param availability_zones: Availability zones for nodes. Must use VirtualMachineScaleSets - AgentPoolType. + :param availability_zones: The list of Availability zones to use for nodes. This can only be + specified if the AgentPoolType property is 'VirtualMachineScaleSets'. :type availability_zones: list[str] - :param enable_node_public_ip: Enable public IP for nodes. + :param enable_node_public_ip: Some scenarios may require nodes in a node pool to receive their + own dedicated public IP addresses. A common scenario is for gaming workloads, where a console + needs to make a direct connection to a cloud virtual machine to minimize hops. For more + information see `assigning a public IP per node + `_. + The default is false. :type enable_node_public_ip: bool - :param node_public_ip_prefix_id: Public IP Prefix ID. VM nodes use IPs assigned from this - Public IP Prefix. + :param node_public_ip_prefix_id: This is of the form: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}. :type node_public_ip_prefix_id: str - :param scale_set_priority: ScaleSetPriority to be used to specify virtual machine scale set - priority. Default to regular. Possible values include: "Spot", "Regular". Default value: - "Regular". + :param scale_set_priority: The Virtual Machine Scale Set priority. If not specified, the + default is 'Regular'. Possible values include: "Spot", "Regular". Default value: "Regular". :type scale_set_priority: str or ~azure.mgmt.containerservice.v2021_05_01.models.ScaleSetPriority - :param scale_set_eviction_policy: ScaleSetEvictionPolicy to be used to specify eviction policy - for Spot virtual machine scale set. Default to Delete. Possible values include: "Delete", + :param scale_set_eviction_policy: This cannot be specified unless the scaleSetPriority is + 'Spot'. If not specified, the default is 'Delete'. Possible values include: "Delete", "Deallocate". Default value: "Delete". :type scale_set_eviction_policy: str or ~azure.mgmt.containerservice.v2021_05_01.models.ScaleSetEvictionPolicy - :param spot_max_price: SpotMaxPrice to be used to specify the maximum price you are willing to - pay in US Dollars. Possible values are any decimal value greater than zero or -1 which - indicates default price to be up-to on-demand. + :param spot_max_price: Possible values are any decimal value greater than zero or -1 which + indicates the willingness to pay any on-demand price. For more details on spot pricing, see + `spot VMs pricing `_. :type spot_max_price: float - :param tags: A set of tags. Agent pool tags to be persisted on the agent pool virtual machine - scale set. + :param tags: A set of tags. The tags to be persisted on the agent pool virtual machine scale + set. :type tags: dict[str, str] - :param node_labels: Agent pool node labels to be persisted across all nodes in agent pool. + :param node_labels: The node labels to be persisted across all nodes in agent pool. :type node_labels: dict[str, str] - :param node_taints: Taints added to new nodes during node pool create and scale. For example, - key=value:NoSchedule. + :param node_taints: The taints added to new nodes during node pool create and scale. For + example, key=value:NoSchedule. :type node_taints: list[str] :param proximity_placement_group_id: The ID for Proximity Placement Group. :type proximity_placement_group_id: str - :param kubelet_config: KubeletConfig specifies the configuration of kubelet on agent nodes. + :param kubelet_config: The Kubelet configuration on the agent pool nodes. :type kubelet_config: ~azure.mgmt.containerservice.v2021_05_01.models.KubeletConfig - :param linux_os_config: LinuxOSConfig specifies the OS configuration of linux agent nodes. + :param linux_os_config: The OS configuration of Linux agent nodes. :type linux_os_config: ~azure.mgmt.containerservice.v2021_05_01.models.LinuxOSConfig - :param enable_encryption_at_host: Whether to enable EncryptionAtHost. + :param enable_encryption_at_host: This is only supported on certain VM sizes and in certain + Azure regions. For more information, see: + https://docs.microsoft.com/azure/aks/enable-host-encryption. :type enable_encryption_at_host: bool :param enable_ultra_ssd: Whether to enable UltraSSD. :type enable_ultra_ssd: bool - :param enable_fips: Whether to use FIPS enabled OS. + :param enable_fips: See `Add a FIPS-enabled node pool + `_ + for more details. :type enable_fips: bool :param gpu_instance_profile: GPUInstanceProfile to be used to specify GPU MIG instance profile - for supported GPU VM SKU. Supported values are MIG1g, MIG2g, MIG3g, MIG4g and MIG7g. Possible - values include: "MIG1g", "MIG2g", "MIG3g", "MIG4g", "MIG7g". + for supported GPU VM SKU. Possible values include: "MIG1g", "MIG2g", "MIG3g", "MIG4g", "MIG7g". :type gpu_instance_profile: str or ~azure.mgmt.containerservice.v2021_05_01.models.GPUInstanceProfile - :param name: Required. Unique name of the agent pool profile in the context of the subscription - and resource group. + :param name: Required. Windows agent pool names must be 6 characters or less. :type name: str """ @@ -2428,11 +2508,17 @@ def __init__( class ManagedClusterAPIServerAccessProfile(msrest.serialization.Model): """Access profile for managed cluster API server. - :param authorized_ip_ranges: Authorized IP Ranges to kubernetes API server. + :param authorized_ip_ranges: IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. + This feature is not compatible with clusters that use Public IP Per Node, or clusters that are + using a Basic Load Balancer. For more information see `API server authorized IP ranges + `_. :type authorized_ip_ranges: list[str] - :param enable_private_cluster: Whether to create the cluster as a private cluster or not. + :param enable_private_cluster: For more details, see `Creating a private AKS cluster + `_. :type enable_private_cluster: bool - :param private_dns_zone: Private dns zone mode for private cluster. + :param private_dns_zone: The default is System. For more details see `configure private DNS + zone `_. + Allowed values are 'system' and 'none'. :type private_dns_zone: str :param enable_private_cluster_public_fqdn: Whether to create additional public FQDN for private cluster or not. @@ -2465,8 +2551,9 @@ def __init__( class ManagedClusterAutoUpgradeProfile(msrest.serialization.Model): """Auto upgrade profile for a managed cluster. - :param upgrade_channel: upgrade channel for auto upgrade. Possible values include: "rapid", - "stable", "patch", "node-image", "none". + :param upgrade_channel: For more information see `setting the AKS cluster auto-upgrade channel + `_. Possible + values include: "rapid", "stable", "patch", "node-image", "none". :type upgrade_channel: str or ~azure.mgmt.containerservice.v2021_05_01.models.UpgradeChannel """ @@ -2485,13 +2572,13 @@ def __init__( class ManagedClusterHTTPProxyConfig(msrest.serialization.Model): - """Configurations for provisioning the cluster with HTTP proxy servers. + """Cluster HTTP proxy configuration. - :param http_proxy: HTTP proxy server endpoint to use. + :param http_proxy: The HTTP proxy server endpoint to use. :type http_proxy: str - :param https_proxy: HTTPS proxy server endpoint to use. + :param https_proxy: The HTTPS proxy server endpoint to use. :type https_proxy: str - :param no_proxy: Endpoints that should not go through proxy. + :param no_proxy: The endpoints that should not go through proxy. :type no_proxy: list[str] :param trusted_ca: Alternative CA cert to use for connecting to proxy servers. :type trusted_ca: str @@ -2531,15 +2618,11 @@ class ManagedClusterIdentity(msrest.serialization.Model): :ivar tenant_id: The tenant id of the system assigned identity which is used by master components. :vartype tenant_id: str - :param type: The type of identity used for the managed cluster. Type 'SystemAssigned' will use - an implicitly created identity in master components and an auto-created user assigned identity - in MC_ resource group in agent nodes. Type 'None' will not use MSI for the managed cluster, - service principal will be used instead. Possible values include: "SystemAssigned", - "UserAssigned", "None". + :param type: For more information see `use managed identities in AKS + `_. Possible values include: + "SystemAssigned", "UserAssigned", "None". :type type: str or ~azure.mgmt.containerservice.v2021_05_01.models.ResourceIdentityType - :param user_assigned_identities: The user identity associated with the managed cluster. This - identity will be used in control plane and only one user assigned identity is allowed. The user - identity dictionary key references will be ARM resource ids in the form: + :param user_assigned_identities: The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. :type user_assigned_identities: dict[str, ~azure.mgmt.containerservice.v2021_05_01.models.Components1Umhcm8SchemasManagedclusteridentityPropertiesUserassignedidentitiesAdditionalproperties] @@ -2619,12 +2702,12 @@ class ManagedClusterLoadBalancerProfile(msrest.serialization.Model): balancer. :type effective_outbound_i_ps: list[~azure.mgmt.containerservice.v2021_05_01.models.ResourceReference] - :param allocated_outbound_ports: Desired number of allocated SNAT ports per VM. Allowed values - must be in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure - dynamically allocating ports. + :param allocated_outbound_ports: The desired number of allocated SNAT ports per VM. Allowed + values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in + Azure dynamically allocating ports. :type allocated_outbound_ports: int :param idle_timeout_in_minutes: Desired outbound flow idle timeout in minutes. Allowed values - must be in the range of 4 to 120 (inclusive). The default value is 30 minutes. + are in the range of 4 to 120 (inclusive). The default value is 30 minutes. :type idle_timeout_in_minutes: int """ @@ -2665,7 +2748,7 @@ def __init__( class ManagedClusterLoadBalancerProfileManagedOutboundIPs(msrest.serialization.Model): """Desired managed outbound IPs for the cluster load balancer. - :param count: Desired number of outbound IP created/managed by Azure for the cluster load + :param count: The desired number of outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. :type count: int """ @@ -2732,19 +2815,19 @@ def __init__( class ManagedClusterPodIdentity(msrest.serialization.Model): - """ManagedClusterPodIdentity. + """Details about the pod identity assigned to the Managed 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. - :param name: Required. Name of the pod identity. + :param name: Required. The name of the pod identity. :type name: str - :param namespace: Required. Namespace of the pod identity. + :param namespace: Required. The namespace of the pod identity. :type namespace: str - :param binding_selector: Binding selector to use for the AzureIdentityBinding resource. + :param binding_selector: The binding selector to use for the AzureIdentityBinding resource. :type binding_selector: str - :param identity: Required. Information of the user assigned identity. + :param identity: Required. The user assigned identity details. :type identity: ~azure.mgmt.containerservice.v2021_05_01.models.UserAssignedIdentity :ivar provisioning_state: The current provisioning state of the pod identity. Possible values include: "Assigned", "Updating", "Deleting", "Failed". @@ -2791,15 +2874,15 @@ def __init__( class ManagedClusterPodIdentityException(msrest.serialization.Model): - """ManagedClusterPodIdentityException. + """See `disable AAD Pod Identity for a specific Pod/Application `_ for more details. All required parameters must be populated in order to send to Azure. - :param name: Required. Name of the pod identity exception. + :param name: Required. The name of the pod identity exception. :type name: str - :param namespace: Required. Namespace of the pod identity exception. + :param namespace: Required. The namespace of the pod identity exception. :type namespace: str - :param pod_labels: Required. Pod labels to match. + :param pod_labels: Required. The pod labels to match. :type pod_labels: dict[str, str] """ @@ -2830,17 +2913,20 @@ def __init__( class ManagedClusterPodIdentityProfile(msrest.serialization.Model): - """ManagedClusterPodIdentityProfile. + """See `use AAD pod identity `_ for more details on pod identity integration. :param enabled: Whether the pod identity addon is enabled. :type enabled: bool - :param allow_network_plugin_kubenet: Customer consent for enabling AAD pod identity addon in - cluster using Kubenet network plugin. + :param allow_network_plugin_kubenet: Running in Kubenet is disabled by default due to the + security related nature of AAD Pod Identity and the risks of IP spoofing. See `using Kubenet + network plugin with AAD Pod Identity + `_ + for more information. :type allow_network_plugin_kubenet: bool - :param user_assigned_identities: User assigned pod identity settings. + :param user_assigned_identities: The pod identities to use in the cluster. :type user_assigned_identities: list[~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterPodIdentity] - :param user_assigned_identity_exceptions: User assigned pod identity exception settings. + :param user_assigned_identity_exceptions: The pod identity exceptions to allow. :type user_assigned_identity_exceptions: list[~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterPodIdentityException] """ @@ -2894,12 +2980,12 @@ class ManagedClusterPoolUpgradeProfile(msrest.serialization.Model): All required parameters must be populated in order to send to Azure. - :param kubernetes_version: Required. Kubernetes version (major, minor, patch). + :param kubernetes_version: Required. The Kubernetes version (major.minor.patch). :type kubernetes_version: str - :param name: Pool name. + :param name: The Agent Pool name. :type name: str - :param os_type: Required. OsType to be used to specify os type. Choose from Linux and Windows. - Default to Linux. Possible values include: "Linux", "Windows". Default value: "Linux". + :param os_type: Required. The operating system type. The default is Linux. Possible values + include: "Linux", "Windows". Default value: "Linux". :type os_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.OSType :param upgrades: List of orchestrator types and versions available for upgrade. :type upgrades: @@ -2937,9 +3023,9 @@ def __init__( class ManagedClusterPoolUpgradeProfileUpgradesItem(msrest.serialization.Model): """ManagedClusterPoolUpgradeProfileUpgradesItem. - :param kubernetes_version: Kubernetes version (major, minor, patch). + :param kubernetes_version: The Kubernetes version (major.minor.patch). :type kubernetes_version: str - :param is_preview: Whether Kubernetes version is currently in preview. + :param is_preview: Whether the Kubernetes version is currently in preview. :type is_preview: bool """ @@ -2963,39 +3049,52 @@ def __init__( class ManagedClusterPropertiesAutoScalerProfile(msrest.serialization.Model): """Parameters to be applied to the cluster-autoscaler when enabled. - :param balance_similar_node_groups: + :param balance_similar_node_groups: Valid values are 'true' and 'false'. :type balance_similar_node_groups: str - :param expander: Possible values include: "least-waste", "most-pods", "priority", "random". + :param expander: If not specified, the default is 'random'. See `expanders + `_ + for more information. Possible values include: "least-waste", "most-pods", "priority", + "random". :type expander: str or ~azure.mgmt.containerservice.v2021_05_01.models.Expander - :param max_empty_bulk_delete: + :param max_empty_bulk_delete: The default is 10. :type max_empty_bulk_delete: str - :param max_graceful_termination_sec: + :param max_graceful_termination_sec: The default is 600. :type max_graceful_termination_sec: str - :param max_node_provision_time: + :param max_node_provision_time: The default is '15m'. Values must be an integer followed by an + 'm'. No unit of time other than minutes (m) is supported. :type max_node_provision_time: str - :param max_total_unready_percentage: + :param max_total_unready_percentage: The default is 45. The maximum is 100 and the minimum is + 0. :type max_total_unready_percentage: str - :param new_pod_scale_up_delay: + :param new_pod_scale_up_delay: For scenarios like burst/batch scale where you don't want CA to + act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore + unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer + followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). :type new_pod_scale_up_delay: str - :param ok_total_unready_count: + :param ok_total_unready_count: This must be an integer. The default is 3. :type ok_total_unready_count: str - :param scan_interval: + :param scan_interval: The default is '10'. Values must be an integer number of seconds. :type scan_interval: str - :param scale_down_delay_after_add: + :param scale_down_delay_after_add: The default is '10m'. Values must be an integer followed by + an 'm'. No unit of time other than minutes (m) is supported. :type scale_down_delay_after_add: str - :param scale_down_delay_after_delete: + :param scale_down_delay_after_delete: The default is the scan-interval. Values must be an + integer followed by an 'm'. No unit of time other than minutes (m) is supported. :type scale_down_delay_after_delete: str - :param scale_down_delay_after_failure: + :param scale_down_delay_after_failure: The default is '3m'. Values must be an integer followed + by an 'm'. No unit of time other than minutes (m) is supported. :type scale_down_delay_after_failure: str - :param scale_down_unneeded_time: + :param scale_down_unneeded_time: The default is '10m'. Values must be an integer followed by an + 'm'. No unit of time other than minutes (m) is supported. :type scale_down_unneeded_time: str - :param scale_down_unready_time: + :param scale_down_unready_time: The default is '20m'. Values must be an integer followed by an + 'm'. No unit of time other than minutes (m) is supported. :type scale_down_unready_time: str - :param scale_down_utilization_threshold: + :param scale_down_utilization_threshold: The default is '0.5'. :type scale_down_utilization_threshold: str - :param skip_nodes_with_local_storage: + :param skip_nodes_with_local_storage: The default is true. :type skip_nodes_with_local_storage: str - :param skip_nodes_with_system_pods: + :param skip_nodes_with_system_pods: The default is true. :type skip_nodes_with_system_pods: str """ @@ -3094,11 +3193,13 @@ def __init__( class ManagedClusterSKU(msrest.serialization.Model): - """ManagedClusterSKU. + """The SKU of a Managed Cluster. - :param name: Name of a managed cluster SKU. Possible values include: "Basic". + :param name: The name of a managed cluster SKU. Possible values include: "Basic". :type name: str or ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterSKUName - :param tier: Tier of a managed cluster SKU. Possible values include: "Paid", "Free". + :param tier: If not specified, the default is 'Free'. See `uptime SLA + `_ for more details. Possible values include: + "Paid", "Free". :type tier: str or ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterSKUTier """ @@ -3126,11 +3227,11 @@ class ManagedClusterUpgradeProfile(msrest.serialization.Model): All required parameters must be populated in order to send to Azure. - :ivar id: Id of upgrade profile. + :ivar id: The ID of the upgrade profile. :vartype id: str - :ivar name: Name of upgrade profile. + :ivar name: The name of the upgrade profile. :vartype name: str - :ivar type: Type of upgrade profile. + :ivar type: The type of the upgrade profile. :vartype type: str :param control_plane_profile: Required. The list of available upgrade versions for the control plane. @@ -3173,12 +3274,12 @@ def __init__( class ManagedClusterWindowsProfile(msrest.serialization.Model): - """Profile for Windows VMs in the container service cluster. + """Profile for Windows VMs in the managed cluster. All required parameters must be populated in order to send to Azure. :param admin_username: Required. Specifies the name of the administrator account. - :code:`
`:code:`
` **restriction:** Cannot end in "." :code:`
`:code:`
` + :code:`
`:code:`
` **Restriction:** Cannot end in "." :code:`
`:code:`
` **Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", @@ -3193,10 +3294,12 @@ class ManagedClusterWindowsProfile(msrest.serialization.Model): :code:`
`:code:`
` **Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!". :type admin_password: str - :param license_type: The licenseType to use for Windows VMs. Windows_Server is used to enable - Azure Hybrid User Benefits for Windows VMs. Possible values include: "None", "Windows_Server". + :param license_type: The license type to use for Windows VMs. See `Azure Hybrid User Benefits + `_ for more details. Possible values + include: "None", "Windows_Server". :type license_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.LicenseType - :param enable_csi_proxy: Whether to enable CSI proxy. + :param enable_csi_proxy: For more details on CSI proxy, see the `CSI proxy GitHub repo + `_. :type enable_csi_proxy: bool """ @@ -3228,11 +3331,11 @@ def __init__( class OperationListResult(msrest.serialization.Model): - """The List Compute Operation operation response. + """The List Operation response. Variables are only populated by the server, and will be ignored when sending a request. - :ivar value: The list of compute operations. + :ivar value: The list of operations. :vartype value: list[~azure.mgmt.containerservice.v2021_05_01.models.OperationValue] """ @@ -3253,15 +3356,15 @@ def __init__( class OperationValue(msrest.serialization.Model): - """Describes the properties of a Compute Operation value. + """Describes the properties of a Operation value. Variables are only populated by the server, and will be ignored when sending a request. - :ivar origin: The origin of the compute operation. + :ivar origin: The origin of the operation. :vartype origin: str - :ivar name: The name of the compute operation. + :ivar name: The name of the operation. :vartype name: str - :ivar operation: The display name of the compute operation. + :ivar operation: The display name of the operation. :vartype operation: str :ivar resource: The display name of the resource the operation applies to. :vartype resource: str @@ -3309,13 +3412,13 @@ class OSOptionProfile(msrest.serialization.Model): All required parameters must be populated in order to send to Azure. - :ivar id: Id of the OS option profile. + :ivar id: The ID of the OS option resource. :vartype id: str - :ivar name: Name of the OS option profile. + :ivar name: The name of the OS option resource. :vartype name: str - :ivar type: Type of the OS option profile. + :ivar type: The type of the OS option resource. :vartype type: str - :param os_option_property_list: Required. The list of OS option properties. + :param os_option_property_list: Required. The list of OS options. :type os_option_property_list: list[~azure.mgmt.containerservice.v2021_05_01.models.OSOptionProperty] """ @@ -3352,9 +3455,9 @@ class OSOptionProperty(msrest.serialization.Model): All required parameters must be populated in order to send to Azure. - :param os_type: Required. OS type. + :param os_type: Required. The OS type. :type os_type: str - :param enable_fips_image: Required. Whether FIPS image is enabled. + :param enable_fips_image: Required. Whether the image is FIPS-enabled. :type enable_fips_image: bool """ @@ -3466,7 +3569,7 @@ def __init__( class PrivateEndpoint(msrest.serialization.Model): """Private endpoint which a connection belongs to. - :param id: The resource Id for private endpoint. + :param id: The resource ID of the private endpoint. :type id: str """ @@ -3573,7 +3676,7 @@ class PrivateLinkResource(msrest.serialization.Model): :type type: str :param group_id: The group ID of the resource. :type group_id: str - :param required_members: RequiredMembers of the resource. + :param required_members: The RequiredMembers of the resource. :type required_members: list[str] :ivar private_link_service_id: The private link service ID of the resource, this field is exposed only to NRP internally. @@ -3682,13 +3785,13 @@ def __init__( class RunCommandRequest(msrest.serialization.Model): - """run command request. + """A run command request. All required parameters must be populated in order to send to Azure. - :param command: Required. command to run. + :param command: Required. The command to run. :type command: str - :param context: base64 encoded zip file, contains files required by the command. + :param context: A base64 encoded zip file containing the files required by the command. :type context: str :param cluster_token: AuthToken issued for AKS AAD Server App. :type cluster_token: str @@ -3723,19 +3826,19 @@ class RunCommandResult(msrest.serialization.Model): Variables are only populated by the server, and will be ignored when sending a request. - :ivar id: command id. + :ivar id: The command id. :vartype id: str :ivar provisioning_state: provisioning State. :vartype provisioning_state: str - :ivar exit_code: exit code of the command. + :ivar exit_code: The exit code of the command. :vartype exit_code: int - :ivar started_at: time when the command started. + :ivar started_at: The time when the command started. :vartype started_at: ~datetime.datetime - :ivar finished_at: time when the command finished. + :ivar finished_at: The time when the command finished. :vartype finished_at: ~datetime.datetime - :ivar logs: command output. + :ivar logs: The command output. :vartype logs: str - :ivar reason: explain why provisioningState is set to failed (if so). + :ivar reason: An explanation of why provisioningState is set to failed (if so). :vartype reason: str """ @@ -3937,7 +4040,7 @@ class SystemData(msrest.serialization.Model): :param created_by_type: The type of identity that created the resource. Possible values include: "User", "Application", "ManagedIdentity", "Key". :type created_by_type: str or ~azure.mgmt.containerservice.v2021_05_01.models.CreatedByType - :param created_at: The timestamp of resource creation (UTC). + :param created_at: The UTC timestamp of resource creation. :type created_at: ~datetime.datetime :param last_modified_by: The identity that last modified the resource. :type last_modified_by: str @@ -4002,10 +4105,12 @@ def __init__( class TimeInWeek(msrest.serialization.Model): """Time in a week. - :param day: A day in a week. Possible values include: "Sunday", "Monday", "Tuesday", + :param day: The day of the week. Possible values include: "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday". :type day: str or ~azure.mgmt.containerservice.v2021_05_01.models.WeekDay - :param hour_slots: hour slots in a day. + :param hour_slots: Each integer hour represents a time range beginning at 0m after the hour + ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 + UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. :type hour_slots: list[int] """ @@ -4027,7 +4132,7 @@ def __init__( class TimeSpan(msrest.serialization.Model): - """The time span with start and end properties. + """For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z. :param start: The start of a time span. :type start: ~datetime.datetime diff --git a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_agent_pools_operations.py b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_agent_pools_operations.py index 76b28d7fd51c..35911eea6d77 100644 --- a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_agent_pools_operations.py +++ b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_agent_pools_operations.py @@ -56,8 +56,7 @@ def list( # type: (...) -> Iterable["_models.AgentPoolListResult"] """Gets a list of agent pools in the specified managed cluster. - Gets a list of agent pools in the specified managed cluster. The operation returns properties - of each agent pool. + Gets a list of agent pools in the specified managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -133,9 +132,9 @@ def get( **kwargs # type: Any ): # type: (...) -> "_models.AgentPool" - """Gets the agent pool. + """Gets the specified managed cluster agent pool. - Gets the details of the agent pool by managed cluster and resource group. + Gets the specified managed cluster agent pool. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -259,7 +258,7 @@ def begin_create_or_update( **kwargs # type: Any ): # type: (...) -> LROPoller["_models.AgentPool"] - """Creates or updates an agent pool. + """Creates or updates an agent pool in the specified managed cluster. Creates or updates an agent pool in the specified managed cluster. @@ -269,7 +268,7 @@ def begin_create_or_update( :type resource_name: str :param agent_pool_name: The name of the agent pool. :type agent_pool_name: str - :param parameters: Parameters supplied to the Create or Update an agent pool operation. + :param parameters: The agent pool to create or update. :type parameters: ~azure.mgmt.containerservice.v2021_05_01.models.AgentPool :keyword callable cls: A custom type or function that will be passed the direct response :keyword str continuation_token: A continuation token to restart a poller from a saved state. @@ -384,9 +383,9 @@ def begin_delete( **kwargs # type: Any ): # type: (...) -> LROPoller[None] - """Deletes an agent pool. + """Deletes an agent pool in the specified managed cluster. - Deletes the agent pool in the specified managed cluster. + Deletes an agent pool in the specified managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -456,10 +455,9 @@ def get_upgrade_profile( **kwargs # type: Any ): # type: (...) -> "_models.AgentPoolUpgradeProfile" - """Gets upgrade profile for an agent pool. + """Gets the upgrade profile for an agent pool. - Gets the details of the upgrade profile for an agent pool with a specified resource group and - managed cluster name. + Gets the upgrade profile for an agent pool. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -521,9 +519,11 @@ def get_available_agent_pool_versions( **kwargs # type: Any ): # type: (...) -> "_models.AgentPoolAvailableVersions" - """Gets a list of supported versions for the specified agent pool. + """Gets a list of supported Kubernetes versions for the specified agent pool. - Gets a list of supported versions for the specified agent pool. + See `supported Kubernetes versions + `_ for more details about + the version lifecycle. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -635,9 +635,11 @@ def begin_upgrade_node_image_version( **kwargs # type: Any ): # type: (...) -> LROPoller["_models.AgentPool"] - """Upgrade node image version of an agent pool to the latest. + """Upgrades the node image version of an agent pool to the latest. - Upgrade node image version of an agent pool to the latest. + Upgrading the node image version of an agent pool applies the newest OS and runtime updates to + the nodes. AKS provides one new image per week with the latest updates. For more details on + node image versions, see: https://docs.microsoft.com/azure/aks/node-image-upgrade. :param resource_group_name: The name of the resource group. :type resource_group_name: str diff --git a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_maintenance_configurations_operations.py b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_maintenance_configurations_operations.py index 0fdcd1ee2fa2..304c6b195833 100644 --- a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_maintenance_configurations_operations.py +++ b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_maintenance_configurations_operations.py @@ -54,8 +54,7 @@ def list_by_managed_cluster( # type: (...) -> Iterable["_models.MaintenanceConfigurationListResult"] """Gets a list of maintenance configurations in the specified managed cluster. - Gets a list of maintenance configurations in the specified managed cluster. The operation - returns properties of each maintenance configuration. + Gets a list of maintenance configurations in the specified managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -131,9 +130,9 @@ def get( **kwargs # type: Any ): # type: (...) -> "_models.MaintenanceConfiguration" - """Gets the maintenance configuration. + """Gets the specified maintenance configuration of a managed cluster. - Gets the details of maintenance configurations by managed cluster and resource group. + Gets the specified maintenance configuration of a managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -197,7 +196,7 @@ def create_or_update( **kwargs # type: Any ): # type: (...) -> "_models.MaintenanceConfiguration" - """Creates or updates a maintenance configurations. + """Creates or updates a maintenance configuration in the specified managed cluster. Creates or updates a maintenance configuration in the specified managed cluster. @@ -207,8 +206,7 @@ def create_or_update( :type resource_name: str :param config_name: The name of the maintenance configuration. :type config_name: str - :param parameters: Parameters supplied to the Create or Update a default maintenance - configuration. + :param parameters: The maintenance configuration to create or update. :type parameters: ~azure.mgmt.containerservice.v2021_05_01.models.MaintenanceConfiguration :keyword callable cls: A custom type or function that will be passed the direct response :return: MaintenanceConfiguration, or the result of cls(response) @@ -272,7 +270,7 @@ def delete( # type: (...) -> None """Deletes a maintenance configuration. - Deletes the maintenance configuration in the specified managed cluster. + Deletes a maintenance configuration. :param resource_group_name: The name of the resource group. :type resource_group_name: str diff --git a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_managed_clusters_operations.py b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_managed_clusters_operations.py index db49ec983fd2..fa0d76950e13 100644 --- a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_managed_clusters_operations.py +++ b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_managed_clusters_operations.py @@ -60,7 +60,7 @@ def get_os_options( :param location: The name of a supported Azure region. :type location: str - :param resource_type: resource type for which the OS options needs to be returned. + :param resource_type: The resource type for which the OS options needs to be returned. :type resource_type: str :keyword callable cls: A custom type or function that will be passed the direct response :return: OSOptionProfile, or the result of cls(response) @@ -116,8 +116,7 @@ def list( # type: (...) -> Iterable["_models.ManagedClusterListResult"] """Gets a list of managed clusters in the specified subscription. - Gets a list of managed clusters in the specified subscription. The operation returns properties - of each managed cluster. + Gets a list of managed clusters in the specified subscription. :keyword callable cls: A custom type or function that will be passed the direct response :return: An iterator like instance of either ManagedClusterListResult or the result of cls(response) @@ -187,8 +186,7 @@ def list_by_resource_group( # type: (...) -> Iterable["_models.ManagedClusterListResult"] """Lists managed clusters in the specified subscription and resource group. - Lists managed clusters in the specified subscription and resource group. The operation returns - properties of each managed cluster. + Lists managed clusters in the specified subscription and resource group. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -260,10 +258,9 @@ def get_upgrade_profile( **kwargs # type: Any ): # type: (...) -> "_models.ManagedClusterUpgradeProfile" - """Gets upgrade profile for a managed cluster. + """Gets the upgrade profile of a managed cluster. - Gets the details of the upgrade profile for a managed cluster with a specified resource group - and name. + Gets the upgrade profile of a managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -325,12 +322,10 @@ def get_access_profile( # type: (...) -> "_models.ManagedClusterAccessProfile" """Gets an access profile of a managed cluster. - Gets the accessProfile for the specified role name of the managed cluster with a specified - resource group and name. **WARNING**\ : This API will be deprecated. Instead use - `ListClusterUserCredentials - `_ or + **WARNING**\ : This API will be deprecated. Instead use `ListClusterUserCredentials + `_ or `ListClusterAdminCredentials - `_ . + `_ . :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -393,9 +388,9 @@ def list_cluster_admin_credentials( **kwargs # type: Any ): # type: (...) -> "_models.CredentialResults" - """Gets cluster admin credential of a managed cluster. + """Lists the admin credentials of a managed cluster. - Gets cluster admin credential of the managed cluster with a specified resource group and name. + Lists the admin credentials of a managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -459,9 +454,9 @@ def list_cluster_user_credentials( **kwargs # type: Any ): # type: (...) -> "_models.CredentialResults" - """Gets cluster user credential of a managed cluster. + """Lists the user credentials of a managed cluster. - Gets cluster user credential of the managed cluster with a specified resource group and name. + Lists the user credentials of a managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -525,10 +520,9 @@ def list_cluster_monitoring_user_credentials( **kwargs # type: Any ): # type: (...) -> "_models.CredentialResults" - """Gets cluster monitoring user credential of a managed cluster. + """Lists the cluster monitoring user credentials of a managed cluster. - Gets cluster monitoring user credential of the managed cluster with a specified resource group - and name. + Lists the cluster monitoring user credentials of a managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -593,7 +587,7 @@ def get( # type: (...) -> "_models.ManagedCluster" """Gets a managed cluster. - Gets the details of the managed cluster with a specified resource group and name. + Gets a managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -713,14 +707,13 @@ def begin_create_or_update( # type: (...) -> LROPoller["_models.ManagedCluster"] """Creates or updates a managed cluster. - Creates or updates a managed cluster with the specified configuration for agents and Kubernetes - version. + Creates or updates a managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str :param resource_name: The name of the managed cluster resource. :type resource_name: str - :param parameters: Parameters supplied to the Create or Update a Managed Cluster operation. + :param parameters: The managed cluster to create or update. :type parameters: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedCluster :keyword callable cls: A custom type or function that will be passed the direct response :keyword str continuation_token: A continuation token to restart a poller from a saved state. @@ -842,7 +835,7 @@ def begin_update_tags( # type: (...) -> LROPoller["_models.ManagedCluster"] """Updates tags on a managed cluster. - Updates a managed cluster with the specified tags. + Updates tags on a managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -960,7 +953,7 @@ def begin_delete( # type: (...) -> LROPoller[None] """Deletes a managed cluster. - Deletes the managed cluster with a specified resource group and name. + Deletes a managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -1077,16 +1070,15 @@ def begin_reset_service_principal_profile( **kwargs # type: Any ): # type: (...) -> LROPoller[None] - """Reset Service Principal Profile of a managed cluster. + """Reset the Service Principal Profile of a managed cluster. - Update the service principal Profile for a managed cluster. + This action cannot be performed on a cluster that is not using a service principal. :param resource_group_name: The name of the resource group. :type resource_group_name: str :param resource_name: The name of the managed cluster resource. :type resource_name: str - :param parameters: Parameters supplied to the Reset Service Principal Profile operation for a - Managed Cluster. + :param parameters: The service principal profile to set on the managed cluster. :type parameters: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterServicePrincipalProfile :keyword callable cls: A custom type or function that will be passed the direct response :keyword str continuation_token: A continuation token to restart a poller from a saved state. @@ -1200,16 +1192,15 @@ def begin_reset_aad_profile( **kwargs # type: Any ): # type: (...) -> LROPoller[None] - """Reset AAD Profile of a managed cluster. + """Reset the AAD Profile of a managed cluster. - Update the AAD Profile for a managed cluster. + Reset the AAD Profile of a managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str :param resource_name: The name of the managed cluster resource. :type resource_name: str - :param parameters: Parameters supplied to the Reset AAD Profile operation for a Managed - Cluster. + :param parameters: The AAD profile to set on the Managed Cluster. :type parameters: ~azure.mgmt.containerservice.v2021_05_01.models.ManagedClusterAADProfile :keyword callable cls: A custom type or function that will be passed the direct response :keyword str continuation_token: A continuation token to restart a poller from a saved state. @@ -1316,9 +1307,10 @@ def begin_rotate_cluster_certificates( **kwargs # type: Any ): # type: (...) -> LROPoller[None] - """Rotate certificates of a managed cluster. + """Rotates the certificates of a managed cluster. - Rotate certificates of a managed cluster. + See `Certificate rotation `_ for + more details about rotating managed cluster certificates. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -1428,9 +1420,13 @@ def begin_stop( **kwargs # type: Any ): # type: (...) -> LROPoller[None] - """Stop Managed Cluster. + """Stops a Managed Cluster. - Stops a Running Managed Cluster. + This can only be performed on Azure Virtual Machine Scale set backed clusters. Stopping a + cluster stops the control plane and agent nodes entirely, while maintaining all object and + cluster state. A cluster does not accrue charges while it is stopped. See `stopping a cluster + `_ for more details about stopping a + cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -1540,9 +1536,10 @@ def begin_start( **kwargs # type: Any ): # type: (...) -> LROPoller[None] - """Start Managed Cluster. + """Starts a previously stopped Managed Cluster. - Starts a Stopped Managed Cluster. + See `starting a cluster `_ for more + details about starting a cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -1664,16 +1661,17 @@ def begin_run_command( **kwargs # type: Any ): # type: (...) -> LROPoller["_models.RunCommandResult"] - """Run Command against Managed Kubernetes Service. + """Submits a command to run against the Managed Cluster. - Submit a command to run against managed kubernetes service, it will create a pod to run the - command. + AKS will create a pod to run the command. This is primarily useful for private clusters. For + more information see `AKS Run Command + `_. :param resource_group_name: The name of the resource group. :type resource_group_name: str :param resource_name: The name of the managed cluster resource. :type resource_name: str - :param request_payload: Parameters supplied to the RunCommand operation. + :param request_payload: The run command request. :type request_payload: ~azure.mgmt.containerservice.v2021_05_01.models.RunCommandRequest :keyword callable cls: A custom type or function that will be passed the direct response :keyword str continuation_token: A continuation token to restart a poller from a saved state. @@ -1739,15 +1737,15 @@ def get_command_result( **kwargs # type: Any ): # type: (...) -> Optional["_models.RunCommandResult"] - """Get command result. + """Gets the results of a command which has been run on the Managed Cluster. - Get command result from previous runCommand invoke. + Gets the results of a command which has been run on the Managed Cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str :param resource_name: The name of the managed cluster resource. :type resource_name: str - :param command_id: Id of the command request. + :param command_id: Id of the command. :type command_id: str :keyword callable cls: A custom type or function that will be passed the direct response :return: RunCommandResult, or the result of cls(response) diff --git a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_operations.py b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_operations.py index c26019e7667c..4932d0d0e94b 100644 --- a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_operations.py +++ b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_operations.py @@ -50,7 +50,9 @@ def list( **kwargs # type: Any ): # type: (...) -> Iterable["_models.OperationListResult"] - """Gets a list of compute operations. + """Gets a list of operations. + + Gets a list of operations. :keyword callable cls: A custom type or function that will be passed the direct response :return: An iterator like instance of either OperationListResult or the result of cls(response) diff --git a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_private_endpoint_connections_operations.py b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_private_endpoint_connections_operations.py index 4cebbb525d11..32afc4933599 100644 --- a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_private_endpoint_connections_operations.py +++ b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_private_endpoint_connections_operations.py @@ -55,8 +55,8 @@ def list( # type: (...) -> "_models.PrivateEndpointConnectionListResult" """Gets a list of private endpoint connections in the specified managed cluster. - Gets a list of private endpoint connections in the specified managed cluster. The operation - returns properties of each private endpoint connection. + To learn more about private clusters, see: + https://docs.microsoft.com/azure/aks/private-clusters. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -116,9 +116,10 @@ def get( **kwargs # type: Any ): # type: (...) -> "_models.PrivateEndpointConnection" - """Gets the private endpoint connection. + """Gets the specified private endpoint connection. - Gets the details of the private endpoint connection by managed cluster and resource group. + To learn more about private clusters, see: + https://docs.microsoft.com/azure/aks/private-clusters. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -184,7 +185,7 @@ def update( # type: (...) -> "_models.PrivateEndpointConnection" """Updates a private endpoint connection. - Updates a private endpoint connection in the specified managed cluster. + Updates a private endpoint connection. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -192,7 +193,7 @@ def update( :type resource_name: str :param private_endpoint_connection_name: The name of the private endpoint connection. :type private_endpoint_connection_name: str - :param parameters: Parameters supplied to the Update a private endpoint connection operation. + :param parameters: The updated private endpoint connection. :type parameters: ~azure.mgmt.containerservice.v2021_05_01.models.PrivateEndpointConnection :keyword callable cls: A custom type or function that will be passed the direct response :return: PrivateEndpointConnection, or the result of cls(response) @@ -303,7 +304,7 @@ def begin_delete( # type: (...) -> LROPoller[None] """Deletes a private endpoint connection. - Deletes the private endpoint connection in the specified managed cluster. + Deletes a private endpoint connection. :param resource_group_name: The name of the resource group. :type resource_group_name: str diff --git a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_private_link_resources_operations.py b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_private_link_resources_operations.py index 09f87df3e667..842312f3a90f 100644 --- a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_private_link_resources_operations.py +++ b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_private_link_resources_operations.py @@ -53,8 +53,8 @@ def list( # type: (...) -> "_models.PrivateLinkResourcesListResult" """Gets a list of private link resources in the specified managed cluster. - Gets a list of private link resources in the specified managed cluster. The operation returns - properties of each private link resource. + To learn more about private clusters, see: + https://docs.microsoft.com/azure/aks/private-clusters. :param resource_group_name: The name of the resource group. :type resource_group_name: str diff --git a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_resolve_private_link_service_id_operations.py b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_resolve_private_link_service_id_operations.py index 888fd53525f6..7be840c05e18 100644 --- a/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_resolve_private_link_service_id_operations.py +++ b/sdk/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01/operations/_resolve_private_link_service_id_operations.py @@ -54,14 +54,13 @@ def post( # type: (...) -> "_models.PrivateLinkResource" """Gets the private link service ID for the specified managed cluster. - Gets the private link service ID the specified managed cluster. + Gets the private link service ID for the specified managed cluster. :param resource_group_name: The name of the resource group. :type resource_group_name: str :param resource_name: The name of the managed cluster resource. :type resource_name: str - :param parameters: Parameters (name, groupId) supplied in order to resolve a private link - service ID. + :param parameters: Parameters required in order to resolve a private link service ID. :type parameters: ~azure.mgmt.containerservice.v2021_05_01.models.PrivateLinkResource :keyword callable cls: A custom type or function that will be passed the direct response :return: PrivateLinkResource, or the result of cls(response)