azure-native.servicefabric.getManagedCluster
Explore with Pulumi AI
Get a Service Fabric managed cluster resource created or in the process of being created in the specified resource group. Azure REST API version: 2023-03-01-preview.
Other available API versions: 2020-01-01-preview, 2022-01-01, 2022-10-01-preview, 2023-07-01-preview, 2023-09-01-preview, 2023-11-01-preview, 2023-12-01-preview, 2024-02-01-preview, 2024-04-01, 2024-06-01-preview, 2024-09-01-preview.
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>
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]
func LookupManagedCluster(ctx *Context, args *LookupManagedClusterArgs, opts ...InvokeOption) (*LookupManagedClusterResult, error)
func LookupManagedClusterOutput(ctx *Context, args *LookupManagedClusterOutputArgs, opts ...InvokeOption) LookupManagedClusterResultOutput
> 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)
}
public static CompletableFuture<GetManagedClusterResult> getManagedCluster(GetManagedClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:servicefabric:getManagedCluster
arguments:
# arguments dictionary
The following arguments are supported:
- Cluster
Name string - The name of the cluster resource.
- Resource
Group stringName - The name of the resource group.
- Cluster
Name string - The name of the cluster resource.
- Resource
Group stringName - The name of the resource group.
- cluster
Name String - The name of the cluster resource.
- resource
Group StringName - The name of the resource group.
- cluster
Name string - The name of the cluster resource.
- resource
Group stringName - The name of the resource group.
- cluster_
name str - The name of the cluster resource.
- resource_
group_ strname - The name of the resource group.
- cluster
Name String - The name of the cluster resource.
- resource
Group StringName - The name of the resource group.
getManagedCluster Result
The following output properties are available:
- Admin
User stringName - VM admin user name.
- Cluster
Certificate List<string>Thumbprints - List of thumbprints of the cluster certificates.
- Cluster
Id string - A service generated unique identifier for the cluster resource.
- Cluster
State string - The current state of the cluster.
- Dns
Name 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.
- Provisioning
State string - The provisioning state of the managed cluster resource.
- Sku
Pulumi.
Azure Native. Service Fabric. Outputs. Sku Response - The sku of the managed cluster
- System
Data Pulumi.Azure Native. Service Fabric. Outputs. System Data Response - Metadata pertaining to creation and last modification of the resource.
- Type string
- Azure resource type.
- Addon
Features List<string> - List of add-on features to enable on the cluster.
- Admin
Password string - VM admin user password.
- Allow
Rdp boolAccess - 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 Pulumi.Versions Cleanup Policy Azure Native. Service Fabric. Outputs. Application Type Versions Cleanup Policy Response - The policy used to clean up unused versions.
- Auxiliary
Subnets List<Pulumi.Azure Native. Service Fabric. Outputs. Subnet Response> - Auxiliary subnets for the cluster.
- Azure
Active Pulumi.Directory Azure Native. Service Fabric. Outputs. Azure Active Directory Response - The AAD authentication settings of the cluster.
- Client
Connection intPort - The port used for client connections to the cluster.
- Clients
List<Pulumi.
Azure Native. Service Fabric. Outputs. Client Certificate Response> - Client certificates that are allowed to manage the cluster.
- Cluster
Code stringVersion - 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 stringCadence - 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 stringMode - The upgrade mode of the cluster when new Service Fabric runtime version is available.
- Enable
Auto boolOSUpgrade - 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
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 boolPublic IP - 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 List<Pulumi.Azure Native. Service Fabric. Outputs. Settings Section Description Response> - The list of custom fabric settings to configure the cluster.
- Http
Gateway intConnection Port - The port used for HTTP connections to the cluster.
- List<Pulumi.
Azure Native. Service Fabric. Outputs. IPTag Response> - The list of IP tags associated with the default public IP address of the cluster.
- Load
Balancing List<Pulumi.Rules Azure Native. Service Fabric. Outputs. Load Balancing Rule Response> - Load balancing rules that are applied to the public load balancer of the cluster.
- Network
Security List<Pulumi.Rules Azure Native. Service Fabric. Outputs. Network Security Rule Response> - Custom Network Security Rules that are applied to the Virtual Network of the cluster.
- Public
IPPrefix stringId - Specify the resource id of a public IP prefix that the load balancer will allocate a public IP address from. Only supports IPv4.
- Service
Endpoints List<Pulumi.Azure Native. Service Fabric. Outputs. Service Endpoint Response> - Service endpoints for subnets in the cluster.
- Subnet
Id 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.
- Dictionary<string, string>
- Azure resource tags.
- Use
Custom boolVnet - 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 stringMode - Indicates the update mode for Cross Az clusters.
- Admin
User stringName - VM admin user name.
- Cluster
Certificate []stringThumbprints - List of thumbprints of the cluster certificates.
- Cluster
Id string - A service generated unique identifier for the cluster resource.
- Cluster
State string - The current state of the cluster.
- Dns
Name 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.
- Provisioning
State string - The provisioning state of the managed cluster resource.
- Sku
Sku
Response - The sku of the managed cluster
- System
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- Type string
- Azure resource type.
- Addon
Features []string - List of add-on features to enable on the cluster.
- Admin
Password string - VM admin user password.
- Allow
Rdp boolAccess - 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 ApplicationVersions Cleanup Policy Type Versions Cleanup Policy Response - The policy used to clean up unused versions.
- Auxiliary
Subnets []SubnetResponse - Auxiliary subnets for the cluster.
- Azure
Active AzureDirectory Active Directory Response - The AAD authentication settings of the cluster.
- Client
Connection intPort - The port used for client connections to the cluster.
- Clients
[]Client
Certificate Response - Client certificates that are allowed to manage the cluster.
- Cluster
Code stringVersion - 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 stringCadence - 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 stringMode - The upgrade mode of the cluster when new Service Fabric runtime version is available.
- Enable
Auto boolOSUpgrade - 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
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 boolPublic IP - 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 []SettingsSection Description Response - The list of custom fabric settings to configure the cluster.
- Http
Gateway intConnection Port - The port used for HTTP connections to the cluster.
- []IPTag
Response - The list of IP tags associated with the default public IP address of the cluster.
- Load
Balancing []LoadRules Balancing Rule Response - Load balancing rules that are applied to the public load balancer of the cluster.
- Network
Security []NetworkRules Security Rule Response - Custom Network Security Rules that are applied to the Virtual Network of the cluster.
- Public
IPPrefix stringId - Specify the resource id of a public IP prefix that the load balancer will allocate a public IP address from. Only supports IPv4.
- Service
Endpoints []ServiceEndpoint Response - Service endpoints for subnets in the cluster.
- Subnet
Id 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.
- map[string]string
- Azure resource tags.
- Use
Custom boolVnet - 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 stringMode - Indicates the update mode for Cross Az clusters.
- admin
User StringName - VM admin user name.
- cluster
Certificate List<String>Thumbprints - List of thumbprints of the cluster certificates.
- cluster
Id String - A service generated unique identifier for the cluster resource.
- cluster
State String - The current state of the cluster.
- dns
Name 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.
- provisioning
State String - The provisioning state of the managed cluster resource.
- sku
Sku
Response - The sku of the managed cluster
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type String
- Azure resource type.
- addon
Features List<String> - List of add-on features to enable on the cluster.
- admin
Password String - VM admin user password.
- allow
Rdp BooleanAccess - 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 ApplicationVersions Cleanup Policy Type Versions Cleanup Policy Response - The policy used to clean up unused versions.
- auxiliary
Subnets List<SubnetResponse> - Auxiliary subnets for the cluster.
- azure
Active AzureDirectory Active Directory Response - The AAD authentication settings of the cluster.
- client
Connection IntegerPort - The port used for client connections to the cluster.
- clients
List<Client
Certificate Response> - Client certificates that are allowed to manage the cluster.
- cluster
Code StringVersion - 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 StringCadence - 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 StringMode - The upgrade mode of the cluster when new Service Fabric runtime version is available.
- enable
Auto BooleanOSUpgrade - 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
Ipv6 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.
- enable
Service BooleanPublic IP - 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 List<SettingsSection Description Response> - The list of custom fabric settings to configure the cluster.
- http
Gateway IntegerConnection Port - The port used for HTTP connections to the cluster.
- List<IPTag
Response> - The list of IP tags associated with the default public IP address of the cluster.
- load
Balancing List<LoadRules Balancing Rule Response> - Load balancing rules that are applied to the public load balancer of the cluster.
- network
Security List<NetworkRules Security Rule Response> - Custom Network Security Rules that are applied to the Virtual Network of the cluster.
- public
IPPrefix StringId - Specify the resource id of a public IP prefix that the load balancer will allocate a public IP address from. Only supports IPv4.
- service
Endpoints List<ServiceEndpoint Response> - Service endpoints for subnets in the cluster.
- subnet
Id 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.
- Map<String,String>
- Azure resource tags.
- use
Custom BooleanVnet - 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 Boolean - Indicates if the cluster has zone resiliency.
- zonal
Update StringMode - Indicates the update mode for Cross Az clusters.
- admin
User stringName - VM admin user name.
- cluster
Certificate string[]Thumbprints - List of thumbprints of the cluster certificates.
- cluster
Id string - A service generated unique identifier for the cluster resource.
- cluster
State string - The current state of the cluster.
- dns
Name 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.
- provisioning
State string - The provisioning state of the managed cluster resource.
- sku
Sku
Response - The sku of the managed cluster
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type string
- Azure resource type.
- addon
Features string[] - List of add-on features to enable on the cluster.
- admin
Password string - VM admin user password.
- allow
Rdp booleanAccess - 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 ApplicationVersions Cleanup Policy Type Versions Cleanup Policy Response - The policy used to clean up unused versions.
- auxiliary
Subnets SubnetResponse[] - Auxiliary subnets for the cluster.
- azure
Active AzureDirectory Active Directory Response - The AAD authentication settings of the cluster.
- client
Connection numberPort - The port used for client connections to the cluster.
- clients
Client
Certificate Response[] - Client certificates that are allowed to manage the cluster.
- cluster
Code stringVersion - 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 stringCadence - 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 stringMode - The upgrade mode of the cluster when new Service Fabric runtime version is available.
- enable
Auto booleanOSUpgrade - 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
Ipv6 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.
- enable
Service booleanPublic IP - 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 SettingsSection Description Response[] - The list of custom fabric settings to configure the cluster.
- http
Gateway numberConnection Port - The port used for HTTP connections to the cluster.
- IPTag
Response[] - The list of IP tags associated with the default public IP address of the cluster.
- load
Balancing LoadRules Balancing Rule Response[] - Load balancing rules that are applied to the public load balancer of the cluster.
- network
Security NetworkRules Security Rule Response[] - Custom Network Security Rules that are applied to the Virtual Network of the cluster.
- public
IPPrefix stringId - Specify the resource id of a public IP prefix that the load balancer will allocate a public IP address from. Only supports IPv4.
- service
Endpoints ServiceEndpoint Response[] - Service endpoints for subnets in the cluster.
- subnet
Id 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.
- {[key: string]: string}
- Azure resource tags.
- use
Custom booleanVnet - 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 boolean - Indicates if the cluster has zone resiliency.
- zonal
Update stringMode - Indicates the update mode for Cross Az clusters.
- admin_
user_ strname - VM admin user name.
- cluster_
certificate_ Sequence[str]thumbprints - 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
Sku
Response - The sku of the managed cluster
- system_
data SystemData Response - 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_ boolaccess - 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_ Applicationversions_ cleanup_ policy Type Versions Cleanup Policy Response - The policy used to clean up unused versions.
- auxiliary_
subnets Sequence[SubnetResponse] - Auxiliary subnets for the cluster.
- azure_
active_ Azuredirectory Active Directory Response - The AAD authentication settings of the cluster.
- client_
connection_ intport - The port used for client connections to the cluster.
- clients
Sequence[Client
Certificate Response] - Client certificates that are allowed to manage the cluster.
- cluster_
code_ strversion - 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_ strcadence - 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_ strmode - The upgrade mode of the cluster when new Service Fabric runtime version is available.
- enable_
auto_ boolos_ upgrade - 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_
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_ boolpublic_ ip - 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[SettingsSection Description Response] - The list of custom fabric settings to configure the cluster.
- http_
gateway_ intconnection_ port - The port used for HTTP connections to the cluster.
- Sequence[IPTag
Response] - The list of IP tags associated with the default public IP address of the cluster.
- load_
balancing_ Sequence[Loadrules Balancing Rule Response] - Load balancing rules that are applied to the public load balancer of the cluster.
- network_
security_ Sequence[Networkrules Security Rule Response] - Custom Network Security Rules that are applied to the Virtual Network of the cluster.
- public_
ip_ strprefix_ id - Specify the resource id of a public IP prefix that the load balancer will allocate a public IP address from. Only supports IPv4.
- service_
endpoints Sequence[ServiceEndpoint Response] - 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.
- Mapping[str, str]
- Azure resource tags.
- use_
custom_ boolvnet - 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_ strmode - Indicates the update mode for Cross Az clusters.
- admin
User StringName - VM admin user name.
- cluster
Certificate List<String>Thumbprints - List of thumbprints of the cluster certificates.
- cluster
Id String - A service generated unique identifier for the cluster resource.
- cluster
State String - The current state of the cluster.
- dns
Name 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.
- provisioning
State String - The provisioning state of the managed cluster resource.
- sku Property Map
- The sku of the managed cluster
- system
Data Property Map - Metadata pertaining to creation and last modification of the resource.
- type String
- Azure resource type.
- addon
Features List<String> - List of add-on features to enable on the cluster.
- admin
Password String - VM admin user password.
- allow
Rdp BooleanAccess - 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 Property MapVersions Cleanup Policy - The policy used to clean up unused versions.
- auxiliary
Subnets List<Property Map> - Auxiliary subnets for the cluster.
- azure
Active Property MapDirectory - The AAD authentication settings of the cluster.
- client
Connection NumberPort - The port used for client connections to the cluster.
- clients List<Property Map>
- Client certificates that are allowed to manage the cluster.
- cluster
Code StringVersion - 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 StringCadence - 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 StringMode - The upgrade mode of the cluster when new Service Fabric runtime version is available.
- enable
Auto BooleanOSUpgrade - 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
Ipv6 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.
- enable
Service BooleanPublic IP - 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 List<Property Map> - The list of custom fabric settings to configure the cluster.
- http
Gateway NumberConnection Port - The port used for HTTP connections to the cluster.
- List<Property Map>
- The list of IP tags associated with the default public IP address of the cluster.
- load
Balancing List<Property Map>Rules - Load balancing rules that are applied to the public load balancer of the cluster.
- network
Security List<Property Map>Rules - Custom Network Security Rules that are applied to the Virtual Network of the cluster.
- public
IPPrefix StringId - Specify the resource id of a public IP prefix that the load balancer will allocate a public IP address from. Only supports IPv4.
- service
Endpoints List<Property Map> - Service endpoints for subnets in the cluster.
- subnet
Id 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.
- Map<String>
- Azure resource tags.
- use
Custom BooleanVnet - 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 Boolean - Indicates if the cluster has zone resiliency.
- zonal
Update StringMode - Indicates the update mode for Cross Az clusters.
Supporting Types
ApplicationTypeVersionsCleanupPolicyResponse
- Max
Unused intVersions To Keep - Number of unused versions per application type to keep.
- Max
Unused intVersions To Keep - Number of unused versions per application type to keep.
- max
Unused IntegerVersions To Keep - Number of unused versions per application type to keep.
- max
Unused numberVersions To Keep - Number of unused versions per application type to keep.
- max_
unused_ intversions_ to_ keep - Number of unused versions per application type to keep.
- max
Unused NumberVersions To Keep - Number of unused versions per application type to keep.
AzureActiveDirectoryResponse
- Client
Application string - Azure active directory client application id.
- Cluster
Application string - Azure active directory cluster application id.
- Tenant
Id string - Azure active directory tenant id.
- Client
Application string - Azure active directory client application id.
- Cluster
Application string - Azure active directory cluster application id.
- Tenant
Id string - Azure active directory tenant id.
- client
Application String - Azure active directory client application id.
- cluster
Application String - Azure active directory cluster application id.
- tenant
Id String - Azure active directory tenant id.
- client
Application string - Azure active directory client application id.
- cluster
Application string - Azure active directory cluster application id.
- tenant
Id 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.
- client
Application String - Azure active directory client application id.
- cluster
Application String - Azure active directory cluster application id.
- tenant
Id String - Azure active directory tenant id.
ClientCertificateResponse
- Is
Admin 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 string - Certificate common name.
- Issuer
Thumbprint string - Issuer thumbprint for the certificate. Only used together with CommonName.
- Thumbprint string
- Certificate thumbprint.
- Is
Admin 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 string - Certificate common name.
- Issuer
Thumbprint string - Issuer thumbprint for the certificate. Only used together with CommonName.
- Thumbprint string
- Certificate thumbprint.
- is
Admin Boolean - 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 String - Certificate common name.
- issuer
Thumbprint String - Issuer thumbprint for the certificate. Only used together with CommonName.
- thumbprint String
- Certificate thumbprint.
- is
Admin boolean - 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 string - Certificate common name.
- issuer
Thumbprint string - Issuer thumbprint for the certificate. Only used together with CommonName.
- thumbprint string
- Certificate thumbprint.
- is_
admin 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.
- is
Admin Boolean - 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 String - Certificate common name.
- issuer
Thumbprint String - Issuer thumbprint for the certificate. Only used together with CommonName.
- thumbprint String
- Certificate thumbprint.
IPTagResponse
- ip_
tag_ strtype - The IP tag type.
- tag str
- The value of the IP tag.
LoadBalancingRuleResponse
- Backend
Port int - The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.
- Frontend
Port 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 string - the reference to the load balancer probe used by the load balancing rule.
- Protocol string
- The reference to the transport protocol used by the load balancing rule.
- Load
Distribution string - 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 stringPath - The probe request path. Only supported for HTTP/HTTPS probes.
- Backend
Port int - The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.
- Frontend
Port 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 string - the reference to the load balancer probe used by the load balancing rule.
- Protocol string
- The reference to the transport protocol used by the load balancing rule.
- Load
Distribution string - 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 stringPath - The probe request path. Only supported for HTTP/HTTPS probes.
- backend
Port Integer - The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.
- frontend
Port 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.
- probe
Protocol String - the reference to the load balancer probe used by the load balancing rule.
- protocol String
- The reference to the transport protocol used by the load balancing rule.
- load
Distribution String - The load distribution policy for this rule.
- probe
Port Integer - The prob port used by the load balancing rule. Acceptable values are between 1 and 65535.
- probe
Request StringPath - The probe request path. Only supported for HTTP/HTTPS probes.
- backend
Port number - The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.
- frontend
Port 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.
- probe
Protocol string - the reference to the load balancer probe used by the load balancing rule.
- protocol string
- The reference to the transport protocol used by the load balancing rule.
- load
Distribution string - The load distribution policy for this rule.
- probe
Port number - The prob port used by the load balancing rule. Acceptable values are between 1 and 65535.
- probe
Request stringPath - The probe request path. Only supported for HTTP/HTTPS probes.
- backend_
port int - The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.
- frontend_
port 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 str - the reference to the load balancer probe used by the load balancing rule.
- protocol 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_ strpath - The probe request path. Only supported for HTTP/HTTPS probes.
- backend
Port Number - The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.
- frontend
Port 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.
- probe
Protocol String - the reference to the load balancer probe used by the load balancing rule.
- protocol String
- The reference to the transport protocol used by the load balancing rule.
- load
Distribution String - The load distribution policy for this rule.
- probe
Port Number - The prob port used by the load balancing rule. Acceptable values are between 1 and 65535.
- probe
Request StringPath - The probe request path. Only supported for HTTP/HTTPS probes.
NetworkSecurityRuleResponse
- Access string
- The network traffic is allowed or denied.
- Direction string
- Network security rule direction.
- Name string
- Network security rule name.
- Priority 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 string
- Network protocol this rule applies to.
- Description string
- Network security rule description.
- Destination
Address stringPrefix - 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 List<string>Prefixes - The destination address prefixes. CIDR or destination IP ranges.
- Destination
Port stringRange - he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
- Destination
Port List<string>Ranges - The destination port ranges.
- Source
Address stringPrefix - 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 List<string>Prefixes - The CIDR or source IP ranges.
- Source
Port stringRange - The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
- Source
Port List<string>Ranges - The source port ranges.
- Access string
- The network traffic is allowed or denied.
- Direction string
- Network security rule direction.
- Name string
- Network security rule name.
- Priority 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 string
- Network protocol this rule applies to.
- Description string
- Network security rule description.
- Destination
Address stringPrefix - 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 []stringPrefixes - The destination address prefixes. CIDR or destination IP ranges.
- Destination
Port stringRange - he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
- Destination
Port []stringRanges - The destination port ranges.
- Source
Address stringPrefix - 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 []stringPrefixes - The CIDR or source IP ranges.
- Source
Port stringRange - The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
- Source
Port []stringRanges - The source port ranges.
- access String
- The network traffic is allowed or denied.
- direction String
- Network security rule direction.
- name String
- Network security rule name.
- priority 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 String
- Network protocol this rule applies to.
- description String
- Network security rule description.
- destination
Address StringPrefix - 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 List<String>Prefixes - The destination address prefixes. CIDR or destination IP ranges.
- destination
Port StringRange - he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
- destination
Port List<String>Ranges - The destination port ranges.
- source
Address StringPrefix - 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 List<String>Prefixes - The CIDR or source IP ranges.
- source
Port StringRange - The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
- source
Port List<String>Ranges - The source port ranges.
- access string
- The network traffic is allowed or denied.
- direction string
- Network security rule direction.
- name string
- Network security rule name.
- priority 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 string
- Network protocol this rule applies to.
- description string
- Network security rule description.
- destination
Address stringPrefix - 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 string[]Prefixes - The destination address prefixes. CIDR or destination IP ranges.
- destination
Port stringRange - he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
- destination
Port string[]Ranges - The destination port ranges.
- source
Address stringPrefix - 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 string[]Prefixes - The CIDR or source IP ranges.
- source
Port stringRange - The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
- source
Port string[]Ranges - The source port ranges.
- access str
- The network traffic is allowed or denied.
- direction str
- Network security rule direction.
- name str
- Network security rule name.
- priority 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 str
- Network protocol this rule applies to.
- description str
- Network security rule description.
- destination_
address_ strprefix - 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_ Sequence[str]prefixes - The destination address prefixes. CIDR or destination IP ranges.
- destination_
port_ strrange - he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
- destination_
port_ Sequence[str]ranges - The destination port ranges.
- source_
address_ strprefix - 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_ Sequence[str]prefixes - The CIDR or source IP ranges.
- source_
port_ strrange - The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
- source_
port_ Sequence[str]ranges - The source port ranges.
- access String
- The network traffic is allowed or denied.
- direction String
- Network security rule direction.
- name String
- Network security rule name.
- priority 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 String
- Network protocol this rule applies to.
- description String
- Network security rule description.
- destination
Address StringPrefix - 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 List<String>Prefixes - The destination address prefixes. CIDR or destination IP ranges.
- destination
Port StringRange - he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
- destination
Port List<String>Ranges - The destination port ranges.
- source
Address StringPrefix - 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 List<String>Prefixes - The CIDR or source IP ranges.
- source
Port StringRange - The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
- source
Port List<String>Ranges - The source port ranges.
ServiceEndpointResponse
SettingsParameterDescriptionResponse
SettingsSectionDescriptionResponse
- Name string
- The section name of the fabric settings.
- Parameters
List<Pulumi.
Azure Native. Service Fabric. Inputs. Settings Parameter Description Response> - The collection of parameters in the section.
- Name string
- The section name of the fabric settings.
- Parameters
[]Settings
Parameter Description Response - The collection of parameters in the section.
- name String
- The section name of the fabric settings.
- parameters
List<Settings
Parameter Description Response> - The collection of parameters in the section.
- name string
- The section name of the fabric settings.
- parameters
Settings
Parameter Description Response[] - The collection of parameters in the section.
- name str
- The section name of the fabric settings.
- parameters
Sequence[Settings
Parameter Description Response] - The collection of parameters in the section.
- name String
- The section name of the fabric settings.
- parameters List<Property Map>
- The collection of parameters in the section.
SkuResponse
- Name string
- Sku Name.
- Name string
- Sku Name.
- name String
- Sku Name.
- name string
- Sku Name.
- name str
- Sku Name.
- name String
- Sku Name.
SubnetResponse
- Name string
- 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 stringGroup Id - Full resource id for the network security group.
- Private
Endpoint stringNetwork Policies - Enable or Disable apply network policies on private end point in the subnet.
- Private
Link stringService Network Policies - Enable or Disable apply network policies on private link service in the subnet.
- Name string
- 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 stringGroup Id - Full resource id for the network security group.
- Private
Endpoint stringNetwork Policies - Enable or Disable apply network policies on private end point in the subnet.
- Private
Link stringService Network Policies - Enable or Disable apply network policies on private link service in the subnet.
- name String
- Subnet name.
- enable
Ipv6 Boolean - Indicates wether to enable Ipv6 or not. If not provided, it will take the same configuration as the cluster.
- network
Security StringGroup Id - Full resource id for the network security group.
- private
Endpoint StringNetwork Policies - Enable or Disable apply network policies on private end point in the subnet.
- private
Link StringService Network Policies - Enable or Disable apply network policies on private link service in the subnet.
- name string
- Subnet name.
- enable
Ipv6 boolean - Indicates wether to enable Ipv6 or not. If not provided, it will take the same configuration as the cluster.
- network
Security stringGroup Id - Full resource id for the network security group.
- private
Endpoint stringNetwork Policies - Enable or Disable apply network policies on private end point in the subnet.
- private
Link stringService Network Policies - Enable or Disable apply network policies on private link service in the subnet.
- name 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_ strgroup_ id - Full resource id for the network security group.
- private_
endpoint_ strnetwork_ policies - Enable or Disable apply network policies on private end point in the subnet.
- private_
link_ strservice_ network_ policies - Enable or Disable apply network policies on private link service in the subnet.
- name String
- Subnet name.
- enable
Ipv6 Boolean - Indicates wether to enable Ipv6 or not. If not provided, it will take the same configuration as the cluster.
- network
Security StringGroup Id - Full resource id for the network security group.
- private
Endpoint StringNetwork Policies - Enable or Disable apply network policies on private end point in the subnet.
- private
Link StringService Network Policies - Enable or Disable apply network policies on private link service in the subnet.
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC).
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC).
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC).
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC).
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC).
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC).
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0