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.75.0 published on Saturday, Nov 30, 2024 by Pulumi
azure-native.documentdb.getService
Explore with Pulumi AI
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.75.0 published on Saturday, Nov 30, 2024 by Pulumi
Gets the status of service. Azure REST API version: 2023-04-15.
Other available API versions: 2023-09-15, 2023-09-15-preview, 2023-11-15, 2023-11-15-preview, 2024-02-15-preview, 2024-05-15, 2024-05-15-preview, 2024-08-15, 2024-09-01-preview, 2024-11-15, 2024-12-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(account_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
service_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetServiceResult
def get_service_output(account_name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
service_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetServiceResult]
func LookupService(ctx *Context, args *LookupServiceArgs, opts ...InvokeOption) (*LookupServiceResult, error)
func LookupServiceOutput(ctx *Context, args *LookupServiceOutputArgs, opts ...InvokeOption) LookupServiceResultOutput
> Note: This function is named LookupService
in the Go SDK.
public static class GetService
{
public static Task<GetServiceResult> InvokeAsync(GetServiceArgs args, InvokeOptions? opts = null)
public static Output<GetServiceResult> Invoke(GetServiceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetServiceResult> getService(GetServiceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:documentdb:getService
arguments:
# arguments dictionary
The following arguments are supported:
- Account
Name string - Cosmos DB database account name.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - Cosmos DB service name.
- Account
Name string - Cosmos DB database account name.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - Cosmos DB service name.
- account
Name String - Cosmos DB database account name.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - Cosmos DB service name.
- account
Name string - Cosmos DB database account name.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- service
Name string - Cosmos DB service name.
- account_
name str - Cosmos DB database account name.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- service_
name str - Cosmos DB service name.
- account
Name String - Cosmos DB database account name.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - Cosmos DB service name.
getService Result
The following output properties are available:
- Id string
- The unique resource identifier of the database account.
- Name string
- The name of the database account.
- Properties
Pulumi.
Azure | Pulumi.Native. Document DB. Outputs. Data Transfer Service Resource Properties Response Azure | Pulumi.Native. Document DB. Outputs. Graph APICompute Service Resource Properties Response Azure | Pulumi.Native. Document DB. Outputs. Materialized Views Builder Service Resource Properties Response Azure Native. Document DB. Outputs. Sql Dedicated Gateway Service Resource Properties Response - Services response resource.
- Type string
- The type of Azure resource.
- Id string
- The unique resource identifier of the database account.
- Name string
- The name of the database account.
- Properties
Data
Transfer | GraphService Resource Properties Response APICompute | MaterializedService Resource Properties Response Views | SqlBuilder Service Resource Properties Response Dedicated Gateway Service Resource Properties Response - Services response resource.
- Type string
- The type of Azure resource.
- id String
- The unique resource identifier of the database account.
- name String
- The name of the database account.
- properties
Data
Transfer | GraphService Resource Properties Response APICompute | MaterializedService Resource Properties Response Views | SqlBuilder Service Resource Properties Response Dedicated Gateway Service Resource Properties Response - Services response resource.
- type String
- The type of Azure resource.
- id string
- The unique resource identifier of the database account.
- name string
- The name of the database account.
- properties
Data
Transfer | GraphService Resource Properties Response APICompute | MaterializedService Resource Properties Response Views | SqlBuilder Service Resource Properties Response Dedicated Gateway Service Resource Properties Response - Services response resource.
- type string
- The type of Azure resource.
- id str
- The unique resource identifier of the database account.
- name str
- The name of the database account.
- properties
Data
Transfer | GraphService Resource Properties Response APICompute | MaterializedService Resource Properties Response Views | SqlBuilder Service Resource Properties Response Dedicated Gateway Service Resource Properties Response - Services response resource.
- type str
- The type of Azure resource.
- id String
- The unique resource identifier of the database account.
- name String
- The name of the database account.
- properties Property Map | Property Map | Property Map | Property Map
- Services response resource.
- type String
- The type of Azure resource.
Supporting Types
DataTransferRegionalServiceResourceResponse
DataTransferServiceResourcePropertiesResponse
- Creation
Time string - Time of the last state change (ISO-8601 format).
- Locations
List<Pulumi.
Azure Native. Document DB. Inputs. Data Transfer Regional Service Resource Response> - An array that contains all of the locations for the service.
- Status string
- Describes the status of a service.
- Instance
Count int - Instance count for the service.
- Instance
Size string - Instance type for the service.
- Creation
Time string - Time of the last state change (ISO-8601 format).
- Locations
[]Data
Transfer Regional Service Resource Response - An array that contains all of the locations for the service.
- Status string
- Describes the status of a service.
- Instance
Count int - Instance count for the service.
- Instance
Size string - Instance type for the service.
- creation
Time String - Time of the last state change (ISO-8601 format).
- locations
List<Data
Transfer Regional Service Resource Response> - An array that contains all of the locations for the service.
- status String
- Describes the status of a service.
- instance
Count Integer - Instance count for the service.
- instance
Size String - Instance type for the service.
- creation
Time string - Time of the last state change (ISO-8601 format).
- locations
Data
Transfer Regional Service Resource Response[] - An array that contains all of the locations for the service.
- status string
- Describes the status of a service.
- instance
Count number - Instance count for the service.
- instance
Size string - Instance type for the service.
- creation_
time str - Time of the last state change (ISO-8601 format).
- locations
Sequence[Data
Transfer Regional Service Resource Response] - An array that contains all of the locations for the service.
- status str
- Describes the status of a service.
- instance_
count int - Instance count for the service.
- instance_
size str - Instance type for the service.
- creation
Time String - Time of the last state change (ISO-8601 format).
- locations List<Property Map>
- An array that contains all of the locations for the service.
- status String
- Describes the status of a service.
- instance
Count Number - Instance count for the service.
- instance
Size String - Instance type for the service.
GraphAPIComputeRegionalServiceResourceResponse
- Graph
Api stringCompute Endpoint - The regional endpoint for GraphAPICompute.
- Location string
- The location name.
- Name string
- The regional service name.
- Status string
- Describes the status of a service.
- Graph
Api stringCompute Endpoint - The regional endpoint for GraphAPICompute.
- Location string
- The location name.
- Name string
- The regional service name.
- Status string
- Describes the status of a service.
- graph
Api StringCompute Endpoint - The regional endpoint for GraphAPICompute.
- location String
- The location name.
- name String
- The regional service name.
- status String
- Describes the status of a service.
- graph
Api stringCompute Endpoint - The regional endpoint for GraphAPICompute.
- location string
- The location name.
- name string
- The regional service name.
- status string
- Describes the status of a service.
- graph_
api_ strcompute_ endpoint - The regional endpoint for GraphAPICompute.
- location str
- The location name.
- name str
- The regional service name.
- status str
- Describes the status of a service.
- graph
Api StringCompute Endpoint - The regional endpoint for GraphAPICompute.
- location String
- The location name.
- name String
- The regional service name.
- status String
- Describes the status of a service.
GraphAPIComputeServiceResourcePropertiesResponse
- Creation
Time string - Time of the last state change (ISO-8601 format).
- Locations
List<Pulumi.
Azure Native. Document DB. Inputs. Graph APICompute Regional Service Resource Response> - An array that contains all of the locations for the service.
- Status string
- Describes the status of a service.
- Graph
Api stringCompute Endpoint - GraphAPICompute endpoint for the service.
- Instance
Count int - Instance count for the service.
- Instance
Size string - Instance type for the service.
- Creation
Time string - Time of the last state change (ISO-8601 format).
- Locations
[]Graph
APICompute Regional Service Resource Response - An array that contains all of the locations for the service.
- Status string
- Describes the status of a service.
- Graph
Api stringCompute Endpoint - GraphAPICompute endpoint for the service.
- Instance
Count int - Instance count for the service.
- Instance
Size string - Instance type for the service.
- creation
Time String - Time of the last state change (ISO-8601 format).
- locations
List<Graph
APICompute Regional Service Resource Response> - An array that contains all of the locations for the service.
- status String
- Describes the status of a service.
- graph
Api StringCompute Endpoint - GraphAPICompute endpoint for the service.
- instance
Count Integer - Instance count for the service.
- instance
Size String - Instance type for the service.
- creation
Time string - Time of the last state change (ISO-8601 format).
- locations
Graph
APICompute Regional Service Resource Response[] - An array that contains all of the locations for the service.
- status string
- Describes the status of a service.
- graph
Api stringCompute Endpoint - GraphAPICompute endpoint for the service.
- instance
Count number - Instance count for the service.
- instance
Size string - Instance type for the service.
- creation_
time str - Time of the last state change (ISO-8601 format).
- locations
Sequence[Graph
APICompute Regional Service Resource Response] - An array that contains all of the locations for the service.
- status str
- Describes the status of a service.
- graph_
api_ strcompute_ endpoint - GraphAPICompute endpoint for the service.
- instance_
count int - Instance count for the service.
- instance_
size str - Instance type for the service.
- creation
Time String - Time of the last state change (ISO-8601 format).
- locations List<Property Map>
- An array that contains all of the locations for the service.
- status String
- Describes the status of a service.
- graph
Api StringCompute Endpoint - GraphAPICompute endpoint for the service.
- instance
Count Number - Instance count for the service.
- instance
Size String - Instance type for the service.
MaterializedViewsBuilderRegionalServiceResourceResponse
MaterializedViewsBuilderServiceResourcePropertiesResponse
- Creation
Time string - Time of the last state change (ISO-8601 format).
- Locations
List<Pulumi.
Azure Native. Document DB. Inputs. Materialized Views Builder Regional Service Resource Response> - An array that contains all of the locations for the service.
- Status string
- Describes the status of a service.
- Instance
Count int - Instance count for the service.
- Instance
Size string - Instance type for the service.
- Creation
Time string - Time of the last state change (ISO-8601 format).
- Locations
[]Materialized
Views Builder Regional Service Resource Response - An array that contains all of the locations for the service.
- Status string
- Describes the status of a service.
- Instance
Count int - Instance count for the service.
- Instance
Size string - Instance type for the service.
- creation
Time String - Time of the last state change (ISO-8601 format).
- locations
List<Materialized
Views Builder Regional Service Resource Response> - An array that contains all of the locations for the service.
- status String
- Describes the status of a service.
- instance
Count Integer - Instance count for the service.
- instance
Size String - Instance type for the service.
- creation
Time string - Time of the last state change (ISO-8601 format).
- locations
Materialized
Views Builder Regional Service Resource Response[] - An array that contains all of the locations for the service.
- status string
- Describes the status of a service.
- instance
Count number - Instance count for the service.
- instance
Size string - Instance type for the service.
- creation_
time str - Time of the last state change (ISO-8601 format).
- locations
Sequence[Materialized
Views Builder Regional Service Resource Response] - An array that contains all of the locations for the service.
- status str
- Describes the status of a service.
- instance_
count int - Instance count for the service.
- instance_
size str - Instance type for the service.
- creation
Time String - Time of the last state change (ISO-8601 format).
- locations List<Property Map>
- An array that contains all of the locations for the service.
- status String
- Describes the status of a service.
- instance
Count Number - Instance count for the service.
- instance
Size String - Instance type for the service.
SqlDedicatedGatewayRegionalServiceResourceResponse
- Location string
- The location name.
- Name string
- The regional service name.
- Sql
Dedicated stringGateway Endpoint - The regional endpoint for SqlDedicatedGateway.
- Status string
- Describes the status of a service.
- Location string
- The location name.
- Name string
- The regional service name.
- Sql
Dedicated stringGateway Endpoint - The regional endpoint for SqlDedicatedGateway.
- Status string
- Describes the status of a service.
- location String
- The location name.
- name String
- The regional service name.
- sql
Dedicated StringGateway Endpoint - The regional endpoint for SqlDedicatedGateway.
- status String
- Describes the status of a service.
- location string
- The location name.
- name string
- The regional service name.
- sql
Dedicated stringGateway Endpoint - The regional endpoint for SqlDedicatedGateway.
- status string
- Describes the status of a service.
- location str
- The location name.
- name str
- The regional service name.
- sql_
dedicated_ strgateway_ endpoint - The regional endpoint for SqlDedicatedGateway.
- status str
- Describes the status of a service.
- location String
- The location name.
- name String
- The regional service name.
- sql
Dedicated StringGateway Endpoint - The regional endpoint for SqlDedicatedGateway.
- status String
- Describes the status of a service.
SqlDedicatedGatewayServiceResourcePropertiesResponse
- Creation
Time string - Time of the last state change (ISO-8601 format).
- Locations
List<Pulumi.
Azure Native. Document DB. Inputs. Sql Dedicated Gateway Regional Service Resource Response> - An array that contains all of the locations for the service.
- Status string
- Describes the status of a service.
- Instance
Count int - Instance count for the service.
- Instance
Size string - Instance type for the service.
- Sql
Dedicated stringGateway Endpoint - SqlDedicatedGateway endpoint for the service.
- Creation
Time string - Time of the last state change (ISO-8601 format).
- Locations
[]Sql
Dedicated Gateway Regional Service Resource Response - An array that contains all of the locations for the service.
- Status string
- Describes the status of a service.
- Instance
Count int - Instance count for the service.
- Instance
Size string - Instance type for the service.
- Sql
Dedicated stringGateway Endpoint - SqlDedicatedGateway endpoint for the service.
- creation
Time String - Time of the last state change (ISO-8601 format).
- locations
List<Sql
Dedicated Gateway Regional Service Resource Response> - An array that contains all of the locations for the service.
- status String
- Describes the status of a service.
- instance
Count Integer - Instance count for the service.
- instance
Size String - Instance type for the service.
- sql
Dedicated StringGateway Endpoint - SqlDedicatedGateway endpoint for the service.
- creation
Time string - Time of the last state change (ISO-8601 format).
- locations
Sql
Dedicated Gateway Regional Service Resource Response[] - An array that contains all of the locations for the service.
- status string
- Describes the status of a service.
- instance
Count number - Instance count for the service.
- instance
Size string - Instance type for the service.
- sql
Dedicated stringGateway Endpoint - SqlDedicatedGateway endpoint for the service.
- creation_
time str - Time of the last state change (ISO-8601 format).
- locations
Sequence[Sql
Dedicated Gateway Regional Service Resource Response] - An array that contains all of the locations for the service.
- status str
- Describes the status of a service.
- instance_
count int - Instance count for the service.
- instance_
size str - Instance type for the service.
- sql_
dedicated_ strgateway_ endpoint - SqlDedicatedGateway endpoint for the service.
- creation
Time String - Time of the last state change (ISO-8601 format).
- locations List<Property Map>
- An array that contains all of the locations for the service.
- status String
- Describes the status of a service.
- instance
Count Number - Instance count for the service.
- instance
Size String - Instance type for the service.
- sql
Dedicated StringGateway Endpoint - SqlDedicatedGateway endpoint for the service.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
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.75.0 published on Saturday, Nov 30, 2024 by Pulumi