@azure/arm-servicefabricmesh package

Classes

ServiceFabricMeshManagementClient

Interfaces

AddRemoveReplicaScalingMechanism

Describes the horizontal auto scaling mechanism that adds or removes replicas (containers or container groups).

Application

Interface representing a Application.

ApplicationCreateOptionalParams

Optional parameters.

ApplicationDeleteOptionalParams

Optional parameters.

ApplicationGetOptionalParams

Optional parameters.

ApplicationListByResourceGroupNextOptionalParams

Optional parameters.

ApplicationListByResourceGroupOptionalParams

Optional parameters.

ApplicationListBySubscriptionNextOptionalParams

Optional parameters.

ApplicationListBySubscriptionOptionalParams

Optional parameters.

ApplicationProperties

Describes properties of a application resource.

ApplicationResourceDescription

This type describes an application resource.

ApplicationResourceDescriptionList

A pageable list of application resources.

ApplicationResourceProperties

This type describes properties of an application resource.

ApplicationScopedVolume

Describes a volume whose lifetime is scoped to the application's lifetime.

ApplicationScopedVolumeCreationParameters

Describes parameters for creating application-scoped volumes.

ApplicationScopedVolumeCreationParametersServiceFabricVolumeDisk

Describes parameters for creating application-scoped volumes provided by Service Fabric Volume Disks

AutoScalingMechanism

Describes the mechanism for performing auto scaling operation. Derived classes will describe the actual mechanism.

AutoScalingMetric

Describes the metric that is used for triggering auto scaling operation. Derived classes will describe resources or metrics.

AutoScalingPolicy

Describes the auto scaling policy

AutoScalingResourceMetric

Describes the resource that is used for triggering auto scaling.

AutoScalingTrigger

Describes the trigger for performing auto scaling operation.

AvailableOperationDisplay

An operation available at the listed Azure resource provider.

AverageLoadScalingTrigger

Describes the average load trigger used for auto scaling.

AzureInternalMonitoringPipelineSinkDescription

Diagnostics settings for Geneva.

CodePackage

Interface representing a CodePackage.

CodePackageGetContainerLogsOptionalParams

Optional parameters.

ContainerCodePackageProperties

Describes a container and its runtime properties.

ContainerEvent

A container event.

ContainerInstanceView

Runtime information of a container instance.

ContainerLabel

Describes a container label.

ContainerLogs

Container logs.

ContainerState

The container state.

DiagnosticsDescription

Describes the diagnostics options available

DiagnosticsRef

Reference to sinks in DiagnosticsDescription.

DiagnosticsSinkProperties

Properties of a DiagnosticsSink.

EndpointProperties

Describes a container endpoint.

EndpointRef

Describes a reference to a service endpoint.

EnvironmentVariable

Describes an environment variable for the container.

ErrorDetailsModel

Error model details information

ErrorErrorModel

Error model information

ErrorModel

The error details.

Gateway

Interface representing a Gateway.

GatewayCreateOptionalParams

Optional parameters.

GatewayDeleteOptionalParams

Optional parameters.

GatewayDestination

Describes destination endpoint for routing traffic.

GatewayGetOptionalParams

Optional parameters.

GatewayListByResourceGroupNextOptionalParams

Optional parameters.

GatewayListByResourceGroupOptionalParams

Optional parameters.

GatewayListBySubscriptionNextOptionalParams

Optional parameters.

GatewayListBySubscriptionOptionalParams

Optional parameters.

GatewayProperties

Describes properties of a gateway resource.

GatewayResourceDescription

This type describes a gateway resource.

GatewayResourceDescriptionList

A pageable list of gateway resources.

GatewayResourceProperties

This type describes properties of a gateway resource.

HttpConfig

Describes the http configuration for external connectivity for this network.

HttpHostConfig

Describes the hostname properties for http routing.

HttpRouteConfig

Describes the hostname properties for http routing.

HttpRouteMatchHeader

Describes header information for http route matching.

HttpRouteMatchPath

Path to match for routing.

HttpRouteMatchRule

Describes a rule for http route matching.

ImageRegistryCredential

Image registry credential.

InlinedValueSecretResourceProperties

Describes the properties of a secret resource whose value is provided explicitly as plaintext. The secret resource may have multiple values, each being uniquely versioned. The secret value of each version is stored encrypted, and delivered as plaintext into the context of applications referencing it.

LocalNetworkResourceProperties

Information about a Service Fabric container network local to a single Service Fabric cluster.

