Azure Native v1.102.0, May 2 23

azure-native.documentdb.getService

Explore with Pulumi AI

Gets the status of service. API Version: 2021-04-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:

AccountName string: Cosmos DB database account name.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
ServiceName string: Cosmos DB service name.

AccountName string: Cosmos DB database account name.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
ServiceName string: Cosmos DB service name.

accountName String: Cosmos DB database account name.
resourceGroupName String: The name of the resource group. The name is case insensitive.
serviceName String: Cosmos DB service name.

accountName string: Cosmos DB database account name.
resourceGroupName string: The name of the resource group. The name is case insensitive.
serviceName string: Cosmos DB service name.

account_name str: Cosmos DB database account name.
resource_group_name str: The name of the resource group. The name is case insensitive.
service_name str: Cosmos DB service name.

accountName String: Cosmos DB database account name.
resourceGroupName String: The name of the resource group. The name is case insensitive.
serviceName 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.AzureNative.DocumentDB.Outputs.DataTransferServiceResourcePropertiesResponse | Pulumi.AzureNative.DocumentDB.Outputs.SqlDedicatedGatewayServiceResourcePropertiesResponse: 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 DataTransferServiceResourcePropertiesResponse | SqlDedicatedGatewayServiceResourcePropertiesResponse: 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 DataTransferServiceResourcePropertiesResponse | SqlDedicatedGatewayServiceResourcePropertiesResponse: 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 DataTransferServiceResourcePropertiesResponse | SqlDedicatedGatewayServiceResourcePropertiesResponse: 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 DataTransferServiceResourcePropertiesResponse | SqlDedicatedGatewayServiceResourcePropertiesResponse: 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: Services response resource.
type String: The type of Azure resource.

Supporting Types

DataTransferRegionalServiceResourceResponse

Location string: The location name.
Name string: The regional service name.
Status string: Describes the status of a service.

Location string: The location name.
Name string: The regional service name.
Status string: Describes the status of a service.

location String: The location name.
name String: The regional service name.
status String: Describes the status of a service.

location string: The location name.
name string: The regional service name.
status string: Describes the status of a service.

location str: The location name.
name str: The regional service name.
status str: Describes the status of a service.

location String: The location name.
name String: The regional service name.
status String: Describes the status of a service.

DataTransferServiceResourcePropertiesResponse

CreationTime string: Time of the last state change (ISO-8601 format).
Locations List<Pulumi.AzureNative.DocumentDB.Inputs.DataTransferRegionalServiceResourceResponse>: An array that contains all of the locations for the service.
Status string: Describes the status of a service.
InstanceCount int: Instance count for the service.
InstanceSize string: Instance type for the service.

CreationTime string: Time of the last state change (ISO-8601 format).
Locations []DataTransferRegionalServiceResourceResponse: An array that contains all of the locations for the service.
Status string: Describes the status of a service.
InstanceCount int: Instance count for the service.
InstanceSize string: Instance type for the service.

creationTime String: Time of the last state change (ISO-8601 format).
locations List<DataTransferRegionalServiceResourceResponse>: An array that contains all of the locations for the service.
status String: Describes the status of a service.
instanceCount Integer: Instance count for the service.
instanceSize String: Instance type for the service.

creationTime string: Time of the last state change (ISO-8601 format).
locations DataTransferRegionalServiceResourceResponse[]: An array that contains all of the locations for the service.
status string: Describes the status of a service.
instanceCount number: Instance count for the service.
instanceSize string: Instance type for the service.

creation_time str: Time of the last state change (ISO-8601 format).
locations Sequence[DataTransferRegionalServiceResourceResponse]: 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.

creationTime 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.
instanceCount Number: Instance count for the service.
instanceSize String: Instance type for the service.

SqlDedicatedGatewayRegionalServiceResourceResponse

Location string: The location name.
Name string: The regional service name.
SqlDedicatedGatewayEndpoint string: The regional endpoint for SqlDedicatedGateway.
Status string: Describes the status of a service.

Location string: The location name.
Name string: The regional service name.
SqlDedicatedGatewayEndpoint string: The regional endpoint for SqlDedicatedGateway.
Status string: Describes the status of a service.

location String: The location name.
name String: The regional service name.
sqlDedicatedGatewayEndpoint String: The regional endpoint for SqlDedicatedGateway.
status String: Describes the status of a service.

location string: The location name.
name string: The regional service name.
sqlDedicatedGatewayEndpoint string: 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_gateway_endpoint str: The regional endpoint for SqlDedicatedGateway.
status str: Describes the status of a service.

location String: The location name.
name String: The regional service name.
sqlDedicatedGatewayEndpoint String: The regional endpoint for SqlDedicatedGateway.
status String: Describes the status of a service.

SqlDedicatedGatewayServiceResourcePropertiesResponse

CreationTime string: Time of the last state change (ISO-8601 format).
Locations List<Pulumi.AzureNative.DocumentDB.Inputs.SqlDedicatedGatewayRegionalServiceResourceResponse>: An array that contains all of the locations for the service.
Status string: Describes the status of a service.
InstanceCount int: Instance count for the service.
InstanceSize string: Instance type for the service.
SqlDedicatedGatewayEndpoint string: SqlDedicatedGateway endpoint for the service.

CreationTime string: Time of the last state change (ISO-8601 format).
Locations []SqlDedicatedGatewayRegionalServiceResourceResponse: An array that contains all of the locations for the service.
Status string: Describes the status of a service.
InstanceCount int: Instance count for the service.
InstanceSize string: Instance type for the service.
SqlDedicatedGatewayEndpoint string: SqlDedicatedGateway endpoint for the service.

creationTime String: Time of the last state change (ISO-8601 format).
locations List<SqlDedicatedGatewayRegionalServiceResourceResponse>: An array that contains all of the locations for the service.
status String: Describes the status of a service.
instanceCount Integer: Instance count for the service.
instanceSize String: Instance type for the service.
sqlDedicatedGatewayEndpoint String: SqlDedicatedGateway endpoint for the service.

creationTime string: Time of the last state change (ISO-8601 format).
locations SqlDedicatedGatewayRegionalServiceResourceResponse[]: An array that contains all of the locations for the service.
status string: Describes the status of a service.
instanceCount number: Instance count for the service.
instanceSize string: Instance type for the service.
sqlDedicatedGatewayEndpoint string: SqlDedicatedGateway endpoint for the service.

creation_time str: Time of the last state change (ISO-8601 format).
locations Sequence[SqlDedicatedGatewayRegionalServiceResourceResponse]: 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_gateway_endpoint str: SqlDedicatedGateway endpoint for the service.

creationTime 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.
instanceCount Number: Instance count for the service.
instanceSize String: Instance type for the service.
sqlDedicatedGatewayEndpoint String: SqlDedicatedGateway endpoint for the service.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0