1. Docs
  2. Reference
  3. API
  4. pulumi_azure
  5. servicefabric

This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

servicefabric

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.servicefabric.Cluster(resource_name, opts=None, add_on_features=None, azure_active_directory=None, certificate=None, certificate_common_names=None, client_certificate_common_names=None, client_certificate_thumbprints=None, cluster_code_version=None, diagnostics_config=None, fabric_settings=None, location=None, management_endpoint=None, name=None, node_types=None, reliability_level=None, resource_group_name=None, reverse_proxy_certificate=None, tags=None, upgrade_mode=None, vm_image=None, __props__=None, __name__=None, __opts__=None)

Manages a Service Fabric Cluster.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_cluster = azure.servicefabric.Cluster("exampleCluster",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    reliability_level="Bronze",
    upgrade_mode="Manual",
    cluster_code_version="6.5.639.9590",
    vm_image="Windows",
    management_endpoint="https://example:80",
    node_type=[{
        "name": "first",
        "instanceCount": 3,
        "isPrimary": True,
        "clientEndpointPort": 2020,
        "httpEndpointPort": 80,
    }])
Parameters

  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • add_on_features (pulumi.Input[list]) – A List of one or more features which should be enabled, such as DnsService.

  • azure_active_directory (pulumi.Input[dict]) – An azure_active_directory block as defined below.

  • certificate (pulumi.Input[dict]) – A certificate block as defined below. Conflicts with certificate_common_names.

  • certificate_common_names (pulumi.Input[dict]) – A certificate_common_names block as defined below. Conflicts with certificate.

  • client_certificate_common_names (pulumi.Input[list]) – A client_certificate_common_name block as defined below.

  • client_certificate_thumbprints (pulumi.Input[list]) – One or two client_certificate_thumbprint blocks as defined below.

  • cluster_code_version (pulumi.Input[str]) – Required if Upgrade Mode set to Manual, Specifies the Version of the Cluster Code of the cluster.

  • diagnostics_config (pulumi.Input[dict]) – A diagnostics_config block as defined below. Changing this forces a new resource to be created.

  • fabric_settings (pulumi.Input[list]) – One or more fabric_settings blocks as defined below.

  • location (pulumi.Input[str]) – Specifies the Azure Region where the Service Fabric Cluster should exist. Changing this forces a new resource to be created.

  • management_endpoint (pulumi.Input[str]) – Specifies the Management Endpoint of the cluster such as http://example.com. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – The name of the Service Fabric Cluster. Changing this forces a new resource to be created.

  • node_types (pulumi.Input[list]) – One or more node_type blocks as defined below.

  • reliability_level (pulumi.Input[str]) – Specifies the Reliability Level of the Cluster. Possible values include None, Bronze, Silver, Gold and Platinum.

  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which the Service Fabric Cluster exists. Changing this forces a new resource to be created.

  • reverse_proxy_certificate (pulumi.Input[dict]) – A reverse_proxy_certificate block as defined below.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • upgrade_mode (pulumi.Input[str]) – Specifies the Upgrade Mode of the cluster. Possible values are Automatic or Manual.

  • vm_image (pulumi.Input[str]) – Specifies the Image expected for the Service Fabric Cluster, such as Windows. Changing this forces a new resource to be created.

The azure_active_directory object supports the following:

  • clientApplicationId (pulumi.Input[str]) - The Azure Active Directory Client ID which should be used for the Client Application.

  • clusterApplicationId (pulumi.Input[str]) - The Azure Active Directory Cluster Application ID.

  • tenant_id (pulumi.Input[str]) - The Azure Active Directory Tenant ID.

The certificate object supports the following:

  • thumbprint (pulumi.Input[str]) - The Thumbprint of the Certificate.

  • thumbprintSecondary (pulumi.Input[str]) - The Secondary Thumbprint of the Certificate.

  • x509StoreName (pulumi.Input[str]) - The X509 Store where the Certificate Exists, such as My.

The certificate_common_names object supports the following:

  • commonNames (pulumi.Input[list]) - A common_names block as defined below.

    • certificateCommonName (pulumi.Input[str]) - The common or subject name of the certificate.

    • certificateIssuerThumbprint (pulumi.Input[str]) - The Issuer Thumbprint of the Certificate.

  • x509StoreName (pulumi.Input[str]) - The X509 Store where the Certificate Exists, such as My.

The client_certificate_common_names object supports the following:

  • commonName (pulumi.Input[str])

  • isAdmin (pulumi.Input[bool]) - Does the Client Certificate have Admin Access to the cluster? Non-admin clients can only perform read only operations on the cluster.

  • issuerThumbprint (pulumi.Input[str])

The client_certificate_thumbprints object supports the following:

  • isAdmin (pulumi.Input[bool]) - Does the Client Certificate have Admin Access to the cluster? Non-admin clients can only perform read only operations on the cluster.

  • thumbprint (pulumi.Input[str]) - The Thumbprint associated with the Client Certificate.

The diagnostics_config object supports the following:

  • blobEndpoint (pulumi.Input[str]) - The Blob Endpoint of the Storage Account.

  • protectedAccountKeyName (pulumi.Input[str]) - The protected diagnostics storage key name, such as StorageAccountKey1.

  • queueEndpoint (pulumi.Input[str]) - The Queue Endpoint of the Storage Account.

  • storage_account_name (pulumi.Input[str]) - The name of the Storage Account where the Diagnostics should be sent to.

  • tableEndpoint (pulumi.Input[str]) - The Table Endpoint of the Storage Account.

The fabric_settings object supports the following:

  • name (pulumi.Input[str]) - The name of the Fabric Setting, such as Security or Federation.

  • parameters (pulumi.Input[dict]) - A map containing settings for the specified Fabric Setting.

The node_types object supports the following:

  • applicationPorts (pulumi.Input[dict]) - A application_ports block as defined below.

    • endPort (pulumi.Input[float]) - The end of the Application Port Range on this Node Type.

    • startPort (pulumi.Input[float]) - The start of the Application Port Range on this Node Type.

  • capacities (pulumi.Input[dict]) - The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has.

  • clientEndpointPort (pulumi.Input[float]) - The Port used for the Client Endpoint for this Node Type. Changing this forces a new resource to be created.

  • durabilityLevel (pulumi.Input[str]) - The Durability Level for this Node Type. Possible values include Bronze, Gold and Silver. Defaults to Bronze. Changing this forces a new resource to be created.

  • ephemeralPorts (pulumi.Input[dict]) - A ephemeral_ports block as defined below.

    • endPort (pulumi.Input[float]) - The end of the Ephemeral Port Range on this Node Type.

    • startPort (pulumi.Input[float]) - The start of the Ephemeral Port Range on this Node Type.

  • httpEndpointPort (pulumi.Input[float]) - The Port used for the HTTP Endpoint for this Node Type. Changing this forces a new resource to be created.

  • instanceCount (pulumi.Input[float]) - The number of nodes for this Node Type.

  • isPrimary (pulumi.Input[bool]) - Is this the Primary Node Type? Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) - The name of the Node Type. Changing this forces a new resource to be created.

  • placementProperties (pulumi.Input[dict]) - The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run.

  • reverseProxyEndpointPort (pulumi.Input[float]) - The Port used for the Reverse Proxy Endpoint for this Node Type. Changing this will upgrade the cluster.

The reverse_proxy_certificate object supports the following:

  • thumbprint (pulumi.Input[str]) - The Thumbprint of the Certificate.

  • thumbprintSecondary (pulumi.Input[str]) - The Secondary Thumbprint of the Certificate.

  • x509StoreName (pulumi.Input[str]) - The X509 Store where the Certificate Exists, such as My.

add_on_features: pulumi.Output[list] = None

A List of one or more features which should be enabled, such as DnsService.

azure_active_directory: pulumi.Output[dict] = None

An azure_active_directory block as defined below.

  • clientApplicationId (str) - The Azure Active Directory Client ID which should be used for the Client Application.

  • clusterApplicationId (str) - The Azure Active Directory Cluster Application ID.

  • tenant_id (str) - The Azure Active Directory Tenant ID.

certificate: pulumi.Output[dict] = None