ManagedProxyResource

The resource model definition for Azure Resource Manager proxy resource. It will have everything other than required location and tags. This proxy resource is explicitly created or updated by including it in the parent resource.

Network

Interface representing a Network.

NetworkCreateOptionalParams

Optional parameters.

NetworkDeleteOptionalParams

Optional parameters.

NetworkGetOptionalParams

Optional parameters.

NetworkListByResourceGroupNextOptionalParams

Optional parameters.

NetworkListByResourceGroupOptionalParams

Optional parameters.

NetworkListBySubscriptionNextOptionalParams

Optional parameters.

NetworkListBySubscriptionOptionalParams

Optional parameters.

NetworkRef

Describes a network reference in a service.

NetworkResourceDescription

This type describes a network resource.

NetworkResourceDescriptionList

A pageable list of network resources.

NetworkResourceProperties

Describes properties of a network resource.

NetworkResourcePropertiesBase

This type describes the properties of a network resource, including its kind.

OperationListResult

Describes the result of the request to list Service Fabric operations.

OperationResult

List of operations available at the listed Azure resource provider.

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

ProvisionedResourceProperties

Describes common properties of a provisioned resource.

ProxyResource

The resource model definition for Azure Resource Manager proxy resource. It will have everything other than required location and tags.

ReliableCollectionsRef

Specifying this parameter adds support for reliable collections

Resource

The resource model definition for Azure Resource Manager resource.

ResourceLimits

This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted.

ResourceRequests

This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits.

ResourceRequirements

This type describes the resource requirements for a container or a service.

Secret

Interface representing a Secret.

SecretCreateOptionalParams

Optional parameters.

SecretDeleteOptionalParams

Optional parameters.

SecretGetOptionalParams

Optional parameters.

SecretListByResourceGroupNextOptionalParams

Optional parameters.

SecretListByResourceGroupOptionalParams

Optional parameters.

SecretListBySubscriptionNextOptionalParams

Optional parameters.

SecretListBySubscriptionOptionalParams

Optional parameters.

SecretResourceDescription

This type describes a secret resource.

SecretResourceDescriptionList

A pageable list of secret resources.

SecretResourceProperties

Describes the properties of a secret resource.

SecretResourcePropertiesBase

This type describes the properties of a secret resource, including its kind.

SecretValue

This type represents the unencrypted value of the secret.

SecretValueCreateOptionalParams

Optional parameters.

SecretValueDeleteOptionalParams

Optional parameters.

SecretValueGetOptionalParams

Optional parameters.

SecretValueListNextOptionalParams

Optional parameters.

SecretValueListOptionalParams

Optional parameters.

SecretValueListValueOptionalParams

Optional parameters.

SecretValueOperations

Interface representing a SecretValueOperations.

SecretValueProperties

This type describes properties of secret value resource.

SecretValueResourceDescription

This type describes a value of a secret resource. The name of this resource is the version identifier corresponding to this secret value.

SecretValueResourceDescriptionList

A pageable list of values of a secret resource. The information does not include only the name of the value and not the actual unencrypted value.

SecretValueResourceProperties

This type describes properties of a secret value resource.

Service

Interface representing a Service.

ServiceFabricMeshManagementClientOptionalParams

Optional parameters.

ServiceGetOptionalParams

Optional parameters.

ServiceListNextOptionalParams

Optional parameters.

ServiceListOptionalParams

Optional parameters.

ServiceProperties

Describes properties of a service resource.

ServiceReplica

Interface representing a ServiceReplica.

ServiceReplicaDescription

Describes a replica of a service resource.

ServiceReplicaDescriptionList

A pageable list of service replicas.

ServiceReplicaGetOptionalParams

Optional parameters.

ServiceReplicaListNextOptionalParams

Optional parameters.

ServiceReplicaListOptionalParams

Optional parameters.

ServiceReplicaProperties

Describes the properties of a service replica.

ServiceResourceDescription

This type describes a service resource.

ServiceResourceDescriptionList

A pageable list of service resources.

ServiceResourceProperties

This type describes properties of a service resource.

Setting

Describes a setting for the container. The setting file path can be fetched from environment variable "Fabric_SettingPath". The path for Windows container is "C:\secrets". The path for Linux container is "/var/secrets".

TcpConfig

Describes the tcp configuration for external connectivity for this network.

TrackedResource

The resource model definition for Azure Resource Manager tracked top-level resource.

Volume

Interface representing a Volume.

