azure-native.appplatform.getService
Get a Service and its properties.
Uses Azure REST API version 2024-01-01-preview.
Other available API versions: 2023-05-01-preview, 2023-07-01-preview, 2023-09-01-preview, 2023-11-01-preview, 2023-12-01, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native appplatform [ApiVersion]. See the version guide for details.
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)
public static Output<GetServiceResult> getService(GetServiceArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:appplatform:getService
  arguments:
    # arguments dictionaryThe following arguments are supported:
- ResourceGroup stringName 
- 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.
- ResourceGroup stringName 
- 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.
- resourceGroup StringName 
- 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.
- resourceGroup stringName 
- 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_ strname 
- 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.
- resourceGroup StringName 
- 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:
- AzureApi stringVersion 
- The Azure API version of the resource.
- Id string
- Fully qualified resource Id for the resource.
- Name string
- The name of the resource.
- Properties
Pulumi.Azure Native. App Platform. Outputs. Cluster Resource Properties Response 
- Properties of the Service resource
- SystemData Pulumi.Azure Native. App Platform. Outputs. System Data Response 
- 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.Azure Native. App Platform. Outputs. Sku Response 
- Sku of the Service resource
- Dictionary<string, string>
- Tags of the service which is a list of key value pairs that describe the resource.
- AzureApi stringVersion 
- The Azure API version of the resource.
- Id string
- Fully qualified resource Id for the resource.
- Name string
- The name of the resource.
- Properties
ClusterResource Properties Response 
- Properties of the Service resource
- SystemData SystemData Response 
- 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
- map[string]string
- Tags of the service which is a list of key value pairs that describe the resource.
- azureApi StringVersion 
- The Azure API version of the resource.
- id String
- Fully qualified resource Id for the resource.
- name String
- The name of the resource.
- properties
ClusterResource Properties Response 
- Properties of the Service resource
- systemData SystemData Response 
- 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
- Map<String,String>
- Tags of the service which is a list of key value pairs that describe the resource.
- azureApi stringVersion 
- The Azure API version of the resource.
- id string
- Fully qualified resource Id for the resource.
- name string
- The name of the resource.
- properties
ClusterResource Properties Response 
- Properties of the Service resource
- systemData SystemData Response 
- 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
- {[key: string]: string}
- Tags of the service which is a list of key value pairs that describe the resource.
- azure_api_ strversion 
- The Azure API version of the resource.
- id str
- Fully qualified resource Id for the resource.
- name str
- The name of the resource.
- properties
ClusterResource Properties Response 
- Properties of the Service resource
- system_data SystemData Response 
- 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
- Mapping[str, str]
- Tags of the service which is a list of key value pairs that describe the resource.
- azureApi StringVersion 
- The Azure API version of 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
- 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
- InfraResource stringGroup 
- The name of the resource group that contains the infrastructure resources
- MaintenanceSchedule Pulumi.Configuration Azure Native. App Platform. Inputs. Weekly Maintenance Schedule Configuration Response 
- Additional Service settings for planned maintenance
- ManagedEnvironment stringId 
- The resource Id of the Managed Environment that the Spring Apps instance builds on
- MarketplaceResource Pulumi.Azure Native. App Platform. Inputs. Marketplace Resource Response 
- Purchasing 3rd party product of the Service resource.
- NetworkProfile Pulumi.Azure Native. App Platform. Inputs. Network Profile Response 
- Network profile of the Service
- VnetAddons Pulumi.Azure Native. App Platform. Inputs. Service VNet Addons Response 
- 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
- InfraResource stringGroup 
- The name of the resource group that contains the infrastructure resources
- MaintenanceSchedule WeeklyConfiguration Maintenance Schedule Configuration Response 
- Additional Service settings for planned maintenance
- ManagedEnvironment stringId 
- The resource Id of the Managed Environment that the Spring Apps instance builds on
- MarketplaceResource MarketplaceResource Response 
- Purchasing 3rd party product of the Service resource.
- NetworkProfile NetworkProfile Response 
- Network profile of the Service
- VnetAddons ServiceVNet Addons Response 
- 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
- infraResource StringGroup 
- The name of the resource group that contains the infrastructure resources
- maintenanceSchedule WeeklyConfiguration Maintenance Schedule Configuration Response 
- Additional Service settings for planned maintenance
- managedEnvironment StringId 
- The resource Id of the Managed Environment that the Spring Apps instance builds on
- marketplaceResource MarketplaceResource Response 
- Purchasing 3rd party product of the Service resource.
- networkProfile NetworkProfile Response 
- Network profile of the Service
- vnetAddons ServiceVNet Addons Response 
- 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
- infraResource stringGroup 
- The name of the resource group that contains the infrastructure resources
- maintenanceSchedule WeeklyConfiguration Maintenance Schedule Configuration Response 
- Additional Service settings for planned maintenance
- managedEnvironment stringId 
- The resource Id of the Managed Environment that the Spring Apps instance builds on
- marketplaceResource MarketplaceResource Response 
- Purchasing 3rd party product of the Service resource.
- networkProfile NetworkProfile Response 
- Network profile of the Service
- vnetAddons ServiceVNet Addons Response 
- 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_ strgroup 
- The name of the resource group that contains the infrastructure resources
- maintenance_schedule_ Weeklyconfiguration Maintenance Schedule Configuration Response 
- Additional Service settings for planned maintenance
- managed_environment_ strid 
- The resource Id of the Managed Environment that the Spring Apps instance builds on
- marketplace_resource MarketplaceResource Response 
- Purchasing 3rd party product of the Service resource.
- network_profile NetworkProfile Response 
- Network profile of the Service
- vnet_addons ServiceVNet Addons Response 
- 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
- infraResource StringGroup 
- The name of the resource group that contains the infrastructure resources
- maintenanceSchedule Property MapConfiguration 
- Additional Service settings for planned maintenance
- managedEnvironment StringId 
- 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  
- ReadTimeout intIn Seconds 
- Ingress read time out in seconds.
- ReadTimeout intIn Seconds 
- Ingress read time out in seconds.
- readTimeout IntegerIn Seconds 
- Ingress read time out in seconds.
- readTimeout numberIn Seconds 
- Ingress read time out in seconds.
- read_timeout_ intin_ seconds 
- Ingress read time out in seconds.
- readTimeout NumberIn Seconds 
- Ingress read time out in seconds.
MarketplaceResourceResponse  
NetworkProfileResponse  
- OutboundIPs Pulumi.Azure Native. App Platform. Inputs. Network Profile Response Outbound IPs 
- Desired outbound IP resources for Azure Spring Apps resource.
- RequiredTraffics List<Pulumi.Azure Native. App Platform. Inputs. Required Traffic Response> 
- Required inbound or outbound traffics for Azure Spring Apps resource.
- AppNetwork stringResource Group 
- Name of the resource group containing network resources for customer apps in Azure Spring Apps
- AppSubnet stringId 
- Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps
- IngressConfig Pulumi.Azure Native. App Platform. Inputs. Ingress Config Response 
- 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
- ServiceRuntime stringNetwork Resource Group 
- Name of the resource group containing network resources of Azure Spring Apps Service Runtime
- ServiceRuntime stringSubnet Id 
- Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime
- OutboundIPs NetworkProfile Response Outbound IPs 
- Desired outbound IP resources for Azure Spring Apps resource.
- RequiredTraffics []RequiredTraffic Response 
- Required inbound or outbound traffics for Azure Spring Apps resource.
- AppNetwork stringResource Group 
- Name of the resource group containing network resources for customer apps in Azure Spring Apps
- AppSubnet stringId 
- Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps
- IngressConfig IngressConfig Response 
- 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
- ServiceRuntime stringNetwork Resource Group 
- Name of the resource group containing network resources of Azure Spring Apps Service Runtime
- ServiceRuntime stringSubnet Id 
- Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime
- outboundIPs NetworkProfile Response Outbound IPs 
- Desired outbound IP resources for Azure Spring Apps resource.
- requiredTraffics List<RequiredTraffic Response> 
- Required inbound or outbound traffics for Azure Spring Apps resource.
- appNetwork StringResource Group 
- Name of the resource group containing network resources for customer apps in Azure Spring Apps
- appSubnet StringId 
- Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps
- ingressConfig IngressConfig Response 
- 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
- serviceRuntime StringNetwork Resource Group 
- Name of the resource group containing network resources of Azure Spring Apps Service Runtime
- serviceRuntime StringSubnet Id 
- Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime
- outboundIPs NetworkProfile Response Outbound IPs 
- Desired outbound IP resources for Azure Spring Apps resource.
- requiredTraffics RequiredTraffic Response[] 
- Required inbound or outbound traffics for Azure Spring Apps resource.
- appNetwork stringResource Group 
- Name of the resource group containing network resources for customer apps in Azure Spring Apps
- appSubnet stringId 
- Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps
- ingressConfig IngressConfig Response 
- 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
- serviceRuntime stringNetwork Resource Group 
- Name of the resource group containing network resources of Azure Spring Apps Service Runtime
- serviceRuntime stringSubnet Id 
- Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime
- outbound_ips NetworkProfile Response Outbound IPs 
- Desired outbound IP resources for Azure Spring Apps resource.
- required_traffics Sequence[RequiredTraffic Response] 
- Required inbound or outbound traffics for Azure Spring Apps resource.
- app_network_ strresource_ group 
- Name of the resource group containing network resources for customer apps in Azure Spring Apps
- app_subnet_ strid 
- Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps
- ingress_config IngressConfig Response 
- 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_ strnetwork_ resource_ group 
- Name of the resource group containing network resources of Azure Spring Apps Service Runtime
- service_runtime_ strsubnet_ id 
- 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.
- appNetwork StringResource Group 
- Name of the resource group containing network resources for customer apps in Azure Spring Apps
- appSubnet StringId 
- 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
- serviceRuntime StringNetwork Resource Group 
- Name of the resource group containing network resources of Azure Spring Apps Service Runtime
- serviceRuntime StringSubnet Id 
- 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  
ServiceVNetAddonsResponse   
- DataPlane boolPublic Endpoint 
- Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet.
- LogStream boolPublic Endpoint 
- Indicates whether the log stream in vnet injection instance could be accessed from internet.
- DataPlane boolPublic Endpoint 
- Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet.
- LogStream boolPublic Endpoint 
- Indicates whether the log stream in vnet injection instance could be accessed from internet.
- dataPlane BooleanPublic Endpoint 
- Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet.
- logStream BooleanPublic Endpoint 
- Indicates whether the log stream in vnet injection instance could be accessed from internet.
- dataPlane booleanPublic Endpoint 
- Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet.
- logStream booleanPublic Endpoint 
- Indicates whether the log stream in vnet injection instance could be accessed from internet.
- data_plane_ boolpublic_ endpoint 
- Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet.
- log_stream_ boolpublic_ endpoint 
- Indicates whether the log stream in vnet injection instance could be accessed from internet.
- dataPlane BooleanPublic Endpoint 
- Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet.
- logStream BooleanPublic Endpoint 
- Indicates whether the log stream in vnet injection instance could be accessed from internet.
SkuResponse 
SystemDataResponse  
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource modification (UTC).
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource modification (UTC).
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource modification (UTC).
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- 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.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource modification (UTC).
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified stringBy Type 
- 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_ strtype 
- The type of identity that created the resource.
- last_modified_ strat 
- The timestamp of resource modification (UTC).
- last_modified_ strby 
- The identity that last modified the resource.
- last_modified_ strby_ type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource modification (UTC).
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
WeeklyMaintenanceScheduleConfigurationResponse    
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
