Share via

@azure-rest/arm-containerservice package

Interfaces

AccessProfile

Profile for enabling a user to access a managed cluster.
AccessProfileOutput

Profile for enabling a user to access a managed cluster.
AgentPool

Agent Pool.
AgentPoolAvailableVersionsOutput

The list of available versions for an agent pool.
AgentPoolAvailableVersionsPropertiesAgentPoolVersionsItemOutput
AgentPoolAvailableVersionsPropertiesOutput

The list of available agent pool versions.
AgentPoolListResultOutput

The response from the List Agent Pools operation.
AgentPoolOutput

Agent Pool.
AgentPoolUpgradeProfileOutput

The list of available upgrades for an agent pool.
AgentPoolUpgradeProfilePropertiesOutput

The list of available upgrade versions.
AgentPoolUpgradeProfilePropertiesUpgradesItemOutput
AgentPoolUpgradeSettings

Settings for upgrading an agentpool
AgentPoolUpgradeSettingsOutput

Settings for upgrading an agentpool
AgentPoolsCreateOrUpdate200Response

Creates or updates an agent pool in the specified managed cluster.
AgentPoolsCreateOrUpdate201Response

Creates or updates an agent pool in the specified managed cluster.
AgentPoolsCreateOrUpdateBodyParam
AgentPoolsCreateOrUpdateDefaultResponse

Creates or updates an agent pool in the specified managed cluster.
AgentPoolsCreateOrUpdateMediaTypesParam
AgentPoolsDelete202Response

Deletes an agent pool in the specified managed cluster.
AgentPoolsDelete204Response

Deletes an agent pool in the specified managed cluster.
AgentPoolsDeleteDefaultResponse

Deletes an agent pool in the specified managed cluster.
AgentPoolsDeleteQueryParam
AgentPoolsDeleteQueryParamProperties
AgentPoolsGet
AgentPoolsGet200Response

Gets the specified managed cluster agent pool.
AgentPoolsGetAvailableAgentPoolVersions
AgentPoolsGetAvailableAgentPoolVersions200Response

See supported Kubernetes versions for more details about the version lifecycle.
AgentPoolsGetDefaultResponse

Gets the specified managed cluster agent pool.
AgentPoolsGetUpgradeProfile
AgentPoolsGetUpgradeProfile200Response

Gets the upgrade profile for an agent pool.
AgentPoolsGetUpgradeProfileDefaultResponse

Gets the upgrade profile for an agent pool.
AgentPoolsList
AgentPoolsList200Response

Gets a list of agent pools in the specified managed cluster.
AgentPoolsListDefaultResponse

Gets a list of agent pools in the specified managed cluster.
AgentPoolsUpgradeNodeImageVersion
AgentPoolsUpgradeNodeImageVersion200Response

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
AgentPoolsUpgradeNodeImageVersion202Headers
AgentPoolsUpgradeNodeImageVersion202Response

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
AgentPoolsUpgradeNodeImageVersionDefaultResponse

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
AzureKeyVaultKms

Azure Key Vault key management service settings for the security profile.
AzureKeyVaultKmsOutput

Azure Key Vault key management service settings for the security profile.
CloudErrorBodyOutput

An error response from the Container service.
CloudErrorOutput

An error response from the Container service.
CommandResultPropertiesOutput

The results of a run command
ContainerServiceClientOptions

The optional parameters for the client
ContainerServiceLinuxProfile

Profile for Linux VMs in the container service cluster.
ContainerServiceLinuxProfileOutput

Profile for Linux VMs in the container service cluster.
ContainerServiceNetworkProfile

Profile of network configuration.
ContainerServiceNetworkProfileOutput

Profile of network configuration.
ContainerServiceSshConfiguration

SSH configuration for Linux-based VMs running on Azure.
ContainerServiceSshConfigurationOutput

SSH configuration for Linux-based VMs running on Azure.
ContainerServiceSshPublicKey

Contains information about SSH certificate public key data.
ContainerServiceSshPublicKeyOutput

Contains information about SSH certificate public key data.
CreationData

Data used when creating a target resource from a source resource.
CreationDataOutput

Data used when creating a target resource from a source resource.
CredentialResultOutput

The credential result response.
CredentialResultsOutput

The list credential result response.
EndpointDependencyOutput

A domain name that AKS agent nodes are reaching at.
EndpointDetailOutput

connect information from the AKS agent nodes to a single endpoint.
ExtendedLocation

The complex type of the extended location.
ExtendedLocationOutput

The complex type of the extended location.
KubeletConfig

See AKS custom node configuration for more details.
KubeletConfigOutput

See AKS custom node configuration for more details.
LinuxOSConfig

See AKS custom node configuration for more details.
LinuxOSConfigOutput

See AKS custom node configuration for more details.
MaintenanceConfiguration

See planned maintenance for more information about planned maintenance.
MaintenanceConfigurationListResultOutput

The response from the List maintenance configurations operation.
MaintenanceConfigurationOutput

See planned maintenance for more information about planned maintenance.
MaintenanceConfigurationProperties

Properties used to configure planned maintenance for a Managed Cluster.
MaintenanceConfigurationPropertiesOutput

Properties used to configure planned maintenance for a Managed Cluster.
MaintenanceConfigurationsCreateOrUpdate200Response

Creates or updates a maintenance configuration in the specified managed cluster.
MaintenanceConfigurationsCreateOrUpdateBodyParam
MaintenanceConfigurationsCreateOrUpdateDefaultResponse

Creates or updates a maintenance configuration in the specified managed cluster.
MaintenanceConfigurationsCreateOrUpdateMediaTypesParam
MaintenanceConfigurationsDelete200Response

Deletes a maintenance configuration.
MaintenanceConfigurationsDelete204Response

Deletes a maintenance configuration.
MaintenanceConfigurationsDeleteDefaultResponse

Deletes a maintenance configuration.
MaintenanceConfigurationsGet
MaintenanceConfigurationsGet200Response

Gets the specified maintenance configuration of a managed cluster.
MaintenanceConfigurationsGetDefaultResponse

Gets the specified maintenance configuration of a managed cluster.
MaintenanceConfigurationsListByManagedCluster
MaintenanceConfigurationsListByManagedCluster200Response

Gets a list of maintenance configurations in the specified managed cluster.
MaintenanceConfigurationsListByManagedClusterDefaultResponse

Gets a list of maintenance configurations in the specified managed cluster.
ManagedCluster

Managed cluster.
ManagedClusterAADProfile

For more details see managed AAD on AKS.
ManagedClusterAADProfileOutput

For more details see managed AAD on AKS.
ManagedClusterAPIServerAccessProfile

Access profile for managed cluster API server.
ManagedClusterAPIServerAccessProfileOutput

Access profile for managed cluster API server.
ManagedClusterAccessProfile

Managed cluster Access Profile.
ManagedClusterAccessProfileOutput

Managed cluster Access Profile.
ManagedClusterAddonProfile

A Kubernetes add-on profile for a managed cluster.
ManagedClusterAddonProfileIdentity

Information of user assigned identity used by this add-on.
ManagedClusterAddonProfileIdentityOutput

Information of user assigned identity used by this add-on.
ManagedClusterAddonProfileOutput

A Kubernetes add-on profile for a managed cluster.
ManagedClusterAgentPoolProfile

Profile for the container service agent pool.
ManagedClusterAgentPoolProfileOutput

Profile for the container service agent pool.
ManagedClusterAgentPoolProfileProperties

Properties for the container service agent pool profile.
ManagedClusterAgentPoolProfilePropertiesOutput

Properties for the container service agent pool profile.
ManagedClusterAutoUpgradeProfile

Auto upgrade profile for a managed cluster.
ManagedClusterAutoUpgradeProfileOutput

Auto upgrade profile for a managed cluster.
ManagedClusterHttpProxyConfig

Cluster HTTP proxy configuration.
ManagedClusterHttpProxyConfigOutput

Cluster HTTP proxy configuration.
ManagedClusterIdentity

Identity for the managed cluster.
ManagedClusterIdentityOutput

Identity for the managed cluster.
ManagedClusterIngressProfile

Ingress profile for the container service cluster.
ManagedClusterIngressProfileOutput

Ingress profile for the container service cluster.
ManagedClusterIngressProfileWebAppRouting

Web App Routing settings for the ingress profile.
ManagedClusterIngressProfileWebAppRoutingOutput

Web App Routing settings for the ingress profile.
ManagedClusterListResultOutput

The response from the List Managed Clusters operation.
ManagedClusterLoadBalancerProfile

Profile of the managed cluster load balancer.
ManagedClusterLoadBalancerProfileManagedOutboundIPs

