Microsoft.ServiceFabric (preview:2020-01-01)

2025/09/26 • 17 new, 17 deleted methods

ManagedClusters_ListByResourceGroup (new)
Description :  Gets all Service Fabric cluster resources created or in the process of being created in the resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: the cluster Fully qualified domain name. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprint:
{
Description: The cluster certificate thumbprint used node to node communication. ,
Required: False ,
}
string ,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for http connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: vm admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: vm admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Describes load balancing rules. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
clients:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Whether the certificate is admin or not. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate Common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: Azure active directory. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
addonFeatures:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagedClusters_ListBySubscription (new)
Description :  Gets all Service Fabric cluster resources created or in the process of being created in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/managedClusters
{
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: the cluster Fully qualified domain name. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprint:
{
Description: The cluster certificate thumbprint used node to node communication. ,
Required: False ,
}
string ,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for http connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: vm admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: vm admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Describes load balancing rules. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
clients:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Whether the certificate is admin or not. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate Common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: Azure active directory. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
addonFeatures:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagedClusters_Get (new)
Description :  Get a Service Fabric managed cluster resource created or in the process of being created in the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: the cluster Fully qualified domain name. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprint:
{
Description: The cluster certificate thumbprint used node to node communication. ,
Required: False ,
}
string ,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for http connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: vm admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: vm admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Describes load balancing rules. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
clients:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Whether the certificate is admin or not. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate Common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: Azure active directory. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
addonFeatures:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagedClusters_CreateOrUpdate (new)
Description :  Create or update a Service Fabric managed cluster resource with the specified name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: The cluster resource. ,
Required: True ,
}
{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: the cluster Fully qualified domain name. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprint:
{
Description: The cluster certificate thumbprint used node to node communication. ,
Required: False ,
}
string ,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for http connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: vm admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: vm admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Describes load balancing rules. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
clients:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Whether the certificate is admin or not. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate Common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: Azure active directory. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
addonFeatures:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: the cluster Fully qualified domain name. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprint:
{
Description: The cluster certificate thumbprint used node to node communication. ,
Required: False ,
}
string ,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for http connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: vm admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: vm admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Describes load balancing rules. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
clients:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Whether the certificate is admin or not. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate Common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: Azure active directory. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
addonFeatures:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: the cluster Fully qualified domain name. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprint:
{
Description: The cluster certificate thumbprint used node to node communication. ,
Required: False ,
}
string ,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for http connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: vm admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: vm admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Describes load balancing rules. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
clients:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Whether the certificate is admin or not. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate Common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: Azure active directory. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
addonFeatures:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: the cluster Fully qualified domain name. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprint:
{
Description: The cluster certificate thumbprint used node to node communication. ,
Required: False ,
}
string ,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for http connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: vm admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: vm admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Describes load balancing rules. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
clients:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Whether the certificate is admin or not. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate Common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: Azure active directory. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
addonFeatures:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagedClusters_Update (new)
Description :  Update the configuration of a Service Fabric managed cluster resource with the specified name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to update the managed cluster configuration. ,
Required: True ,
}
{
properties:
{
Description: Describes the managed cluster resource properties. ,
Required: False ,
}
{
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for http connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
loadBalancingRules:
{
Description: Describes load balancing rules. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
clients:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Whether the certificate is admin or not. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate Common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: Azure active directory. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
addonFeatures:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: Managed cluster update parameters ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: the cluster Fully qualified domain name. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprint:
{
Description: The cluster certificate thumbprint used node to node communication. ,
Required: False ,
}
string ,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for http connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: vm admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: vm admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Describes load balancing rules. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
clients:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Whether the certificate is admin or not. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate Common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: Azure active directory. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
addonFeatures:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: the cluster Fully qualified domain name. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprint:
{
Description: The cluster certificate thumbprint used node to node communication. ,
Required: False ,
}
string ,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for http connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: vm admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: vm admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Describes load balancing rules. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
clients:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Whether the certificate is admin or not. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate Common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: Azure active directory. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
addonFeatures:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagedClusters_Delete (new)
Description :  Delete a Service Fabric managed cluster resource with the specified name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Operations_List (new)
Description :  Get the list of available Service Fabric resource provider API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ServiceFabric/operations
{
api-version:
{
Description: The version of the Service Fabric resource provider API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the Service Fabric resource provider. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation. ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: The name of the provider. ,
Required: False ,
}
string ,
resource:
{
Description: The resource on which the operation is performed ,
Required: False ,
}
string ,
operation:
{
Description: The operation that can be performed. ,
Required: False ,
}
string ,
description:
{
Description: Operation description ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin result ,
Required: False ,
}
string ,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagedClusterVersions_ListByOS (new)
Description :  Gets all available code versions for Service Fabric cluster resources by OS type.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/managedclusters/locations/{location}/osType/{osType}/clusterVersions
{
location:
{
Description: The location for the cluster code versions. This is different from cluster location. ,
Required: True ,
}
string ,
osType:
{
Description: The operating system of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
msiVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
osType:
{
Description: Indicates the operating system of the cluster. ,
Enum:
{
Windows: No description available. ,
Ubuntu: No description available. ,
RedHat: No description available. ,
Ubuntu18_04: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Operations_List (new)
Description :  Get the list of available Service Fabric resource provider API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ServiceFabric/operations
{
api-version:
{
Description: The version of the Service Fabric resource provider API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the Service Fabric resource provider. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation. ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: The name of the provider. ,
Required: False ,
}
string ,
resource:
{
Description: The resource on which the operation is performed ,
Required: False ,
}
string ,
operation:
{
Description: The operation that can be performed. ,
Required: False ,
}
string ,
description:
{
Description: Operation description ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin result ,
Required: False ,
}
string ,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
NodeTypes_ListByManagedClusters (new)
Description :  Gets all Node types of the specified managed cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of node types. ,
Required: False ,
}
[
{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
NodeTypes_Restart (new)
Description :  Restarts one or more nodes on the node type. It will disable the fabric nodes, trigger a restart on the VMs and activate the nodes back again.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/restart
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: parameters for restart action. ,
Required: True ,
}
{
nodes:
{
Description: List of node names from the node type. ,
Required: True ,
}
[
string ,
]
,
force:
{
Description: Force the action to go through. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
NodeTypes_Reimage (new)
Description :  Reimages one or more nodes on the node type. It will disable the fabric nodes, trigger a reimage on the VMs and activate the nodes back again.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/reimage
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: parameters for reimage action. ,
Required: True ,
}
{
nodes:
{
Description: List of node names from the node type. ,
Required: True ,
}
[
string ,
]
,
force:
{
Description: Force the action to go through. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
NodeTypes_DeleteNode (new)
Description :  Deletes one or more nodes on the node type. It will disable the fabric nodes, trigger a delete on the VMs and removes the state from the cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/deleteNode
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: parameters for delete action. ,
Required: True ,
}
{
nodes:
{
Description: List of node names from the node type. ,
Required: True ,
}
[
string ,
]
,
force:
{
Description: Force the action to go through. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
NodeTypes_Get (new)
Description :  Get a Service Fabric node type of a given managed cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
NodeTypes_CreateOrUpdate (new)
Description :  Create or update a Service Fabric node type of a given managed cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The node type resource. ,
Required: True ,
}
{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
NodeTypes_Update (new)
Description :  Update the configuration of a node type of a given managed cluster.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to update the node type configuration. ,
Required: True ,
}
{
properties:
{
Description: Node type update properties. ,
Required: False ,
}
{
vmInstanceCount:
{
Description: The number of nodes in the node type. ,
Format: int32 ,
Required: False ,
}
integer ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
tags:
{
Description: Node type update parameters ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
NodeTypes_Delete (new)
Description :  Delete a Service Fabric node type of a given managed cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagedClusters_ListByResourceGroup (removed)
Description :  Gets all Service Fabric cluster resources created or in the process of being created in the resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: the cluster Fully qualified domain name. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprint:
{
Description: The cluster certificate thumbprint used node to node communication. ,
Required: False ,
}
string ,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for http connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: vm admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: vm admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Describes load balancing rules. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
clients:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Whether the certificate is admin or not. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate Common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: Azure active directory. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
addonFeatures:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagedClusters_ListBySubscription (removed)
Description :  Gets all Service Fabric cluster resources created or in the process of being created in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/managedClusters
{
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: the cluster Fully qualified domain name. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprint:
{
Description: The cluster certificate thumbprint used node to node communication. ,
Required: False ,
}
string ,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for http connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: vm admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: vm admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Describes load balancing rules. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
clients:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Whether the certificate is admin or not. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate Common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: Azure active directory. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
addonFeatures:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagedClusters_Get (removed)
Description :  Get a Service Fabric managed cluster resource created or in the process of being created in the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: the cluster Fully qualified domain name. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprint:
{
Description: The cluster certificate thumbprint used node to node communication. ,
Required: False ,
}
string ,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for http connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: vm admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: vm admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Describes load balancing rules. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
clients:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Whether the certificate is admin or not. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate Common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: Azure active directory. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
addonFeatures:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagedClusters_CreateOrUpdate (removed)
Description :  Create or update a Service Fabric managed cluster resource with the specified name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: The cluster resource. ,
Required: True ,
}
{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: the cluster Fully qualified domain name. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprint:
{
Description: The cluster certificate thumbprint used node to node communication. ,
Required: False ,
}
string ,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for http connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: vm admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: vm admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Describes load balancing rules. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
clients:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Whether the certificate is admin or not. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate Common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: Azure active directory. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
addonFeatures:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: the cluster Fully qualified domain name. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprint:
{
Description: The cluster certificate thumbprint used node to node communication. ,
Required: False ,
}
string ,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for http connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: vm admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: vm admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Describes load balancing rules. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
clients:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Whether the certificate is admin or not. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate Common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: Azure active directory. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
addonFeatures:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: the cluster Fully qualified domain name. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprint:
{
Description: The cluster certificate thumbprint used node to node communication. ,
Required: False ,
}
string ,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for http connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: vm admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: vm admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Describes load balancing rules. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
clients:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Whether the certificate is admin or not. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate Common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: Azure active directory. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
addonFeatures:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: the cluster Fully qualified domain name. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprint:
{
Description: The cluster certificate thumbprint used node to node communication. ,
Required: False ,
}
string ,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for http connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: vm admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: vm admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Describes load balancing rules. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
clients:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Whether the certificate is admin or not. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate Common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: Azure active directory. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
addonFeatures:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagedClusters_Update (removed)
Description :  Update the configuration of a Service Fabric managed cluster resource with the specified name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to update the managed cluster configuration. ,
Required: True ,
}
{
properties:
{
Description: Describes the managed cluster resource properties. ,
Required: False ,
}
{
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for http connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
loadBalancingRules:
{
Description: Describes load balancing rules. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
clients:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Whether the certificate is admin or not. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate Common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: Azure active directory. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
addonFeatures:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: Managed cluster update parameters ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: the cluster Fully qualified domain name. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprint:
{
Description: The cluster certificate thumbprint used node to node communication. ,
Required: False ,
}
string ,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for http connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: vm admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: vm admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Describes load balancing rules. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
clients:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Whether the certificate is admin or not. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate Common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: Azure active directory. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
addonFeatures:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: the cluster Fully qualified domain name. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: No description available. ,
Deploying: No description available. ,
BaselineUpgrade: No description available. ,
UpdatingUserConfiguration: No description available. ,
UpdatingUserCertificate: No description available. ,
UpdatingInfrastructure: No description available. ,
EnforcingClusterVersion: No description available. ,
UpgradeServiceUnreachable: No description available. ,
AutoScale: No description available. ,
Ready: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprint:
{
Description: The cluster certificate thumbprint used node to node communication. ,
Required: False ,
}
string ,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for http connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: vm admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: vm admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Describes load balancing rules. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
}
,
Required: True ,
}
enum ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: No description available. ,
http: No description available. ,
https: No description available. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
}
,
]
,
clients:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Whether the certificate is admin or not. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate Thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate Common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: Azure active directory. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
addonFeatures:
{
Description: client certificates for the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: The sku of the managed cluster ,
Required: False ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagedClusters_Delete (removed)
Description :  Delete a Service Fabric managed cluster resource with the specified name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Operations_List (removed)
Description :  Get the list of available Service Fabric resource provider API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ServiceFabric/operations
{
api-version:
{
Description: The version of the Service Fabric resource provider API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the Service Fabric resource provider. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation. ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: The name of the provider. ,
Required: False ,
}
string ,
resource:
{
Description: The resource on which the operation is performed ,
Required: False ,
}
string ,
operation:
{
Description: The operation that can be performed. ,
Required: False ,
}
string ,
description:
{
Description: Operation description ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin result ,
Required: False ,
}
string ,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ManagedClusterVersions_ListByOS (removed)
Description :  Gets all available code versions for Service Fabric cluster resources by OS type.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/managedclusters/locations/{location}/osType/{osType}/clusterVersions
{
location:
{
Description: The location for the cluster code versions. This is different from cluster location. ,
Required: True ,
}
string ,
osType:
{
Description: The operating system of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
msiVersion:
{
Description: The Service Fabric runtime version of the cluster. ,
Required: False ,
}
string ,
supportExpiryUtc:
{
Description: The date of expiry of support of the version. ,
Required: False ,
}
string ,
osType:
{
Description: Indicates the operating system of the cluster. ,
Enum:
{
Windows: No description available. ,
Ubuntu: No description available. ,
RedHat: No description available. ,
Ubuntu18_04: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Operations_List (removed)
Description :  Get the list of available Service Fabric resource provider API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ServiceFabric/operations
{
api-version:
{
Description: The version of the Service Fabric resource provider API ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the Service Fabric resource provider. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation. ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: The name of the provider. ,
Required: False ,
}
string ,
resource:
{
Description: The resource on which the operation is performed ,
Required: False ,
}
string ,
operation:
{
Description: The operation that can be performed. ,
Required: False ,
}
string ,
description:
{
Description: Operation description ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin result ,
Required: False ,
}
string ,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
NodeTypes_ListByManagedClusters (removed)
Description :  Gets all Node types of the specified managed cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of node types. ,
Required: False ,
}
[
{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
NodeTypes_Restart (removed)
Description :  Restarts one or more nodes on the node type. It will disable the fabric nodes, trigger a restart on the VMs and activate the nodes back again.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/restart
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: parameters for restart action. ,
Required: True ,
}
{
nodes:
{
Description: List of node names from the node type. ,
Required: True ,
}
[
string ,
]
,
force:
{
Description: Force the action to go through. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
NodeTypes_Reimage (removed)
Description :  Reimages one or more nodes on the node type. It will disable the fabric nodes, trigger a reimage on the VMs and activate the nodes back again.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/reimage
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: parameters for reimage action. ,
Required: True ,
}
{
nodes:
{
Description: List of node names from the node type. ,
Required: True ,
}
[
string ,
]
,
force:
{
Description: Force the action to go through. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
NodeTypes_DeleteNode (removed)
Description :  Deletes one or more nodes on the node type. It will disable the fabric nodes, trigger a delete on the VMs and removes the state from the cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/deleteNode
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: parameters for delete action. ,
Required: True ,
}
{
nodes:
{
Description: List of node names from the node type. ,
Required: True ,
}
[
string ,
]
,
force:
{
Description: Force the action to go through. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
NodeTypes_Get (removed)
Description :  Get a Service Fabric node type of a given managed cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
NodeTypes_CreateOrUpdate (removed)
Description :  Create or update a Service Fabric node type of a given managed cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The node type resource. ,
Required: True ,
}
{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
NodeTypes_Update (removed)
Description :  Update the configuration of a node type of a given managed cluster.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to update the node type configuration. ,
Required: True ,
}
{
properties:
{
Description: Node type update properties. ,
Required: False ,
}
{
vmInstanceCount:
{
Description: The number of nodes in the node type. ,
Format: int32 ,
Required: False ,
}
integer ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
tags:
{
Description: Node type update parameters ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
} ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
NodeTypes_Delete (removed)
Description :  Delete a Service Fabric node type of a given managed cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}
{
subscriptionId:
{
Description: The customer subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2020-01-01-preview" for this specification. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}