Microsoft.HybridContainerService (preview:2025-02-01)

2025/09/25 • 30 new methods

provisionedClusterInstances_Get (new)
Description :  Gets the provisioned cluster instance
Reference :  Link ¶

⚼ Request

GET:  /{connectedClusterResourceUri}/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default
{
connectedClusterResourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the connected cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provisioned cluster. ,
Required: False ,
}
{
linuxProfile:
{
Description: The profile for Linux VMs in the provisioned cluster. ,
Required: False ,
}
{
ssh:
{
Description: SSH configuration for VMs of the provisioned cluster. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with VMs. A maximum of 1 key may be specified. ,
Required: False ,
}
[
{
keyData:
{
Description: Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
controlPlane:
{
Description: The profile for control plane of the provisioned cluster. ,
Required: False ,
}
{
count:
{
Description: Number of control plane nodes. The default value is 1, and the count should be an odd number ,
Format: int32 ,
Required: False ,
}
integer ,
vmSize:
{
Description: VM sku size of the control plane nodes ,
Required: False ,
}
string ,
controlPlaneEndpoint:
{
Description: IP Address of the Kubernetes API server ,
Required: False ,
}
{
hostIP:
{
Description: IP address of the Kubernetes API server ,
Required: False ,
}
string ,
}
,
}
,
kubernetesVersion:
{
Description: The version of Kubernetes in use by the provisioned cluster. ,
Required: False ,
}
string ,
networkProfile:
{
Description: The network configuration profile for the provisioned cluster. ,
Required: False ,
}
{
loadBalancerProfile:
{
Description: Profile of the HA Proxy load balancer. ,
Required: False ,
}
{
count:
{
Description: Number of HA Proxy load balancer VMs. The default value is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
networkPolicy:
{
Description: Network policy used for building Kubernetes network. Possible values include: 'calico'. ,
Enum:
{
calico: No description available. ,
}
,
Required: False ,
}
enum ,
podCidr:
{
Description: A CIDR notation IP Address range from which to assign pod IPs. ,
Required: False ,
}
string ,
}
,
storageProfile:
{
Description: The storage configuration profile for the provisioned cluster. ,
Required: False ,
}
{
smbCsiDriver:
{
Description: SMB CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether to enable SMB CSI Driver. The default value is true. ,
Required: False ,
}
boolean ,
}
,
nfsCsiDriver:
{
Description: NFS CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether to enable NFS CSI Driver. The default value is true. ,
Required: False ,
}
boolean ,
}
,
}
,
clusterVMAccessProfile:
{
Description: The SSH restricted access profile for the VMs in the provisioned cluster. ,
Required: False ,
}
{
authorizedIPRanges:
{
Description: IP Address or CIDR for SSH access to VMs in the provisioned cluster ,
Required: False ,
}
string ,
}
,
agentPoolProfiles:
{
Description: The agent pool properties for the provisioned cluster. ,
Required: False ,
}
[
string ,
]
,
cloudProviderProfile:
{
Description: The profile for the underlying cloud infrastructure provider for the provisioned cluster. ,
Required: False ,
}
{
infraNetworkProfile:
{
Description: The profile for the infrastructure networks used by the provisioned cluster ,
Required: False ,
}
{
vnetSubnetIds:
{
Description: List of ARM resource Ids (maximum 1) for the infrastructure network object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName} ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
provisioningState:
{
Description: The status of the latest long running operation for the provisioned cluster. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed status of the provisioned cluster. ,
Required: False ,
}
{
controlPlaneStatus:
{
Description: The detailed status of the provisioned cluster components including addons. ,
Required: False ,
}
[
{
name:
{
Description: Name of the addon or component ,
Required: False ,
}
string ,
phase:
{
Description: Observed phase of the addon or component on the provisioned cluster. Possible values include: 'pending', 'provisioning', 'provisioning {HelmChartInstalled}', 'provisioning {MSICertificateDownloaded}', 'provisioned', 'deleting', 'failed', 'upgrading' ,
Enum:
{
pending: No description available. ,
provisioning: No description available. ,
provisioning {HelmChartInstalled}: No description available. ,
provisioning {MSICertificateDownloaded}: No description available. ,
provisioned: No description available. ,
deleting: No description available. ,
failed: No description available. ,
upgrading: No description available. ,
}
,
Required: False ,
}
enum ,
ready:
{
Description: Indicates whether the addon or component is ready ,
Required: False ,
}
boolean ,
errorMessage:
{
Description: Observed error message from the addon or component ,
Required: False ,
}
string ,
}
,
]
,
currentState:
{
Description: The current state of the provisioned cluster. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: Error messages during a provisioned cluster operation or steady state. ,
Required: False ,
}
string ,
}
,
licenseProfile:
{
Description: The license profile of the provisioned cluster. ,
Required: False ,
}
{
azureHybridBenefit:
{
Description: Indicates whether Azure Hybrid Benefit is opted in. Default value is false ,
Enum:
{
True: No description available. ,
False: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
autoScalerProfile:
{
Description: Parameters to be applied to the cluster-autoscaler when auto scaling is enabled for the provisioned cluster. ,
Required: False ,
}
{
balance-similar-node-groups:
{
Description: Valid values are 'true' and 'false' ,
Required: False ,
}
string ,
expander:
{
Description: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. ,
Enum:
{
least-waste: 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. ,
most-pods: 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. ,
priority: Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md). ,
random: Used when you don't have a particular need for the node groups to scale differently. ,
}
,
Required: False ,
}
enum ,
max-empty-bulk-delete:
{
Description: The default is 10. ,
Required: False ,
}
string ,
max-graceful-termination-sec:
{
Description: The default is 600. ,
Required: False ,
}
string ,
max-node-provision-time:
{
Description: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
max-total-unready-percentage:
{
Description: The default is 45. The maximum is 100 and the minimum is 0. ,
Required: False ,
}
string ,
new-pod-scale-up-delay:
{
Description: 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). ,
Required: False ,
}
string ,
ok-total-unready-count:
{
Description: This must be an integer. The default is 3. ,
Required: False ,
}
string ,
scan-interval:
{
Description: The default is '10'. Values must be an integer number of seconds. ,
Required: False ,
}
string ,
scale-down-delay-after-add:
{
Description: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-delay-after-delete:
{
Description: 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. ,
Required: False ,
}
string ,
scale-down-delay-after-failure:
{
Description: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-unneeded-time:
{
Description: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-unready-time:
{
Description: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-utilization-threshold:
{
Description: The default is '0.5'. ,
Required: False ,
}
string ,
skip-nodes-with-local-storage:
{
Description: The default is true. ,
Required: False ,
}
string ,
skip-nodes-with-system-pods:
{
Description: The default is true. ,
Required: False ,
}
string ,
}
,
}
,
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
provisionedClusterInstances_CreateOrUpdate (new)
Description :  Creates or updates the provisioned cluster instance
Reference :  Link ¶

⚼ Request

PUT:  /{connectedClusterResourceUri}/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default
{
connectedClusterResourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the connected cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
provisionedClusterInstance:
{
Description: Provisioned Cluster resource definition ,
Required: True ,
}
{
properties:
{
Description: Properties of the provisioned cluster. ,
Required: False ,
}
{
linuxProfile:
{
Description: The profile for Linux VMs in the provisioned cluster. ,
Required: False ,
}
{
ssh:
{
Description: SSH configuration for VMs of the provisioned cluster. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with VMs. A maximum of 1 key may be specified. ,
Required: False ,
}
[
{
keyData:
{
Description: Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
controlPlane:
{
Description: The profile for control plane of the provisioned cluster. ,
Required: False ,
}
{
count:
{
Description: Number of control plane nodes. The default value is 1, and the count should be an odd number ,
Format: int32 ,
Required: False ,
}
integer ,
vmSize:
{
Description: VM sku size of the control plane nodes ,
Required: False ,
}
string ,
controlPlaneEndpoint:
{
Description: IP Address of the Kubernetes API server ,
Required: False ,
}
{
hostIP:
{
Description: IP address of the Kubernetes API server ,
Required: False ,
}
string ,
}
,
}
,
kubernetesVersion:
{
Description: The version of Kubernetes in use by the provisioned cluster. ,
Required: False ,
}
string ,
networkProfile:
{
Description: The network configuration profile for the provisioned cluster. ,
Required: False ,
}
{
loadBalancerProfile:
{
Description: Profile of the HA Proxy load balancer. ,
Required: False ,
}
{
count:
{
Description: Number of HA Proxy load balancer VMs. The default value is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
networkPolicy:
{
Description: Network policy used for building Kubernetes network. Possible values include: 'calico'. ,
Enum:
{
calico: No description available. ,
}
,
Required: False ,
}
enum ,
podCidr:
{
Description: A CIDR notation IP Address range from which to assign pod IPs. ,
Required: False ,
}
string ,
}
,
storageProfile:
{
Description: The storage configuration profile for the provisioned cluster. ,
Required: False ,
}
{
smbCsiDriver:
{
Description: SMB CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether to enable SMB CSI Driver. The default value is true. ,
Required: False ,
}
boolean ,
}
,
nfsCsiDriver:
{
Description: NFS CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether to enable NFS CSI Driver. The default value is true. ,
Required: False ,
}
boolean ,
}
,
}
,
clusterVMAccessProfile:
{
Description: The SSH restricted access profile for the VMs in the provisioned cluster. ,
Required: False ,
}
{
authorizedIPRanges:
{
Description: IP Address or CIDR for SSH access to VMs in the provisioned cluster ,
Required: False ,
}
string ,
}
,
agentPoolProfiles:
{
Description: The agent pool properties for the provisioned cluster. ,
Required: False ,
}
[
string ,
]
,
cloudProviderProfile:
{
Description: The profile for the underlying cloud infrastructure provider for the provisioned cluster. ,
Required: False ,
}
{
infraNetworkProfile:
{
Description: The profile for the infrastructure networks used by the provisioned cluster ,
Required: False ,
}
{
vnetSubnetIds:
{
Description: List of ARM resource Ids (maximum 1) for the infrastructure network object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName} ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
provisioningState:
{
Description: The status of the latest long running operation for the provisioned cluster. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed status of the provisioned cluster. ,
Required: False ,
}
{
controlPlaneStatus:
{
Description: The detailed status of the provisioned cluster components including addons. ,
Required: False ,
}
[
{
name:
{
Description: Name of the addon or component ,
Required: False ,
}
string ,
phase:
{
Description: Observed phase of the addon or component on the provisioned cluster. Possible values include: 'pending', 'provisioning', 'provisioning {HelmChartInstalled}', 'provisioning {MSICertificateDownloaded}', 'provisioned', 'deleting', 'failed', 'upgrading' ,
Enum:
{
pending: No description available. ,
provisioning: No description available. ,
provisioning {HelmChartInstalled}: No description available. ,
provisioning {MSICertificateDownloaded}: No description available. ,
provisioned: No description available. ,
deleting: No description available. ,
failed: No description available. ,
upgrading: No description available. ,
}
,
Required: False ,
}
enum ,
ready:
{
Description: Indicates whether the addon or component is ready ,
Required: False ,
}
boolean ,
errorMessage:
{
Description: Observed error message from the addon or component ,
Required: False ,
}
string ,
}
,
]
,
currentState:
{
Description: The current state of the provisioned cluster. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: Error messages during a provisioned cluster operation or steady state. ,
Required: False ,
}
string ,
}
,
licenseProfile:
{
Description: The license profile of the provisioned cluster. ,
Required: False ,
}
{
azureHybridBenefit:
{
Description: Indicates whether Azure Hybrid Benefit is opted in. Default value is false ,
Enum:
{
True: No description available. ,
False: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
autoScalerProfile:
{
Description: Parameters to be applied to the cluster-autoscaler when auto scaling is enabled for the provisioned cluster. ,
Required: False ,
}
{
balance-similar-node-groups:
{
Description: Valid values are 'true' and 'false' ,
Required: False ,
}
string ,
expander:
{
Description: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. ,
Enum:
{
least-waste: 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. ,
most-pods: 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. ,
priority: Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md). ,
random: Used when you don't have a particular need for the node groups to scale differently. ,
}
,
Required: False ,
}
enum ,
max-empty-bulk-delete:
{
Description: The default is 10. ,
Required: False ,
}
string ,
max-graceful-termination-sec:
{
Description: The default is 600. ,
Required: False ,
}
string ,
max-node-provision-time:
{
Description: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
max-total-unready-percentage:
{
Description: The default is 45. The maximum is 100 and the minimum is 0. ,
Required: False ,
}
string ,
new-pod-scale-up-delay:
{
Description: 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). ,
Required: False ,
}
string ,
ok-total-unready-count:
{
Description: This must be an integer. The default is 3. ,
Required: False ,
}
string ,
scan-interval:
{
Description: The default is '10'. Values must be an integer number of seconds. ,
Required: False ,
}
string ,
scale-down-delay-after-add:
{
Description: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-delay-after-delete:
{
Description: 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. ,
Required: False ,
}
string ,
scale-down-delay-after-failure:
{
Description: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-unneeded-time:
{
Description: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-unready-time:
{
Description: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-utilization-threshold:
{
Description: The default is '0.5'. ,
Required: False ,
}
string ,
skip-nodes-with-local-storage:
{
Description: The default is true. ,
Required: False ,
}
string ,
skip-nodes-with-system-pods:
{
Description: The default is true. ,
Required: False ,
}
string ,
}
,
}
,
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provisioned cluster. ,
Required: False ,
}
{
linuxProfile:
{
Description: The profile for Linux VMs in the provisioned cluster. ,
Required: False ,
}
{
ssh:
{
Description: SSH configuration for VMs of the provisioned cluster. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with VMs. A maximum of 1 key may be specified. ,
Required: False ,
}
[
{
keyData:
{
Description: Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
controlPlane:
{
Description: The profile for control plane of the provisioned cluster. ,
Required: False ,
}
{
count:
{
Description: Number of control plane nodes. The default value is 1, and the count should be an odd number ,
Format: int32 ,
Required: False ,
}
integer ,
vmSize:
{
Description: VM sku size of the control plane nodes ,
Required: False ,
}
string ,
controlPlaneEndpoint:
{
Description: IP Address of the Kubernetes API server ,
Required: False ,
}
{
hostIP:
{
Description: IP address of the Kubernetes API server ,
Required: False ,
}
string ,
}
,
}
,
kubernetesVersion:
{
Description: The version of Kubernetes in use by the provisioned cluster. ,
Required: False ,
}
string ,
networkProfile:
{
Description: The network configuration profile for the provisioned cluster. ,
Required: False ,
}
{
loadBalancerProfile:
{
Description: Profile of the HA Proxy load balancer. ,
Required: False ,
}
{
count:
{
Description: Number of HA Proxy load balancer VMs. The default value is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
networkPolicy:
{
Description: Network policy used for building Kubernetes network. Possible values include: 'calico'. ,
Enum:
{
calico: No description available. ,
}
,
Required: False ,
}
enum ,
podCidr:
{
Description: A CIDR notation IP Address range from which to assign pod IPs. ,
Required: False ,
}
string ,
}
,
storageProfile:
{
Description: The storage configuration profile for the provisioned cluster. ,
Required: False ,
}
{
smbCsiDriver:
{
Description: SMB CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether to enable SMB CSI Driver. The default value is true. ,
Required: False ,
}
boolean ,
}
,
nfsCsiDriver:
{
Description: NFS CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether to enable NFS CSI Driver. The default value is true. ,
Required: False ,
}
boolean ,
}
,
}
,
clusterVMAccessProfile:
{
Description: The SSH restricted access profile for the VMs in the provisioned cluster. ,
Required: False ,
}
{
authorizedIPRanges:
{
Description: IP Address or CIDR for SSH access to VMs in the provisioned cluster ,
Required: False ,
}
string ,
}
,
agentPoolProfiles:
{
Description: The agent pool properties for the provisioned cluster. ,
Required: False ,
}
[
string ,
]
,
cloudProviderProfile:
{
Description: The profile for the underlying cloud infrastructure provider for the provisioned cluster. ,
Required: False ,
}
{
infraNetworkProfile:
{
Description: The profile for the infrastructure networks used by the provisioned cluster ,
Required: False ,
}
{
vnetSubnetIds:
{
Description: List of ARM resource Ids (maximum 1) for the infrastructure network object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName} ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
provisioningState:
{
Description: The status of the latest long running operation for the provisioned cluster. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed status of the provisioned cluster. ,
Required: False ,
}
{
controlPlaneStatus:
{
Description: The detailed status of the provisioned cluster components including addons. ,
Required: False ,
}
[
{
name:
{
Description: Name of the addon or component ,
Required: False ,
}
string ,
phase:
{
Description: Observed phase of the addon or component on the provisioned cluster. Possible values include: 'pending', 'provisioning', 'provisioning {HelmChartInstalled}', 'provisioning {MSICertificateDownloaded}', 'provisioned', 'deleting', 'failed', 'upgrading' ,
Enum:
{
pending: No description available. ,
provisioning: No description available. ,
provisioning {HelmChartInstalled}: No description available. ,
provisioning {MSICertificateDownloaded}: No description available. ,
provisioned: No description available. ,
deleting: No description available. ,
failed: No description available. ,
upgrading: No description available. ,
}
,
Required: False ,
}
enum ,
ready:
{
Description: Indicates whether the addon or component is ready ,
Required: False ,
}
boolean ,
errorMessage:
{
Description: Observed error message from the addon or component ,
Required: False ,
}
string ,
}
,
]
,
currentState:
{
Description: The current state of the provisioned cluster. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: Error messages during a provisioned cluster operation or steady state. ,
Required: False ,
}
string ,
}
,
licenseProfile:
{
Description: The license profile of the provisioned cluster. ,
Required: False ,
}
{
azureHybridBenefit:
{
Description: Indicates whether Azure Hybrid Benefit is opted in. Default value is false ,
Enum:
{
True: No description available. ,
False: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
autoScalerProfile:
{
Description: Parameters to be applied to the cluster-autoscaler when auto scaling is enabled for the provisioned cluster. ,
Required: False ,
}
{
balance-similar-node-groups:
{
Description: Valid values are 'true' and 'false' ,
Required: False ,
}
string ,
expander:
{
Description: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. ,
Enum:
{
least-waste: 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. ,
most-pods: 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. ,
priority: Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md). ,
random: Used when you don't have a particular need for the node groups to scale differently. ,
}
,
Required: False ,
}
enum ,
max-empty-bulk-delete:
{
Description: The default is 10. ,
Required: False ,
}
string ,
max-graceful-termination-sec:
{
Description: The default is 600. ,
Required: False ,
}
string ,
max-node-provision-time:
{
Description: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
max-total-unready-percentage:
{
Description: The default is 45. The maximum is 100 and the minimum is 0. ,
Required: False ,
}
string ,
new-pod-scale-up-delay:
{
Description: 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). ,
Required: False ,
}
string ,
ok-total-unready-count:
{
Description: This must be an integer. The default is 3. ,
Required: False ,
}
string ,
scan-interval:
{
Description: The default is '10'. Values must be an integer number of seconds. ,
Required: False ,
}
string ,
scale-down-delay-after-add:
{
Description: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-delay-after-delete:
{
Description: 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. ,
Required: False ,
}
string ,
scale-down-delay-after-failure:
{
Description: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-unneeded-time:
{
Description: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-unready-time:
{
Description: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-utilization-threshold:
{
Description: The default is '0.5'. ,
Required: False ,
}
string ,
skip-nodes-with-local-storage:
{
Description: The default is true. ,
Required: False ,
}
string ,
skip-nodes-with-system-pods:
{
Description: The default is true. ,
Required: False ,
}
string ,
}
,
}
,
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the provisioned cluster. ,
Required: False ,
}
{
linuxProfile:
{
Description: The profile for Linux VMs in the provisioned cluster. ,
Required: False ,
}
{
ssh:
{
Description: SSH configuration for VMs of the provisioned cluster. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with VMs. A maximum of 1 key may be specified. ,
Required: False ,
}
[
{
keyData:
{
Description: Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
controlPlane:
{
Description: The profile for control plane of the provisioned cluster. ,
Required: False ,
}
{
count:
{
Description: Number of control plane nodes. The default value is 1, and the count should be an odd number ,
Format: int32 ,
Required: False ,
}
integer ,
vmSize:
{
Description: VM sku size of the control plane nodes ,
Required: False ,
}
string ,
controlPlaneEndpoint:
{
Description: IP Address of the Kubernetes API server ,
Required: False ,
}
{
hostIP:
{
Description: IP address of the Kubernetes API server ,
Required: False ,
}
string ,
}
,
}
,
kubernetesVersion:
{
Description: The version of Kubernetes in use by the provisioned cluster. ,
Required: False ,
}
string ,
networkProfile:
{
Description: The network configuration profile for the provisioned cluster. ,
Required: False ,
}
{
loadBalancerProfile:
{
Description: Profile of the HA Proxy load balancer. ,
Required: False ,
}
{
count:
{
Description: Number of HA Proxy load balancer VMs. The default value is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
networkPolicy:
{
Description: Network policy used for building Kubernetes network. Possible values include: 'calico'. ,
Enum:
{
calico: No description available. ,
}
,
Required: False ,
}
enum ,
podCidr:
{
Description: A CIDR notation IP Address range from which to assign pod IPs. ,
Required: False ,
}
string ,
}
,
storageProfile:
{
Description: The storage configuration profile for the provisioned cluster. ,
Required: False ,
}
{
smbCsiDriver:
{
Description: SMB CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether to enable SMB CSI Driver. The default value is true. ,
Required: False ,
}
boolean ,
}
,
nfsCsiDriver:
{
Description: NFS CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether to enable NFS CSI Driver. The default value is true. ,
Required: False ,
}
boolean ,
}
,
}
,
clusterVMAccessProfile:
{
Description: The SSH restricted access profile for the VMs in the provisioned cluster. ,
Required: False ,
}
{
authorizedIPRanges:
{
Description: IP Address or CIDR for SSH access to VMs in the provisioned cluster ,
Required: False ,
}
string ,
}
,
agentPoolProfiles:
{
Description: The agent pool properties for the provisioned cluster. ,
Required: False ,
}
[
string ,
]
,
cloudProviderProfile:
{
Description: The profile for the underlying cloud infrastructure provider for the provisioned cluster. ,
Required: False ,
}
{
infraNetworkProfile:
{
Description: The profile for the infrastructure networks used by the provisioned cluster ,
Required: False ,
}
{
vnetSubnetIds:
{
Description: List of ARM resource Ids (maximum 1) for the infrastructure network object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName} ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
provisioningState:
{
Description: The status of the latest long running operation for the provisioned cluster. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed status of the provisioned cluster. ,
Required: False ,
}
{
controlPlaneStatus:
{
Description: The detailed status of the provisioned cluster components including addons. ,
Required: False ,
}
[
{
name:
{
Description: Name of the addon or component ,
Required: False ,
}
string ,
phase:
{
Description: Observed phase of the addon or component on the provisioned cluster. Possible values include: 'pending', 'provisioning', 'provisioning {HelmChartInstalled}', 'provisioning {MSICertificateDownloaded}', 'provisioned', 'deleting', 'failed', 'upgrading' ,
Enum:
{
pending: No description available. ,
provisioning: No description available. ,
provisioning {HelmChartInstalled}: No description available. ,
provisioning {MSICertificateDownloaded}: No description available. ,
provisioned: No description available. ,
deleting: No description available. ,
failed: No description available. ,
upgrading: No description available. ,
}
,
Required: False ,
}
enum ,
ready:
{
Description: Indicates whether the addon or component is ready ,
Required: False ,
}
boolean ,
errorMessage:
{
Description: Observed error message from the addon or component ,
Required: False ,
}
string ,
}
,
]
,
currentState:
{
Description: The current state of the provisioned cluster. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: Error messages during a provisioned cluster operation or steady state. ,
Required: False ,
}
string ,
}
,
licenseProfile:
{
Description: The license profile of the provisioned cluster. ,
Required: False ,
}
{
azureHybridBenefit:
{
Description: Indicates whether Azure Hybrid Benefit is opted in. Default value is false ,
Enum:
{
True: No description available. ,
False: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
autoScalerProfile:
{
Description: Parameters to be applied to the cluster-autoscaler when auto scaling is enabled for the provisioned cluster. ,
Required: False ,
}
{
balance-similar-node-groups:
{
Description: Valid values are 'true' and 'false' ,
Required: False ,
}
string ,
expander:
{
Description: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. ,
Enum:
{
least-waste: 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. ,
most-pods: 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. ,
priority: Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md). ,
random: Used when you don't have a particular need for the node groups to scale differently. ,
}
,
Required: False ,
}
enum ,
max-empty-bulk-delete:
{
Description: The default is 10. ,
Required: False ,
}
string ,
max-graceful-termination-sec:
{
Description: The default is 600. ,
Required: False ,
}
string ,
max-node-provision-time:
{
Description: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
max-total-unready-percentage:
{
Description: The default is 45. The maximum is 100 and the minimum is 0. ,
Required: False ,
}
string ,
new-pod-scale-up-delay:
{
Description: 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). ,
Required: False ,
}
string ,
ok-total-unready-count:
{
Description: This must be an integer. The default is 3. ,
Required: False ,
}
string ,
scan-interval:
{
Description: The default is '10'. Values must be an integer number of seconds. ,
Required: False ,
}
string ,
scale-down-delay-after-add:
{
Description: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-delay-after-delete:
{
Description: 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. ,
Required: False ,
}
string ,
scale-down-delay-after-failure:
{
Description: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-unneeded-time:
{
Description: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-unready-time:
{
Description: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-utilization-threshold:
{
Description: The default is '0.5'. ,
Required: False ,
}
string ,
skip-nodes-with-local-storage:
{
Description: The default is true. ,
Required: False ,
}
string ,
skip-nodes-with-system-pods:
{
Description: The default is true. ,
Required: False ,
}
string ,
}
,
}
,
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
provisionedClusterInstances_Delete (new)
Description :  Deletes the provisioned cluster instance
Reference :  Link ¶

⚼ Request

DELETE:  /{connectedClusterResourceUri}/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default
{
connectedClusterResourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the connected cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
provisionedClusterInstances_List (new)
Description :  Lists the ProvisionedClusterInstance resource associated with the ConnectedCluster
Reference :  Link ¶

⚼ Request

GET:  /{connectedClusterResourceUri}/providers/Microsoft.HybridContainerService/provisionedClusterInstances
{
connectedClusterResourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the connected cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: Properties of the provisioned cluster. ,
Required: False ,
}
{
linuxProfile:
{
Description: The profile for Linux VMs in the provisioned cluster. ,
Required: False ,
}
{
ssh:
{
Description: SSH configuration for VMs of the provisioned cluster. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with VMs. A maximum of 1 key may be specified. ,
Required: False ,
}
[
{
keyData:
{
Description: Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
controlPlane:
{
Description: The profile for control plane of the provisioned cluster. ,
Required: False ,
}
{
count:
{
Description: Number of control plane nodes. The default value is 1, and the count should be an odd number ,
Format: int32 ,
Required: False ,
}
integer ,
vmSize:
{
Description: VM sku size of the control plane nodes ,
Required: False ,
}
string ,
controlPlaneEndpoint:
{
Description: IP Address of the Kubernetes API server ,
Required: False ,
}
{
hostIP:
{
Description: IP address of the Kubernetes API server ,
Required: False ,
}
string ,
}
,
}
,
kubernetesVersion:
{
Description: The version of Kubernetes in use by the provisioned cluster. ,
Required: False ,
}
string ,
networkProfile:
{
Description: The network configuration profile for the provisioned cluster. ,
Required: False ,
}
{
loadBalancerProfile:
{
Description: Profile of the HA Proxy load balancer. ,
Required: False ,
}
{
count:
{
Description: Number of HA Proxy load balancer VMs. The default value is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
networkPolicy:
{
Description: Network policy used for building Kubernetes network. Possible values include: 'calico'. ,
Enum:
{
calico: No description available. ,
}
,
Required: False ,
}
enum ,
podCidr:
{
Description: A CIDR notation IP Address range from which to assign pod IPs. ,
Required: False ,
}
string ,
}
,
storageProfile:
{
Description: The storage configuration profile for the provisioned cluster. ,
Required: False ,
}
{
smbCsiDriver:
{
Description: SMB CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether to enable SMB CSI Driver. The default value is true. ,
Required: False ,
}
boolean ,
}
,
nfsCsiDriver:
{
Description: NFS CSI Driver settings for the storage profile. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether to enable NFS CSI Driver. The default value is true. ,
Required: False ,
}
boolean ,
}
,
}
,
clusterVMAccessProfile:
{
Description: The SSH restricted access profile for the VMs in the provisioned cluster. ,
Required: False ,
}
{
authorizedIPRanges:
{
Description: IP Address or CIDR for SSH access to VMs in the provisioned cluster ,
Required: False ,
}
string ,
}
,
agentPoolProfiles:
{
Description: The agent pool properties for the provisioned cluster. ,
Required: False ,
}
[
string ,
]
,
cloudProviderProfile:
{
Description: The profile for the underlying cloud infrastructure provider for the provisioned cluster. ,
Required: False ,
}
{
infraNetworkProfile:
{
Description: The profile for the infrastructure networks used by the provisioned cluster ,
Required: False ,
}
{
vnetSubnetIds:
{
Description: List of ARM resource Ids (maximum 1) for the infrastructure network object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName} ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
provisioningState:
{
Description: The status of the latest long running operation for the provisioned cluster. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed status of the provisioned cluster. ,
Required: False ,
}
{
controlPlaneStatus:
{
Description: The detailed status of the provisioned cluster components including addons. ,
Required: False ,
}
[
{
name:
{
Description: Name of the addon or component ,
Required: False ,
}
string ,
phase:
{
Description: Observed phase of the addon or component on the provisioned cluster. Possible values include: 'pending', 'provisioning', 'provisioning {HelmChartInstalled}', 'provisioning {MSICertificateDownloaded}', 'provisioned', 'deleting', 'failed', 'upgrading' ,
Enum:
{
pending: No description available. ,
provisioning: No description available. ,
provisioning {HelmChartInstalled}: No description available. ,
provisioning {MSICertificateDownloaded}: No description available. ,
provisioned: No description available. ,
deleting: No description available. ,
failed: No description available. ,
upgrading: No description available. ,
}
,
Required: False ,
}
enum ,
ready:
{
Description: Indicates whether the addon or component is ready ,
Required: False ,
}
boolean ,
errorMessage:
{
Description: Observed error message from the addon or component ,
Required: False ,
}
string ,
}
,
]
,
currentState:
{
Description: The current state of the provisioned cluster. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: Error messages during a provisioned cluster operation or steady state. ,
Required: False ,
}
string ,
}
,
licenseProfile:
{
Description: The license profile of the provisioned cluster. ,
Required: False ,
}
{
azureHybridBenefit:
{
Description: Indicates whether Azure Hybrid Benefit is opted in. Default value is false ,
Enum:
{
True: No description available. ,
False: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
autoScalerProfile:
{
Description: Parameters to be applied to the cluster-autoscaler when auto scaling is enabled for the provisioned cluster. ,
Required: False ,
}
{
balance-similar-node-groups:
{
Description: Valid values are 'true' and 'false' ,
Required: False ,
}
string ,
expander:
{
Description: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. ,
Enum:
{
least-waste: 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. ,
most-pods: 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. ,
priority: Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md). ,
random: Used when you don't have a particular need for the node groups to scale differently. ,
}
,
Required: False ,
}
enum ,
max-empty-bulk-delete:
{
Description: The default is 10. ,
Required: False ,
}
string ,
max-graceful-termination-sec:
{
Description: The default is 600. ,
Required: False ,
}
string ,
max-node-provision-time:
{
Description: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
max-total-unready-percentage:
{
Description: The default is 45. The maximum is 100 and the minimum is 0. ,
Required: False ,
}
string ,
new-pod-scale-up-delay:
{
Description: 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). ,
Required: False ,
}
string ,
ok-total-unready-count:
{
Description: This must be an integer. The default is 3. ,
Required: False ,
}
string ,
scan-interval:
{
Description: The default is '10'. Values must be an integer number of seconds. ,
Required: False ,
}
string ,
scale-down-delay-after-add:
{
Description: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-delay-after-delete:
{
Description: 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. ,
Required: False ,
}
string ,
scale-down-delay-after-failure:
{
Description: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-unneeded-time:
{
Description: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-unready-time:
{
Description: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. ,
Required: False ,
}
string ,
scale-down-utilization-threshold:
{
Description: The default is '0.5'. ,
Required: False ,
}
string ,
skip-nodes-with-local-storage:
{
Description: The default is true. ,
Required: False ,
}
string ,
skip-nodes-with-system-pods:
{
Description: The default is true. ,
Required: False ,
}
string ,
}
,
}
,
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
provisionedClusterInstances_GetUpgradeProfile (new)
Description :  Gets the upgrade profile of a provisioned cluster
Reference :  Link ¶

⚼ Request

GET:  /{connectedClusterResourceUri}/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default/upgradeProfiles/default
{
connectedClusterResourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the connected cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the upgrade profile. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
controlPlaneProfile:
{
Description: The list of available kubernetes version upgrades for the control plane. ,
Required: True ,
}
{
kubernetesVersion:
{
Description: The Kubernetes version (major.minor.patch). ,
Required: False ,
}
string ,
osType:
{
Description: OSType to be used to specify OS type for the VMs. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows' ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: False ,
}
enum ,
upgrades:
{
Description: List of available kubernetes versions for upgrade. ,
Required: False ,
}
[
{
kubernetesVersion:
{
Description: The Kubernetes version (major.minor.patch). ,
Required: False ,
}
string ,
isPreview:
{
Description: Whether the Kubernetes version is currently in preview. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridIdentityMetadata_Put (new)
Description :  Creates the hybrid identity metadata proxy resource that facilitates the managed identity provisioning.
Reference :  Link ¶

⚼ Request

PUT:  /{connectedClusterResourceUri}/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default/hybridIdentityMetadata/default
{
connectedClusterResourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the connected cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Hybrid Identity Metadata resource definition ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: True ,
}
{
resourceUid:
{
Description: Unique id of the parent provisioned cluster resource. ,
Required: False ,
}
string ,
publicKey:
{
Description: Onboarding public key for provisioning the Managed identity for the connected cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: True ,
}
{
resourceUid:
{
Description: Unique id of the parent provisioned cluster resource. ,
Required: False ,
}
string ,
publicKey:
{
Description: Onboarding public key for provisioning the Managed identity for the connected cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: True ,
}
{
resourceUid:
{
Description: Unique id of the parent provisioned cluster resource. ,
Required: False ,
}
string ,
publicKey:
{
Description: Onboarding public key for provisioning the Managed identity for the connected cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridIdentityMetadata_Get (new)
Description :  Get the hybrid identity metadata proxy resource.
Reference :  Link ¶

⚼ Request

GET:  /{connectedClusterResourceUri}/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default/hybridIdentityMetadata/default
{
connectedClusterResourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the connected cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: True ,
}
{
resourceUid:
{
Description: Unique id of the parent provisioned cluster resource. ,
Required: False ,
}
string ,
publicKey:
{
Description: Onboarding public key for provisioning the Managed identity for the connected cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridIdentityMetadata_Delete (new)
Description :  Deletes the hybrid identity metadata proxy resource.
Reference :  Link ¶

⚼ Request

DELETE:  /{connectedClusterResourceUri}/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default/hybridIdentityMetadata/default
{
connectedClusterResourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the connected cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridIdentityMetadata_ListByCluster (new)
Description :  Lists the hybrid identity metadata proxy resource in a provisioned cluster instance.
Reference :  Link ¶

⚼ Request

GET:  /{connectedClusterResourceUri}/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default/hybridIdentityMetadata
{
connectedClusterResourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the connected cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Url to follow for getting next page of hybridIdentityMetadata. ,
Required: False ,
}
string ,
value:
{
Description: Array of hybridIdentityMetadata ,
Required: True ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: True ,
}
{
resourceUid:
{
Description: Unique id of the parent provisioned cluster resource. ,
Required: False ,
}
string ,
publicKey:
{
Description: Onboarding public key for provisioning the Managed identity for the connected cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
agentPool_Get (new)
Description :  Gets the specified agent pool in the provisioned cluster
Reference :  Link ¶

⚼ Request

GET:  /{connectedClusterResourceUri}/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default/agentPools/{agentPoolName}
{
connectedClusterResourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the connected cluster resource. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: Parameter for the name of the agent pool in the provisioned cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the agent pool resource ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
agentPool_CreateOrUpdate (new)
Description :  Creates or updates the agent pool in the provisioned cluster
Reference :  Link ¶

⚼ Request

PUT:  /{connectedClusterResourceUri}/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default/agentPools/{agentPoolName}
{
connectedClusterResourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the connected cluster resource. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: Parameter for the name of the agent pool in the provisioned cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
agentPool:
{
Description: Agent Pool resource definition ,
Required: True ,
}
{
properties:
{
Description: Properties of the agent pool resource ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the agent pool resource ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the agent pool resource ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
agentPool_Delete (new)
Description :  Deletes the specified agent pool in the provisioned cluster
Reference :  Link ¶

⚼ Request

DELETE:  /{connectedClusterResourceUri}/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default/agentPools/{agentPoolName}
{
connectedClusterResourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the connected cluster resource. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: Parameter for the name of the agent pool in the provisioned cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
agentPool_ListByProvisionedCluster (new)
Description :  Gets the list of agent pools in the specified provisioned cluster
Reference :  Link ¶

⚼ Request

GET:  /{connectedClusterResourceUri}/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default/agentPools
{
connectedClusterResourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the connected cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: Properties of the agent pool resource ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
provisionedClusterInstances_ListUserKubeconfig (new)
Description :  Lists the user credentials of the provisioned cluster (can only be used within private network)
Reference :  Link ¶

⚼ Request

POST:  /{connectedClusterResourceUri}/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default/listUserKubeconfig
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
connectedClusterResourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the connected cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Operation Id ,
Required: False ,
}
string ,
name:
{
Description: Operation Name ,
Required: False ,
}
string ,
resourceId:
{
Description: ARM Resource Id of the provisioned cluster instance ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
kubeconfigs:
{
Description: Base64-encoded Kubernetes configuration file. ,
Required: False ,
}
[
{
name:
{
Description: The name of the credential. ,
Required: False ,
}
string ,
value:
{
Description: Base64-encoded Kubernetes configuration file. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
provisionedClusterInstances_ListAdminKubeconfig (new)
Description :  Lists the admin credentials of the provisioned cluster (can only be used within private network)
Reference :  Link ¶

⚼ Request

POST:  /{connectedClusterResourceUri}/providers/Microsoft.HybridContainerService/provisionedClusterInstances/default/listAdminKubeconfig
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
connectedClusterResourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the connected cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Operation Id ,
Required: False ,
}
string ,
name:
{
Description: Operation Name ,
Required: False ,
}
string ,
resourceId:
{
Description: ARM Resource Id of the provisioned cluster instance ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
kubeconfigs:
{
Description: Base64-encoded Kubernetes configuration file. ,
Required: False ,
}
[
{
name:
{
Description: The name of the credential. ,
Required: False ,
}
string ,
value:
{
Description: Base64-encoded Kubernetes configuration file. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GetKubernetesVersions (new)
Description :  Lists the supported kubernetes versions for the specified custom location
Reference :  Link ¶

⚼ Request

GET:  /{customLocationResourceUri}/providers/Microsoft.HybridContainerService/kubernetesVersions/default
{
customLocationResourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the custom location resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: List of supported Kubernetes versions ,
Required: False ,
}
[
{
version:
{
Description: major.minor version of Kubernetes release ,
Required: False ,
}
string ,
isPreview:
{
Description: Whether this version is in preview mode. ,
Required: False ,
}
boolean ,
patchVersions:
{
Description: Patch versions of a Kubernetes release ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PutKubernetesVersions (new)
Description :  Puts the default kubernetes version resource type (one time operation, before listing the kubernetes versions)
Reference :  Link ¶

⚼ Request

PUT:  /{customLocationResourceUri}/providers/Microsoft.HybridContainerService/kubernetesVersions/default
{
customLocationResourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the custom location resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
kubernetesVersions:
{
Description: Kubernetes Versions resource definition ,
Required: True ,
}
{
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: List of supported Kubernetes versions ,
Required: False ,
}
[
{
version:
{
Description: major.minor version of Kubernetes release ,
Required: False ,
}
string ,
isPreview:
{
Description: Whether this version is in preview mode. ,
Required: False ,
}
boolean ,
patchVersions:
{
Description: Patch versions of a Kubernetes release ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: List of supported Kubernetes versions ,
Required: False ,
}
[
{
version:
{
Description: major.minor version of Kubernetes release ,
Required: False ,
}
string ,
isPreview:
{
Description: Whether this version is in preview mode. ,
Required: False ,
}
boolean ,
patchVersions:
{
Description: Patch versions of a Kubernetes release ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: List of supported Kubernetes versions ,
Required: False ,
}
[
{
version:
{
Description: major.minor version of Kubernetes release ,
Required: False ,
}
string ,
isPreview:
{
Description: Whether this version is in preview mode. ,
Required: False ,
}
boolean ,
patchVersions:
{
Description: Patch versions of a Kubernetes release ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeleteKubernetesVersions (new)
Description :  Delete the default kubernetes versions resource type
Reference :  Link ¶

⚼ Request

DELETE:  /{customLocationResourceUri}/providers/Microsoft.HybridContainerService/kubernetesVersions/default
{
customLocationResourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the custom location resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
KubernetesVersions_List (new)
Description :  Lists the supported kubernetes versions for the specified custom location
Reference :  Link ¶

⚼ Request

GET:  /{customLocationResourceUri}/providers/Microsoft.HybridContainerService/kubernetesVersions
{
customLocationResourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the custom location resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: List of supported Kubernetes versions ,
Required: False ,
}
[
{
version:
{
Description: major.minor version of Kubernetes release ,
Required: False ,
}
string ,
isPreview:
{
Description: Whether this version is in preview mode. ,
Required: False ,
}
boolean ,
patchVersions:
{
Description: Patch versions of a Kubernetes release ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GetVMSkus (new)
Description :  Lists the supported VM skus for the specified custom location
Reference :  Link ¶

⚼ Request

GET:  /{customLocationResourceUri}/providers/Microsoft.HybridContainerService/skus/default
{
customLocationResourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the custom location resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: List of supported VM SKUs. ,
Required: False ,
}
[
{
resourceType:
{
Description: The type of resource the SKU applies to. ,
Required: False ,
}
string ,
capabilities:
{
Description: The list of name-value pairs to describe VM SKU capabilities like MemoryGB, vCPUs, etc. ,
Required: False ,
}
[
{
name:
{
Description: Name of the VM SKU capability ,
Required: False ,
}
string ,
value:
{
Description: Value of the VM SKU capability ,
Required: False ,
}
string ,
}
,
]
,
name:
{
Description: The name of the VM SKU ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the VM SKU ,
Required: False ,
}
string ,
size:
{
Description: The size of the VM SKU ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PutVMSkus (new)
Description :  Puts the default VM skus resource type (one time operation, before listing the VM skus)
Reference :  Link ¶

⚼ Request

PUT:  /{customLocationResourceUri}/providers/Microsoft.HybridContainerService/skus/default
{
customLocationResourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the custom location resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
skus:
{
Description: VM SKUs resource definition ,
Required: True ,
}
{
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: List of supported VM SKUs. ,
Required: False ,
}
[
{
resourceType:
{
Description: The type of resource the SKU applies to. ,
Required: False ,
}
string ,
capabilities:
{
Description: The list of name-value pairs to describe VM SKU capabilities like MemoryGB, vCPUs, etc. ,
Required: False ,
}
[
{
name:
{
Description: Name of the VM SKU capability ,
Required: False ,
}
string ,
value:
{
Description: Value of the VM SKU capability ,
Required: False ,
}
string ,
}
,
]
,
name:
{
Description: The name of the VM SKU ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the VM SKU ,
Required: False ,
}
string ,
size:
{
Description: The size of the VM SKU ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: List of supported VM SKUs. ,
Required: False ,
}
[
{
resourceType:
{
Description: The type of resource the SKU applies to. ,
Required: False ,
}
string ,
capabilities:
{
Description: The list of name-value pairs to describe VM SKU capabilities like MemoryGB, vCPUs, etc. ,
Required: False ,
}
[
{
name:
{
Description: Name of the VM SKU capability ,
Required: False ,
}
string ,
value:
{
Description: Value of the VM SKU capability ,
Required: False ,
}
string ,
}
,
]
,
name:
{
Description: The name of the VM SKU ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the VM SKU ,
Required: False ,
}
string ,
size:
{
Description: The size of the VM SKU ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: List of supported VM SKUs. ,
Required: False ,
}
[
{
resourceType:
{
Description: The type of resource the SKU applies to. ,
Required: False ,
}
string ,
capabilities:
{
Description: The list of name-value pairs to describe VM SKU capabilities like MemoryGB, vCPUs, etc. ,
Required: False ,
}
[
{
name:
{
Description: Name of the VM SKU capability ,
Required: False ,
}
string ,
value:
{
Description: Value of the VM SKU capability ,
Required: False ,
}
string ,
}
,
]
,
name:
{
Description: The name of the VM SKU ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the VM SKU ,
Required: False ,
}
string ,
size:
{
Description: The size of the VM SKU ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeleteVMSkus (new)
Description :  Deletes the default VM skus resource type
Reference :  Link ¶

⚼ Request

DELETE:  /{customLocationResourceUri}/providers/Microsoft.HybridContainerService/skus/default
{
customLocationResourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the custom location resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VMSkus_List (new)
Description :  Lists the supported VM skus for the specified custom location
Reference :  Link ¶

⚼ Request

GET:  /{customLocationResourceUri}/providers/Microsoft.HybridContainerService/skus
{
customLocationResourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the custom location resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Upgrading: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: List of supported VM SKUs. ,
Required: False ,
}
[
{
resourceType:
{
Description: The type of resource the SKU applies to. ,
Required: False ,
}
string ,
capabilities:
{
Description: The list of name-value pairs to describe VM SKU capabilities like MemoryGB, vCPUs, etc. ,
Required: False ,
}
[
{
name:
{
Description: Name of the VM SKU capability ,
Required: False ,
}
string ,
value:
{
Description: Value of the VM SKU capability ,
Required: False ,
}
string ,
}
,
]
,
name:
{
Description: The name of the VM SKU ,
Required: False ,
}
string ,
tier:
{
Description: The tier of the VM SKU ,
Required: False ,
}
string ,
size:
{
Description: The size of the VM SKU ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Lists the supported operations
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.HybridContainerService/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
virtualNetworks_Retrieve (new)
Description :  Gets the specified virtual network resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks/{virtualNetworkName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualNetworkName:
{
Description: Parameter for the name of the virtual network ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the virtual network resource ,
Required: False ,
}
{
infraVnetProfile:
{
Required: False ,
}
{
hci:
{
Description: Infrastructure network profile for HCI platform ,
Required: False ,
}
{
mocGroup:
{
Description: Group in MOC(Microsoft On-premises Cloud) ,
Required: False ,
}
string ,
mocLocation:
{
Description: Location in MOC(Microsoft On-premises Cloud) ,
Required: False ,
}
string ,
mocVnetName:
{
Description: Virtual Network name in MOC(Microsoft On-premises Cloud) ,
Required: False ,
}
string ,
}
,
}
,
vipPool:
{
Description: Range of IP Addresses for Kubernetes API Server and services if using HA Proxy load balancer ,
Required: False ,
}
[
{
endIP:
{
Description: Ending IP address for the IP Pool ,
Required: False ,
}
string ,
startIP:
{
Description: Starting IP address for the IP Pool ,
Required: False ,
}
string ,
}
,
]
,
vmipPool:
{
Description: Range of IP Addresses for Kubernetes node VMs ,
Required: False ,
}
[
{
endIP:
{
Description: Ending IP address for the IP Pool ,
Required: False ,
}
string ,
startIP:
{
Description: Starting IP address for the IP Pool ,
Required: False ,
}
string ,
}
,
]
,
dnsServers:
{
Description: List of DNS server IP Addresses associated with the network ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: IP Address of the Gateway associated with the network ,
Required: False ,
}
string ,
ipAddressPrefix:
{
Description: IP Address Prefix of the network ,
Required: False ,
}
string ,
vlanID:
{
Description: VLAN Id used by the network ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the virtual network resource ,
Required: False ,
}
{
operationStatus:
{
Description: The detailed status of the long running operation. ,
Required: False ,
}
{
error:
{
Description: The error if any from the operation. ,
Required: False ,
}
{
code:
{
Description: The error code from the operation. ,
Required: False ,
}
string ,
message:
{
Description: The error message from the operation. ,
Required: False ,
}
string ,
}
,
operationId:
{
Description: The identifier of the operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation. ,
Required: False ,
}
string ,
}
,
}
,
}
,
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
virtualNetworks_CreateOrUpdate (new)
Description :  Creates or updates the virtual network resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks/{virtualNetworkName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualNetworkName:
{
Description: Parameter for the name of the virtual network ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
virtualNetworks:
{
Description: Virtual Network resource definition ,
Required: True ,
}
{
properties:
{
Description: Properties of the virtual network resource ,
Required: False ,
}
{
infraVnetProfile:
{
Required: False ,
}
{
hci:
{
Description: Infrastructure network profile for HCI platform ,
Required: False ,
}
{
mocGroup:
{
Description: Group in MOC(Microsoft On-premises Cloud) ,
Required: False ,
}
string ,
mocLocation:
{
Description: Location in MOC(Microsoft On-premises Cloud) ,
Required: False ,
}
string ,
mocVnetName:
{
Description: Virtual Network name in MOC(Microsoft On-premises Cloud) ,
Required: False ,
}
string ,
}
,
}
,
vipPool:
{
Description: Range of IP Addresses for Kubernetes API Server and services if using HA Proxy load balancer ,
Required: False ,
}
[
{
endIP:
{
Description: Ending IP address for the IP Pool ,
Required: False ,
}
string ,
startIP:
{
Description: Starting IP address for the IP Pool ,
Required: False ,
}
string ,
}
,
]
,
vmipPool:
{
Description: Range of IP Addresses for Kubernetes node VMs ,
Required: False ,
}
[
{
endIP:
{
Description: Ending IP address for the IP Pool ,
Required: False ,
}
string ,
startIP:
{
Description: Starting IP address for the IP Pool ,
Required: False ,
}
string ,
}
,
]
,
dnsServers:
{
Description: List of DNS server IP Addresses associated with the network ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: IP Address of the Gateway associated with the network ,
Required: False ,
}
string ,
ipAddressPrefix:
{
Description: IP Address Prefix of the network ,
Required: False ,
}
string ,
vlanID:
{
Description: VLAN Id used by the network ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the virtual network resource ,
Required: False ,
}
{
operationStatus:
{
Description: The detailed status of the long running operation. ,
Required: False ,
}
{
error:
{
Description: The error if any from the operation. ,
Required: False ,
}
{
code:
{
Description: The error code from the operation. ,
Required: False ,
}
string ,
message:
{
Description: The error message from the operation. ,
Required: False ,
}
string ,
}
,
operationId:
{
Description: The identifier of the operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation. ,
Required: False ,
}
string ,
}
,
}
,
}
,
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the virtual network resource ,
Required: False ,
}
{
infraVnetProfile:
{
Required: False ,
}
{
hci:
{
Description: Infrastructure network profile for HCI platform ,
Required: False ,
}
{
mocGroup:
{
Description: Group in MOC(Microsoft On-premises Cloud) ,
Required: False ,
}
string ,
mocLocation:
{
Description: Location in MOC(Microsoft On-premises Cloud) ,
Required: False ,
}
string ,
mocVnetName:
{
Description: Virtual Network name in MOC(Microsoft On-premises Cloud) ,
Required: False ,
}
string ,
}
,
}
,
vipPool:
{
Description: Range of IP Addresses for Kubernetes API Server and services if using HA Proxy load balancer ,
Required: False ,
}
[
{
endIP:
{
Description: Ending IP address for the IP Pool ,
Required: False ,
}
string ,
startIP:
{
Description: Starting IP address for the IP Pool ,
Required: False ,
}
string ,
}
,
]
,
vmipPool:
{
Description: Range of IP Addresses for Kubernetes node VMs ,
Required: False ,
}
[
{
endIP:
{
Description: Ending IP address for the IP Pool ,
Required: False ,
}
string ,
startIP:
{
Description: Starting IP address for the IP Pool ,
Required: False ,
}
string ,
}
,
]
,
dnsServers:
{
Description: List of DNS server IP Addresses associated with the network ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: IP Address of the Gateway associated with the network ,
Required: False ,
}
string ,
ipAddressPrefix:
{
Description: IP Address Prefix of the network ,
Required: False ,
}
string ,
vlanID:
{
Description: VLAN Id used by the network ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the virtual network resource ,
Required: False ,
}
{
operationStatus:
{
Description: The detailed status of the long running operation. ,
Required: False ,
}
{
error:
{
Description: The error if any from the operation. ,
Required: False ,
}
{
code:
{
Description: The error code from the operation. ,
Required: False ,
}
string ,
message:
{
Description: The error message from the operation. ,
Required: False ,
}
string ,
}
,
operationId:
{
Description: The identifier of the operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation. ,
Required: False ,
}
string ,
}
,
}
,
}
,
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the virtual network resource ,
Required: False ,
}
{
infraVnetProfile:
{
Required: False ,
}
{
hci:
{
Description: Infrastructure network profile for HCI platform ,
Required: False ,
}
{
mocGroup:
{
Description: Group in MOC(Microsoft On-premises Cloud) ,
Required: False ,
}
string ,
mocLocation:
{
Description: Location in MOC(Microsoft On-premises Cloud) ,
Required: False ,
}
string ,
mocVnetName:
{
Description: Virtual Network name in MOC(Microsoft On-premises Cloud) ,
Required: False ,
}
string ,
}
,
}
,
vipPool:
{
Description: Range of IP Addresses for Kubernetes API Server and services if using HA Proxy load balancer ,
Required: False ,
}
[
{
endIP:
{
Description: Ending IP address for the IP Pool ,
Required: False ,
}
string ,
startIP:
{
Description: Starting IP address for the IP Pool ,
Required: False ,
}
string ,
}
,
]
,
vmipPool:
{
Description: Range of IP Addresses for Kubernetes node VMs ,
Required: False ,
}
[
{
endIP:
{
Description: Ending IP address for the IP Pool ,
Required: False ,
}
string ,
startIP:
{
Description: Starting IP address for the IP Pool ,
Required: False ,
}
string ,
}
,
]
,
dnsServers:
{
Description: List of DNS server IP Addresses associated with the network ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: IP Address of the Gateway associated with the network ,
Required: False ,
}
string ,
ipAddressPrefix:
{
Description: IP Address Prefix of the network ,
Required: False ,
}
string ,
vlanID:
{
Description: VLAN Id used by the network ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the virtual network resource ,
Required: False ,
}
{
operationStatus:
{
Description: The detailed status of the long running operation. ,
Required: False ,
}
{
error:
{
Description: The error if any from the operation. ,
Required: False ,
}
{
code:
{
Description: The error code from the operation. ,
Required: False ,
}
string ,
message:
{
Description: The error message from the operation. ,
Required: False ,
}
string ,
}
,
operationId:
{
Description: The identifier of the operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation. ,
Required: False ,
}
string ,
}
,
}
,
}
,
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
virtualNetworks_Delete (new)
Description :  Deletes the specified virtual network resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks/{virtualNetworkName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualNetworkName:
{
Description: Parameter for the name of the virtual network ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
virtualNetworks_Update (new)
Description :  Patches the virtual network resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks/{virtualNetworkName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualNetworkName:
{
Description: Parameter for the name of the virtual network ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
virtualNetworks:
{
Description: Virtual Network resource patch definition ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the virtual network resource ,
Required: False ,
}
{
infraVnetProfile:
{
Required: False ,
}
{
hci:
{
Description: Infrastructure network profile for HCI platform ,
Required: False ,
}
{
mocGroup:
{
Description: Group in MOC(Microsoft On-premises Cloud) ,
Required: False ,
}
string ,
mocLocation:
{
Description: Location in MOC(Microsoft On-premises Cloud) ,
Required: False ,
}
string ,
mocVnetName:
{
Description: Virtual Network name in MOC(Microsoft On-premises Cloud) ,
Required: False ,
}
string ,
}
,
}
,
vipPool:
{
Description: Range of IP Addresses for Kubernetes API Server and services if using HA Proxy load balancer ,
Required: False ,
}
[
{
endIP:
{
Description: Ending IP address for the IP Pool ,
Required: False ,
}
string ,
startIP:
{
Description: Starting IP address for the IP Pool ,
Required: False ,
}
string ,
}
,
]
,
vmipPool:
{
Description: Range of IP Addresses for Kubernetes node VMs ,
Required: False ,
}
[
{
endIP:
{
Description: Ending IP address for the IP Pool ,
Required: False ,
}
string ,
startIP:
{
Description: Starting IP address for the IP Pool ,
Required: False ,
}
string ,
}
,
]
,
dnsServers:
{
Description: List of DNS server IP Addresses associated with the network ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: IP Address of the Gateway associated with the network ,
Required: False ,
}
string ,
ipAddressPrefix:
{
Description: IP Address Prefix of the network ,
Required: False ,
}
string ,
vlanID:
{
Description: VLAN Id used by the network ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the virtual network resource ,
Required: False ,
}
{
operationStatus:
{
Description: The detailed status of the long running operation. ,
Required: False ,
}
{
error:
{
Description: The error if any from the operation. ,
Required: False ,
}
{
code:
{
Description: The error code from the operation. ,
Required: False ,
}
string ,
message:
{
Description: The error message from the operation. ,
Required: False ,
}
string ,
}
,
operationId:
{
Description: The identifier of the operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation. ,
Required: False ,
}
string ,
}
,
}
,
}
,
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
virtualNetworks_ListByResourceGroup (new)
Description :  Lists the virtual networks in the specified resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: Properties of the virtual network resource ,
Required: False ,
}
{
infraVnetProfile:
{
Required: False ,
}
{
hci:
{
Description: Infrastructure network profile for HCI platform ,
Required: False ,
}
{
mocGroup:
{
Description: Group in MOC(Microsoft On-premises Cloud) ,
Required: False ,
}
string ,
mocLocation:
{
Description: Location in MOC(Microsoft On-premises Cloud) ,
Required: False ,
}
string ,
mocVnetName:
{
Description: Virtual Network name in MOC(Microsoft On-premises Cloud) ,
Required: False ,
}
string ,
}
,
}
,
vipPool:
{
Description: Range of IP Addresses for Kubernetes API Server and services if using HA Proxy load balancer ,
Required: False ,
}
[
{
endIP:
{
Description: Ending IP address for the IP Pool ,
Required: False ,
}
string ,
startIP:
{
Description: Starting IP address for the IP Pool ,
Required: False ,
}
string ,
}
,
]
,
vmipPool:
{
Description: Range of IP Addresses for Kubernetes node VMs ,
Required: False ,
}
[
{
endIP:
{
Description: Ending IP address for the IP Pool ,
Required: False ,
}
string ,
startIP:
{
Description: Starting IP address for the IP Pool ,
Required: False ,
}
string ,
}
,
]
,
dnsServers:
{
Description: List of DNS server IP Addresses associated with the network ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: IP Address of the Gateway associated with the network ,
Required: False ,
}
string ,
ipAddressPrefix:
{
Description: IP Address Prefix of the network ,
Required: False ,
}
string ,
vlanID:
{
Description: VLAN Id used by the network ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the virtual network resource ,
Required: False ,
}
{
operationStatus:
{
Description: The detailed status of the long running operation. ,
Required: False ,
}
{
error:
{
Description: The error if any from the operation. ,
Required: False ,
}
{
code:
{
Description: The error code from the operation. ,
Required: False ,
}
string ,
message:
{
Description: The error message from the operation. ,
Required: False ,
}
string ,
}
,
operationId:
{
Description: The identifier of the operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation. ,
Required: False ,
}
string ,
}
,
}
,
}
,
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
virtualNetworks_ListBySubscription (new)
Description :  Lists the virtual networks in the specified subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridContainerService/virtualNetworks
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: Properties of the virtual network resource ,
Required: False ,
}
{
infraVnetProfile:
{
Required: False ,
}
{
hci:
{
Description: Infrastructure network profile for HCI platform ,
Required: False ,
}
{
mocGroup:
{
Description: Group in MOC(Microsoft On-premises Cloud) ,
Required: False ,
}
string ,
mocLocation:
{
Description: Location in MOC(Microsoft On-premises Cloud) ,
Required: False ,
}
string ,
mocVnetName:
{
Description: Virtual Network name in MOC(Microsoft On-premises Cloud) ,
Required: False ,
}
string ,
}
,
}
,
vipPool:
{
Description: Range of IP Addresses for Kubernetes API Server and services if using HA Proxy load balancer ,
Required: False ,
}
[
{
endIP:
{
Description: Ending IP address for the IP Pool ,
Required: False ,
}
string ,
startIP:
{
Description: Starting IP address for the IP Pool ,
Required: False ,
}
string ,
}
,
]
,
vmipPool:
{
Description: Range of IP Addresses for Kubernetes node VMs ,
Required: False ,
}
[
{
endIP:
{
Description: Ending IP address for the IP Pool ,
Required: False ,
}
string ,
startIP:
{
Description: Starting IP address for the IP Pool ,
Required: False ,
}
string ,
}
,
]
,
dnsServers:
{
Description: List of DNS server IP Addresses associated with the network ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: IP Address of the Gateway associated with the network ,
Required: False ,
}
string ,
ipAddressPrefix:
{
Description: IP Address Prefix of the network ,
Required: False ,
}
string ,
vlanID:
{
Description: VLAN Id used by the network ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the virtual network resource ,
Required: False ,
}
{
operationStatus:
{
Description: The detailed status of the long running operation. ,
Required: False ,
}
{
error:
{
Description: The error if any from the operation. ,
Required: False ,
}
{
code:
{
Description: The error code from the operation. ,
Required: False ,
}
string ,
message:
{
Description: The error message from the operation. ,
Required: False ,
}
string ,
}
,
operationId:
{
Description: The identifier of the operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation. ,
Required: False ,
}
string ,
}
,
}
,
}
,
extendedLocation:
{
Description: Extended location pointing to the underlying infrastructure ,
Required: False ,
}
{
type:
{
Description: The extended location type. Allowed value: 'CustomLocation' ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: ARM Id of the extended location. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}