← All packages

Azure Native

Pulumi Official

Package maintained by Pulumi

v1.64.0 published on Wednesday, May 4, 2022 by Pulumi

Source code

getService

Service resource API Version: 2020-07-01.

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.

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

def get_service(resource_group_name: Optional[str] = None,
                service_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetServiceResult
def get_service_output(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)
// Output-based functions aren't available in Java yet

Fn::Invoke:
  Function: azure-native:appplatform:getService
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ResourceGroupName string: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServiceName string: The name of the Service resource.

ResourceGroupName string: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServiceName string: The name of the Service resource.

resourceGroupName String: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName String: The name of the Service resource.

resourceGroupName string: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName string: The name of the Service resource.

resource_group_name str: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
service_name str: The name of the Service resource.

resourceGroupName String: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName String: The name of the Service resource.

getService Result

The following output properties are available:

Id string: Fully qualified resource Id for the resource.
Name string: The name of the resource.
Properties Pulumi.AzureNative.AppPlatform.Outputs.ClusterResourcePropertiesResponse: Properties of the Service resource
Type string: The type of the resource.
Location string: The GEO location of the resource.
Sku Pulumi.AzureNative.AppPlatform.Outputs.SkuResponse: Sku of the Service resource
Tags Dictionary<string, string>: Tags of the service which is a list of key value pairs that describe the resource.

Id string: Fully qualified resource Id for the resource.
Name string: The name of the resource.
Properties ClusterResourcePropertiesResponse: Properties of the Service resource
Type string: The type of the resource.
Location string: The GEO location of the resource.
Sku SkuResponse: Sku of the Service resource
Tags map[string]string: Tags of the service which is a list of key value pairs that describe the resource.

id String: Fully qualified resource Id for the resource.
name String: The name of the resource.
properties ClusterResourcePropertiesResponse: Properties of the Service resource
type String: The type of the resource.
location String: The GEO location of the resource.
sku SkuResponse: Sku of the Service resource
tags Map: Tags of the service which is a list of key value pairs that describe the resource.

id string: Fully qualified resource Id for the resource.
name string: The name of the resource.
properties ClusterResourcePropertiesResponse: Properties of the Service resource
type string: The type of the resource.
location string: The GEO location of the resource.
sku SkuResponse: Sku of the Service resource
tags {[key: string]: string}: Tags of the service which is a list of key value pairs that describe the resource.

id str: Fully qualified resource Id for the resource.
name str: The name of the resource.
properties ClusterResourcePropertiesResponse: Properties of the Service resource
type str: The type of the resource.
location str: The GEO location of the resource.
sku SkuResponse: Sku of the Service resource
tags Mapping[str, str]: Tags of the service which is a list of key value pairs that describe the resource.

id String: Fully qualified resource Id for the resource.
name String: The name of the resource.
properties Property Map: Properties of the Service resource
type String: The type of the resource.
location String: The GEO location of the resource.
sku Property Map: Sku of the Service resource
tags Map: Tags of the service which is a list of key value pairs that describe the resource.

Supporting Types

ClusterResourcePropertiesResponse

ProvisioningState string: Provisioning state of the Service
ServiceId string: ServiceInstanceEntity GUID which uniquely identifies a created resource
Version int: Version of the Service
NetworkProfile Pulumi.AzureNative.AppPlatform.Inputs.NetworkProfileResponse: Network profile of the Service

ProvisioningState string: Provisioning state of the Service
ServiceId string: ServiceInstanceEntity GUID which uniquely identifies a created resource
Version int: Version of the Service
NetworkProfile NetworkProfileResponse: Network profile of the Service

provisioningState String: Provisioning state of the Service
serviceId String: ServiceInstanceEntity GUID which uniquely identifies a created resource
version Integer: Version of the Service
networkProfile NetworkProfileResponse: Network profile of the Service

provisioningState string: Provisioning state of the Service
serviceId string: ServiceInstanceEntity GUID which uniquely identifies a created resource
version number: Version of the Service
networkProfile NetworkProfileResponse: Network profile of the Service

provisioning_state str: Provisioning state of the Service
service_id str: ServiceInstanceEntity GUID which uniquely identifies a created resource
version int: Version of the Service
network_profile NetworkProfileResponse: Network profile of the Service

provisioningState String: Provisioning state of the Service
serviceId String: ServiceInstanceEntity GUID which uniquely identifies a created resource
version Number: Version of the Service
networkProfile Property Map: Network profile of the Service

NetworkProfileResponse

OutboundIPs Pulumi.AzureNative.AppPlatform.Inputs.NetworkProfileResponseOutboundIPs: Desired outbound IP resources for Azure Spring Cloud instance.
RequiredTraffics List<Pulumi.AzureNative.AppPlatform.Inputs.RequiredTrafficResponse>: Required inbound or outbound traffics for Azure Spring Cloud instance.
AppNetworkResourceGroup string: Name of the resource group containing network resources of Azure Spring Cloud Apps
AppSubnetId string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Apps
ServiceCidr string: Azure Spring Cloud service reserved CIDR
ServiceRuntimeNetworkResourceGroup string: Name of the resource group containing network resources of Azure Spring Cloud Service Runtime
ServiceRuntimeSubnetId string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Service Runtime

OutboundIPs NetworkProfileResponseOutboundIPs: Desired outbound IP resources for Azure Spring Cloud instance.
RequiredTraffics []RequiredTrafficResponse: Required inbound or outbound traffics for Azure Spring Cloud instance.
AppNetworkResourceGroup string: Name of the resource group containing network resources of Azure Spring Cloud Apps
AppSubnetId string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Apps
ServiceCidr string: Azure Spring Cloud service reserved CIDR
ServiceRuntimeNetworkResourceGroup string: Name of the resource group containing network resources of Azure Spring Cloud Service Runtime
ServiceRuntimeSubnetId string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Service Runtime

outboundIPs NetworkProfileResponseOutboundIPs: Desired outbound IP resources for Azure Spring Cloud instance.
requiredTraffics ListTrafficResponse>: Required inbound or outbound traffics for Azure Spring Cloud instance.
appNetworkResourceGroup String: Name of the resource group containing network resources of Azure Spring Cloud Apps
appSubnetId String: Fully qualified resource Id of the subnet to host Azure Spring Cloud Apps
serviceCidr String: Azure Spring Cloud service reserved CIDR
serviceRuntimeNetworkResourceGroup String: Name of the resource group containing network resources of Azure Spring Cloud Service Runtime
serviceRuntimeSubnetId String: Fully qualified resource Id of the subnet to host Azure Spring Cloud Service Runtime

outboundIPs NetworkProfileResponseOutboundIPs: Desired outbound IP resources for Azure Spring Cloud instance.
requiredTraffics RequiredTrafficResponse[]: Required inbound or outbound traffics for Azure Spring Cloud instance.
appNetworkResourceGroup string: Name of the resource group containing network resources of Azure Spring Cloud Apps
appSubnetId string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Apps
serviceCidr string: Azure Spring Cloud service reserved CIDR
serviceRuntimeNetworkResourceGroup string: Name of the resource group containing network resources of Azure Spring Cloud Service Runtime
serviceRuntimeSubnetId string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Service Runtime

outbound_ips NetworkProfileResponseOutboundIPs: Desired outbound IP resources for Azure Spring Cloud instance.
required_traffics Sequence[RequiredTrafficResponse]: Required inbound or outbound traffics for Azure Spring Cloud instance.
app_network_resource_group str: Name of the resource group containing network resources of Azure Spring Cloud Apps
app_subnet_id str: Fully qualified resource Id of the subnet to host Azure Spring Cloud Apps
service_cidr str: Azure Spring Cloud service reserved CIDR
service_runtime_network_resource_group str: Name of the resource group containing network resources of Azure Spring Cloud Service Runtime
service_runtime_subnet_id str: Fully qualified resource Id of the subnet to host Azure Spring Cloud Service Runtime

outboundIPs Property Map: Desired outbound IP resources for Azure Spring Cloud instance.
requiredTraffics List: Required inbound or outbound traffics for Azure Spring Cloud instance.
appNetworkResourceGroup String: Name of the resource group containing network resources of Azure Spring Cloud Apps
appSubnetId String: Fully qualified resource Id of the subnet to host Azure Spring Cloud Apps
serviceCidr String: Azure Spring Cloud service reserved CIDR
serviceRuntimeNetworkResourceGroup String: Name of the resource group containing network resources of Azure Spring Cloud Service Runtime
serviceRuntimeSubnetId String: Fully qualified resource Id of the subnet to host Azure Spring Cloud Service Runtime

NetworkProfileResponseOutboundIPs

PublicIPs List<string>: A list of public IP addresses.

PublicIPs []string: A list of public IP addresses.

publicIPs List: A list of public IP addresses.

publicIPs string[]: A list of public IP addresses.

public_ips Sequence[str]: A list of public IP addresses.

publicIPs List: A list of public IP addresses.

RequiredTrafficResponse

Direction string: The direction of required traffic
Fqdns List<string>: The FQDN list of required traffic
Ips List<string>: The ip list of required traffic
Port int: The port of required traffic
Protocol string: The protocol of required traffic

Direction string: The direction of required traffic
Fqdns []string: The FQDN list of required traffic
Ips []string: The ip list of required traffic
Port int: The port of required traffic
Protocol string: The protocol of required traffic

direction String: The direction of required traffic
fqdns List: The FQDN list of required traffic
ips List: The ip list of required traffic
port Integer: The port of required traffic
protocol String: The protocol of required traffic

direction string: The direction of required traffic
fqdns string[]: The FQDN list of required traffic
ips string[]: The ip list of required traffic
port number: The port of required traffic
protocol string: The protocol of required traffic

direction str: The direction of required traffic
fqdns Sequence[str]: The FQDN list of required traffic
ips Sequence[str]: The ip list of required traffic
port int: The port of required traffic
protocol str: The protocol of required traffic

direction String: The direction of required traffic
fqdns List: The FQDN list of required traffic
ips List: The ip list of required traffic
port Number: The port of required traffic
protocol String: The protocol of required traffic

SkuResponse

Capacity int: Current capacity of the target resource
Name string: Name of the Sku
Tier string: Tier of the Sku

Capacity int: Current capacity of the target resource
Name string: Name of the Sku
Tier string: Tier of the Sku

capacity Integer: Current capacity of the target resource
name String: Name of the Sku
tier String: Tier of the Sku

capacity number: Current capacity of the target resource
name string: Name of the Sku
tier string: Tier of the Sku

capacity int: Current capacity of the target resource
name str: Name of the Sku
tier str: Tier of the Sku

capacity Number: Current capacity of the target resource
name String: Name of the Sku
tier String: Tier of the Sku

Package Details

Repository: https://github.com/pulumi/pulumi-azure-native
License: Apache-2.0