1. Packages
  2. Azure Native
  3. API Docs
  4. servicefabric
  5. getManagedCluster
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.servicefabric.getManagedCluster

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Get a Service Fabric managed cluster resource created or in the process of being created in the specified resource group.

Uses Azure REST API version 2024-04-01.

Other available API versions: 2023-03-01-preview, 2023-07-01-preview, 2023-09-01-preview, 2023-11-01-preview, 2023-12-01-preview, 2024-02-01-preview, 2024-06-01-preview, 2024-09-01-preview, 2024-11-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native servicefabric [ApiVersion]. See the version guide for details.

Using getManagedCluster

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getManagedCluster(args: GetManagedClusterArgs, opts?: InvokeOptions): Promise<GetManagedClusterResult>
function getManagedClusterOutput(args: GetManagedClusterOutputArgs, opts?: InvokeOptions): Output<GetManagedClusterResult>
Copy
def get_managed_cluster(cluster_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetManagedClusterResult
def get_managed_cluster_output(cluster_name: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetManagedClusterResult]
Copy
func LookupManagedCluster(ctx *Context, args *LookupManagedClusterArgs, opts ...InvokeOption) (*LookupManagedClusterResult, error)
func LookupManagedClusterOutput(ctx *Context, args *LookupManagedClusterOutputArgs, opts ...InvokeOption) LookupManagedClusterResultOutput
Copy

> Note: This function is named LookupManagedCluster in the Go SDK.

public static class GetManagedCluster 
{
    public static Task<GetManagedClusterResult> InvokeAsync(GetManagedClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetManagedClusterResult> Invoke(GetManagedClusterInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetManagedClusterResult> getManagedCluster(GetManagedClusterArgs args, InvokeOptions options)
public static Output<GetManagedClusterResult> getManagedCluster(GetManagedClusterArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:servicefabric:getManagedCluster
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the cluster resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
clusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
cluster_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the cluster resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the cluster resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.

getManagedCluster Result

The following output properties are available:

AdminUserName string
VM admin user name.
AzureApiVersion string
The Azure API version of the resource.
ClusterCertificateThumbprints List<string>
List of thumbprints of the cluster certificates.
ClusterId string
A service generated unique identifier for the cluster resource.
ClusterState string
The current state of the cluster.
DnsName string
The cluster dns name.
Etag string
Azure resource etag.
Fqdn string
The fully qualified domain name associated with the public load balancer of the cluster.
Id string
Azure resource identifier.
Ipv4Address string
The IPv4 address associated with the public load balancer of the cluster.
Ipv6Address string
IPv6 address for the cluster if IPv6 is enabled.
Location string
Azure resource location.
Name string
Azure resource name.
ProvisioningState string
The provisioning state of the managed cluster resource.
Sku Pulumi.AzureNative.ServiceFabric.Outputs.SkuResponse
The sku of the managed cluster
SystemData Pulumi.AzureNative.ServiceFabric.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
Azure resource type.
AddonFeatures List<string>
List of add-on features to enable on the cluster.
AdminPassword string
VM admin user password.
AllowRdpAccess bool
Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false.
ApplicationTypeVersionsCleanupPolicy Pulumi.AzureNative.ServiceFabric.Outputs.ApplicationTypeVersionsCleanupPolicyResponse
The policy used to clean up unused versions.
AuxiliarySubnets List<Pulumi.AzureNative.ServiceFabric.Outputs.SubnetResponse>
Auxiliary subnets for the cluster.
AzureActiveDirectory Pulumi.AzureNative.ServiceFabric.Outputs.AzureActiveDirectoryResponse
The AAD authentication settings of the cluster.
ClientConnectionPort int
The port used for client connections to the cluster.
Clients List<Pulumi.AzureNative.ServiceFabric.Outputs.ClientCertificateResponse>
Client certificates that are allowed to manage the cluster.
ClusterCodeVersion string
The Service Fabric runtime version of the cluster. This property is required when clusterUpgradeMode is set to 'Manual'. To get list of available Service Fabric versions for new clusters use ClusterVersion API. To get the list of available version for existing clusters use availableClusterVersions.
ClusterUpgradeCadence string
Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when clusterUpgradeMode is set to 'Automatic'.
ClusterUpgradeMode string
The upgrade mode of the cluster when new Service Fabric runtime version is available.
DdosProtectionPlanId string
Specify the resource id of a DDoS network protection plan that will be associated with the virtual network of the cluster.
EnableAutoOSUpgrade bool
Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false.
EnableHttpGatewayExclusiveAuthMode bool
If true, token-based authentication is not allowed on the HttpGatewayEndpoint. This is required to support TLS versions 1.3 and above. If token-based authentication is used, HttpGatewayTokenAuthConnectionPort must be defined.
EnableIpv6 bool
Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false.
EnableServicePublicIP bool
Setting this to true will link the IPv4 address as the ServicePublicIP of the IPv6 address. It can only be set to True if IPv6 is enabled on the cluster.
FabricSettings List<Pulumi.AzureNative.ServiceFabric.Outputs.SettingsSectionDescriptionResponse>
The list of custom fabric settings to configure the cluster.
HttpGatewayConnectionPort int
The port used for HTTP connections to the cluster.
HttpGatewayTokenAuthConnectionPort int
The port used for token-auth based HTTPS connections to the cluster. Cannot be set to the same port as HttpGatewayEndpoint.
IpTags List<Pulumi.AzureNative.ServiceFabric.Outputs.IpTagResponse>
The list of IP tags associated with the default public IP address of the cluster.
LoadBalancingRules List<Pulumi.AzureNative.ServiceFabric.Outputs.LoadBalancingRuleResponse>
Load balancing rules that are applied to the public load balancer of the cluster.
NetworkSecurityRules List<Pulumi.AzureNative.ServiceFabric.Outputs.NetworkSecurityRuleResponse>
Custom Network Security Rules that are applied to the Virtual Network of the cluster.
PublicIPPrefixId string
Specify the resource id of a public IPv4 prefix that the load balancer will allocate a public IPv4 address from. This setting cannot be changed once the cluster is created.
PublicIPv6PrefixId string
Specify the resource id of a public IPv6 prefix that the load balancer will allocate a public IPv6 address from. This setting cannot be changed once the cluster is created.
ServiceEndpoints List<Pulumi.AzureNative.ServiceFabric.Outputs.ServiceEndpointResponse>
Service endpoints for subnets in the cluster.
SubnetId string
If specified, the node types for the cluster are created in this subnet instead of the default VNet. The networkSecurityRules specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created.
Tags Dictionary<string, string>
Azure resource tags.
UpgradeDescription Pulumi.AzureNative.ServiceFabric.Outputs.ClusterUpgradePolicyResponse
The policy to use when upgrading the cluster.
UseCustomVnet bool
For new clusters, this parameter indicates that it uses Bring your own VNet, but the subnet is specified at node type level; and for such clusters, the subnetId property is required for node types.
ZonalResiliency bool
Indicates if the cluster has zone resiliency.
ZonalUpdateMode string
Indicates the update mode for Cross Az clusters.
AdminUserName string
VM admin user name.
AzureApiVersion string
The Azure API version of the resource.
ClusterCertificateThumbprints []string
List of thumbprints of the cluster certificates.
ClusterId string
A service generated unique identifier for the cluster resource.
ClusterState string
The current state of the cluster.
DnsName string
The cluster dns name.
Etag string
Azure resource etag.
Fqdn string
The fully qualified domain name associated with the public load balancer of the cluster.
Id string
Azure resource identifier.
Ipv4Address string
The IPv4 address associated with the public load balancer of the cluster.
Ipv6Address string
IPv6 address for the cluster if IPv6 is enabled.
Location string
Azure resource location.
Name string
Azure resource name.
ProvisioningState string
The provisioning state of the managed cluster resource.
Sku SkuResponse
The sku of the managed cluster
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
Azure resource type.
AddonFeatures []string
List of add-on features to enable on the cluster.
AdminPassword string
VM admin user password.
AllowRdpAccess bool
Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false.
ApplicationTypeVersionsCleanupPolicy ApplicationTypeVersionsCleanupPolicyResponse
The policy used to clean up unused versions.
AuxiliarySubnets []SubnetResponse
Auxiliary subnets for the cluster.
AzureActiveDirectory AzureActiveDirectoryResponse
The AAD authentication settings of the cluster.
ClientConnectionPort int
The port used for client connections to the cluster.
Clients []ClientCertificateResponse
Client certificates that are allowed to manage the cluster.
ClusterCodeVersion string
The Service Fabric runtime version of the cluster. This property is required when clusterUpgradeMode is set to 'Manual'. To get list of available Service Fabric versions for new clusters use ClusterVersion API. To get the list of available version for existing clusters use availableClusterVersions.
ClusterUpgradeCadence string
Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when clusterUpgradeMode is set to 'Automatic'.
ClusterUpgradeMode string
The upgrade mode of the cluster when new Service Fabric runtime version is available.
DdosProtectionPlanId string
Specify the resource id of a DDoS network protection plan that will be associated with the virtual network of the cluster.
EnableAutoOSUpgrade bool
Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false.
EnableHttpGatewayExclusiveAuthMode bool
If true, token-based authentication is not allowed on the HttpGatewayEndpoint. This is required to support TLS versions 1.3 and above. If token-based authentication is used, HttpGatewayTokenAuthConnectionPort must be defined.
EnableIpv6 bool
Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false.
EnableServicePublicIP bool
Setting this to true will link the IPv4 address as the ServicePublicIP of the IPv6 address. It can only be set to True if IPv6 is enabled on the cluster.
FabricSettings []SettingsSectionDescriptionResponse
The list of custom fabric settings to configure the cluster.
HttpGatewayConnectionPort int
The port used for HTTP connections to the cluster.
HttpGatewayTokenAuthConnectionPort int
The port used for token-auth based HTTPS connections to the cluster. Cannot be set to the same port as HttpGatewayEndpoint.
IpTags []IpTagResponse
The list of IP tags associated with the default public IP address of the cluster.
LoadBalancingRules []LoadBalancingRuleResponse
Load balancing rules that are applied to the public load balancer of the cluster.
NetworkSecurityRules []NetworkSecurityRuleResponse
Custom Network Security Rules that are applied to the Virtual Network of the cluster.
PublicIPPrefixId string
Specify the resource id of a public IPv4 prefix that the load balancer will allocate a public IPv4 address from. This setting cannot be changed once the cluster is created.
PublicIPv6PrefixId string
Specify the resource id of a public IPv6 prefix that the load balancer will allocate a public IPv6 address from. This setting cannot be changed once the cluster is created.
ServiceEndpoints []ServiceEndpointResponse
Service endpoints for subnets in the cluster.
SubnetId string
If specified, the node types for the cluster are created in this subnet instead of the default VNet. The networkSecurityRules specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created.
Tags map[string]string
Azure resource tags.
UpgradeDescription ClusterUpgradePolicyResponse
The policy to use when upgrading the cluster.
UseCustomVnet bool
For new clusters, this parameter indicates that it uses Bring your own VNet, but the subnet is specified at node type level; and for such clusters, the subnetId property is required for node types.
ZonalResiliency bool
Indicates if the cluster has zone resiliency.
ZonalUpdateMode string
Indicates the update mode for Cross Az clusters.
adminUserName String
VM admin user name.
azureApiVersion String
The Azure API version of the resource.
clusterCertificateThumbprints List<String>
List of thumbprints of the cluster certificates.
clusterId String
A service generated unique identifier for the cluster resource.
clusterState String
The current state of the cluster.
dnsName String
The cluster dns name.
etag String
Azure resource etag.
fqdn String
The fully qualified domain name associated with the public load balancer of the cluster.
id String
Azure resource identifier.
ipv4Address String
The IPv4 address associated with the public load balancer of the cluster.
ipv6Address String
IPv6 address for the cluster if IPv6 is enabled.
location String
Azure resource location.
name String
Azure resource name.
provisioningState String
The provisioning state of the managed cluster resource.
sku SkuResponse
The sku of the managed cluster
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
Azure resource type.
addonFeatures List<String>
List of add-on features to enable on the cluster.
adminPassword String
VM admin user password.
allowRdpAccess Boolean
Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false.
applicationTypeVersionsCleanupPolicy ApplicationTypeVersionsCleanupPolicyResponse
The policy used to clean up unused versions.
auxiliarySubnets List<SubnetResponse>
Auxiliary subnets for the cluster.
azureActiveDirectory AzureActiveDirectoryResponse
The AAD authentication settings of the cluster.
clientConnectionPort Integer
The port used for client connections to the cluster.
clients List<ClientCertificateResponse>
Client certificates that are allowed to manage the cluster.
clusterCodeVersion String
The Service Fabric runtime version of the cluster. This property is required when clusterUpgradeMode is set to 'Manual'. To get list of available Service Fabric versions for new clusters use ClusterVersion API. To get the list of available version for existing clusters use availableClusterVersions.
clusterUpgradeCadence String
Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when clusterUpgradeMode is set to 'Automatic'.
clusterUpgradeMode String
The upgrade mode of the cluster when new Service Fabric runtime version is available.
ddosProtectionPlanId String
Specify the resource id of a DDoS network protection plan that will be associated with the virtual network of the cluster.
enableAutoOSUpgrade Boolean
Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false.
enableHttpGatewayExclusiveAuthMode Boolean
If true, token-based authentication is not allowed on the HttpGatewayEndpoint. This is required to support TLS versions 1.3 and above. If token-based authentication is used, HttpGatewayTokenAuthConnectionPort must be defined.
enableIpv6 Boolean
Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false.
enableServicePublicIP Boolean
Setting this to true will link the IPv4 address as the ServicePublicIP of the IPv6 address. It can only be set to True if IPv6 is enabled on the cluster.
fabricSettings List<SettingsSectionDescriptionResponse>
The list of custom fabric settings to configure the cluster.
httpGatewayConnectionPort Integer
The port used for HTTP connections to the cluster.
httpGatewayTokenAuthConnectionPort Integer
The port used for token-auth based HTTPS connections to the cluster. Cannot be set to the same port as HttpGatewayEndpoint.
ipTags List<IpTagResponse>
The list of IP tags associated with the default public IP address of the cluster.
loadBalancingRules List<LoadBalancingRuleResponse>
Load balancing rules that are applied to the public load balancer of the cluster.
networkSecurityRules List<NetworkSecurityRuleResponse>
Custom Network Security Rules that are applied to the Virtual Network of the cluster.
publicIPPrefixId String
Specify the resource id of a public IPv4 prefix that the load balancer will allocate a public IPv4 address from. This setting cannot be changed once the cluster is created.
publicIPv6PrefixId String
Specify the resource id of a public IPv6 prefix that the load balancer will allocate a public IPv6 address from. This setting cannot be changed once the cluster is created.
serviceEndpoints List<ServiceEndpointResponse>
Service endpoints for subnets in the cluster.
subnetId String
If specified, the node types for the cluster are created in this subnet instead of the default VNet. The networkSecurityRules specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created.
tags Map<String,String>
Azure resource tags.
upgradeDescription ClusterUpgradePolicyResponse
The policy to use when upgrading the cluster.
useCustomVnet Boolean
For new clusters, this parameter indicates that it uses Bring your own VNet, but the subnet is specified at node type level; and for such clusters, the subnetId property is required for node types.
zonalResiliency Boolean
Indicates if the cluster has zone resiliency.
zonalUpdateMode String
Indicates the update mode for Cross Az clusters.
adminUserName string
VM admin user name.
azureApiVersion string
The Azure API version of the resource.
clusterCertificateThumbprints string[]
List of thumbprints of the cluster certificates.
clusterId string
A service generated unique identifier for the cluster resource.
clusterState string
The current state of the cluster.
dnsName string
The cluster dns name.
etag string
Azure resource etag.
fqdn string
The fully qualified domain name associated with the public load balancer of the cluster.
id string
Azure resource identifier.
ipv4Address string
The IPv4 address associated with the public load balancer of the cluster.
ipv6Address string
IPv6 address for the cluster if IPv6 is enabled.
location string
Azure resource location.
name string
Azure resource name.
provisioningState string
The provisioning state of the managed cluster resource.
sku SkuResponse
The sku of the managed cluster
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
Azure resource type.
addonFeatures string[]
List of add-on features to enable on the cluster.
adminPassword string
VM admin user password.
allowRdpAccess boolean
Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false.
applicationTypeVersionsCleanupPolicy ApplicationTypeVersionsCleanupPolicyResponse
The policy used to clean up unused versions.
auxiliarySubnets SubnetResponse[]
Auxiliary subnets for the cluster.
azureActiveDirectory AzureActiveDirectoryResponse
The AAD authentication settings of the cluster.
clientConnectionPort number
The port used for client connections to the cluster.
clients ClientCertificateResponse[]
Client certificates that are allowed to manage the cluster.
clusterCodeVersion string
The Service Fabric runtime version of the cluster. This property is required when clusterUpgradeMode is set to 'Manual'. To get list of available Service Fabric versions for new clusters use ClusterVersion API. To get the list of available version for existing clusters use availableClusterVersions.
clusterUpgradeCadence string
Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when clusterUpgradeMode is set to 'Automatic'.
clusterUpgradeMode string
The upgrade mode of the cluster when new Service Fabric runtime version is available.
ddosProtectionPlanId string
Specify the resource id of a DDoS network protection plan that will be associated with the virtual network of the cluster.
enableAutoOSUpgrade boolean
Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false.
enableHttpGatewayExclusiveAuthMode boolean
If true, token-based authentication is not allowed on the HttpGatewayEndpoint. This is required to support TLS versions 1.3 and above. If token-based authentication is used, HttpGatewayTokenAuthConnectionPort must be defined.
enableIpv6 boolean
Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false.
enableServicePublicIP boolean
Setting this to true will link the IPv4 address as the ServicePublicIP of the IPv6 address. It can only be set to True if IPv6 is enabled on the cluster.
fabricSettings SettingsSectionDescriptionResponse[]
The list of custom fabric settings to configure the cluster.
httpGatewayConnectionPort number
The port used for HTTP connections to the cluster.
httpGatewayTokenAuthConnectionPort number
The port used for token-auth based HTTPS connections to the cluster. Cannot be set to the same port as HttpGatewayEndpoint.
ipTags IpTagResponse[]
The list of IP tags associated with the default public IP address of the cluster.
loadBalancingRules LoadBalancingRuleResponse[]
Load balancing rules that are applied to the public load balancer of the cluster.
networkSecurityRules NetworkSecurityRuleResponse[]
Custom Network Security Rules that are applied to the Virtual Network of the cluster.
publicIPPrefixId string
Specify the resource id of a public IPv4 prefix that the load balancer will allocate a public IPv4 address from. This setting cannot be changed once the cluster is created.
publicIPv6PrefixId string
Specify the resource id of a public IPv6 prefix that the load balancer will allocate a public IPv6 address from. This setting cannot be changed once the cluster is created.
serviceEndpoints ServiceEndpointResponse[]
Service endpoints for subnets in the cluster.
subnetId string
If specified, the node types for the cluster are created in this subnet instead of the default VNet. The networkSecurityRules specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created.
tags {[key: string]: string}
Azure resource tags.
upgradeDescription ClusterUpgradePolicyResponse
The policy to use when upgrading the cluster.
useCustomVnet boolean
For new clusters, this parameter indicates that it uses Bring your own VNet, but the subnet is specified at node type level; and for such clusters, the subnetId property is required for node types.
zonalResiliency boolean
Indicates if the cluster has zone resiliency.
zonalUpdateMode string
Indicates the update mode for Cross Az clusters.
admin_user_name str
VM admin user name.
azure_api_version str
The Azure API version of the resource.
cluster_certificate_thumbprints Sequence[str]
List of thumbprints of the cluster certificates.
cluster_id str
A service generated unique identifier for the cluster resource.
cluster_state str
The current state of the cluster.
dns_name str
The cluster dns name.
etag str
Azure resource etag.
fqdn str
The fully qualified domain name associated with the public load balancer of the cluster.
id str
Azure resource identifier.
ipv4_address str
The IPv4 address associated with the public load balancer of the cluster.
ipv6_address str
IPv6 address for the cluster if IPv6 is enabled.
location str
Azure resource location.
name str
Azure resource name.
provisioning_state str
The provisioning state of the managed cluster resource.
sku SkuResponse
The sku of the managed cluster
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
Azure resource type.
addon_features Sequence[str]
List of add-on features to enable on the cluster.
admin_password str
VM admin user password.
allow_rdp_access bool
Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false.
application_type_versions_cleanup_policy ApplicationTypeVersionsCleanupPolicyResponse
The policy used to clean up unused versions.
auxiliary_subnets Sequence[SubnetResponse]
Auxiliary subnets for the cluster.
azure_active_directory AzureActiveDirectoryResponse
The AAD authentication settings of the cluster.
client_connection_port int
The port used for client connections to the cluster.
clients Sequence[ClientCertificateResponse]
Client certificates that are allowed to manage the cluster.
cluster_code_version str
The Service Fabric runtime version of the cluster. This property is required when clusterUpgradeMode is set to 'Manual'. To get list of available Service Fabric versions for new clusters use ClusterVersion API. To get the list of available version for existing clusters use availableClusterVersions.
cluster_upgrade_cadence str
Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when clusterUpgradeMode is set to 'Automatic'.
cluster_upgrade_mode str
The upgrade mode of the cluster when new Service Fabric runtime version is available.
ddos_protection_plan_id str
Specify the resource id of a DDoS network protection plan that will be associated with the virtual network of the cluster.
enable_auto_os_upgrade bool
Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false.
enable_http_gateway_exclusive_auth_mode bool
If true, token-based authentication is not allowed on the HttpGatewayEndpoint. This is required to support TLS versions 1.3 and above. If token-based authentication is used, HttpGatewayTokenAuthConnectionPort must be defined.
enable_ipv6 bool
Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false.
enable_service_public_ip bool
Setting this to true will link the IPv4 address as the ServicePublicIP of the IPv6 address. It can only be set to True if IPv6 is enabled on the cluster.
fabric_settings Sequence[SettingsSectionDescriptionResponse]
The list of custom fabric settings to configure the cluster.
http_gateway_connection_port int
The port used for HTTP connections to the cluster.
http_gateway_token_auth_connection_port int
The port used for token-auth based HTTPS connections to the cluster. Cannot be set to the same port as HttpGatewayEndpoint.
ip_tags Sequence[IpTagResponse]
The list of IP tags associated with the default public IP address of the cluster.
load_balancing_rules Sequence[LoadBalancingRuleResponse]
Load balancing rules that are applied to the public load balancer of the cluster.
network_security_rules Sequence[NetworkSecurityRuleResponse]
Custom Network Security Rules that are applied to the Virtual Network of the cluster.
public_i_pv6_prefix_id str
Specify the resource id of a public IPv6 prefix that the load balancer will allocate a public IPv6 address from. This setting cannot be changed once the cluster is created.
public_ip_prefix_id str
Specify the resource id of a public IPv4 prefix that the load balancer will allocate a public IPv4 address from. This setting cannot be changed once the cluster is created.
service_endpoints Sequence[ServiceEndpointResponse]
Service endpoints for subnets in the cluster.
subnet_id str
If specified, the node types for the cluster are created in this subnet instead of the default VNet. The networkSecurityRules specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created.
tags Mapping[str, str]
Azure resource tags.
upgrade_description ClusterUpgradePolicyResponse
The policy to use when upgrading the cluster.
use_custom_vnet bool
For new clusters, this parameter indicates that it uses Bring your own VNet, but the subnet is specified at node type level; and for such clusters, the subnetId property is required for node types.
zonal_resiliency bool
Indicates if the cluster has zone resiliency.
zonal_update_mode str
Indicates the update mode for Cross Az clusters.
adminUserName String
VM admin user name.
azureApiVersion String
The Azure API version of the resource.
clusterCertificateThumbprints List<String>
List of thumbprints of the cluster certificates.
clusterId String
A service generated unique identifier for the cluster resource.
clusterState String
The current state of the cluster.
dnsName String
The cluster dns name.
etag String
Azure resource etag.
fqdn String
The fully qualified domain name associated with the public load balancer of the cluster.
id String
Azure resource identifier.
ipv4Address String
The IPv4 address associated with the public load balancer of the cluster.
ipv6Address String
IPv6 address for the cluster if IPv6 is enabled.
location String
Azure resource location.
name String
Azure resource name.
provisioningState String
The provisioning state of the managed cluster resource.
sku Property Map
The sku of the managed cluster
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
Azure resource type.
addonFeatures List<String>
List of add-on features to enable on the cluster.
adminPassword String
VM admin user password.
allowRdpAccess Boolean
Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false.
applicationTypeVersionsCleanupPolicy Property Map
The policy used to clean up unused versions.
auxiliarySubnets List<Property Map>
Auxiliary subnets for the cluster.
azureActiveDirectory Property Map
The AAD authentication settings of the cluster.
clientConnectionPort Number
The port used for client connections to the cluster.
clients List<Property Map>
Client certificates that are allowed to manage the cluster.
clusterCodeVersion String
The Service Fabric runtime version of the cluster. This property is required when clusterUpgradeMode is set to 'Manual'. To get list of available Service Fabric versions for new clusters use ClusterVersion API. To get the list of available version for existing clusters use availableClusterVersions.
clusterUpgradeCadence String
Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when clusterUpgradeMode is set to 'Automatic'.
clusterUpgradeMode String
The upgrade mode of the cluster when new Service Fabric runtime version is available.
ddosProtectionPlanId String
Specify the resource id of a DDoS network protection plan that will be associated with the virtual network of the cluster.
enableAutoOSUpgrade Boolean
Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false.
enableHttpGatewayExclusiveAuthMode Boolean
If true, token-based authentication is not allowed on the HttpGatewayEndpoint. This is required to support TLS versions 1.3 and above. If token-based authentication is used, HttpGatewayTokenAuthConnectionPort must be defined.
enableIpv6 Boolean
Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false.
enableServicePublicIP Boolean
Setting this to true will link the IPv4 address as the ServicePublicIP of the IPv6 address. It can only be set to True if IPv6 is enabled on the cluster.
fabricSettings List<Property Map>
The list of custom fabric settings to configure the cluster.
httpGatewayConnectionPort Number
The port used for HTTP connections to the cluster.
httpGatewayTokenAuthConnectionPort Number
The port used for token-auth based HTTPS connections to the cluster. Cannot be set to the same port as HttpGatewayEndpoint.
ipTags List<Property Map>
The list of IP tags associated with the default public IP address of the cluster.
loadBalancingRules List<Property Map>
Load balancing rules that are applied to the public load balancer of the cluster.
networkSecurityRules List<Property Map>
Custom Network Security Rules that are applied to the Virtual Network of the cluster.
publicIPPrefixId String
Specify the resource id of a public IPv4 prefix that the load balancer will allocate a public IPv4 address from. This setting cannot be changed once the cluster is created.
publicIPv6PrefixId String
Specify the resource id of a public IPv6 prefix that the load balancer will allocate a public IPv6 address from. This setting cannot be changed once the cluster is created.
serviceEndpoints List<Property Map>
Service endpoints for subnets in the cluster.
subnetId String
If specified, the node types for the cluster are created in this subnet instead of the default VNet. The networkSecurityRules specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created.
tags Map<String>
Azure resource tags.
upgradeDescription Property Map
The policy to use when upgrading the cluster.
useCustomVnet Boolean
For new clusters, this parameter indicates that it uses Bring your own VNet, but the subnet is specified at node type level; and for such clusters, the subnetId property is required for node types.
zonalResiliency Boolean
Indicates if the cluster has zone resiliency.
zonalUpdateMode String
Indicates the update mode for Cross Az clusters.

Supporting Types

ApplicationTypeVersionsCleanupPolicyResponse

MaxUnusedVersionsToKeep This property is required. int
Number of unused versions per application type to keep.
MaxUnusedVersionsToKeep This property is required. int
Number of unused versions per application type to keep.
maxUnusedVersionsToKeep This property is required. Integer
Number of unused versions per application type to keep.
maxUnusedVersionsToKeep This property is required. number
Number of unused versions per application type to keep.
max_unused_versions_to_keep This property is required. int
Number of unused versions per application type to keep.
maxUnusedVersionsToKeep This property is required. Number
Number of unused versions per application type to keep.

AzureActiveDirectoryResponse

ClientApplication string
Azure active directory client application id.
ClusterApplication string
Azure active directory cluster application id.
TenantId string
Azure active directory tenant id.
ClientApplication string
Azure active directory client application id.
ClusterApplication string
Azure active directory cluster application id.
TenantId string
Azure active directory tenant id.
clientApplication String
Azure active directory client application id.
clusterApplication String
Azure active directory cluster application id.
tenantId String
Azure active directory tenant id.
clientApplication string
Azure active directory client application id.
clusterApplication string
Azure active directory cluster application id.
tenantId string
Azure active directory tenant id.
client_application str
Azure active directory client application id.
cluster_application str
Azure active directory cluster application id.
tenant_id str
Azure active directory tenant id.
clientApplication String
Azure active directory client application id.
clusterApplication String
Azure active directory cluster application id.
tenantId String
Azure active directory tenant id.

ClientCertificateResponse

IsAdmin This property is required. bool
Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster.
CommonName string
Certificate common name.
IssuerThumbprint string
Issuer thumbprint for the certificate. Only used together with CommonName.
Thumbprint string
Certificate thumbprint.
IsAdmin This property is required. bool
Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster.
CommonName string
Certificate common name.
IssuerThumbprint string
Issuer thumbprint for the certificate. Only used together with CommonName.
Thumbprint string
Certificate thumbprint.
isAdmin This property is required. Boolean
Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster.
commonName String
Certificate common name.
issuerThumbprint String
Issuer thumbprint for the certificate. Only used together with CommonName.
thumbprint String
Certificate thumbprint.
isAdmin This property is required. boolean
Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster.
commonName string
Certificate common name.
issuerThumbprint string
Issuer thumbprint for the certificate. Only used together with CommonName.
thumbprint string
Certificate thumbprint.
is_admin This property is required. bool
Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster.
common_name str
Certificate common name.
issuer_thumbprint str
Issuer thumbprint for the certificate. Only used together with CommonName.
thumbprint str
Certificate thumbprint.
isAdmin This property is required. Boolean
Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster.
commonName String
Certificate common name.
issuerThumbprint String
Issuer thumbprint for the certificate. Only used together with CommonName.
thumbprint String
Certificate thumbprint.

ClusterHealthPolicyResponse

MaxPercentUnhealthyApplications This property is required. int

The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10.

The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.

MaxPercentUnhealthyNodes This property is required. int

The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10.

The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.

In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.

MaxPercentUnhealthyApplications This property is required. int

The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10.

The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.

MaxPercentUnhealthyNodes This property is required. int

The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10.

The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.

In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.

maxPercentUnhealthyApplications This property is required. Integer

The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10.

The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.

maxPercentUnhealthyNodes This property is required. Integer

The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10.

The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.

In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.

maxPercentUnhealthyApplications This property is required. number

The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10.

The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.

maxPercentUnhealthyNodes This property is required. number

The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10.

The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.

In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.

max_percent_unhealthy_applications This property is required. int

The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10.

The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.

max_percent_unhealthy_nodes This property is required. int

The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10.

The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.

In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.

maxPercentUnhealthyApplications This property is required. Number

The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10.

The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.

maxPercentUnhealthyNodes This property is required. Number

The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10.

The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.

In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.

ClusterMonitoringPolicyResponse

HealthCheckRetryTimeout This property is required. string
The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
HealthCheckStableDuration This property is required. string
The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
HealthCheckWaitDuration This property is required. string
The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
UpgradeDomainTimeout This property is required. string
The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
UpgradeTimeout This property is required. string
The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
HealthCheckRetryTimeout This property is required. string
The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
HealthCheckStableDuration This property is required. string
The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
HealthCheckWaitDuration This property is required. string
The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
UpgradeDomainTimeout This property is required. string
The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
UpgradeTimeout This property is required. string
The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
healthCheckRetryTimeout This property is required. String
The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
healthCheckStableDuration This property is required. String
The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
healthCheckWaitDuration This property is required. String
The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
upgradeDomainTimeout This property is required. String
The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
upgradeTimeout This property is required. String
The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
healthCheckRetryTimeout This property is required. string
The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
healthCheckStableDuration This property is required. string
The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
healthCheckWaitDuration This property is required. string
The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
upgradeDomainTimeout This property is required. string
The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
upgradeTimeout This property is required. string
The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
health_check_retry_timeout This property is required. str
The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
health_check_stable_duration This property is required. str
The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
health_check_wait_duration This property is required. str
The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
upgrade_domain_timeout This property is required. str
The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
upgrade_timeout This property is required. str
The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
healthCheckRetryTimeout This property is required. String
The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
healthCheckStableDuration This property is required. String
The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
healthCheckWaitDuration This property is required. String
The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
upgradeDomainTimeout This property is required. String
The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
upgradeTimeout This property is required. String
The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.

ClusterUpgradeDeltaHealthPolicyResponse

MaxPercentDeltaUnhealthyNodes This property is required. int
The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.
MaxPercentDeltaUnhealthyApplications int
The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. NOTE: This value will overwrite the value specified in properties.UpgradeDescription.HealthPolicy.MaxPercentUnhealthyApplications
MaxPercentUpgradeDomainDeltaUnhealthyNodes int
The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits.
MaxPercentDeltaUnhealthyNodes This property is required. int
The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.
MaxPercentDeltaUnhealthyApplications int
The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. NOTE: This value will overwrite the value specified in properties.UpgradeDescription.HealthPolicy.MaxPercentUnhealthyApplications
MaxPercentUpgradeDomainDeltaUnhealthyNodes int
The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits.
maxPercentDeltaUnhealthyNodes This property is required. Integer
The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.
maxPercentDeltaUnhealthyApplications Integer
The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. NOTE: This value will overwrite the value specified in properties.UpgradeDescription.HealthPolicy.MaxPercentUnhealthyApplications
maxPercentUpgradeDomainDeltaUnhealthyNodes Integer
The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits.
maxPercentDeltaUnhealthyNodes This property is required. number
The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.
maxPercentDeltaUnhealthyApplications number
The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. NOTE: This value will overwrite the value specified in properties.UpgradeDescription.HealthPolicy.MaxPercentUnhealthyApplications
maxPercentUpgradeDomainDeltaUnhealthyNodes number
The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits.
max_percent_delta_unhealthy_nodes This property is required. int
The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.
max_percent_delta_unhealthy_applications int
The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. NOTE: This value will overwrite the value specified in properties.UpgradeDescription.HealthPolicy.MaxPercentUnhealthyApplications
max_percent_upgrade_domain_delta_unhealthy_nodes int
The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits.
maxPercentDeltaUnhealthyNodes This property is required. Number
The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.
maxPercentDeltaUnhealthyApplications Number
The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. NOTE: This value will overwrite the value specified in properties.UpgradeDescription.HealthPolicy.MaxPercentUnhealthyApplications
maxPercentUpgradeDomainDeltaUnhealthyNodes Number
The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits.

ClusterUpgradePolicyResponse

DeltaHealthPolicy Pulumi.AzureNative.ServiceFabric.Inputs.ClusterUpgradeDeltaHealthPolicyResponse
The cluster delta health policy defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
ForceRestart bool
If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
HealthPolicy Pulumi.AzureNative.ServiceFabric.Inputs.ClusterHealthPolicyResponse
The cluster health policy defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
MonitoringPolicy Pulumi.AzureNative.ServiceFabric.Inputs.ClusterMonitoringPolicyResponse
The cluster monitoring policy describes the parameters for monitoring an upgrade in Monitored mode.
UpgradeReplicaSetCheckTimeout string
The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. This value must be between 00:00:00 and 49710.06:28:15 (unsigned 32 bit integer for seconds)
DeltaHealthPolicy ClusterUpgradeDeltaHealthPolicyResponse
The cluster delta health policy defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
ForceRestart bool
If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
HealthPolicy ClusterHealthPolicyResponse
The cluster health policy defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
MonitoringPolicy ClusterMonitoringPolicyResponse
The cluster monitoring policy describes the parameters for monitoring an upgrade in Monitored mode.
UpgradeReplicaSetCheckTimeout string
The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. This value must be between 00:00:00 and 49710.06:28:15 (unsigned 32 bit integer for seconds)
deltaHealthPolicy ClusterUpgradeDeltaHealthPolicyResponse
The cluster delta health policy defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
forceRestart Boolean
If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
healthPolicy ClusterHealthPolicyResponse
The cluster health policy defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
monitoringPolicy ClusterMonitoringPolicyResponse
The cluster monitoring policy describes the parameters for monitoring an upgrade in Monitored mode.
upgradeReplicaSetCheckTimeout String
The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. This value must be between 00:00:00 and 49710.06:28:15 (unsigned 32 bit integer for seconds)
deltaHealthPolicy ClusterUpgradeDeltaHealthPolicyResponse
The cluster delta health policy defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
forceRestart boolean
If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
healthPolicy ClusterHealthPolicyResponse
The cluster health policy defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
monitoringPolicy ClusterMonitoringPolicyResponse
The cluster monitoring policy describes the parameters for monitoring an upgrade in Monitored mode.
upgradeReplicaSetCheckTimeout string
The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. This value must be between 00:00:00 and 49710.06:28:15 (unsigned 32 bit integer for seconds)
delta_health_policy ClusterUpgradeDeltaHealthPolicyResponse
The cluster delta health policy defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
force_restart bool
If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
health_policy ClusterHealthPolicyResponse
The cluster health policy defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
monitoring_policy ClusterMonitoringPolicyResponse
The cluster monitoring policy describes the parameters for monitoring an upgrade in Monitored mode.
upgrade_replica_set_check_timeout str
The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. This value must be between 00:00:00 and 49710.06:28:15 (unsigned 32 bit integer for seconds)
deltaHealthPolicy Property Map
The cluster delta health policy defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
forceRestart Boolean
If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
healthPolicy Property Map
The cluster health policy defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
monitoringPolicy Property Map
The cluster monitoring policy describes the parameters for monitoring an upgrade in Monitored mode.
upgradeReplicaSetCheckTimeout String
The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. This value must be between 00:00:00 and 49710.06:28:15 (unsigned 32 bit integer for seconds)

IpTagResponse

IpTagType This property is required. string
IP tag type. Example: FirstPartyUsage.
Tag This property is required. string
IP tag associated with the public IP. Example: SQL, Storage etc.
IpTagType This property is required. string
IP tag type. Example: FirstPartyUsage.
Tag This property is required. string
IP tag associated with the public IP. Example: SQL, Storage etc.
ipTagType This property is required. String
IP tag type. Example: FirstPartyUsage.
tag This property is required. String
IP tag associated with the public IP. Example: SQL, Storage etc.
ipTagType This property is required. string
IP tag type. Example: FirstPartyUsage.
tag This property is required. string
IP tag associated with the public IP. Example: SQL, Storage etc.
ip_tag_type This property is required. str
IP tag type. Example: FirstPartyUsage.
tag This property is required. str
IP tag associated with the public IP. Example: SQL, Storage etc.
ipTagType This property is required. String
IP tag type. Example: FirstPartyUsage.
tag This property is required. String
IP tag associated with the public IP. Example: SQL, Storage etc.

LoadBalancingRuleResponse

BackendPort This property is required. int
The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.
FrontendPort This property is required. int
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.
ProbeProtocol This property is required. string
the reference to the load balancer probe used by the load balancing rule.
Protocol This property is required. string
The reference to the transport protocol used by the load balancing rule.
LoadDistribution string
The load distribution policy for this rule.
ProbePort int
The prob port used by the load balancing rule. Acceptable values are between 1 and 65535.
ProbeRequestPath string
The probe request path. Only supported for HTTP/HTTPS probes.
BackendPort This property is required. int
The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.
FrontendPort This property is required. int
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.
ProbeProtocol This property is required. string
the reference to the load balancer probe used by the load balancing rule.
Protocol This property is required. string
The reference to the transport protocol used by the load balancing rule.
LoadDistribution string
The load distribution policy for this rule.
ProbePort int
The prob port used by the load balancing rule. Acceptable values are between 1 and 65535.
ProbeRequestPath string
The probe request path. Only supported for HTTP/HTTPS probes.
backendPort This property is required. Integer
The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.
frontendPort This property is required. Integer
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.
probeProtocol This property is required. String
the reference to the load balancer probe used by the load balancing rule.
protocol This property is required. String
The reference to the transport protocol used by the load balancing rule.
loadDistribution String
The load distribution policy for this rule.
probePort Integer
The prob port used by the load balancing rule. Acceptable values are between 1 and 65535.
probeRequestPath String
The probe request path. Only supported for HTTP/HTTPS probes.
backendPort This property is required. number
The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.
frontendPort This property is required. number
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.
probeProtocol This property is required. string
the reference to the load balancer probe used by the load balancing rule.
protocol This property is required. string
The reference to the transport protocol used by the load balancing rule.
loadDistribution string
The load distribution policy for this rule.
probePort number
The prob port used by the load balancing rule. Acceptable values are between 1 and 65535.
probeRequestPath string
The probe request path. Only supported for HTTP/HTTPS probes.
backend_port This property is required. int
The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.
frontend_port This property is required. int
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.
probe_protocol This property is required. str
the reference to the load balancer probe used by the load balancing rule.
protocol This property is required. str
The reference to the transport protocol used by the load balancing rule.
load_distribution str
The load distribution policy for this rule.
probe_port int
The prob port used by the load balancing rule. Acceptable values are between 1 and 65535.
probe_request_path str
The probe request path. Only supported for HTTP/HTTPS probes.
backendPort This property is required. Number
The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.
frontendPort This property is required. Number
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.
probeProtocol This property is required. String
the reference to the load balancer probe used by the load balancing rule.
protocol This property is required. String
The reference to the transport protocol used by the load balancing rule.
loadDistribution String
The load distribution policy for this rule.
probePort Number
The prob port used by the load balancing rule. Acceptable values are between 1 and 65535.
probeRequestPath String
The probe request path. Only supported for HTTP/HTTPS probes.

NetworkSecurityRuleResponse

Access This property is required. string
The network traffic is allowed or denied.
Direction This property is required. string
Network security rule direction.
Name This property is required. string
Network security rule name.
Priority This property is required. int
The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.
Protocol This property is required. string
Network protocol this rule applies to.
Description string
Network security rule description.
DestinationAddressPrefix string
The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.
DestinationAddressPrefixes List<string>
The destination address prefixes. CIDR or destination IP ranges.
DestinationPortRange string
he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
DestinationPortRanges List<string>
The destination port ranges.
SourceAddressPrefix string
The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.
SourceAddressPrefixes List<string>
The CIDR or source IP ranges.
SourcePortRange string
The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
SourcePortRanges List<string>
The source port ranges.
Access This property is required. string
The network traffic is allowed or denied.
Direction This property is required. string
Network security rule direction.
Name This property is required. string
Network security rule name.
Priority This property is required. int
The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.
Protocol This property is required. string
Network protocol this rule applies to.
Description string
Network security rule description.
DestinationAddressPrefix string
The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.
DestinationAddressPrefixes []string
The destination address prefixes. CIDR or destination IP ranges.
DestinationPortRange string
he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
DestinationPortRanges []string
The destination port ranges.
SourceAddressPrefix string
The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.
SourceAddressPrefixes []string
The CIDR or source IP ranges.
SourcePortRange string
The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
SourcePortRanges []string
The source port ranges.
access This property is required. String
The network traffic is allowed or denied.
direction This property is required. String
Network security rule direction.
name This property is required. String
Network security rule name.
priority This property is required. Integer
The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.
protocol This property is required. String
Network protocol this rule applies to.
description String
Network security rule description.
destinationAddressPrefix String
The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.
destinationAddressPrefixes List<String>
The destination address prefixes. CIDR or destination IP ranges.
destinationPortRange String
he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
destinationPortRanges List<String>
The destination port ranges.
sourceAddressPrefix String
The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.
sourceAddressPrefixes List<String>
The CIDR or source IP ranges.
sourcePortRange String
The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
sourcePortRanges List<String>
The source port ranges.
access This property is required. string
The network traffic is allowed or denied.
direction This property is required. string
Network security rule direction.
name This property is required. string
Network security rule name.
priority This property is required. number
The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.
protocol This property is required. string
Network protocol this rule applies to.
description string
Network security rule description.
destinationAddressPrefix string
The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.
destinationAddressPrefixes string[]
The destination address prefixes. CIDR or destination IP ranges.
destinationPortRange string
he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
destinationPortRanges string[]
The destination port ranges.
sourceAddressPrefix string
The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.
sourceAddressPrefixes string[]
The CIDR or source IP ranges.
sourcePortRange string
The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
sourcePortRanges string[]
The source port ranges.
access This property is required. str
The network traffic is allowed or denied.
direction This property is required. str
Network security rule direction.
name This property is required. str
Network security rule name.
priority This property is required. int
The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.
protocol This property is required. str
Network protocol this rule applies to.
description str
Network security rule description.
destination_address_prefix str
The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.
destination_address_prefixes Sequence[str]
The destination address prefixes. CIDR or destination IP ranges.
destination_port_range str
he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
destination_port_ranges Sequence[str]
The destination port ranges.
source_address_prefix str
The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.
source_address_prefixes Sequence[str]
The CIDR or source IP ranges.
source_port_range str
The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
source_port_ranges Sequence[str]
The source port ranges.
access This property is required. String
The network traffic is allowed or denied.
direction This property is required. String
Network security rule direction.
name This property is required. String
Network security rule name.
priority This property is required. Number
The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.
protocol This property is required. String
Network protocol this rule applies to.
description String
Network security rule description.
destinationAddressPrefix String
The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.
destinationAddressPrefixes List<String>
The destination address prefixes. CIDR or destination IP ranges.
destinationPortRange String
he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
destinationPortRanges List<String>
The destination port ranges.
sourceAddressPrefix String
The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.
sourceAddressPrefixes List<String>
The CIDR or source IP ranges.
sourcePortRange String
The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
sourcePortRanges List<String>
The source port ranges.

ServiceEndpointResponse

Service This property is required. string
The type of the endpoint service.
Locations List<string>
A list of locations.
Service This property is required. string
The type of the endpoint service.
Locations []string
A list of locations.
service This property is required. String
The type of the endpoint service.
locations List<String>
A list of locations.
service This property is required. string
The type of the endpoint service.
locations string[]
A list of locations.
service This property is required. str
The type of the endpoint service.
locations Sequence[str]
A list of locations.
service This property is required. String
The type of the endpoint service.
locations List<String>
A list of locations.

SettingsParameterDescriptionResponse

Name This property is required. string
The parameter name of fabric setting.
Value This property is required. string
The parameter value of fabric setting.
Name This property is required. string
The parameter name of fabric setting.
Value This property is required. string
The parameter value of fabric setting.
name This property is required. String
The parameter name of fabric setting.
value This property is required. String
The parameter value of fabric setting.
name This property is required. string
The parameter name of fabric setting.
value This property is required. string
The parameter value of fabric setting.
name This property is required. str
The parameter name of fabric setting.
value This property is required. str
The parameter value of fabric setting.
name This property is required. String
The parameter name of fabric setting.
value This property is required. String
The parameter value of fabric setting.

SettingsSectionDescriptionResponse

Name This property is required. string
The section name of the fabric settings.
Parameters This property is required. List<Pulumi.AzureNative.ServiceFabric.Inputs.SettingsParameterDescriptionResponse>
The collection of parameters in the section.
Name This property is required. string
The section name of the fabric settings.
Parameters This property is required. []SettingsParameterDescriptionResponse
The collection of parameters in the section.
name This property is required. String
The section name of the fabric settings.
parameters This property is required. List<SettingsParameterDescriptionResponse>
The collection of parameters in the section.
name This property is required. string
The section name of the fabric settings.
parameters This property is required. SettingsParameterDescriptionResponse[]
The collection of parameters in the section.
name This property is required. str
The section name of the fabric settings.
parameters This property is required. Sequence[SettingsParameterDescriptionResponse]
The collection of parameters in the section.
name This property is required. String
The section name of the fabric settings.
parameters This property is required. List<Property Map>
The collection of parameters in the section.

SkuResponse

Name This property is required. string
Sku Name.
Name This property is required. string
Sku Name.
name This property is required. String
Sku Name.
name This property is required. string
Sku Name.
name This property is required. str
Sku Name.
name This property is required. String
Sku Name.

SubnetResponse

Name This property is required. string
Subnet name.
EnableIpv6 bool
Indicates wether to enable Ipv6 or not. If not provided, it will take the same configuration as the cluster.
NetworkSecurityGroupId string
Full resource id for the network security group.
PrivateEndpointNetworkPolicies string
Enable or Disable apply network policies on private end point in the subnet.
PrivateLinkServiceNetworkPolicies string
Enable or Disable apply network policies on private link service in the subnet.
Name This property is required. string
Subnet name.
EnableIpv6 bool
Indicates wether to enable Ipv6 or not. If not provided, it will take the same configuration as the cluster.
NetworkSecurityGroupId string
Full resource id for the network security group.
PrivateEndpointNetworkPolicies string
Enable or Disable apply network policies on private end point in the subnet.
PrivateLinkServiceNetworkPolicies string
Enable or Disable apply network policies on private link service in the subnet.
name This property is required. String
Subnet name.
enableIpv6 Boolean
Indicates wether to enable Ipv6 or not. If not provided, it will take the same configuration as the cluster.
networkSecurityGroupId String
Full resource id for the network security group.
privateEndpointNetworkPolicies String
Enable or Disable apply network policies on private end point in the subnet.
privateLinkServiceNetworkPolicies String
Enable or Disable apply network policies on private link service in the subnet.
name This property is required. string
Subnet name.
enableIpv6 boolean
Indicates wether to enable Ipv6 or not. If not provided, it will take the same configuration as the cluster.
networkSecurityGroupId string
Full resource id for the network security group.
privateEndpointNetworkPolicies string
Enable or Disable apply network policies on private end point in the subnet.
privateLinkServiceNetworkPolicies string
Enable or Disable apply network policies on private link service in the subnet.
name This property is required. str
Subnet name.
enable_ipv6 bool
Indicates wether to enable Ipv6 or not. If not provided, it will take the same configuration as the cluster.
network_security_group_id str
Full resource id for the network security group.
private_endpoint_network_policies str
Enable or Disable apply network policies on private end point in the subnet.
private_link_service_network_policies str
Enable or Disable apply network policies on private link service in the subnet.
name This property is required. String
Subnet name.
enableIpv6 Boolean
Indicates wether to enable Ipv6 or not. If not provided, it will take the same configuration as the cluster.
networkSecurityGroupId String
Full resource id for the network security group.
privateEndpointNetworkPolicies String
Enable or Disable apply network policies on private end point in the subnet.
privateLinkServiceNetworkPolicies String
Enable or Disable apply network policies on private link service in the subnet.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi