1. Packages
  2. Azure Native
  3. API Docs
  4. appplatform
  5. getService
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

azure-native.appplatform.getService

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

    Get a Service and its properties. Azure REST API version: 2023-05-01-preview.

    Other available API versions: 2023-07-01-preview, 2023-09-01-preview, 2023-11-01-preview, 2023-12-01, 2024-01-01-preview, 2024-05-01-preview.

    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
    SystemData Pulumi.AzureNative.AppPlatform.Outputs.SystemDataResponse
    Metadata pertaining to creation and last modification of the 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
    SystemData SystemDataResponse
    Metadata pertaining to creation and last modification of the 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
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the 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
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the 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
    system_data SystemDataResponse
    Metadata pertaining to creation and last modification of the 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
    systemData Property Map
    Metadata pertaining to creation and last modification of the 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<String>
    Tags of the service which is a list of key value pairs that describe the resource.

    Supporting Types

    ClusterResourcePropertiesResponse

    Fqdn string
    Fully qualified dns name of the service instance
    PowerState string
    Power state of the Service
    ProvisioningState string
    Provisioning state of the Service
    ServiceId string
    ServiceInstanceEntity Id which uniquely identifies a created resource
    Version int
    Version of the Service
    InfraResourceGroup string
    The name of the resource group that contains the infrastructure resources
    ManagedEnvironmentId string
    The resource Id of the Managed Environment that the Spring Apps instance builds on
    MarketplaceResource Pulumi.AzureNative.AppPlatform.Inputs.MarketplaceResourceResponse
    Purchasing 3rd party product of the Service resource.
    NetworkProfile Pulumi.AzureNative.AppPlatform.Inputs.NetworkProfileResponse
    Network profile of the Service
    VnetAddons Pulumi.AzureNative.AppPlatform.Inputs.ServiceVNetAddonsResponse
    Additional Service settings in vnet injection instance
    ZoneRedundant bool
    Fqdn string
    Fully qualified dns name of the service instance
    PowerState string
    Power state of the Service
    ProvisioningState string
    Provisioning state of the Service
    ServiceId string
    ServiceInstanceEntity Id which uniquely identifies a created resource
    Version int
    Version of the Service
    InfraResourceGroup string
    The name of the resource group that contains the infrastructure resources
    ManagedEnvironmentId string
    The resource Id of the Managed Environment that the Spring Apps instance builds on
    MarketplaceResource MarketplaceResourceResponse
    Purchasing 3rd party product of the Service resource.
    NetworkProfile NetworkProfileResponse
    Network profile of the Service
    VnetAddons ServiceVNetAddonsResponse
    Additional Service settings in vnet injection instance
    ZoneRedundant bool
    fqdn String
    Fully qualified dns name of the service instance
    powerState String
    Power state of the Service
    provisioningState String
    Provisioning state of the Service
    serviceId String
    ServiceInstanceEntity Id which uniquely identifies a created resource
    version Integer
    Version of the Service
    infraResourceGroup String
    The name of the resource group that contains the infrastructure resources
    managedEnvironmentId String
    The resource Id of the Managed Environment that the Spring Apps instance builds on
    marketplaceResource MarketplaceResourceResponse
    Purchasing 3rd party product of the Service resource.
    networkProfile NetworkProfileResponse
    Network profile of the Service
    vnetAddons ServiceVNetAddonsResponse
    Additional Service settings in vnet injection instance
    zoneRedundant Boolean
    fqdn string
    Fully qualified dns name of the service instance
    powerState string
    Power state of the Service
    provisioningState string
    Provisioning state of the Service
    serviceId string
    ServiceInstanceEntity Id which uniquely identifies a created resource
    version number
    Version of the Service
    infraResourceGroup string
    The name of the resource group that contains the infrastructure resources
    managedEnvironmentId string
    The resource Id of the Managed Environment that the Spring Apps instance builds on
    marketplaceResource MarketplaceResourceResponse
    Purchasing 3rd party product of the Service resource.
    networkProfile NetworkProfileResponse
    Network profile of the Service
    vnetAddons ServiceVNetAddonsResponse
    Additional Service settings in vnet injection instance
    zoneRedundant boolean
    fqdn str
    Fully qualified dns name of the service instance
    power_state str
    Power state of the Service
    provisioning_state str
    Provisioning state of the Service
    service_id str
    ServiceInstanceEntity Id which uniquely identifies a created resource
    version int
    Version of the Service
    infra_resource_group str
    The name of the resource group that contains the infrastructure resources
    managed_environment_id str
    The resource Id of the Managed Environment that the Spring Apps instance builds on
    marketplace_resource MarketplaceResourceResponse
    Purchasing 3rd party product of the Service resource.
    network_profile NetworkProfileResponse
    Network profile of the Service
    vnet_addons ServiceVNetAddonsResponse
    Additional Service settings in vnet injection instance
    zone_redundant bool
    fqdn String
    Fully qualified dns name of the service instance
    powerState String
    Power state of the Service
    provisioningState String
    Provisioning state of the Service
    serviceId String
    ServiceInstanceEntity Id which uniquely identifies a created resource
    version Number
    Version of the Service
    infraResourceGroup String
    The name of the resource group that contains the infrastructure resources
    managedEnvironmentId String
    The resource Id of the Managed Environment that the Spring Apps instance builds on
    marketplaceResource Property Map
    Purchasing 3rd party product of the Service resource.
    networkProfile Property Map
    Network profile of the Service
    vnetAddons Property Map
    Additional Service settings in vnet injection instance
    zoneRedundant Boolean

    IngressConfigResponse

    ReadTimeoutInSeconds int
    Ingress read time out in seconds.
    ReadTimeoutInSeconds int
    Ingress read time out in seconds.
    readTimeoutInSeconds Integer
    Ingress read time out in seconds.
    readTimeoutInSeconds number
    Ingress read time out in seconds.
    read_timeout_in_seconds int
    Ingress read time out in seconds.
    readTimeoutInSeconds Number
    Ingress read time out in seconds.

    MarketplaceResourceResponse

    Plan string
    The plan id of the 3rd Party Artifact that is being procured.
    Product string
    The 3rd Party artifact that is being procured.
    Publisher string
    The publisher id of the 3rd Party Artifact that is being bought.
    Plan string
    The plan id of the 3rd Party Artifact that is being procured.
    Product string
    The 3rd Party artifact that is being procured.
    Publisher string
    The publisher id of the 3rd Party Artifact that is being bought.
    plan String
    The plan id of the 3rd Party Artifact that is being procured.
    product String
    The 3rd Party artifact that is being procured.
    publisher String
    The publisher id of the 3rd Party Artifact that is being bought.
    plan string
    The plan id of the 3rd Party Artifact that is being procured.
    product string
    The 3rd Party artifact that is being procured.
    publisher string
    The publisher id of the 3rd Party Artifact that is being bought.
    plan str
    The plan id of the 3rd Party Artifact that is being procured.
    product str
    The 3rd Party artifact that is being procured.
    publisher str
    The publisher id of the 3rd Party Artifact that is being bought.
    plan String
    The plan id of the 3rd Party Artifact that is being procured.
    product String
    The 3rd Party artifact that is being procured.
    publisher String
    The publisher id of the 3rd Party Artifact that is being bought.

    NetworkProfileResponse

    OutboundIPs Pulumi.AzureNative.AppPlatform.Inputs.NetworkProfileResponseOutboundIPs
    Desired outbound IP resources for Azure Spring Apps resource.
    RequiredTraffics List<Pulumi.AzureNative.AppPlatform.Inputs.RequiredTrafficResponse>
    Required inbound or outbound traffics for Azure Spring Apps resource.
    AppNetworkResourceGroup string
    Name of the resource group containing network resources for customer apps in Azure Spring Apps
    AppSubnetId string
    Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps
    IngressConfig Pulumi.AzureNative.AppPlatform.Inputs.IngressConfigResponse
    Ingress configuration payload for Azure Spring Apps resource.
    OutboundType string
    The egress traffic type of Azure Spring Apps VNet instances.
    ServiceCidr string
    Azure Spring Apps service reserved CIDR
    ServiceRuntimeNetworkResourceGroup string
    Name of the resource group containing network resources of Azure Spring Apps Service Runtime
    ServiceRuntimeSubnetId string
    Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime
    OutboundIPs NetworkProfileResponseOutboundIPs
    Desired outbound IP resources for Azure Spring Apps resource.
    RequiredTraffics []RequiredTrafficResponse
    Required inbound or outbound traffics for Azure Spring Apps resource.
    AppNetworkResourceGroup string
    Name of the resource group containing network resources for customer apps in Azure Spring Apps
    AppSubnetId string
    Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps
    IngressConfig IngressConfigResponse
    Ingress configuration payload for Azure Spring Apps resource.
    OutboundType string
    The egress traffic type of Azure Spring Apps VNet instances.
    ServiceCidr string
    Azure Spring Apps service reserved CIDR
    ServiceRuntimeNetworkResourceGroup string
    Name of the resource group containing network resources of Azure Spring Apps Service Runtime
    ServiceRuntimeSubnetId string
    Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime
    outboundIPs NetworkProfileResponseOutboundIPs
    Desired outbound IP resources for Azure Spring Apps resource.
    requiredTraffics List<RequiredTrafficResponse>
    Required inbound or outbound traffics for Azure Spring Apps resource.
    appNetworkResourceGroup String
    Name of the resource group containing network resources for customer apps in Azure Spring Apps
    appSubnetId String
    Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps
    ingressConfig IngressConfigResponse
    Ingress configuration payload for Azure Spring Apps resource.
    outboundType String
    The egress traffic type of Azure Spring Apps VNet instances.
    serviceCidr String
    Azure Spring Apps service reserved CIDR
    serviceRuntimeNetworkResourceGroup String
    Name of the resource group containing network resources of Azure Spring Apps Service Runtime
    serviceRuntimeSubnetId String
    Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime
    outboundIPs NetworkProfileResponseOutboundIPs
    Desired outbound IP resources for Azure Spring Apps resource.
    requiredTraffics RequiredTrafficResponse[]
    Required inbound or outbound traffics for Azure Spring Apps resource.
    appNetworkResourceGroup string
    Name of the resource group containing network resources for customer apps in Azure Spring Apps
    appSubnetId string
    Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps
    ingressConfig IngressConfigResponse
    Ingress configuration payload for Azure Spring Apps resource.
    outboundType string
    The egress traffic type of Azure Spring Apps VNet instances.
    serviceCidr string
    Azure Spring Apps service reserved CIDR
    serviceRuntimeNetworkResourceGroup string
    Name of the resource group containing network resources of Azure Spring Apps Service Runtime
    serviceRuntimeSubnetId string
    Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime
    outbound_ips NetworkProfileResponseOutboundIPs
    Desired outbound IP resources for Azure Spring Apps resource.
    required_traffics Sequence[RequiredTrafficResponse]
    Required inbound or outbound traffics for Azure Spring Apps resource.
    app_network_resource_group str
    Name of the resource group containing network resources for customer apps in Azure Spring Apps
    app_subnet_id str
    Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps
    ingress_config IngressConfigResponse
    Ingress configuration payload for Azure Spring Apps resource.
    outbound_type str
    The egress traffic type of Azure Spring Apps VNet instances.
    service_cidr str
    Azure Spring Apps service reserved CIDR
    service_runtime_network_resource_group str
    Name of the resource group containing network resources of Azure Spring Apps Service Runtime
    service_runtime_subnet_id str
    Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime
    outboundIPs Property Map
    Desired outbound IP resources for Azure Spring Apps resource.
    requiredTraffics List<Property Map>
    Required inbound or outbound traffics for Azure Spring Apps resource.
    appNetworkResourceGroup String
    Name of the resource group containing network resources for customer apps in Azure Spring Apps
    appSubnetId String
    Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps
    ingressConfig Property Map
    Ingress configuration payload for Azure Spring Apps resource.
    outboundType String
    The egress traffic type of Azure Spring Apps VNet instances.
    serviceCidr String
    Azure Spring Apps service reserved CIDR
    serviceRuntimeNetworkResourceGroup String
    Name of the resource group containing network resources of Azure Spring Apps Service Runtime
    serviceRuntimeSubnetId String
    Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime

    NetworkProfileResponseOutboundIPs

    PublicIPs List<string>
    A list of public IP addresses.
    PublicIPs []string
    A list of public IP addresses.
    publicIPs List<String>
    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<String>
    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<String>
    The FQDN list of required traffic
    ips List<String>
    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<String>
    The FQDN list of required traffic
    ips List<String>
    The ip list of required traffic
    port Number
    The port of required traffic
    protocol String
    The protocol of required traffic

    ServiceVNetAddonsResponse

    DataPlanePublicEndpoint bool
    Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet.
    LogStreamPublicEndpoint bool
    Indicates whether the log stream in vnet injection instance could be accessed from internet.
    DataPlanePublicEndpoint bool
    Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet.
    LogStreamPublicEndpoint bool
    Indicates whether the log stream in vnet injection instance could be accessed from internet.
    dataPlanePublicEndpoint Boolean
    Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet.
    logStreamPublicEndpoint Boolean
    Indicates whether the log stream in vnet injection instance could be accessed from internet.
    dataPlanePublicEndpoint boolean
    Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet.
    logStreamPublicEndpoint boolean
    Indicates whether the log stream in vnet injection instance could be accessed from internet.
    data_plane_public_endpoint bool
    Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet.
    log_stream_public_endpoint bool
    Indicates whether the log stream in vnet injection instance could be accessed from internet.
    dataPlanePublicEndpoint Boolean
    Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet.
    logStreamPublicEndpoint Boolean
    Indicates whether the log stream in vnet injection instance could be accessed from internet.

    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

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource modification (UTC).
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource modification (UTC).
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource modification (UTC).
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource modification (UTC).
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource modification (UTC).
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource modification (UTC).
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi