azure-native.appplatform.getService
Explore with Pulumi AI
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 dictionary
The following arguments are supported:
- Resource
Group 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.
- Service
Name string - The name of the Service resource.
- Resource
Group 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.
- Service
Name string - The name of the Service resource.
- resource
Group 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.
- service
Name String - The name of the Service resource.
- resource
Group 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.
- service
Name 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.
- resource
Group 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.
- service
Name String - The name of the Service resource.
getService Result
The following output properties are available:
- Azure
Api 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
- System
Data 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.
- Azure
Api 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
Cluster
Resource Properties Response - Properties of the Service resource
- System
Data 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
Sku
Response - Sku of the Service resource
- map[string]string
- Tags of the service which is a list of key value pairs that describe the resource.
- azure
Api 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
Cluster
Resource Properties Response - Properties of the Service resource
- system
Data 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
Sku
Response - Sku of the Service resource
- Map<String,String>
- Tags of the service which is a list of key value pairs that describe the resource.
- azure
Api 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
Cluster
Resource Properties Response - Properties of the Service resource
- system
Data 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
Sku
Response - 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
Cluster
Resource 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
Sku
Response - Sku of the Service resource
- Mapping[str, str]
- Tags of the service which is a list of key value pairs that describe the resource.
- azure
Api 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
- system
Data 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
- Power
State string - Power state of the Service
- Provisioning
State string - Provisioning state of the Service
- Service
Id string - ServiceInstanceEntity Id which uniquely identifies a created resource
- Version int
- Version of the Service
- Infra
Resource stringGroup - The name of the resource group that contains the infrastructure resources
- Maintenance
Schedule Pulumi.Configuration Azure Native. App Platform. Inputs. Weekly Maintenance Schedule Configuration Response - Additional Service settings for planned maintenance
- Managed
Environment stringId - The resource Id of the Managed Environment that the Spring Apps instance builds on
- Marketplace
Resource Pulumi.Azure Native. App Platform. Inputs. Marketplace Resource Response - Purchasing 3rd party product of the Service resource.
- Network
Profile Pulumi.Azure Native. App Platform. Inputs. Network Profile Response - Network profile of the Service
- Vnet
Addons Pulumi.Azure Native. App Platform. Inputs. Service VNet Addons Response - Additional Service settings in vnet injection instance
- Zone
Redundant bool
- Fqdn string
- Fully qualified dns name of the service instance
- Power
State string - Power state of the Service
- Provisioning
State string - Provisioning state of the Service
- Service
Id string - ServiceInstanceEntity Id which uniquely identifies a created resource
- Version int
- Version of the Service
- Infra
Resource stringGroup - 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 stringId - 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
- power
State String - Power state of the Service
- provisioning
State String - Provisioning state of the Service
- service
Id String - ServiceInstanceEntity Id which uniquely identifies a created resource
- version Integer
- Version of the Service
- infra
Resource StringGroup - 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 StringId - 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 Boolean
- fqdn string
- Fully qualified dns name of the service instance
- power
State string - Power state of the Service
- provisioning
State string - Provisioning state of the Service
- service
Id string - ServiceInstanceEntity Id which uniquely identifies a created resource
- version number
- Version of the Service
- infra
Resource stringGroup - 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 stringId - 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 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
- power
State String - Power state of the Service
- provisioning
State String - Provisioning state of the Service
- service
Id String - ServiceInstanceEntity Id which uniquely identifies a created resource
- version Number
- Version of the Service
- infra
Resource StringGroup - The name of the resource group that contains the infrastructure resources
- maintenance
Schedule Property MapConfiguration - Additional Service settings for planned maintenance
- managed
Environment StringId - The resource Id of the Managed Environment that the Spring Apps instance builds on
- marketplace
Resource Property Map - Purchasing 3rd party product of the Service resource.
- network
Profile Property Map - Network profile of the Service
- vnet
Addons Property Map - Additional Service settings in vnet injection instance
- zone
Redundant Boolean
IngressConfigResponse
- Read
Timeout intIn Seconds - Ingress read time out in seconds.
- Read
Timeout intIn Seconds - Ingress read time out in seconds.
- read
Timeout IntegerIn Seconds - Ingress read time out in seconds.
- read
Timeout numberIn Seconds - Ingress read time out in seconds.
- read_
timeout_ intin_ seconds - Ingress read time out in seconds.
- read
Timeout NumberIn Seconds - Ingress read time out in seconds.
MarketplaceResourceResponse
NetworkProfileResponse
- Outbound
IPs Pulumi.Azure Native. App Platform. Inputs. Network Profile Response Outbound IPs - Desired outbound IP resources for Azure Spring Apps resource.
- Required
Traffics List<Pulumi.Azure Native. App Platform. Inputs. Required Traffic Response> - Required inbound or outbound traffics for Azure Spring Apps resource.
- App
Network stringResource Group - Name of the resource group containing network resources for customer apps in Azure Spring Apps
- App
Subnet stringId - Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps
- Ingress
Config Pulumi.Azure Native. App Platform. Inputs. Ingress Config Response - Ingress configuration payload for Azure Spring Apps resource.
- Outbound
Type string - The egress traffic type of Azure Spring Apps VNet instances.
- Service
Cidr string - Azure Spring Apps service reserved CIDR
- Service
Runtime stringNetwork Resource Group - Name of the resource group containing network resources of Azure Spring Apps Service Runtime
- Service
Runtime 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 []RequiredTraffic Response - Required inbound or outbound traffics for Azure Spring Apps resource.
- App
Network stringResource Group - Name of the resource group containing network resources for customer apps in Azure Spring Apps
- App
Subnet stringId - 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 string - The egress traffic type of Azure Spring Apps VNet instances.
- Service
Cidr string - Azure Spring Apps service reserved CIDR
- Service
Runtime stringNetwork Resource Group - Name of the resource group containing network resources of Azure Spring Apps Service Runtime
- Service
Runtime 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 List<RequiredTraffic Response> - Required inbound or outbound traffics for Azure Spring Apps resource.
- app
Network StringResource Group - Name of the resource group containing network resources for customer apps in Azure Spring Apps
- app
Subnet StringId - 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 String - The egress traffic type of Azure Spring Apps VNet instances.
- service
Cidr String - Azure Spring Apps service reserved CIDR
- service
Runtime StringNetwork Resource Group - Name of the resource group containing network resources of Azure Spring Apps Service Runtime
- service
Runtime 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 RequiredTraffic Response[] - Required inbound or outbound traffics for Azure Spring Apps resource.
- app
Network stringResource Group - Name of the resource group containing network resources for customer apps in Azure Spring Apps
- app
Subnet stringId - 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 string - The egress traffic type of Azure Spring Apps VNet instances.
- service
Cidr string - Azure Spring Apps service reserved CIDR
- service
Runtime stringNetwork Resource Group - Name of the resource group containing network resources of Azure Spring Apps Service Runtime
- service
Runtime 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
- outbound
IPs Property Map - Desired outbound IP resources for Azure Spring Apps resource.
- required
Traffics List<Property Map> - Required inbound or outbound traffics for Azure Spring Apps resource.
- app
Network StringResource Group - Name of the resource group containing network resources for customer apps in Azure Spring Apps
- app
Subnet StringId - Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps
- ingress
Config Property Map - Ingress configuration payload for Azure Spring Apps resource.
- outbound
Type String - The egress traffic type of Azure Spring Apps VNet instances.
- service
Cidr String - Azure Spring Apps service reserved CIDR
- service
Runtime StringNetwork Resource Group - Name of the resource group containing network resources of Azure Spring Apps Service Runtime
- service
Runtime StringSubnet Id - Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime
NetworkProfileResponseOutboundIPs
- Public
IPs List<string> - A list of public IP addresses.
- Public
IPs []string - A list of public IP addresses.
- public
IPs List<String> - A list of public IP addresses.
- public
IPs string[] - A list of public IP addresses.
- public_
ips Sequence[str] - A list of public IP addresses.
- public
IPs List<String> - A list of public IP addresses.
RequiredTrafficResponse
ServiceVNetAddonsResponse
- 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.
- 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.
- data
Plane BooleanPublic Endpoint - Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet.
- log
Stream BooleanPublic Endpoint - Indicates whether the log stream in vnet injection instance could be accessed from internet.
- data
Plane booleanPublic Endpoint - Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet.
- log
Stream 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.
- data
Plane BooleanPublic Endpoint - Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet.
- log
Stream BooleanPublic Endpoint - Indicates whether the log stream in vnet injection instance could be accessed from internet.
SkuResponse
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource modification (UTC).
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource modification (UTC).
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource modification (UTC).
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource modification (UTC).
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified 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.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource modification (UTC).
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified 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