A certificate block as defined below. Conflicts with certificate_common_names.

  • thumbprint (str) - The Thumbprint of the Certificate.

  • thumbprintSecondary (str) - The Secondary Thumbprint of the Certificate.

  • x509StoreName (str) - The X509 Store where the Certificate Exists, such as My.

certificate_common_names: pulumi.Output[dict] = None

A certificate_common_names block as defined below. Conflicts with certificate.

  • commonNames (list) - A common_names block as defined below.

    • certificateCommonName (str) - The common or subject name of the certificate.

    • certificateIssuerThumbprint (str) - The Issuer Thumbprint of the Certificate.

  • x509StoreName (str) - The X509 Store where the Certificate Exists, such as My.

client_certificate_common_names: pulumi.Output[list] = None

A client_certificate_common_name block as defined below.

  • commonName (str)

  • isAdmin (bool) - Does the Client Certificate have Admin Access to the cluster? Non-admin clients can only perform read only operations on the cluster.

  • issuerThumbprint (str)

client_certificate_thumbprints: pulumi.Output[list] = None

One or two client_certificate_thumbprint blocks as defined below.

  • isAdmin (bool) - Does the Client Certificate have Admin Access to the cluster? Non-admin clients can only perform read only operations on the cluster.

  • thumbprint (str) - The Thumbprint associated with the Client Certificate.

cluster_code_version: pulumi.Output[str] = None

Required if Upgrade Mode set to Manual, Specifies the Version of the Cluster Code of the cluster.

cluster_endpoint: pulumi.Output[str] = None

The Cluster Endpoint for this Service Fabric Cluster.

diagnostics_config: pulumi.Output[dict] = None

A diagnostics_config block as defined below. Changing this forces a new resource to be created.

  • blobEndpoint (str) - The Blob Endpoint of the Storage Account.

  • protectedAccountKeyName (str) - The protected diagnostics storage key name, such as StorageAccountKey1.

  • queueEndpoint (str) - The Queue Endpoint of the Storage Account.

  • storage_account_name (str) - The name of the Storage Account where the Diagnostics should be sent to.

  • tableEndpoint (str) - The Table Endpoint of the Storage Account.

fabric_settings: pulumi.Output[list] = None

One or more fabric_settings blocks as defined below.

  • name (str) - The name of the Fabric Setting, such as Security or Federation.

  • parameters (dict) - A map containing settings for the specified Fabric Setting.

location: pulumi.Output[str] = None

Specifies the Azure Region where the Service Fabric Cluster should exist. Changing this forces a new resource to be created.

management_endpoint: pulumi.Output[str] = None

Specifies the Management Endpoint of the cluster such as http://example.com. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None

The name of the Service Fabric Cluster. Changing this forces a new resource to be created.

node_types: pulumi.Output[list] = None

One or more node_type blocks as defined below.

  • applicationPorts (dict) - A application_ports block as defined below.

    • endPort (float) - The end of the Application Port Range on this Node Type.

    • startPort (float) - The start of the Application Port Range on this Node Type.

  • capacities (dict) - The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has.

  • clientEndpointPort (float) - The Port used for the Client Endpoint for this Node Type. Changing this forces a new resource to be created.

  • durabilityLevel (str) - The Durability Level for this Node Type. Possible values include Bronze, Gold and Silver. Defaults to Bronze. Changing this forces a new resource to be created.

  • ephemeralPorts (dict) - A ephemeral_ports block as defined below.

    • endPort (float) - The end of the Ephemeral Port Range on this Node Type.

    • startPort (float) - The start of the Ephemeral Port Range on this Node Type.

  • httpEndpointPort (float) - The Port used for the HTTP Endpoint for this Node Type. Changing this forces a new resource to be created.

  • instanceCount (float) - The number of nodes for this Node Type.

  • isPrimary (bool) - Is this the Primary Node Type? Changing this forces a new resource to be created.

  • name (str) - The name of the Node Type. Changing this forces a new resource to be created.

  • placementProperties (dict) - The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run.

  • reverseProxyEndpointPort (float) - The Port used for the Reverse Proxy Endpoint for this Node Type. Changing this will upgrade the cluster.

