Module servicefabric

@pulumi/azure > 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 Cluster

extends CustomResource

Manage a Service Fabric Cluster.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const testResourceGroup = new azure.core.ResourceGroup("test", {
    location: "West Europe",
    name: "example-resources",
});
const testCluster = new azure.servicefabric.Cluster("test", {
    clusterCodeVersion: "6.3.176.9494",
    location: testResourceGroup.location,
    managementEndpoint: "https://example:80",
    name: "example-servicefabric",
    nodeTypes: [{
        clientEndpointPort: 2020,
        httpEndpointPort: 80,
        instanceCount: 3,
        isPrimary: true,
        name: "first",
    }],
    reliabilityLevel: "Bronze",
    resourceGroupName: testResourceGroup.name,
    upgradeMode: "Manual",
    vmImage: "Windows",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/service_fabric_cluster.html.markdown.

constructor

new Cluster(name: string, args: ClusterArgs, opts?: pulumi.CustomResourceOptions)

Create a Cluster resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A 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): Cluster

Get 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 | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns 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<{
    clientApplicationId: string;
    clusterApplicationId: string;
    tenantId: string;
} | undefined>;

An azureActiveDirectory block as defined below.

property certificate

public certificate: pulumi.Output<{
    thumbprint: string;
    thumbprintSecondary: undefined | string;
    x509StoreName: string;
} | undefined>;

A certificate block as defined below. Conflicts with certificateCommonNames.

property certificateCommonNames

public certificateCommonNames: pulumi.Output<{
    commonNames: {
        certificateCommonName: string;
        certificateIssuerThumbprint: undefined | string;
    }[];
    x509StoreName: string;
} | undefined>;

A certificateCommonNames block as defined below. Conflicts with certificate.

property clientCertificateThumbprints

public clientCertificateThumbprints: pulumi.Output<{
    isAdmin: boolean;
    thumbprint: string;
}[] | 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<{
    blobEndpoint: string;
    protectedAccountKeyName: string;
    queueEndpoint: string;
    storageAccountName: string;
    tableEndpoint: string;
} | undefined>;

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

property fabricSettings

public fabricSettings: pulumi.Output<{
    name: string;
    parameters: undefined | {[key: string]: any};
}[] | 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<{
    applicationPorts: {
        endPort: number;
        startPort: number;
    };
    capacities: undefined | {[key: string]: any};
    clientEndpointPort: number;
    durabilityLevel: undefined | string;
    ephemeralPorts: {
        endPort: number;
        startPort: number;
    };
    httpEndpointPort: number;
    instanceCount: number;
    isPrimary: boolean;
    name: string;
    placementProperties: undefined | {[key: string]: any};
    reverseProxyEndpointPort: undefined | number;
}[]>;

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<{
    thumbprint: string;
    thumbprintSecondary: undefined | string;
    x509StoreName: string;
} | undefined>;

A reverseProxyCertificate block as defined below.

property tags

public tags: pulumi.Output<{[key: string]: any}>;

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.

interface ClusterArgs

The 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<{
    clientApplicationId: pulumi.Input<string>;
    clusterApplicationId: pulumi.Input<string>;
    tenantId: pulumi.Input<string>;
}>;

An azureActiveDirectory block as defined below.

property certificate

certificate?: pulumi.Input<{
    thumbprint: pulumi.Input<string>;
    thumbprintSecondary: pulumi.Input<string>;
    x509StoreName: pulumi.Input<string>;
}>;

A certificate block as defined below. Conflicts with certificateCommonNames.

property certificateCommonNames

certificateCommonNames?: pulumi.Input<{
    commonNames: pulumi.Input<pulumi.Input<{
        certificateCommonName: pulumi.Input<string>;
        certificateIssuerThumbprint: pulumi.Input<string>;
    }>[]>;
    x509StoreName: pulumi.Input<string>;
}>;

A certificateCommonNames block as defined below. Conflicts with certificate.

property clientCertificateThumbprints

clientCertificateThumbprints?: pulumi.Input<pulumi.Input<{
    isAdmin: pulumi.Input<boolean>;
    thumbprint: pulumi.Input<string>;
}>[]>;

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<{
    blobEndpoint: pulumi.Input<string>;
    protectedAccountKeyName: pulumi.Input<string>;
    queueEndpoint: pulumi.Input<string>;
    storageAccountName: pulumi.Input<string>;
    tableEndpoint: pulumi.Input<string>;
}>;

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

property fabricSettings

fabricSettings?: pulumi.Input<pulumi.Input<{
    name: pulumi.Input<string>;
    parameters: pulumi.Input<{[key: string]: any}>;
}>[]>;

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<{
    applicationPorts: pulumi.Input<{
        endPort: pulumi.Input<number>;
        startPort: pulumi.Input<number>;
    }>;
    capacities: pulumi.Input<{[key: string]: any}>;
    clientEndpointPort: pulumi.Input<number>;
    durabilityLevel: pulumi.Input<string>;
    ephemeralPorts: pulumi.Input<{
        endPort: pulumi.Input<number>;
        startPort: pulumi.Input<number>;
    }>;
    httpEndpointPort: pulumi.Input<number>;
    instanceCount: pulumi.Input<number>;
    isPrimary: pulumi.Input<boolean>;
    name: pulumi.Input<string>;
    placementProperties: pulumi.Input<{[key: string]: any}>;
    reverseProxyEndpointPort: pulumi.Input<number>;
}>[]>;

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<{
    thumbprint: pulumi.Input<string>;
    thumbprintSecondary: pulumi.Input<string>;
    x509StoreName: pulumi.Input<string>;
}>;

A reverseProxyCertificate block as defined below.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

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

Input 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<{
    clientApplicationId: pulumi.Input<string>;
    clusterApplicationId: pulumi.Input<string>;
    tenantId: pulumi.Input<string>;
}>;

An azureActiveDirectory block as defined below.

property certificate

certificate?: pulumi.Input<{
    thumbprint: pulumi.Input<string>;
    thumbprintSecondary: pulumi.Input<string>;
    x509StoreName: pulumi.Input<string>;
}>;

A certificate block as defined below. Conflicts with certificateCommonNames.

property certificateCommonNames

certificateCommonNames?: pulumi.Input<{
    commonNames: pulumi.Input<pulumi.Input<{
        certificateCommonName: pulumi.Input<string>;
        certificateIssuerThumbprint: pulumi.Input<string>;
    }>[]>;
    x509StoreName: pulumi.Input<string>;
}>;

A certificateCommonNames block as defined below. Conflicts with certificate.

property clientCertificateThumbprints

clientCertificateThumbprints?: pulumi.Input<pulumi.Input<{
    isAdmin: pulumi.Input<boolean>;
    thumbprint: pulumi.Input<string>;
}>[]>;

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<{
    blobEndpoint: pulumi.Input<string>;
    protectedAccountKeyName: pulumi.Input<string>;
    queueEndpoint: pulumi.Input<string>;
    storageAccountName: pulumi.Input<string>;
    tableEndpoint: pulumi.Input<string>;
}>;

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

property fabricSettings

fabricSettings?: pulumi.Input<pulumi.Input<{
    name: pulumi.Input<string>;
    parameters: pulumi.Input<{[key: string]: any}>;
}>[]>;

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<{
    applicationPorts: pulumi.Input<{
        endPort: pulumi.Input<number>;
        startPort: pulumi.Input<number>;
    }>;
    capacities: pulumi.Input<{[key: string]: any}>;
    clientEndpointPort: pulumi.Input<number>;
    durabilityLevel: pulumi.Input<string>;
    ephemeralPorts: pulumi.Input<{
        endPort: pulumi.Input<number>;
        startPort: pulumi.Input<number>;
    }>;
    httpEndpointPort: pulumi.Input<number>;
    instanceCount: pulumi.Input<number>;
    isPrimary: pulumi.Input<boolean>;
    name: pulumi.Input<string>;
    placementProperties: pulumi.Input<{[key: string]: any}>;
    reverseProxyEndpointPort: pulumi.Input<number>;
}>[]>;

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<{
    thumbprint: pulumi.Input<string>;
    thumbprintSecondary: pulumi.Input<string>;
    x509StoreName: pulumi.Input<string>;
}>;

A reverseProxyCertificate block as defined below.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

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.