Desired managed outbound IPs for the cluster load balancer.
ManagedClusterLoadBalancerProfileManagedOutboundIPsOutput

Desired managed outbound IPs for the cluster load balancer.
ManagedClusterLoadBalancerProfileOutboundIPPrefixes

Desired outbound IP Prefix resources for the cluster load balancer.
ManagedClusterLoadBalancerProfileOutboundIPPrefixesOutput

Desired outbound IP Prefix resources for the cluster load balancer.
ManagedClusterLoadBalancerProfileOutboundIPs

Desired outbound IP resources for the cluster load balancer.
ManagedClusterLoadBalancerProfileOutboundIPsOutput

Desired outbound IP resources for the cluster load balancer.
ManagedClusterLoadBalancerProfileOutput

Profile of the managed cluster load balancer.
ManagedClusterManagedOutboundIPProfile

Profile of the managed outbound IP resources of the managed cluster.
ManagedClusterManagedOutboundIPProfileOutput

Profile of the managed outbound IP resources of the managed cluster.
ManagedClusterNATGatewayProfile

Profile of the managed cluster NAT gateway.
ManagedClusterNATGatewayProfileOutput

Profile of the managed cluster NAT gateway.
ManagedClusterOidcIssuerProfile

The OIDC issuer profile of the Managed Cluster.
ManagedClusterOidcIssuerProfileOutput

The OIDC issuer profile of the Managed Cluster.
ManagedClusterOutput

Managed cluster.
ManagedClusterPodIdentity

Details about the pod identity assigned to the Managed Cluster.
ManagedClusterPodIdentityException

See disable AAD Pod Identity for a specific Pod/Application for more details.
ManagedClusterPodIdentityExceptionOutput

See disable AAD Pod Identity for a specific Pod/Application for more details.
ManagedClusterPodIdentityOutput

Details about the pod identity assigned to the Managed Cluster.
ManagedClusterPodIdentityProfile

See use AAD pod identity for more details on pod identity integration.
ManagedClusterPodIdentityProfileOutput

See use AAD pod identity for more details on pod identity integration.
ManagedClusterPodIdentityProvisioningError

An error response from the pod identity provisioning.
ManagedClusterPodIdentityProvisioningErrorBody

An error response from the pod identity provisioning.
ManagedClusterPodIdentityProvisioningErrorBodyOutput

An error response from the pod identity provisioning.
ManagedClusterPodIdentityProvisioningErrorOutput

An error response from the pod identity provisioning.
ManagedClusterPodIdentityProvisioningInfo
ManagedClusterPodIdentityProvisioningInfoOutput
ManagedClusterPoolUpgradeProfileOutput

The list of available upgrade versions.
ManagedClusterPoolUpgradeProfileUpgradesItemOutput
ManagedClusterProperties

Properties of the managed cluster.
ManagedClusterPropertiesAutoScalerProfile

Parameters to be applied to the cluster-autoscaler when enabled
ManagedClusterPropertiesAutoScalerProfileOutput

Parameters to be applied to the cluster-autoscaler when enabled
ManagedClusterPropertiesForSnapshot

managed cluster properties for snapshot, these properties are read only.
ManagedClusterPropertiesForSnapshotOutput

managed cluster properties for snapshot, these properties are read only.
ManagedClusterPropertiesOutput

Properties of the managed cluster.
ManagedClusterSKU

The SKU of a Managed Cluster.
ManagedClusterSKUOutput

The SKU of a Managed Cluster.
ManagedClusterSecurityProfile

Security profile for the container service cluster.
ManagedClusterSecurityProfileDefender

Microsoft Defender settings for the security profile.
ManagedClusterSecurityProfileDefenderOutput

Microsoft Defender settings for the security profile.
ManagedClusterSecurityProfileDefenderSecurityMonitoring

Microsoft Defender settings for the security profile threat detection.
ManagedClusterSecurityProfileDefenderSecurityMonitoringOutput

Microsoft Defender settings for the security profile threat detection.
ManagedClusterSecurityProfileOutput

Security profile for the container service cluster.
ManagedClusterSecurityProfileWorkloadIdentity

Workload Identity settings for the security profile.
ManagedClusterSecurityProfileWorkloadIdentityOutput

Workload Identity settings for the security profile.
ManagedClusterServicePrincipalProfile

Information about a service principal identity for the cluster to use for manipulating Azure APIs.
ManagedClusterServicePrincipalProfileOutput

Information about a service principal identity for the cluster to use for manipulating Azure APIs.
ManagedClusterSnapshot

A managed cluster snapshot resource.
ManagedClusterSnapshotListResultOutput

The response from the List Managed Cluster Snapshots operation.
ManagedClusterSnapshotOutput

A managed cluster snapshot resource.
ManagedClusterSnapshotProperties

Properties for a managed cluster snapshot.
ManagedClusterSnapshotPropertiesOutput

Properties for a managed cluster snapshot.
ManagedClusterSnapshotsCreateOrUpdate200Response

Creates or updates a managed cluster snapshot.
ManagedClusterSnapshotsCreateOrUpdate201Response

Creates or updates a managed cluster snapshot.
ManagedClusterSnapshotsCreateOrUpdateBodyParam
ManagedClusterSnapshotsCreateOrUpdateDefaultResponse

Creates or updates a managed cluster snapshot.
ManagedClusterSnapshotsCreateOrUpdateMediaTypesParam
ManagedClusterSnapshotsDelete200Response

Deletes a managed cluster snapshot.
ManagedClusterSnapshotsDelete204Response

Deletes a managed cluster snapshot.
ManagedClusterSnapshotsDeleteDefaultResponse

Deletes a managed cluster snapshot.
ManagedClusterSnapshotsGet
ManagedClusterSnapshotsGet200Response

Gets a managed cluster snapshot.
ManagedClusterSnapshotsGetDefaultResponse

Gets a managed cluster snapshot.
ManagedClusterSnapshotsList
ManagedClusterSnapshotsList200Response

Gets a list of managed cluster snapshots in the specified subscription.
ManagedClusterSnapshotsListByResourceGroup
ManagedClusterSnapshotsListByResourceGroup200Response

Lists managed cluster snapshots in the specified subscription and resource group.
ManagedClusterSnapshotsListByResourceGroupDefaultResponse

Lists managed cluster snapshots in the specified subscription and resource group.
ManagedClusterSnapshotsListDefaultResponse

Gets a list of managed cluster snapshots in the specified subscription.
ManagedClusterSnapshotsUpdateTags200Response

Updates tags on a managed cluster snapshot.
ManagedClusterSnapshotsUpdateTagsBodyParam
ManagedClusterSnapshotsUpdateTagsDefaultResponse

Updates tags on a managed cluster snapshot.
ManagedClusterSnapshotsUpdateTagsMediaTypesParam
ManagedClusterStorageProfile

Storage profile for the container service cluster.
ManagedClusterStorageProfileBlobCSIDriver

AzureBlob CSI Driver settings for the storage profile.
ManagedClusterStorageProfileBlobCSIDriverOutput

AzureBlob CSI Driver settings for the storage profile.
ManagedClusterStorageProfileDiskCSIDriver

AzureDisk CSI Driver settings for the storage profile.
ManagedClusterStorageProfileDiskCSIDriverOutput

AzureDisk CSI Driver settings for the storage profile.
ManagedClusterStorageProfileFileCSIDriver

AzureFile CSI Driver settings for the storage profile.
ManagedClusterStorageProfileFileCSIDriverOutput

AzureFile CSI Driver settings for the storage profile.
ManagedClusterStorageProfileOutput

Storage profile for the container service cluster.
ManagedClusterStorageProfileSnapshotController

Snapshot Controller settings for the storage profile.
ManagedClusterStorageProfileSnapshotControllerOutput

Snapshot Controller settings for the storage profile.
ManagedClusterUpgradeProfileOutput

The list of available upgrades for compute pools.
ManagedClusterUpgradeProfilePropertiesOutput

Control plane and agent pool upgrade profiles.
ManagedClusterWindowsProfile

Profile for Windows VMs in the managed cluster.
ManagedClusterWindowsProfileOutput

Profile for Windows VMs in the managed cluster.
ManagedClusterWorkloadAutoScalerProfile

Workload Auto-scaler profile for the container service cluster.
ManagedClusterWorkloadAutoScalerProfileKeda

KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile.
ManagedClusterWorkloadAutoScalerProfileKedaOutput

KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile.
ManagedClusterWorkloadAutoScalerProfileOutput

Workload Auto-scaler profile for the container service cluster.
ManagedClustersCreateOrUpdate200Response

