Azure Native v1 v1.104.0, Jul 6 23

These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.

Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

azure-native.servicefabric.getService

Explore with Pulumi AI

These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.

Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

Using getService

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.

TypeScript
Python
Go
C#
Java
YAML

function getService(args: GetServiceArgs, opts?: InvokeOptions): Promise<GetServiceResult>
function getServiceOutput(args: GetServiceOutputArgs, opts?: InvokeOptions): Output<GetServiceResult>

def get_service(application_name: Optional[str] = None,
                cluster_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                service_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetServiceResult
def get_service_output(application_name: Optional[pulumi.Input[str]] = None,
                cluster_name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                service_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetServiceResult]

func LookupService(ctx *Context, args *LookupServiceArgs, opts ...InvokeOption) (*LookupServiceResult, error)
func LookupServiceOutput(ctx *Context, args *LookupServiceOutputArgs, opts ...InvokeOption) LookupServiceResultOutput

> Note: This function is named LookupService in the Go SDK.

public static class GetService 
{
    public static Task<GetServiceResult> InvokeAsync(GetServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetServiceResult> Invoke(GetServiceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetServiceResult> getService(GetServiceArgs args, InvokeOptions options)
public static Output<GetServiceResult> getService(GetServiceArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:servicefabric:getService
  arguments:
    # arguments dictionary

The following arguments are supported:

ApplicationName string: The name of the application resource.
ClusterName string: The name of the cluster resource.
ResourceGroupName string: The name of the resource group.
ServiceName string: The name of the service resource in the format of {applicationName}~{serviceName}.

ApplicationName string: The name of the application resource.
ClusterName string: The name of the cluster resource.
ResourceGroupName string: The name of the resource group.
ServiceName string: The name of the service resource in the format of {applicationName}~{serviceName}.

applicationName String: The name of the application resource.
clusterName String: The name of the cluster resource.
resourceGroupName String: The name of the resource group.
serviceName String: The name of the service resource in the format of {applicationName}~{serviceName}.

applicationName string: The name of the application resource.
clusterName string: The name of the cluster resource.
resourceGroupName string: The name of the resource group.
serviceName string: The name of the service resource in the format of {applicationName}~{serviceName}.

application_name str: The name of the application resource.
cluster_name str: The name of the cluster resource.
resource_group_name str: The name of the resource group.
service_name str: The name of the service resource in the format of {applicationName}~{serviceName}.

applicationName String: The name of the application resource.
clusterName String: The name of the cluster resource.
resourceGroupName String: The name of the resource group.
serviceName String: The name of the service resource in the format of {applicationName}~{serviceName}.

getService Result

The following output properties are available:

Etag string: Azure resource etag.
Id string: Azure resource identifier.
Name string: Azure resource name.
ProvisioningState string: The current deployment or provisioning state, which only appears in the response
ServiceKind string: The kind of service (Stateless or Stateful).
Type string: Azure resource type.
CorrelationScheme List<Pulumi.AzureNative.ServiceFabric.Outputs.ServiceCorrelationDescriptionResponse>: A list that describes the correlation of the service with other services.
DefaultMoveCost string: Specifies the move cost for the service.
Location string: It will be deprecated in New API, resource location depends on the parent resource.
PartitionDescription Pulumi.AzureNative.ServiceFabric.Outputs.NamedPartitionSchemeDescriptionResponse | Pulumi.AzureNative.ServiceFabric.Outputs.SingletonPartitionSchemeDescriptionResponse | Pulumi.AzureNative.ServiceFabric.Outputs.UniformInt64RangePartitionSchemeDescriptionResponse: Describes how the service is partitioned.
PlacementConstraints string: The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".
ServiceDnsName string: Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name.
ServiceLoadMetrics List<Pulumi.AzureNative.ServiceFabric.Outputs.ServiceLoadMetricDescriptionResponse>: The service load metrics is given as an array of ServiceLoadMetricDescription objects.
ServicePackageActivationMode string: The activation Mode of the service package
ServicePlacementPolicies List<Pulumi.AzureNative.ServiceFabric.Outputs.ServicePlacementPolicyDescriptionResponse>: A list that describes the correlation of the service with other services.
ServiceTypeName string: The name of the service type
Tags Dictionary<string, string>: Azure resource tags.

Etag string: Azure resource etag.
Id string: Azure resource identifier.
Name string: Azure resource name.
ProvisioningState string: The current deployment or provisioning state, which only appears in the response
ServiceKind string: The kind of service (Stateless or Stateful).
Type string: Azure resource type.
CorrelationScheme []ServiceCorrelationDescriptionResponse: A list that describes the correlation of the service with other services.
DefaultMoveCost string: Specifies the move cost for the service.
Location string: It will be deprecated in New API, resource location depends on the parent resource.
PartitionDescription NamedPartitionSchemeDescriptionResponse | SingletonPartitionSchemeDescriptionResponse | UniformInt64RangePartitionSchemeDescriptionResponse: Describes how the service is partitioned.
PlacementConstraints string: The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".
ServiceDnsName string: Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name.
ServiceLoadMetrics []ServiceLoadMetricDescriptionResponse: The service load metrics is given as an array of ServiceLoadMetricDescription objects.
ServicePackageActivationMode string: The activation Mode of the service package
ServicePlacementPolicies []ServicePlacementPolicyDescriptionResponse: A list that describes the correlation of the service with other services.
ServiceTypeName string: The name of the service type
Tags map[string]string: Azure resource tags.

etag String: Azure resource etag.
id String: Azure resource identifier.
name String: Azure resource name.
provisioningState String: The current deployment or provisioning state, which only appears in the response
serviceKind String: The kind of service (Stateless or Stateful).
type String: Azure resource type.
correlationScheme List<ServiceCorrelationDescriptionResponse>: A list that describes the correlation of the service with other services.
defaultMoveCost String: Specifies the move cost for the service.
location String: It will be deprecated in New API, resource location depends on the parent resource.
partitionDescription NamedPartitionSchemeDescriptionResponse | SingletonPartitionSchemeDescriptionResponse | UniformInt64RangePartitionSchemeDescriptionResponse: Describes how the service is partitioned.
placementConstraints String: The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".
serviceDnsName String: Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name.
serviceLoadMetrics List<ServiceLoadMetricDescriptionResponse>: The service load metrics is given as an array of ServiceLoadMetricDescription objects.
servicePackageActivationMode String: The activation Mode of the service package
servicePlacementPolicies List<ServicePlacementPolicyDescriptionResponse>: A list that describes the correlation of the service with other services.
serviceTypeName String: The name of the service type
tags Map<String,String>: Azure resource tags.

etag string: Azure resource etag.
id string: Azure resource identifier.
name string: Azure resource name.
provisioningState string: The current deployment or provisioning state, which only appears in the response
serviceKind string: The kind of service (Stateless or Stateful).
type string: Azure resource type.
correlationScheme ServiceCorrelationDescriptionResponse[]: A list that describes the correlation of the service with other services.
defaultMoveCost string: Specifies the move cost for the service.
location string: It will be deprecated in New API, resource location depends on the parent resource.
partitionDescription NamedPartitionSchemeDescriptionResponse | SingletonPartitionSchemeDescriptionResponse | UniformInt64RangePartitionSchemeDescriptionResponse: Describes how the service is partitioned.
placementConstraints string: The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".
serviceDnsName string: Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name.
serviceLoadMetrics ServiceLoadMetricDescriptionResponse[]: The service load metrics is given as an array of ServiceLoadMetricDescription objects.
servicePackageActivationMode string: The activation Mode of the service package
servicePlacementPolicies ServicePlacementPolicyDescriptionResponse[]: A list that describes the correlation of the service with other services.
serviceTypeName string: The name of the service type
tags {[key: string]: string}: Azure resource tags.

etag str: Azure resource etag.
id str: Azure resource identifier.
name str: Azure resource name.
provisioning_state str: The current deployment or provisioning state, which only appears in the response
service_kind str: The kind of service (Stateless or Stateful).
type str: Azure resource type.
correlation_scheme Sequence[ServiceCorrelationDescriptionResponse]: A list that describes the correlation of the service with other services.
default_move_cost str: Specifies the move cost for the service.
location str: It will be deprecated in New API, resource location depends on the parent resource.
partition_description NamedPartitionSchemeDescriptionResponse | SingletonPartitionSchemeDescriptionResponse | UniformInt64RangePartitionSchemeDescriptionResponse: Describes how the service is partitioned.
placement_constraints str: The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".
service_dns_name str: Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name.
service_load_metrics Sequence[ServiceLoadMetricDescriptionResponse]: The service load metrics is given as an array of ServiceLoadMetricDescription objects.
service_package_activation_mode str: The activation Mode of the service package
service_placement_policies Sequence[ServicePlacementPolicyDescriptionResponse]: A list that describes the correlation of the service with other services.
service_type_name str: The name of the service type
tags Mapping[str, str]: Azure resource tags.

etag String: Azure resource etag.
id String: Azure resource identifier.
name String: Azure resource name.
provisioningState String: The current deployment or provisioning state, which only appears in the response
serviceKind String: The kind of service (Stateless or Stateful).
type String: Azure resource type.
correlationScheme List<Property Map>: A list that describes the correlation of the service with other services.
defaultMoveCost String: Specifies the move cost for the service.
location String: It will be deprecated in New API, resource location depends on the parent resource.
partitionDescription Property Map | Property Map | Property Map: Describes how the service is partitioned.
placementConstraints String: The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".
serviceDnsName String: Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name.
serviceLoadMetrics List<Property Map>: The service load metrics is given as an array of ServiceLoadMetricDescription objects.
servicePackageActivationMode String: The activation Mode of the service package
servicePlacementPolicies List<Property Map>: A list that describes the correlation of the service with other services.
serviceTypeName String: The name of the service type
tags Map<String>: Azure resource tags.

Supporting Types

NamedPartitionSchemeDescriptionResponse

Count int: The number of partitions.
Names List<string>: Array of size specified by the ‘count’ parameter, for the names of the partitions.

Count int: The number of partitions.
Names []string: Array of size specified by the ‘count’ parameter, for the names of the partitions.

count Integer: The number of partitions.
names List<String>: Array of size specified by the ‘count’ parameter, for the names of the partitions.

count number: The number of partitions.
names string[]: Array of size specified by the ‘count’ parameter, for the names of the partitions.

count int: The number of partitions.
names Sequence[str]: Array of size specified by the ‘count’ parameter, for the names of the partitions.

count Number: The number of partitions.
names List<String>: Array of size specified by the ‘count’ parameter, for the names of the partitions.

ServiceCorrelationDescriptionResponse

Scheme string: The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName.
ServiceName string: The name of the service that the correlation relationship is established with.

Scheme string: The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName.
ServiceName string: The name of the service that the correlation relationship is established with.

scheme String: The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName.
serviceName String: The name of the service that the correlation relationship is established with.

scheme string: The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName.
serviceName string: The name of the service that the correlation relationship is established with.

scheme str: The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName.
service_name str: The name of the service that the correlation relationship is established with.

scheme String: The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName.
serviceName String: The name of the service that the correlation relationship is established with.

ServiceLoadMetricDescriptionResponse

Name string: The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive.
DefaultLoad int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric.
PrimaryDefaultLoad int: Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica.
SecondaryDefaultLoad int: Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica.
Weight string: The service load metric relative weight, compared to other metrics configured for this service, as a number.

Name string: The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive.
DefaultLoad int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric.
PrimaryDefaultLoad int: Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica.
SecondaryDefaultLoad int: Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica.
Weight string: The service load metric relative weight, compared to other metrics configured for this service, as a number.

name String: The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive.
defaultLoad Integer: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric.
primaryDefaultLoad Integer: Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica.
secondaryDefaultLoad Integer: Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica.
weight String: The service load metric relative weight, compared to other metrics configured for this service, as a number.

name string: The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive.
defaultLoad number: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric.
primaryDefaultLoad number: Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica.
secondaryDefaultLoad number: Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica.
weight string: The service load metric relative weight, compared to other metrics configured for this service, as a number.

name str: The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive.
default_load int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric.
primary_default_load int: Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica.
secondary_default_load int: Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica.
weight str: The service load metric relative weight, compared to other metrics configured for this service, as a number.

name String: The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive.
defaultLoad Number: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric.
primaryDefaultLoad Number: Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica.
secondaryDefaultLoad Number: Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica.
weight String: The service load metric relative weight, compared to other metrics configured for this service, as a number.

ServicePlacementPolicyDescriptionResponse

Type string: The type of placement policy for a service fabric service. Following are the possible values.

Type string: The type of placement policy for a service fabric service. Following are the possible values.

type String: The type of placement policy for a service fabric service. Following are the possible values.

type string: The type of placement policy for a service fabric service. Following are the possible values.

type str: The type of placement policy for a service fabric service. Following are the possible values.

type String: The type of placement policy for a service fabric service. Following are the possible values.

SingletonPartitionSchemeDescriptionResponse

UniformInt64RangePartitionSchemeDescriptionResponse

Count int: The number of partitions.
HighKey string: String indicating the upper bound of the partition key range that should be split between the partition ‘count’
LowKey string: String indicating the lower bound of the partition key range that should be split between the partition ‘count’

Count int: The number of partitions.
HighKey string: String indicating the upper bound of the partition key range that should be split between the partition ‘count’
LowKey string: String indicating the lower bound of the partition key range that should be split between the partition ‘count’

count Integer: The number of partitions.
highKey String: String indicating the upper bound of the partition key range that should be split between the partition ‘count’
lowKey String: String indicating the lower bound of the partition key range that should be split between the partition ‘count’

count number: The number of partitions.
highKey string: String indicating the upper bound of the partition key range that should be split between the partition ‘count’
lowKey string: String indicating the lower bound of the partition key range that should be split between the partition ‘count’

count int: The number of partitions.
high_key str: String indicating the upper bound of the partition key range that should be split between the partition ‘count’
low_key str: String indicating the lower bound of the partition key range that should be split between the partition ‘count’

count Number: The number of partitions.
highKey String: String indicating the upper bound of the partition key range that should be split between the partition ‘count’
lowKey String: String indicating the lower bound of the partition key range that should be split between the partition ‘count’

Package Details

Repository: azure-native-v1 pulumi/pulumi-azure-native
License: Apache-2.0

These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.

Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.servicefabric.getService

On this page

On this page

Using getService

getService Result

Supporting Types

NamedPartitionSchemeDescriptionResponse

ServiceCorrelationDescriptionResponse

ServiceLoadMetricDescriptionResponse

ServicePlacementPolicyDescriptionResponse

SingletonPartitionSchemeDescriptionResponse

UniformInt64RangePartitionSchemeDescriptionResponse

Package Details

On this page

On this page