VolumeCreateOptionalParams

Optional parameters.

VolumeDeleteOptionalParams

Optional parameters.

VolumeGetOptionalParams

Optional parameters.

VolumeListByResourceGroupNextOptionalParams

Optional parameters.

VolumeListByResourceGroupOptionalParams

Optional parameters.

VolumeListBySubscriptionNextOptionalParams

Optional parameters.

VolumeListBySubscriptionOptionalParams

Optional parameters.

VolumeProperties

Describes properties of a volume resource.

VolumeProviderParametersAzureFile

This type describes a volume provided by an Azure Files file share.

VolumeReference

Describes a reference to a volume resource.

VolumeResourceDescription

This type describes a volume resource.

VolumeResourceDescriptionList

A pageable list of volume resources.

VolumeResourceProperties

This type describes properties of a volume resource.

Type Aliases

ApplicationCreateResponse

Contains response data for the create operation.

ApplicationGetResponse

Contains response data for the get operation.

ApplicationListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

ApplicationListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

ApplicationListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

ApplicationListBySubscriptionResponse

Contains response data for the listBySubscription operation.

ApplicationScopedVolumeCreationParametersUnion
ApplicationScopedVolumeKind

Defines values for ApplicationScopedVolumeKind.
KnownApplicationScopedVolumeKind can be used interchangeably with ApplicationScopedVolumeKind, this enum contains the known values that the service supports.

Known values supported by the service

ServiceFabricVolumeDisk: Provides Service Fabric High Availability Volume Disk

AutoScalingMechanismKind

Defines values for AutoScalingMechanismKind.
KnownAutoScalingMechanismKind can be used interchangeably with AutoScalingMechanismKind, this enum contains the known values that the service supports.

Known values supported by the service

AddRemoveReplica: Indicates that scaling should be performed by adding or removing replicas.

AutoScalingMechanismUnion
AutoScalingMetricKind

Defines values for AutoScalingMetricKind.
KnownAutoScalingMetricKind can be used interchangeably with AutoScalingMetricKind, this enum contains the known values that the service supports.

Known values supported by the service

Resource: Indicates that the metric is one of resources, like cpu or memory.

AutoScalingMetricUnion
AutoScalingResourceMetricName

Defines values for AutoScalingResourceMetricName.
KnownAutoScalingResourceMetricName can be used interchangeably with AutoScalingResourceMetricName, this enum contains the known values that the service supports.

Known values supported by the service

cpu: Indicates that the resource is CPU cores.
memoryInGB: Indicates that the resource is memory in GB.

AutoScalingTriggerKind

Defines values for AutoScalingTriggerKind.
KnownAutoScalingTriggerKind can be used interchangeably with AutoScalingTriggerKind, this enum contains the known values that the service supports.

Known values supported by the service

AverageLoad: Indicates that scaling should be performed based on average load of all replicas in the service.

AutoScalingTriggerUnion
CodePackageGetContainerLogsResponse

Contains response data for the getContainerLogs operation.

DiagnosticsSinkKind

Defines values for DiagnosticsSinkKind.
KnownDiagnosticsSinkKind can be used interchangeably with DiagnosticsSinkKind, this enum contains the known values that the service supports.

Known values supported by the service

Invalid: Indicates an invalid sink kind. All Service Fabric enumerations have the invalid type.
AzureInternalMonitoringPipeline: Diagnostics settings for Geneva.

DiagnosticsSinkPropertiesUnion
GatewayCreateResponse

Contains response data for the create operation.

GatewayGetResponse

Contains response data for the get operation.

GatewayListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

GatewayListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

GatewayListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

GatewayListBySubscriptionResponse

Contains response data for the listBySubscription operation.

HeaderMatchType

Defines values for HeaderMatchType.
KnownHeaderMatchType can be used interchangeably with HeaderMatchType, this enum contains the known values that the service supports.

Known values supported by the service

exact

HealthState

Defines values for HealthState.
KnownHealthState can be used interchangeably with HealthState, this enum contains the known values that the service supports.

Known values supported by the service

Invalid: Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero.
Ok: Indicates the health state is okay. The value is 1.
Warning: Indicates the health state is at a warning level. The value is 2.
Error: Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3.
Unknown: Indicates an unknown health status. The value is 65535.

NetworkCreateResponse

Contains response data for the create operation.

NetworkGetResponse

Contains response data for the get operation.

NetworkKind

Defines values for NetworkKind.
KnownNetworkKind can be used interchangeably with NetworkKind, this enum contains the known values that the service supports.