reliability_level: pulumi.Output[str] = None

Specifies the Reliability Level of the Cluster. Possible values include None, Bronze, Silver, Gold and Platinum.

resource_group_name: pulumi.Output[str] = None

The name of the Resource Group in which the Service Fabric Cluster exists. Changing this forces a new resource to be created.

reverse_proxy_certificate: pulumi.Output[dict] = None

A reverse_proxy_certificate block as defined below.

  • thumbprint (str) - The Thumbprint of the Certificate.

  • thumbprintSecondary (str) - The Secondary Thumbprint of the Certificate.

  • x509StoreName (str) - The X509 Store where the Certificate Exists, such as My.

tags: pulumi.Output[dict] = None

A mapping of tags to assign to the resource.

upgrade_mode: pulumi.Output[str] = None

Specifies the Upgrade Mode of the cluster. Possible values are Automatic or Manual.

vm_image: pulumi.Output[str] = None

Specifies the Image expected for the Service Fabric Cluster, such as Windows. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, add_on_features=None, azure_active_directory=None, certificate=None, certificate_common_names=None, client_certificate_common_names=None, client_certificate_thumbprints=None, cluster_code_version=None, cluster_endpoint=None, diagnostics_config=None, fabric_settings=None, location=None, management_endpoint=None, name=None, node_types=None, reliability_level=None, resource_group_name=None, reverse_proxy_certificate=None, tags=None, upgrade_mode=None, vm_image=None)

Get an existing Cluster resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • add_on_features (pulumi.Input[list]) – A List of one or more features which should be enabled, such as DnsService.

  • azure_active_directory (pulumi.Input[dict]) – An azure_active_directory block as defined below.

  • certificate (pulumi.Input[dict]) – A certificate block as defined below. Conflicts with certificate_common_names.

  • certificate_common_names (pulumi.Input[dict]) – A certificate_common_names block as defined below. Conflicts with certificate.

  • client_certificate_common_names (pulumi.Input[list]) – A client_certificate_common_name block as defined below.

  • client_certificate_thumbprints (pulumi.Input[list]) – One or two client_certificate_thumbprint blocks as defined below.

  • cluster_code_version (pulumi.Input[str]) – Required if Upgrade Mode set to Manual, Specifies the Version of the Cluster Code of the cluster.

  • cluster_endpoint (pulumi.Input[str]) – The Cluster Endpoint for this Service Fabric Cluster.

  • diagnostics_config (pulumi.Input[dict]) – A diagnostics_config block as defined below. Changing this forces a new resource to be created.

  • fabric_settings (pulumi.Input[list]) – One or more fabric_settings blocks as defined below.

  • location (pulumi.Input[str]) – Specifies the Azure Region where the Service Fabric Cluster should exist. Changing this forces a new resource to be created.

  • management_endpoint (pulumi.Input[str]) – Specifies the Management Endpoint of the cluster such as http://example.com. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – The name of the Service Fabric Cluster. Changing this forces a new resource to be created.

  • node_types (pulumi.Input[list]) – One or more node_type blocks as defined below.

  • reliability_level (pulumi.Input[str]) – Specifies the Reliability Level of the Cluster. Possible values include None, Bronze, Silver, Gold and Platinum.

  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which the Service Fabric Cluster exists. Changing this forces a new resource to be created.

  • reverse_proxy_certificate (pulumi.Input[dict]) – A reverse_proxy_certificate block as defined below.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • upgrade_mode (pulumi.Input[str]) – Specifies the Upgrade Mode of the cluster. Possible values are Automatic or Manual.

  • vm_image (pulumi.Input[str]) – Specifies the Image expected for the Service Fabric Cluster, such as Windows. Changing this forces a new resource to be created.

The azure_active_directory object supports the following:

  • clientApplicationId (pulumi.Input[str]) - The Azure Active Directory Client ID which should be used for the Client Application.

  • clusterApplicationId (pulumi.Input[str]) - The Azure Active Directory Cluster Application ID.

  • tenant_id (pulumi.Input[str]) - The Azure Active Directory Tenant ID.

