Module 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.
Resources
Others
Resources
Resource Cluster
class Cluster extends CustomResourceManages a Service Fabric Cluster.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleCluster = new azure.servicefabric.Cluster("exampleCluster", {
resourceGroupName: exampleResourceGroup.name,
location: exampleResourceGroup.location,
reliabilityLevel: "Bronze",
upgradeMode: "Manual",
clusterCodeVersion: "6.5.639.9590",
vmImage: "Windows",
managementEndpoint: "https://example:80",
node_type: [{
name: "first",
instanceCount: 3,
isPrimary: true,
clientEndpointPort: 2020,
httpEndpointPort: 80,
}],
});constructor
new Cluster(name: string, args: ClusterArgs, opts?: pulumi.CustomResourceOptions)Create a Cluster resource with the given unique name, arguments, and options.
nameThe unique name of the resource.argsThe arguments to use to populate this resource's properties.optsA bag of options that control this resource's behavior.
method get
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterState, opts?: pulumi.CustomResourceOptions): ClusterGet an existing Cluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
method getProvider
getProvider(moduleMember: string): ProviderResource | undefinedmethod isInstance
public static isInstance(obj: any): obj is ClusterReturns true if the given object is an instance of Cluster. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
property addOnFeatures
public addOnFeatures: pulumi.Output<string[] | undefined>;A List of one or more features which should be enabled, such as DnsService.
property azureActiveDirectory
public azureActiveDirectory: pulumi.Output<ClusterAzureActiveDirectory | undefined>;An azureActiveDirectory block as defined below.
property certificate
public certificate: pulumi.Output<ClusterCertificate | undefined>;A certificate block as defined below. Conflicts with certificateCommonNames.
property certificateCommonNames
public certificateCommonNames: pulumi.Output<ClusterCertificateCommonNames | undefined>;A certificateCommonNames block as defined below. Conflicts with certificate.
property clientCertificateCommonNames
public clientCertificateCommonNames: pulumi.Output<ClusterClientCertificateCommonName[] | undefined>;A clientCertificateCommonName block as defined below.
property clientCertificateThumbprints
public clientCertificateThumbprints: pulumi.Output<ClusterClientCertificateThumbprint[] | undefined>;One or two clientCertificateThumbprint blocks as defined below.
property clusterCodeVersion
public clusterCodeVersion: pulumi.Output<string>;Required if Upgrade Mode set to Manual, Specifies the Version of the Cluster Code of the cluster.
property clusterEndpoint
public clusterEndpoint: pulumi.Output<string>;The Cluster Endpoint for this Service Fabric Cluster.
property diagnosticsConfig
public diagnosticsConfig: pulumi.Output<ClusterDiagnosticsConfig | undefined>;A diagnosticsConfig block as defined below. Changing this forces a new resource to be created.
property fabricSettings
public fabricSettings: pulumi.Output<ClusterFabricSetting[] | undefined>;One or more fabricSettings blocks as defined below.
property id
id: Output<ID>;id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
property location
public location: pulumi.Output<string>;Specifies the Azure Region where the Service Fabric Cluster should exist. Changing this forces a new resource to be created.
property managementEndpoint
public managementEndpoint: pulumi.Output<string>;Specifies the Management Endpoint of the cluster such as http://example.com. Changing this forces a new resource to be created.
property name
public name: pulumi.Output<string>;The name of the Service Fabric Cluster. Changing this forces a new resource to be created.
property nodeTypes
public nodeTypes: pulumi.Output<ClusterNodeType[]>;One or more nodeType blocks as defined below.
property reliabilityLevel
public reliabilityLevel: pulumi.Output<string>;Specifies the Reliability Level of the Cluster. Possible values include None, Bronze, Silver, Gold and Platinum.
property resourceGroupName
public resourceGroupName: pulumi.Output<string>;The name of the Resource Group in which the Service Fabric Cluster exists. Changing this forces a new resource to be created.
property reverseProxyCertificate
public reverseProxyCertificate: pulumi.Output<ClusterReverseProxyCertificate | undefined>;A reverseProxyCertificate block as defined below.
property tags
public tags: pulumi.Output<{[key: string]: string} | undefined>;A mapping of tags to assign to the resource.
property upgradeMode
public upgradeMode: pulumi.Output<string>;Specifies the Upgrade Mode of the cluster. Possible values are Automatic or Manual.
property urn
urn: Output<URN>;urn is the stable logical URN used to distinctly address a resource, both before and after deployments.
property vmImage
public vmImage: pulumi.Output<string>;Specifies the Image expected for the Service Fabric Cluster, such as Windows. Changing this forces a new resource to be created.
Others
interface ClusterArgs
interface ClusterArgsThe set of arguments for constructing a Cluster resource.
property addOnFeatures
addOnFeatures?: pulumi.Input<pulumi.Input<string>[]>;A List of one or more features which should be enabled, such as DnsService.
property azureActiveDirectory
azureActiveDirectory?: pulumi.Input<ClusterAzureActiveDirectory>;An azureActiveDirectory block as defined below.
property certificate
certificate?: pulumi.Input<ClusterCertificate>;A certificate block as defined below. Conflicts with certificateCommonNames.
property certificateCommonNames
certificateCommonNames?: pulumi.Input<ClusterCertificateCommonNames>;A certificateCommonNames block as defined below. Conflicts with certificate.
property clientCertificateCommonNames
clientCertificateCommonNames?: pulumi.Input<pulumi.Input<ClusterClientCertificateCommonName>[]>;A clientCertificateCommonName block as defined below.
property clientCertificateThumbprints
clientCertificateThumbprints?: pulumi.Input<pulumi.Input<ClusterClientCertificateThumbprint>[]>;One or two clientCertificateThumbprint blocks as defined below.
property clusterCodeVersion
clusterCodeVersion?: pulumi.Input<string>;Required if Upgrade Mode set to Manual, Specifies the Version of the Cluster Code of the cluster.
property diagnosticsConfig
diagnosticsConfig?: pulumi.Input<ClusterDiagnosticsConfig>;A diagnosticsConfig block as defined below. Changing this forces a new resource to be created.
property fabricSettings
fabricSettings?: pulumi.Input<pulumi.Input<ClusterFabricSetting>[]>;One or more fabricSettings blocks as defined below.
property location
location?: pulumi.Input<string>;Specifies the Azure Region where the Service Fabric Cluster should exist. Changing this forces a new resource to be created.
property managementEndpoint
managementEndpoint: pulumi.Input<string>;Specifies the Management Endpoint of the cluster such as http://example.com. Changing this forces a new resource to be created.
property name
name?: pulumi.Input<string>;The name of the Service Fabric Cluster. Changing this forces a new resource to be created.
property nodeTypes
nodeTypes: pulumi.Input<pulumi.Input<ClusterNodeType>[]>;One or more nodeType blocks as defined below.
property reliabilityLevel
reliabilityLevel: pulumi.Input<string>;Specifies the Reliability Level of the Cluster. Possible values include None, Bronze, Silver, Gold and Platinum.
property resourceGroupName
resourceGroupName: pulumi.Input<string>;The name of the Resource Group in which the Service Fabric Cluster exists. Changing this forces a new resource to be created.
property reverseProxyCertificate
reverseProxyCertificate?: pulumi.Input<ClusterReverseProxyCertificate>;A reverseProxyCertificate block as defined below.
property tags
tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;A mapping of tags to assign to the resource.
property upgradeMode
upgradeMode: pulumi.Input<string>;Specifies the Upgrade Mode of the cluster. Possible values are Automatic or Manual.
property vmImage
vmImage: pulumi.Input<string>;Specifies the Image expected for the Service Fabric Cluster, such as Windows. Changing this forces a new resource to be created.
interface ClusterState
interface ClusterStateInput properties used for looking up and filtering Cluster resources.
property addOnFeatures
addOnFeatures?: pulumi.Input<pulumi.Input<string>[]>;A List of one or more features which should be enabled, such as DnsService.
property azureActiveDirectory
azureActiveDirectory?: pulumi.Input<ClusterAzureActiveDirectory>;An azureActiveDirectory block as defined below.
property certificate
certificate?: pulumi.Input<ClusterCertificate>;A certificate block as defined below. Conflicts with certificateCommonNames.
property certificateCommonNames
certificateCommonNames?: pulumi.Input<ClusterCertificateCommonNames>;A certificateCommonNames block as defined below. Conflicts with certificate.
property clientCertificateCommonNames
clientCertificateCommonNames?: pulumi.Input<pulumi.Input<ClusterClientCertificateCommonName>[]>;A clientCertificateCommonName block as defined below.
property clientCertificateThumbprints
clientCertificateThumbprints?: pulumi.Input<pulumi.Input<ClusterClientCertificateThumbprint>[]>;One or two clientCertificateThumbprint blocks as defined below.
property clusterCodeVersion
clusterCodeVersion?: pulumi.Input<string>;Required if Upgrade Mode set to Manual, Specifies the Version of the Cluster Code of the cluster.
property clusterEndpoint
clusterEndpoint?: pulumi.Input<string>;The Cluster Endpoint for this Service Fabric Cluster.
property diagnosticsConfig
diagnosticsConfig?: pulumi.Input<ClusterDiagnosticsConfig>;A diagnosticsConfig block as defined below. Changing this forces a new resource to be created.
property fabricSettings
fabricSettings?: pulumi.Input<pulumi.Input<ClusterFabricSetting>[]>;One or more fabricSettings blocks as defined below.
property location
location?: pulumi.Input<string>;Specifies the Azure Region where the Service Fabric Cluster should exist. Changing this forces a new resource to be created.
property managementEndpoint
managementEndpoint?: pulumi.Input<string>;Specifies the Management Endpoint of the cluster such as http://example.com. Changing this forces a new resource to be created.
property name
name?: pulumi.Input<string>;The name of the Service Fabric Cluster. Changing this forces a new resource to be created.
property nodeTypes
nodeTypes?: pulumi.Input<pulumi.Input<ClusterNodeType>[]>;One or more nodeType blocks as defined below.
property reliabilityLevel
reliabilityLevel?: pulumi.Input<string>;Specifies the Reliability Level of the Cluster. Possible values include None, Bronze, Silver, Gold and Platinum.
property resourceGroupName
resourceGroupName?: pulumi.Input<string>;The name of the Resource Group in which the Service Fabric Cluster exists. Changing this forces a new resource to be created.
property reverseProxyCertificate
reverseProxyCertificate?: pulumi.Input<ClusterReverseProxyCertificate>;A reverseProxyCertificate block as defined below.
property tags
tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;A mapping of tags to assign to the resource.
property upgradeMode
upgradeMode?: pulumi.Input<string>;Specifies the Upgrade Mode of the cluster. Possible values are Automatic or Manual.
property vmImage
vmImage?: pulumi.Input<string>;Specifies the Image expected for the Service Fabric Cluster, such as Windows. Changing this forces a new resource to be created.