Known values supported by the service

Local: Indicates a container network local to a single Service Fabric cluster. The value is 1.

NetworkListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

NetworkListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

NetworkListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

NetworkListBySubscriptionResponse

Contains response data for the listBySubscription operation.

NetworkResourcePropertiesBaseUnion
NetworkResourcePropertiesUnion
OperatingSystemType

Defines values for OperatingSystemType.
KnownOperatingSystemType can be used interchangeably with OperatingSystemType, this enum contains the known values that the service supports.

Known values supported by the service

Linux: The required operating system is Linux.
Windows: The required operating system is Windows.

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

PathMatchType

Defines values for PathMatchType.
KnownPathMatchType can be used interchangeably with PathMatchType, this enum contains the known values that the service supports.

Known values supported by the service

prefix

ResourceStatus

Defines values for ResourceStatus.
KnownResourceStatus can be used interchangeably with ResourceStatus, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Indicates the resource status is unknown. The value is zero.
Ready: Indicates the resource is ready. The value is 1.
Upgrading: Indicates the resource is upgrading. The value is 2.
Creating: Indicates the resource is being created. The value is 3.
Deleting: Indicates the resource is being deleted. The value is 4.
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5.

SecretCreateResponse

Contains response data for the create operation.

SecretGetResponse

Contains response data for the get operation.

SecretKind

Defines values for SecretKind.
KnownSecretKind can be used interchangeably with SecretKind, this enum contains the known values that the service supports.

Known values supported by the service

inlinedValue: A simple secret resource whose plaintext value is provided by the user.

SecretListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

SecretListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

SecretListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

SecretListBySubscriptionResponse

Contains response data for the listBySubscription operation.

SecretResourcePropertiesBaseUnion
SecretResourcePropertiesUnion
SecretValueCreateResponse

Contains response data for the create operation.

SecretValueGetResponse

Contains response data for the get operation.

SecretValueListNextResponse

Contains response data for the listNext operation.

SecretValueListResponse

Contains response data for the list operation.

SecretValueListValueResponse

Contains response data for the listValue operation.

ServiceGetResponse

Contains response data for the get operation.

ServiceListNextResponse

Contains response data for the listNext operation.

ServiceListResponse

Contains response data for the list operation.

ServiceReplicaGetResponse

Contains response data for the get operation.

ServiceReplicaListNextResponse

Contains response data for the listNext operation.

ServiceReplicaListResponse

Contains response data for the list operation.

SizeTypes

Defines values for SizeTypes.
KnownSizeTypes can be used interchangeably with SizeTypes, this enum contains the known values that the service supports.

Known values supported by the service

Small
Medium
Large

VolumeCreateResponse

Contains response data for the create operation.

VolumeGetResponse

Contains response data for the get operation.

VolumeListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

VolumeListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

VolumeListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

VolumeListBySubscriptionResponse

Contains response data for the listBySubscription operation.

VolumeProvider

Defines values for VolumeProvider.
KnownVolumeProvider can be used interchangeably with VolumeProvider, this enum contains the known values that the service supports.

Known values supported by the service

SFAzureFile: Provides volumes that are backed by Azure Files.

Enums

KnownApplicationScopedVolumeKind

Known values of ApplicationScopedVolumeKind that the service accepts.

KnownAutoScalingMechanismKind

Known values of AutoScalingMechanismKind that the service accepts.

KnownAutoScalingMetricKind

Known values of AutoScalingMetricKind that the service accepts.

KnownAutoScalingResourceMetricName

Known values of AutoScalingResourceMetricName that the service accepts.

KnownAutoScalingTriggerKind

Known values of AutoScalingTriggerKind that the service accepts.

KnownDiagnosticsSinkKind

Known values of DiagnosticsSinkKind that the service accepts.

KnownHeaderMatchType

Known values of HeaderMatchType that the service accepts.

KnownHealthState

Known values of HealthState that the service accepts.

KnownNetworkKind

Known values of NetworkKind that the service accepts.

KnownOperatingSystemType

Known values of OperatingSystemType that the service accepts.

KnownPathMatchType

Known values of PathMatchType that the service accepts.

KnownResourceStatus

Known values of ResourceStatus that the service accepts.

KnownSecretKind

Known values of SecretKind that the service accepts.

KnownSizeTypes

Known values of SizeTypes that the service accepts.

KnownVolumeProvider

Known values of VolumeProvider that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.