Creates or updates a managed cluster.
ManagedClustersCreateOrUpdate201Response

Creates or updates a managed cluster.
ManagedClustersCreateOrUpdateBodyParam
ManagedClustersCreateOrUpdateDefaultResponse

Creates or updates a managed cluster.
ManagedClustersCreateOrUpdateMediaTypesParam
ManagedClustersDelete202Response

Deletes a managed cluster.
ManagedClustersDelete204Response

Deletes a managed cluster.
ManagedClustersDeleteDefaultResponse

Deletes a managed cluster.
ManagedClustersDeleteQueryParam
ManagedClustersDeleteQueryParamProperties
ManagedClustersGet
ManagedClustersGet200Response

Gets a managed cluster.
ManagedClustersGetAccessProfile
ManagedClustersGetAccessProfile200Response

WARNING: This API will be deprecated. Instead use ListClusterUserCredentials or ListClusterAdminCredentials .
ManagedClustersGetAccessProfileDefaultResponse

WARNING: This API will be deprecated. Instead use ListClusterUserCredentials or ListClusterAdminCredentials .
ManagedClustersGetCommandResult
ManagedClustersGetCommandResult200Response

Gets the results of a command which has been run on the Managed Cluster.
ManagedClustersGetCommandResult202Response

Gets the results of a command which has been run on the Managed Cluster.
ManagedClustersGetCommandResultDefaultResponse

Gets the results of a command which has been run on the Managed Cluster.
ManagedClustersGetDefaultResponse

Gets a managed cluster.
ManagedClustersGetOSOptions
ManagedClustersGetOSOptions200Response

Gets supported OS options in the specified subscription.
ManagedClustersGetOSOptionsDefaultResponse

Gets supported OS options in the specified subscription.
ManagedClustersGetOSOptionsQueryParam
ManagedClustersGetOSOptionsQueryParamProperties
ManagedClustersGetUpgradeProfile
ManagedClustersGetUpgradeProfile200Response

Gets the upgrade profile of a managed cluster.
ManagedClustersGetUpgradeProfileDefaultResponse

Gets the upgrade profile of a managed cluster.
ManagedClustersList
ManagedClustersList200Response

Gets a list of managed clusters in the specified subscription.
ManagedClustersListByResourceGroup
ManagedClustersListByResourceGroup200Response

Lists managed clusters in the specified subscription and resource group.
ManagedClustersListByResourceGroupDefaultResponse

Lists managed clusters in the specified subscription and resource group.
ManagedClustersListClusterAdminCredentials
ManagedClustersListClusterAdminCredentials200Response

Lists the admin credentials of a managed cluster.
ManagedClustersListClusterAdminCredentialsDefaultResponse

Lists the admin credentials of a managed cluster.
ManagedClustersListClusterAdminCredentialsQueryParam
ManagedClustersListClusterAdminCredentialsQueryParamProperties
ManagedClustersListClusterMonitoringUserCredentials
ManagedClustersListClusterMonitoringUserCredentials200Response

Lists the cluster monitoring user credentials of a managed cluster.
ManagedClustersListClusterMonitoringUserCredentialsDefaultResponse

Lists the cluster monitoring user credentials of a managed cluster.
ManagedClustersListClusterMonitoringUserCredentialsQueryParam
ManagedClustersListClusterMonitoringUserCredentialsQueryParamProperties
ManagedClustersListClusterUserCredentials
ManagedClustersListClusterUserCredentials200Response

Lists the user credentials of a managed cluster.
ManagedClustersListClusterUserCredentialsDefaultResponse

Lists the user credentials of a managed cluster.
ManagedClustersListClusterUserCredentialsQueryParam
ManagedClustersListClusterUserCredentialsQueryParamProperties
ManagedClustersListDefaultResponse

Gets a list of managed clusters in the specified subscription.
ManagedClustersListOutboundNetworkDependenciesEndpoints
ManagedClustersListOutboundNetworkDependenciesEndpoints200Response

Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. The operation returns properties of each egress endpoint.
ManagedClustersListOutboundNetworkDependenciesEndpointsDefaultResponse

Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. The operation returns properties of each egress endpoint.
ManagedClustersResetAADProfile
ManagedClustersResetAADProfile200Response

Reset the AAD Profile of a managed cluster.
ManagedClustersResetAADProfile202Response

Reset the AAD Profile of a managed cluster.
ManagedClustersResetAADProfileBodyParam
ManagedClustersResetAADProfileDefaultResponse

Reset the AAD Profile of a managed cluster.
ManagedClustersResetAADProfileMediaTypesParam
ManagedClustersResetServicePrincipalProfile
ManagedClustersResetServicePrincipalProfile200Response

This action cannot be performed on a cluster that is not using a service principal
ManagedClustersResetServicePrincipalProfile202Response

This action cannot be performed on a cluster that is not using a service principal
ManagedClustersResetServicePrincipalProfileBodyParam
ManagedClustersResetServicePrincipalProfileDefaultResponse

This action cannot be performed on a cluster that is not using a service principal
ManagedClustersResetServicePrincipalProfileMediaTypesParam
ManagedClustersRotateClusterCertificates
ManagedClustersRotateClusterCertificates202Response

See Certificate rotation for more details about rotating managed cluster certificates.
ManagedClustersRotateClusterCertificates204Response

See Certificate rotation for more details about rotating managed cluster certificates.
ManagedClustersRotateClusterCertificatesDefaultResponse

See Certificate rotation for more details about rotating managed cluster certificates.
ManagedClustersRotateServiceAccountSigningKeys
ManagedClustersRotateServiceAccountSigningKeys202Response

Rotates the service account signing keys of a managed cluster.
ManagedClustersRotateServiceAccountSigningKeys204Response

Rotates the service account signing keys of a managed cluster.
ManagedClustersRotateServiceAccountSigningKeysDefaultResponse

Rotates the service account signing keys of a managed cluster.
ManagedClustersRunCommand
ManagedClustersRunCommand200Response

AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see AKS Run Command.
ManagedClustersRunCommand202Response

AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see AKS Run Command.
ManagedClustersRunCommandBodyParam
ManagedClustersRunCommandDefaultResponse

AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see AKS Run Command.
ManagedClustersRunCommandMediaTypesParam
ManagedClustersStart
ManagedClustersStart202Response

See starting a cluster for more details about starting a cluster.
ManagedClustersStart204Response

See starting a cluster for more details about starting a cluster.
ManagedClustersStartDefaultResponse

See starting a cluster for more details about starting a cluster.
ManagedClustersStop
ManagedClustersStop202Response

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.
ManagedClustersStop204Response

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.
ManagedClustersStopDefaultResponse

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.
ManagedClustersUpdateTags200Response

Updates tags on a managed cluster.
ManagedClustersUpdateTagsBodyParam
ManagedClustersUpdateTagsDefaultResponse

Updates tags on a managed cluster.
ManagedClustersUpdateTagsMediaTypesParam
ManagedServiceIdentityUserAssignedIdentitiesValue
ManagedServiceIdentityUserAssignedIdentitiesValueOutput
NetworkProfileForSnapshot

network profile for managed cluster snapshot, these properties are read only.
NetworkProfileForSnapshotOutput

network profile for managed cluster snapshot, these properties are read only.
OSOptionProfileOutput

The OS option profile.
OSOptionPropertyListOutput

The list of OS option properties.
OSOptionPropertyOutput

OS option property.
OperationListResultOutput

The List Operation response.
OperationValueDisplayOutput

Describes the properties of a Operation Value Display.
OperationValueOutput

Describes the properties of a Operation value.
OperationsList
OperationsList200Response

Gets a list of operations.
OperationsListDefaultResponse

Gets a list of operations.
OutboundEnvironmentEndpointCollectionOutput

Collection of OutboundEnvironmentEndpoint
OutboundEnvironmentEndpointOutput

Egress endpoints which AKS agent nodes connect to for common purpose.
PageSettings

An interface that tracks the settings for paged iteration
PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.
PagingOptions

Options for the paging helper
PowerState

Describes the Power State of the cluster
PowerStateOutput

Describes the Power State of the cluster
PrivateEndpoint

Private endpoint which a connection belongs to.
PrivateEndpointConnection

A private endpoint connection
PrivateEndpointConnectionListResultOutput

A list of private endpoint connections
PrivateEndpointConnectionOutput

A private endpoint connection
PrivateEndpointConnectionProperties

Properties of a private endpoint connection.
PrivateEndpointConnectionPropertiesOutput

Properties of a private endpoint connection.
PrivateEndpointConnectionsDelete200Response

Deletes a private endpoint connection.
PrivateEndpointConnectionsDelete204Response