The certificate object supports the following:

  • thumbprint (pulumi.Input[str]) - The Thumbprint of the Certificate.

  • thumbprintSecondary (pulumi.Input[str]) - The Secondary Thumbprint of the Certificate.

  • x509StoreName (pulumi.Input[str]) - The X509 Store where the Certificate Exists, such as My.

The certificate_common_names object supports the following:

  • commonNames (pulumi.Input[list]) - A common_names block as defined below.

    • certificateCommonName (pulumi.Input[str]) - The common or subject name of the certificate.

    • certificateIssuerThumbprint (pulumi.Input[str]) - The Issuer Thumbprint of the Certificate.

  • x509StoreName (pulumi.Input[str]) - The X509 Store where the Certificate Exists, such as My.

The client_certificate_common_names object supports the following:

  • commonName (pulumi.Input[str])

  • isAdmin (pulumi.Input[bool]) - Does the Client Certificate have Admin Access to the cluster? Non-admin clients can only perform read only operations on the cluster.

  • issuerThumbprint (pulumi.Input[str])

The client_certificate_thumbprints object supports the following:

  • isAdmin (pulumi.Input[bool]) - Does the Client Certificate have Admin Access to the cluster? Non-admin clients can only perform read only operations on the cluster.

  • thumbprint (pulumi.Input[str]) - The Thumbprint associated with the Client Certificate.

The diagnostics_config object supports the following:

  • blobEndpoint (pulumi.Input[str]) - The Blob Endpoint of the Storage Account.

  • protectedAccountKeyName (pulumi.Input[str]) - The protected diagnostics storage key name, such as StorageAccountKey1.

  • queueEndpoint (pulumi.Input[str]) - The Queue Endpoint of the Storage Account.

  • storage_account_name (pulumi.Input[str]) - The name of the Storage Account where the Diagnostics should be sent to.

  • tableEndpoint (pulumi.Input[str]) - The Table Endpoint of the Storage Account.

The fabric_settings object supports the following:

  • name (pulumi.Input[str]) - The name of the Fabric Setting, such as Security or Federation.

  • parameters (pulumi.Input[dict]) - A map containing settings for the specified Fabric Setting.

The node_types object supports the following:

  • applicationPorts (pulumi.Input[dict]) - A application_ports block as defined below.

    • endPort (pulumi.Input[float]) - The end of the Application Port Range on this Node Type.

    • startPort (pulumi.Input[float]) - The start of the Application Port Range on this Node Type.

  • capacities (pulumi.Input[dict]) - The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has.

  • clientEndpointPort (pulumi.Input[float]) - The Port used for the Client Endpoint for this Node Type. Changing this forces a new resource to be created.

  • durabilityLevel (pulumi.Input[str]) - The Durability Level for this Node Type. Possible values include Bronze, Gold and Silver. Defaults to Bronze. Changing this forces a new resource to be created.

  • ephemeralPorts (pulumi.Input[dict]) - A ephemeral_ports block as defined below.

    • endPort (pulumi.Input[float]) - The end of the Ephemeral Port Range on this Node Type.

    • startPort (pulumi.Input[float]) - The start of the Ephemeral Port Range on this Node Type.

  • httpEndpointPort (pulumi.Input[float]) - The Port used for the HTTP Endpoint for this Node Type. Changing this forces a new resource to be created.

  • instanceCount (pulumi.Input[float]) - The number of nodes for this Node Type.

  • isPrimary (pulumi.Input[bool]) - Is this the Primary Node Type? Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) - The name of the Node Type. Changing this forces a new resource to be created.

  • placementProperties (pulumi.Input[dict]) - The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run.

  • reverseProxyEndpointPort (pulumi.Input[float]) - The Port used for the Reverse Proxy Endpoint for this Node Type. Changing this will upgrade the cluster.

The reverse_proxy_certificate object supports the following:

  • thumbprint (pulumi.Input[str]) - The Thumbprint of the Certificate.

  • thumbprintSecondary (pulumi.Input[str]) - The Secondary Thumbprint of the Certificate.

  • x509StoreName (pulumi.Input[str]) - The X509 Store where the Certificate Exists, such as My.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str