Deletes a private endpoint connection.
PrivateEndpointConnectionsDeleteDefaultResponse

Deletes a private endpoint connection.
PrivateEndpointConnectionsGet
PrivateEndpointConnectionsGet200Response

To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters
PrivateEndpointConnectionsGetDefaultResponse

To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters
PrivateEndpointConnectionsList
PrivateEndpointConnectionsList200Response

To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters
PrivateEndpointConnectionsListDefaultResponse

To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters
PrivateEndpointConnectionsUpdate200Response

Updates a private endpoint connection.
PrivateEndpointConnectionsUpdateBodyParam
PrivateEndpointConnectionsUpdateDefaultResponse

Updates a private endpoint connection.
PrivateEndpointConnectionsUpdateMediaTypesParam
PrivateEndpointOutput

Private endpoint which a connection belongs to.
PrivateLinkResource

A private link resource
PrivateLinkResourceOutput

A private link resource
PrivateLinkResourcesList
PrivateLinkResourcesList200Response

To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters
PrivateLinkResourcesListDefaultResponse

To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters
PrivateLinkResourcesListResultOutput

A list of private link resources
PrivateLinkServiceConnectionState

The state of a private link service connection.
PrivateLinkServiceConnectionStateOutput

The state of a private link service connection.
ResolvePrivateLinkServiceIdPost
ResolvePrivateLinkServiceIdPost200Response

Gets the private link service ID for the specified managed cluster.
ResolvePrivateLinkServiceIdPostBodyParam
ResolvePrivateLinkServiceIdPostDefaultResponse

Gets the private link service ID for the specified managed cluster.
ResolvePrivateLinkServiceIdPostMediaTypesParam
Resource

Common fields that are returned in the response for all Azure Resource Manager resources
ResourceOutput

Common fields that are returned in the response for all Azure Resource Manager resources
ResourceReference

A reference to an Azure resource.
ResourceReferenceOutput

A reference to an Azure resource.
Routes
RunCommandRequest

A run command request
RunCommandResultOutput

run command result.
SimplePollerLike

A simple poller that can be used to poll a long running operation.
Snapshot

A node pool snapshot resource.
SnapshotListResultOutput

The response from the List Snapshots operation.
SnapshotOutput

A node pool snapshot resource.
SnapshotProperties

Properties used to configure a node pool snapshot.
SnapshotPropertiesOutput

Properties used to configure a node pool snapshot.
SnapshotsCreateOrUpdate200Response

Creates or updates a snapshot.
SnapshotsCreateOrUpdate201Response

Creates or updates a snapshot.
SnapshotsCreateOrUpdateBodyParam
SnapshotsCreateOrUpdateDefaultResponse

Creates or updates a snapshot.
SnapshotsCreateOrUpdateMediaTypesParam
SnapshotsDelete200Response

Deletes a snapshot.
SnapshotsDelete204Response

Deletes a snapshot.
SnapshotsDeleteDefaultResponse

Deletes a snapshot.
SnapshotsGet
SnapshotsGet200Response

Gets a snapshot.
SnapshotsGetDefaultResponse

Gets a snapshot.
SnapshotsList
SnapshotsList200Response

Gets a list of snapshots in the specified subscription.
SnapshotsListByResourceGroup
SnapshotsListByResourceGroup200Response

Lists snapshots in the specified subscription and resource group.
SnapshotsListByResourceGroupDefaultResponse

Lists snapshots in the specified subscription and resource group.
SnapshotsListDefaultResponse

Gets a list of snapshots in the specified subscription.
SnapshotsUpdateTags200Response

Updates tags on a snapshot.
SnapshotsUpdateTagsBodyParam
SnapshotsUpdateTagsDefaultResponse

Updates tags on a snapshot.
SnapshotsUpdateTagsMediaTypesParam
SubResource

Reference to another subresource.
SubResourceOutput

Reference to another subresource.
SysctlConfig

Sysctl settings for Linux agent nodes.
SysctlConfigOutput

Sysctl settings for Linux agent nodes.
SystemData

Metadata pertaining to creation and last modification of the resource.
SystemDataOutput

Metadata pertaining to creation and last modification of the resource.
TagsObject

Tags object for patch operations.
TimeInWeek

Time in a week.
TimeInWeekOutput

Time in a week.
TimeSpan

For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z.
TimeSpanOutput

For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z.
TrackedResource

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
TrackedResourceOutput

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
TrustedAccessRoleBinding

Defines binding between a resource and role
TrustedAccessRoleBindingListResultOutput

List of trusted access role bindings
TrustedAccessRoleBindingOutput

Defines binding between a resource and role
TrustedAccessRoleBindingProperties

Properties for trusted access role binding
TrustedAccessRoleBindingPropertiesOutput

Properties for trusted access role binding
TrustedAccessRoleBindingsCreateOrUpdate200Response

Create or update a trusted access role binding
TrustedAccessRoleBindingsCreateOrUpdateBodyParam
TrustedAccessRoleBindingsCreateOrUpdateDefaultResponse

Create or update a trusted access role binding
TrustedAccessRoleBindingsCreateOrUpdateMediaTypesParam
TrustedAccessRoleBindingsDelete200Response

Delete a trusted access role binding.
TrustedAccessRoleBindingsDelete204Response

Delete a trusted access role binding.
TrustedAccessRoleBindingsDeleteDefaultResponse

Delete a trusted access role binding.
TrustedAccessRoleBindingsGet
TrustedAccessRoleBindingsGet200Response

Get a trusted access role binding.
TrustedAccessRoleBindingsGetDefaultResponse

Get a trusted access role binding.
TrustedAccessRoleBindingsList
TrustedAccessRoleBindingsList200Response

List trusted access role bindings.
TrustedAccessRoleBindingsListDefaultResponse

List trusted access role bindings.
TrustedAccessRoleListResultOutput

List of trusted access roles
TrustedAccessRoleOutput

Trusted access role definition.
TrustedAccessRoleRuleOutput

Rule for trusted access role
TrustedAccessRolesList
TrustedAccessRolesList200Response

List supported trusted access roles.
TrustedAccessRolesListDefaultResponse

List supported trusted access roles.
UserAssignedIdentity

Details about a user assigned identity.
UserAssignedIdentityOutput

Details about a user assigned identity.
WindowsGmsaProfile

Windows gMSA Profile in the managed cluster.
WindowsGmsaProfileOutput

Windows gMSA Profile in the managed cluster.

Type Aliases

AgentPoolsCreateOrUpdateParameters
AgentPoolsDeleteParameters
AgentPoolsGetAvailableAgentPoolVersionsParameters
AgentPoolsGetParameters
AgentPoolsGetUpgradeProfileParameters
AgentPoolsListParameters
AgentPoolsUpgradeNodeImageVersionParameters
ContainerServiceClient
GetArrayType

Helper type to extract the type of an array
GetPage

The type of a custom function that defines how to get a page and a link to the next one if any.
MaintenanceConfigurationsCreateOrUpdateParameters
MaintenanceConfigurationsDeleteParameters
MaintenanceConfigurationsGetParameters
MaintenanceConfigurationsListByManagedClusterParameters
ManagedClusterSnapshotsCreateOrUpdateParameters
ManagedClusterSnapshotsDeleteParameters
ManagedClusterSnapshotsGetParameters
ManagedClusterSnapshotsListByResourceGroupParameters
ManagedClusterSnapshotsListParameters
ManagedClusterSnapshotsUpdateTagsParameters
ManagedClustersCreateOrUpdateParameters
ManagedClustersDeleteParameters
ManagedClustersGetAccessProfileParameters
ManagedClustersGetCommandResultParameters
ManagedClustersGetOSOptionsParameters
ManagedClustersGetParameters
ManagedClustersGetUpgradeProfileParameters
ManagedClustersListByResourceGroupParameters
ManagedClustersListClusterAdminCredentialsParameters
ManagedClustersListClusterMonitoringUserCredentialsParameters
ManagedClustersListClusterUserCredentialsParameters
ManagedClustersListOutboundNetworkDependenciesEndpointsParameters
ManagedClustersListParameters
ManagedClustersResetAADProfileParameters
ManagedClustersResetServicePrincipalProfileParameters
ManagedClustersRotateClusterCertificatesParameters
ManagedClustersRotateServiceAccountSigningKeysParameters
ManagedClustersRunCommandParameters
ManagedClustersStartParameters
ManagedClustersStopParameters
ManagedClustersUpdateTagsParameters
OperationsListParameters
PaginateReturn

Helper type to infer the Type of the paged elements from the response type This type is generated based on the swagger information for x-ms-pageable specifically on the itemName property which indicates the property of the response where the page items are found. The default value is value. This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
PrivateEndpointConnectionsDeleteParameters
PrivateEndpointConnectionsGetParameters
PrivateEndpointConnectionsListParameters
PrivateEndpointConnectionsUpdateParameters
PrivateLinkResourcesListParameters
ResolvePrivateLinkServiceIdPostParameters
SnapshotsCreateOrUpdateParameters
SnapshotsDeleteParameters
SnapshotsGetParameters
SnapshotsListByResourceGroupParameters
SnapshotsListParameters
SnapshotsUpdateTagsParameters
TrustedAccessRoleBindingsCreateOrUpdateParameters
TrustedAccessRoleBindingsDeleteParameters
TrustedAccessRoleBindingsGetParameters
TrustedAccessRoleBindingsListParameters
TrustedAccessRolesListParameters

Functions

default(TokenCredential, ContainerServiceClientOptions)

Initialize a new instance of ContainerServiceClient
getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Helper function that builds a Poller object to help polling a long running operation.
isUnexpected(OperationsList200Response | OperationsListDefaultResponse)
isUnexpected(ManagedClustersGetOSOptions200Response | ManagedClustersGetOSOptionsDefaultResponse)
isUnexpected(ManagedClustersList200Response | ManagedClustersListDefaultResponse)
isUnexpected(ManagedClustersListByResourceGroup200Response | ManagedClustersListByResourceGroupDefaultResponse)
isUnexpected(ManagedClustersGetUpgradeProfile200Response | ManagedClustersGetUpgradeProfileDefaultResponse)
isUnexpected(ManagedClustersGetAccessProfile200Response | ManagedClustersGetAccessProfileDefaultResponse)
isUnexpected(ManagedClustersListClusterAdminCredentials200Response | ManagedClustersListClusterAdminCredentialsDefaultResponse)
isUnexpected(ManagedClustersListClusterUserCredentials200Response | ManagedClustersListClusterUserCredentialsDefaultResponse)
isUnexpected(ManagedClustersListClusterMonitoringUserCredentials200Response | ManagedClustersListClusterMonitoringUserCredentialsDefaultResponse)
isUnexpected(ManagedClustersGet200Response | ManagedClustersGetDefaultResponse)
isUnexpected(ManagedClustersCreateOrUpdate200Response | ManagedClustersCreateOrUpdate201Response | ManagedClustersCreateOrUpdateDefaultResponse)
isUnexpected(ManagedClustersUpdateTags200Response | ManagedClustersUpdateTagsDefaultResponse)
isUnexpected(ManagedClustersDelete202Response | ManagedClustersDelete204Response | ManagedClustersDeleteDefaultResponse)
isUnexpected(ManagedClustersResetServicePrincipalProfile200Response | ManagedClustersResetServicePrincipalProfile202Response | ManagedClustersResetServicePrincipalProfileDefaultResponse)
isUnexpected(ManagedClustersResetAADProfile200Response | ManagedClustersResetAADProfile202Response | ManagedClustersResetAADProfileDefaultResponse)
isUnexpected(ManagedClustersRotateClusterCertificates202Response | ManagedClustersRotateClusterCertificates204Response | ManagedClustersRotateClusterCertificatesDefaultResponse)
isUnexpected(ManagedClustersRotateServiceAccountSigningKeys202Response | ManagedClustersRotateServiceAccountSigningKeys204Response | ManagedClustersRotateServiceAccountSigningKeysDefaultResponse)
isUnexpected(ManagedClustersStop202Response | ManagedClustersStop204Response | ManagedClustersStopDefaultResponse)
isUnexpected(ManagedClustersStart202Response | ManagedClustersStart204Response | ManagedClustersStartDefaultResponse)
isUnexpected(ManagedClustersRunCommand200Response | ManagedClustersRunCommand202Response | ManagedClustersRunCommandDefaultResponse)
isUnexpected(ManagedClustersGetCommandResult200Response | ManagedClustersGetCommandResult202Response | ManagedClustersGetCommandResultDefaultResponse)
isUnexpected(ManagedClustersListOutboundNetworkDependenciesEndpoints200Response | ManagedClustersListOutboundNetworkDependenciesEndpointsDefaultResponse)
isUnexpected(MaintenanceConfigurationsListByManagedCluster200Response | MaintenanceConfigurationsListByManagedClusterDefaultResponse)
isUnexpected(MaintenanceConfigurationsGet200Response | MaintenanceConfigurationsGetDefaultResponse)
isUnexpected(MaintenanceConfigurationsCreateOrUpdate200Response | MaintenanceConfigurationsCreateOrUpdateDefaultResponse)
isUnexpected(MaintenanceConfigurationsDelete200Response | MaintenanceConfigurationsDelete204Response | MaintenanceConfigurationsDeleteDefaultResponse)
isUnexpected(AgentPoolsList200Response | AgentPoolsListDefaultResponse)
isUnexpected(AgentPoolsGet200Response | AgentPoolsGetDefaultResponse)
isUnexpected(AgentPoolsCreateOrUpdate200Response | AgentPoolsCreateOrUpdate201Response | AgentPoolsCreateOrUpdateDefaultResponse)
isUnexpected(AgentPoolsDelete202Response | AgentPoolsDelete204Response | AgentPoolsDeleteDefaultResponse)
isUnexpected(AgentPoolsGetUpgradeProfile200Response | AgentPoolsGetUpgradeProfileDefaultResponse)
isUnexpected(AgentPoolsUpgradeNodeImageVersion200Response | AgentPoolsUpgradeNodeImageVersion202Response | AgentPoolsUpgradeNodeImageVersionDefaultResponse)
isUnexpected(PrivateEndpointConnectionsList200Response | PrivateEndpointConnectionsListDefaultResponse)
isUnexpected(PrivateEndpointConnectionsGet200Response | PrivateEndpointConnectionsGetDefaultResponse)
isUnexpected(PrivateEndpointConnectionsUpdate200Response | PrivateEndpointConnectionsUpdateDefaultResponse)
isUnexpected(PrivateEndpointConnectionsDelete200Response | PrivateEndpointConnectionsDelete204Response | PrivateEndpointConnectionsDeleteDefaultResponse)
isUnexpected(PrivateLinkResourcesList200Response | PrivateLinkResourcesListDefaultResponse)
isUnexpected(ResolvePrivateLinkServiceIdPost200Response | ResolvePrivateLinkServiceIdPostDefaultResponse)
isUnexpected(SnapshotsList200Response | SnapshotsListDefaultResponse)
isUnexpected(SnapshotsListByResourceGroup200Response | SnapshotsListByResourceGroupDefaultResponse)
isUnexpected(SnapshotsGet200Response | SnapshotsGetDefaultResponse)
isUnexpected(SnapshotsCreateOrUpdate200Response | SnapshotsCreateOrUpdate201Response | SnapshotsCreateOrUpdateDefaultResponse)
isUnexpected(SnapshotsUpdateTags200Response | SnapshotsUpdateTagsDefaultResponse)
isUnexpected(SnapshotsDelete200Response | SnapshotsDelete204Response | SnapshotsDeleteDefaultResponse)
isUnexpected(ManagedClusterSnapshotsList200Response | ManagedClusterSnapshotsListDefaultResponse)
isUnexpected(ManagedClusterSnapshotsListByResourceGroup200Response | ManagedClusterSnapshotsListByResourceGroupDefaultResponse)
isUnexpected(ManagedClusterSnapshotsGet200Response | ManagedClusterSnapshotsGetDefaultResponse)
isUnexpected(ManagedClusterSnapshotsCreateOrUpdate200Response | ManagedClusterSnapshotsCreateOrUpdate201Response | ManagedClusterSnapshotsCreateOrUpdateDefaultResponse)
isUnexpected(ManagedClusterSnapshotsUpdateTags200Response | ManagedClusterSnapshotsUpdateTagsDefaultResponse)
isUnexpected(ManagedClusterSnapshotsDelete200Response | ManagedClusterSnapshotsDelete204Response | ManagedClusterSnapshotsDeleteDefaultResponse)
isUnexpected(TrustedAccessRolesList200Response | TrustedAccessRolesListDefaultResponse)
isUnexpected(TrustedAccessRoleBindingsList200Response | TrustedAccessRoleBindingsListDefaultResponse)
isUnexpected(TrustedAccessRoleBindingsGet200Response | TrustedAccessRoleBindingsGetDefaultResponse)
isUnexpected(TrustedAccessRoleBindingsCreateOrUpdate200Response | TrustedAccessRoleBindingsCreateOrUpdateDefaultResponse)
isUnexpected(TrustedAccessRoleBindingsDelete200Response | TrustedAccessRoleBindingsDelete204Response | TrustedAccessRoleBindingsDeleteDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension

Function Details

default(TokenCredential, ContainerServiceClientOptions)

Initialize a new instance of ContainerServiceClient

function default(credentials: TokenCredential, options?: ContainerServiceClientOptions): ContainerServiceClient

Parameters

credentials
TokenCredential

uniquely identify client credential

options
ContainerServiceClientOptions

the parameter for all optional parameters

Returns

ContainerServiceClient

getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Helper function that builds a Poller object to help polling a long running operation.

function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parameters

client
Client

Client to use for sending the request to get additional pages.

initialResponse

TResult

The initial response.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Options to set a resume state or custom polling interval.

Returns

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

  • A poller object to poll for operation state updates and eventually get the final response.

isUnexpected(OperationsList200Response | OperationsListDefaultResponse) 

function isUnexpected(response: OperationsList200Response | OperationsListDefaultResponse): response

Parameters

response

OperationsList200Response | OperationsListDefaultResponse

Returns

response

isUnexpected(ManagedClustersGetOSOptions200Response | ManagedClustersGetOSOptionsDefaultResponse) 

function isUnexpected(response: ManagedClustersGetOSOptions200Response | ManagedClustersGetOSOptionsDefaultResponse): response

Parameters

response

ManagedClustersGetOSOptions200Response | ManagedClustersGetOSOptionsDefaultResponse

Returns

response

isUnexpected(ManagedClustersList200Response | ManagedClustersListDefaultResponse) 

function isUnexpected(response: ManagedClustersList200Response | ManagedClustersListDefaultResponse): response

Parameters

response

ManagedClustersList200Response | ManagedClustersListDefaultResponse

Returns

response

isUnexpected(ManagedClustersListByResourceGroup200Response | ManagedClustersListByResourceGroupDefaultResponse) 

function isUnexpected(response: ManagedClustersListByResourceGroup200Response | ManagedClustersListByResourceGroupDefaultResponse): response

Parameters

response

ManagedClustersListByResourceGroup200Response | ManagedClustersListByResourceGroupDefaultResponse

Returns

response

isUnexpected(ManagedClustersGetUpgradeProfile200Response | ManagedClustersGetUpgradeProfileDefaultResponse) 

function isUnexpected(response: ManagedClustersGetUpgradeProfile200Response | ManagedClustersGetUpgradeProfileDefaultResponse): response

Parameters

response

ManagedClustersGetUpgradeProfile200Response | ManagedClustersGetUpgradeProfileDefaultResponse

Returns

response

isUnexpected(ManagedClustersGetAccessProfile200Response | ManagedClustersGetAccessProfileDefaultResponse) 

function isUnexpected(response: ManagedClustersGetAccessProfile200Response | ManagedClustersGetAccessProfileDefaultResponse): response

Parameters

response

ManagedClustersGetAccessProfile200Response | ManagedClustersGetAccessProfileDefaultResponse

Returns

response

isUnexpected(ManagedClustersListClusterAdminCredentials200Response | ManagedClustersListClusterAdminCredentialsDefaultResponse) 

function isUnexpected(response: ManagedClustersListClusterAdminCredentials200Response | ManagedClustersListClusterAdminCredentialsDefaultResponse): response

Parameters

response

ManagedClustersListClusterAdminCredentials200Response | ManagedClustersListClusterAdminCredentialsDefaultResponse

Returns

response

isUnexpected(ManagedClustersListClusterUserCredentials200Response | ManagedClustersListClusterUserCredentialsDefaultResponse) 

function isUnexpected(response: ManagedClustersListClusterUserCredentials200Response | ManagedClustersListClusterUserCredentialsDefaultResponse): response

Parameters

response

ManagedClustersListClusterUserCredentials200Response | ManagedClustersListClusterUserCredentialsDefaultResponse

Returns

response

isUnexpected(ManagedClustersListClusterMonitoringUserCredentials200Response | ManagedClustersListClusterMonitoringUserCredentialsDefaultResponse) 

function isUnexpected(response: ManagedClustersListClusterMonitoringUserCredentials200Response | ManagedClustersListClusterMonitoringUserCredentialsDefaultResponse): response

Parameters

response

ManagedClustersListClusterMonitoringUserCredentials200Response | ManagedClustersListClusterMonitoringUserCredentialsDefaultResponse

Returns

response

isUnexpected(ManagedClustersGet200Response | ManagedClustersGetDefaultResponse) 

function isUnexpected(response: ManagedClustersGet200Response | ManagedClustersGetDefaultResponse): response

Parameters

response

ManagedClustersGet200Response | ManagedClustersGetDefaultResponse

Returns

response

isUnexpected(ManagedClustersCreateOrUpdate200Response | ManagedClustersCreateOrUpdate201Response | ManagedClustersCreateOrUpdateDefaultResponse) 

function isUnexpected(response: ManagedClustersCreateOrUpdate200Response | ManagedClustersCreateOrUpdate201Response | ManagedClustersCreateOrUpdateDefaultResponse): response

Parameters

response

ManagedClustersCreateOrUpdate200Response | ManagedClustersCreateOrUpdate201Response | ManagedClustersCreateOrUpdateDefaultResponse

Returns

response

isUnexpected(ManagedClustersUpdateTags200Response | ManagedClustersUpdateTagsDefaultResponse) 

function isUnexpected(response: ManagedClustersUpdateTags200Response | ManagedClustersUpdateTagsDefaultResponse): response

Parameters

response

ManagedClustersUpdateTags200Response | ManagedClustersUpdateTagsDefaultResponse

Returns

response

isUnexpected(ManagedClustersDelete202Response | ManagedClustersDelete204Response | ManagedClustersDeleteDefaultResponse) 

function isUnexpected(response: ManagedClustersDelete202Response | ManagedClustersDelete204Response | ManagedClustersDeleteDefaultResponse): response

Parameters

response

ManagedClustersDelete202Response | ManagedClustersDelete204Response | ManagedClustersDeleteDefaultResponse

Returns

response

isUnexpected(ManagedClustersResetServicePrincipalProfile200Response | ManagedClustersResetServicePrincipalProfile202Response | ManagedClustersResetServicePrincipalProfileDefaultResponse) 

function isUnexpected(response: ManagedClustersResetServicePrincipalProfile200Response | ManagedClustersResetServicePrincipalProfile202Response | ManagedClustersResetServicePrincipalProfileDefaultResponse): response

Parameters

response

ManagedClustersResetServicePrincipalProfile200Response | ManagedClustersResetServicePrincipalProfile202Response | ManagedClustersResetServicePrincipalProfileDefaultResponse

Returns

response

isUnexpected(ManagedClustersResetAADProfile200Response | ManagedClustersResetAADProfile202Response | ManagedClustersResetAADProfileDefaultResponse) 

function isUnexpected(response: ManagedClustersResetAADProfile200Response | ManagedClustersResetAADProfile202Response | ManagedClustersResetAADProfileDefaultResponse): response

Parameters

response

ManagedClustersResetAADProfile200Response | ManagedClustersResetAADProfile202Response | ManagedClustersResetAADProfileDefaultResponse

Returns

response

isUnexpected(ManagedClustersRotateClusterCertificates202Response | ManagedClustersRotateClusterCertificates204Response | ManagedClustersRotateClusterCertificatesDefaultResponse) 

function isUnexpected(response: ManagedClustersRotateClusterCertificates202Response | ManagedClustersRotateClusterCertificates204Response | ManagedClustersRotateClusterCertificatesDefaultResponse): response

Parameters

response

ManagedClustersRotateClusterCertificates202Response | ManagedClustersRotateClusterCertificates204Response | ManagedClustersRotateClusterCertificatesDefaultResponse

Returns

response

isUnexpected(ManagedClustersRotateServiceAccountSigningKeys202Response | ManagedClustersRotateServiceAccountSigningKeys204Response | ManagedClustersRotateServiceAccountSigningKeysDefaultResponse) 

function isUnexpected(response: ManagedClustersRotateServiceAccountSigningKeys202Response | ManagedClustersRotateServiceAccountSigningKeys204Response | ManagedClustersRotateServiceAccountSigningKeysDefaultResponse): response

Parameters

response

ManagedClustersRotateServiceAccountSigningKeys202Response | ManagedClustersRotateServiceAccountSigningKeys204Response | ManagedClustersRotateServiceAccountSigningKeysDefaultResponse

Returns

response

isUnexpected(ManagedClustersStop202Response | ManagedClustersStop204Response | ManagedClustersStopDefaultResponse) 

function isUnexpected(response: ManagedClustersStop202Response | ManagedClustersStop204Response | ManagedClustersStopDefaultResponse): response

Parameters

response

ManagedClustersStop202Response | ManagedClustersStop204Response | ManagedClustersStopDefaultResponse

Returns

response

isUnexpected(ManagedClustersStart202Response | ManagedClustersStart204Response | ManagedClustersStartDefaultResponse) 

function isUnexpected(response: ManagedClustersStart202Response | ManagedClustersStart204Response | ManagedClustersStartDefaultResponse): response

Parameters

response

ManagedClustersStart202Response | ManagedClustersStart204Response | ManagedClustersStartDefaultResponse

Returns

response

isUnexpected(ManagedClustersRunCommand200Response | ManagedClustersRunCommand202Response | ManagedClustersRunCommandDefaultResponse) 

function isUnexpected(response: ManagedClustersRunCommand200Response | ManagedClustersRunCommand202Response | ManagedClustersRunCommandDefaultResponse): response

Parameters

response

ManagedClustersRunCommand200Response | ManagedClustersRunCommand202Response | ManagedClustersRunCommandDefaultResponse

Returns

response

isUnexpected(ManagedClustersGetCommandResult200Response | ManagedClustersGetCommandResult202Response | ManagedClustersGetCommandResultDefaultResponse) 

function isUnexpected(response: ManagedClustersGetCommandResult200Response | ManagedClustersGetCommandResult202Response | ManagedClustersGetCommandResultDefaultResponse): response

Parameters

response

ManagedClustersGetCommandResult200Response | ManagedClustersGetCommandResult202Response | ManagedClustersGetCommandResultDefaultResponse

Returns

response

isUnexpected(ManagedClustersListOutboundNetworkDependenciesEndpoints200Response | ManagedClustersListOutboundNetworkDependenciesEndpointsDefaultResponse) 

function isUnexpected(response: ManagedClustersListOutboundNetworkDependenciesEndpoints200Response | ManagedClustersListOutboundNetworkDependenciesEndpointsDefaultResponse): response

Parameters

response

ManagedClustersListOutboundNetworkDependenciesEndpoints200Response | ManagedClustersListOutboundNetworkDependenciesEndpointsDefaultResponse

Returns

response

isUnexpected(MaintenanceConfigurationsListByManagedCluster200Response | MaintenanceConfigurationsListByManagedClusterDefaultResponse) 

function isUnexpected(response: MaintenanceConfigurationsListByManagedCluster200Response | MaintenanceConfigurationsListByManagedClusterDefaultResponse): response

Parameters

response

MaintenanceConfigurationsListByManagedCluster200Response | MaintenanceConfigurationsListByManagedClusterDefaultResponse

Returns

response

isUnexpected(MaintenanceConfigurationsGet200Response | MaintenanceConfigurationsGetDefaultResponse) 

function isUnexpected(response: MaintenanceConfigurationsGet200Response | MaintenanceConfigurationsGetDefaultResponse): response

Parameters

response

MaintenanceConfigurationsGet200Response | MaintenanceConfigurationsGetDefaultResponse

Returns

response

isUnexpected(MaintenanceConfigurationsCreateOrUpdate200Response | MaintenanceConfigurationsCreateOrUpdateDefaultResponse) 

function isUnexpected(response: MaintenanceConfigurationsCreateOrUpdate200Response | MaintenanceConfigurationsCreateOrUpdateDefaultResponse): response

Parameters

response

MaintenanceConfigurationsCreateOrUpdate200Response | MaintenanceConfigurationsCreateOrUpdateDefaultResponse

Returns

response

isUnexpected(MaintenanceConfigurationsDelete200Response | MaintenanceConfigurationsDelete204Response | MaintenanceConfigurationsDeleteDefaultResponse) 

function isUnexpected(response: MaintenanceConfigurationsDelete200Response | MaintenanceConfigurationsDelete204Response | MaintenanceConfigurationsDeleteDefaultResponse): response

Parameters

response

MaintenanceConfigurationsDelete200Response | MaintenanceConfigurationsDelete204Response | MaintenanceConfigurationsDeleteDefaultResponse

Returns

response

isUnexpected(AgentPoolsList200Response | AgentPoolsListDefaultResponse) 

function isUnexpected(response: AgentPoolsList200Response | AgentPoolsListDefaultResponse): response

Parameters

response

AgentPoolsList200Response | AgentPoolsListDefaultResponse

Returns

response

isUnexpected(AgentPoolsGet200Response | AgentPoolsGetDefaultResponse) 

function isUnexpected(response: AgentPoolsGet200Response | AgentPoolsGetDefaultResponse): response

Parameters

response

AgentPoolsGet200Response | AgentPoolsGetDefaultResponse

Returns

response

isUnexpected(AgentPoolsCreateOrUpdate200Response | AgentPoolsCreateOrUpdate201Response | AgentPoolsCreateOrUpdateDefaultResponse) 

function isUnexpected(response: AgentPoolsCreateOrUpdate200Response | AgentPoolsCreateOrUpdate201Response | AgentPoolsCreateOrUpdateDefaultResponse): response

Parameters

response

AgentPoolsCreateOrUpdate200Response | AgentPoolsCreateOrUpdate201Response | AgentPoolsCreateOrUpdateDefaultResponse

Returns

response

isUnexpected(AgentPoolsDelete202Response | AgentPoolsDelete204Response | AgentPoolsDeleteDefaultResponse) 

function isUnexpected(response: AgentPoolsDelete202Response | AgentPoolsDelete204Response | AgentPoolsDeleteDefaultResponse): response

Parameters

response

AgentPoolsDelete202Response | AgentPoolsDelete204Response | AgentPoolsDeleteDefaultResponse

Returns

response

isUnexpected(AgentPoolsGetUpgradeProfile200Response | AgentPoolsGetUpgradeProfileDefaultResponse) 

function isUnexpected(response: AgentPoolsGetUpgradeProfile200Response | AgentPoolsGetUpgradeProfileDefaultResponse): response

Parameters

response

AgentPoolsGetUpgradeProfile200Response | AgentPoolsGetUpgradeProfileDefaultResponse

Returns

response

isUnexpected(AgentPoolsUpgradeNodeImageVersion200Response | AgentPoolsUpgradeNodeImageVersion202Response | AgentPoolsUpgradeNodeImageVersionDefaultResponse) 

function isUnexpected(response: AgentPoolsUpgradeNodeImageVersion200Response | AgentPoolsUpgradeNodeImageVersion202Response | AgentPoolsUpgradeNodeImageVersionDefaultResponse): response

Parameters

response

AgentPoolsUpgradeNodeImageVersion200Response | AgentPoolsUpgradeNodeImageVersion202Response | AgentPoolsUpgradeNodeImageVersionDefaultResponse

Returns

response

isUnexpected(PrivateEndpointConnectionsList200Response | PrivateEndpointConnectionsListDefaultResponse) 

function isUnexpected(response: PrivateEndpointConnectionsList200Response | PrivateEndpointConnectionsListDefaultResponse): response

Parameters

response

PrivateEndpointConnectionsList200Response | PrivateEndpointConnectionsListDefaultResponse

Returns

response

isUnexpected(PrivateEndpointConnectionsGet200Response | PrivateEndpointConnectionsGetDefaultResponse) 

function isUnexpected(response: PrivateEndpointConnectionsGet200Response | PrivateEndpointConnectionsGetDefaultResponse): response

Parameters

response

PrivateEndpointConnectionsGet200Response | PrivateEndpointConnectionsGetDefaultResponse

Returns

response

isUnexpected(PrivateEndpointConnectionsUpdate200Response | PrivateEndpointConnectionsUpdateDefaultResponse) 

function isUnexpected(response: PrivateEndpointConnectionsUpdate200Response | PrivateEndpointConnectionsUpdateDefaultResponse): response

Parameters

response

PrivateEndpointConnectionsUpdate200Response | PrivateEndpointConnectionsUpdateDefaultResponse

Returns

response

isUnexpected(PrivateEndpointConnectionsDelete200Response | PrivateEndpointConnectionsDelete204Response | PrivateEndpointConnectionsDeleteDefaultResponse) 

function isUnexpected(response: PrivateEndpointConnectionsDelete200Response | PrivateEndpointConnectionsDelete204Response | PrivateEndpointConnectionsDeleteDefaultResponse): response

Parameters

response

PrivateEndpointConnectionsDelete200Response | PrivateEndpointConnectionsDelete204Response | PrivateEndpointConnectionsDeleteDefaultResponse

Returns

response

isUnexpected(PrivateLinkResourcesList200Response | PrivateLinkResourcesListDefaultResponse) 

function isUnexpected(response: PrivateLinkResourcesList200Response | PrivateLinkResourcesListDefaultResponse): response

Parameters

response

PrivateLinkResourcesList200Response | PrivateLinkResourcesListDefaultResponse

Returns

response

isUnexpected(ResolvePrivateLinkServiceIdPost200Response | ResolvePrivateLinkServiceIdPostDefaultResponse) 

function isUnexpected(response: ResolvePrivateLinkServiceIdPost200Response | ResolvePrivateLinkServiceIdPostDefaultResponse): response

Parameters

response

ResolvePrivateLinkServiceIdPost200Response | ResolvePrivateLinkServiceIdPostDefaultResponse

Returns

response

isUnexpected(SnapshotsList200Response | SnapshotsListDefaultResponse) 

function isUnexpected(response: SnapshotsList200Response | SnapshotsListDefaultResponse): response

Parameters

response

SnapshotsList200Response | SnapshotsListDefaultResponse

Returns

response

isUnexpected(SnapshotsListByResourceGroup200Response | SnapshotsListByResourceGroupDefaultResponse) 

function isUnexpected(response: SnapshotsListByResourceGroup200Response | SnapshotsListByResourceGroupDefaultResponse): response

Parameters

response

SnapshotsListByResourceGroup200Response | SnapshotsListByResourceGroupDefaultResponse

Returns

response

isUnexpected(SnapshotsGet200Response | SnapshotsGetDefaultResponse) 

function isUnexpected(response: SnapshotsGet200Response | SnapshotsGetDefaultResponse): response

Parameters

response

SnapshotsGet200Response | SnapshotsGetDefaultResponse

Returns

response

isUnexpected(SnapshotsCreateOrUpdate200Response | SnapshotsCreateOrUpdate201Response | SnapshotsCreateOrUpdateDefaultResponse) 

function isUnexpected(response: SnapshotsCreateOrUpdate200Response | SnapshotsCreateOrUpdate201Response | SnapshotsCreateOrUpdateDefaultResponse): response

Parameters

response

SnapshotsCreateOrUpdate200Response | SnapshotsCreateOrUpdate201Response | SnapshotsCreateOrUpdateDefaultResponse

Returns

response

isUnexpected(SnapshotsUpdateTags200Response | SnapshotsUpdateTagsDefaultResponse) 

function isUnexpected(response: SnapshotsUpdateTags200Response | SnapshotsUpdateTagsDefaultResponse): response

Parameters

response

SnapshotsUpdateTags200Response | SnapshotsUpdateTagsDefaultResponse

Returns

response

isUnexpected(SnapshotsDelete200Response | SnapshotsDelete204Response | SnapshotsDeleteDefaultResponse) 

function isUnexpected(response: SnapshotsDelete200Response | SnapshotsDelete204Response | SnapshotsDeleteDefaultResponse): response

Parameters

response

SnapshotsDelete200Response | SnapshotsDelete204Response | SnapshotsDeleteDefaultResponse

Returns

response

isUnexpected(ManagedClusterSnapshotsList200Response | ManagedClusterSnapshotsListDefaultResponse) 

function isUnexpected(response: ManagedClusterSnapshotsList200Response | ManagedClusterSnapshotsListDefaultResponse): response

Parameters

response

ManagedClusterSnapshotsList200Response | ManagedClusterSnapshotsListDefaultResponse

Returns

response

isUnexpected(ManagedClusterSnapshotsListByResourceGroup200Response | ManagedClusterSnapshotsListByResourceGroupDefaultResponse) 

function isUnexpected(response: ManagedClusterSnapshotsListByResourceGroup200Response | ManagedClusterSnapshotsListByResourceGroupDefaultResponse): response

Parameters

response

ManagedClusterSnapshotsListByResourceGroup200Response | ManagedClusterSnapshotsListByResourceGroupDefaultResponse

Returns

response

isUnexpected(ManagedClusterSnapshotsGet200Response | ManagedClusterSnapshotsGetDefaultResponse) 

function isUnexpected(response: ManagedClusterSnapshotsGet200Response | ManagedClusterSnapshotsGetDefaultResponse): response

Parameters

response

ManagedClusterSnapshotsGet200Response | ManagedClusterSnapshotsGetDefaultResponse

Returns

response

isUnexpected(ManagedClusterSnapshotsCreateOrUpdate200Response | ManagedClusterSnapshotsCreateOrUpdate201Response | ManagedClusterSnapshotsCreateOrUpdateDefaultResponse) 

function isUnexpected(response: ManagedClusterSnapshotsCreateOrUpdate200Response | ManagedClusterSnapshotsCreateOrUpdate201Response | ManagedClusterSnapshotsCreateOrUpdateDefaultResponse): response

Parameters

response

ManagedClusterSnapshotsCreateOrUpdate200Response | ManagedClusterSnapshotsCreateOrUpdate201Response | ManagedClusterSnapshotsCreateOrUpdateDefaultResponse

Returns

response

isUnexpected(ManagedClusterSnapshotsUpdateTags200Response | ManagedClusterSnapshotsUpdateTagsDefaultResponse) 

function isUnexpected(response: ManagedClusterSnapshotsUpdateTags200Response | ManagedClusterSnapshotsUpdateTagsDefaultResponse): response

Parameters

response

ManagedClusterSnapshotsUpdateTags200Response | ManagedClusterSnapshotsUpdateTagsDefaultResponse

Returns

response

isUnexpected(ManagedClusterSnapshotsDelete200Response | ManagedClusterSnapshotsDelete204Response | ManagedClusterSnapshotsDeleteDefaultResponse) 

function isUnexpected(response: ManagedClusterSnapshotsDelete200Response | ManagedClusterSnapshotsDelete204Response | ManagedClusterSnapshotsDeleteDefaultResponse): response

Parameters

response

ManagedClusterSnapshotsDelete200Response | ManagedClusterSnapshotsDelete204Response | ManagedClusterSnapshotsDeleteDefaultResponse

Returns

response

isUnexpected(TrustedAccessRolesList200Response | TrustedAccessRolesListDefaultResponse) 

function isUnexpected(response: TrustedAccessRolesList200Response | TrustedAccessRolesListDefaultResponse): response

Parameters

response

TrustedAccessRolesList200Response | TrustedAccessRolesListDefaultResponse

Returns

response

isUnexpected(TrustedAccessRoleBindingsList200Response | TrustedAccessRoleBindingsListDefaultResponse) 

function isUnexpected(response: TrustedAccessRoleBindingsList200Response | TrustedAccessRoleBindingsListDefaultResponse): response

Parameters

response

TrustedAccessRoleBindingsList200Response | TrustedAccessRoleBindingsListDefaultResponse

Returns

response

isUnexpected(TrustedAccessRoleBindingsGet200Response | TrustedAccessRoleBindingsGetDefaultResponse) 

function isUnexpected(response: TrustedAccessRoleBindingsGet200Response | TrustedAccessRoleBindingsGetDefaultResponse): response

Parameters

response

TrustedAccessRoleBindingsGet200Response | TrustedAccessRoleBindingsGetDefaultResponse

Returns

response

isUnexpected(TrustedAccessRoleBindingsCreateOrUpdate200Response | TrustedAccessRoleBindingsCreateOrUpdateDefaultResponse) 

function isUnexpected(response: TrustedAccessRoleBindingsCreateOrUpdate200Response | TrustedAccessRoleBindingsCreateOrUpdateDefaultResponse): response

Parameters

response

TrustedAccessRoleBindingsCreateOrUpdate200Response | TrustedAccessRoleBindingsCreateOrUpdateDefaultResponse

Returns

response

isUnexpected(TrustedAccessRoleBindingsDelete200Response | TrustedAccessRoleBindingsDelete204Response | TrustedAccessRoleBindingsDeleteDefaultResponse) 

function isUnexpected(response: TrustedAccessRoleBindingsDelete200Response | TrustedAccessRoleBindingsDelete204Response | TrustedAccessRoleBindingsDeleteDefaultResponse): response

Parameters

response

TrustedAccessRoleBindingsDelete200Response | TrustedAccessRoleBindingsDelete204Response | TrustedAccessRoleBindingsDeleteDefaultResponse

Returns

response

paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension

function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>

Parameters

client
Client

Client to use for sending the next page requests

initialResponse

TResponse

Initial response containing the nextLink and current page of elements

options

PagingOptions<TResponse>

Returns

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

  • PagedAsyncIterableIterator to iterate the elements