Azure Native v1.102.0, May 2 23

azure-native.healthcareapis.getDicomService

Explore with Pulumi AI

Gets the properties of the specified DICOM Service. API Version: 2022-05-15.

Using getDicomService

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 getDicomService(args: GetDicomServiceArgs, opts?: InvokeOptions): Promise<GetDicomServiceResult>
function getDicomServiceOutput(args: GetDicomServiceOutputArgs, opts?: InvokeOptions): Output<GetDicomServiceResult>

def get_dicom_service(dicom_service_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      workspace_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetDicomServiceResult
def get_dicom_service_output(dicom_service_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      workspace_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetDicomServiceResult]

func LookupDicomService(ctx *Context, args *LookupDicomServiceArgs, opts ...InvokeOption) (*LookupDicomServiceResult, error)
func LookupDicomServiceOutput(ctx *Context, args *LookupDicomServiceOutputArgs, opts ...InvokeOption) LookupDicomServiceResultOutput

> Note: This function is named LookupDicomService in the Go SDK.

public static class GetDicomService 
{
    public static Task<GetDicomServiceResult> InvokeAsync(GetDicomServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetDicomServiceResult> Invoke(GetDicomServiceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDicomServiceResult> getDicomService(GetDicomServiceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:healthcareapis:getDicomService
  arguments:
    # arguments dictionary

The following arguments are supported:

DicomServiceName string: The name of DICOM Service resource.
ResourceGroupName string: The name of the resource group that contains the service instance.
WorkspaceName string: The name of workspace resource.

DicomServiceName string: The name of DICOM Service resource.
ResourceGroupName string: The name of the resource group that contains the service instance.
WorkspaceName string: The name of workspace resource.

dicomServiceName String: The name of DICOM Service resource.
resourceGroupName String: The name of the resource group that contains the service instance.
workspaceName String: The name of workspace resource.

dicomServiceName string: The name of DICOM Service resource.
resourceGroupName string: The name of the resource group that contains the service instance.
workspaceName string: The name of workspace resource.

dicom_service_name str: The name of DICOM Service resource.
resource_group_name str: The name of the resource group that contains the service instance.
workspace_name str: The name of workspace resource.

dicomServiceName String: The name of DICOM Service resource.
resourceGroupName String: The name of the resource group that contains the service instance.
workspaceName String: The name of workspace resource.

getDicomService Result

The following output properties are available:

Id string: The resource identifier.
Name string: The resource name.
PrivateEndpointConnections List<Pulumi.AzureNative.HealthcareApis.Outputs.PrivateEndpointConnectionResponse>: The list of private endpoint connections that are set up for this resource.
ProvisioningState string: The provisioning state.
PublicNetworkAccess string: Control permission for data plane traffic coming from public networks while private endpoint is enabled.
ServiceUrl string: The url of the Dicom Services.
SystemData Pulumi.AzureNative.HealthcareApis.Outputs.SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
Type string: The resource type.
AuthenticationConfiguration Pulumi.AzureNative.HealthcareApis.Outputs.DicomServiceAuthenticationConfigurationResponse: Dicom Service authentication configuration.
CorsConfiguration Pulumi.AzureNative.HealthcareApis.Outputs.CorsConfigurationResponse: Dicom Service Cors configuration.
Etag string: An etag associated with the resource, used for optimistic concurrency when editing it.
Identity Pulumi.AzureNative.HealthcareApis.Outputs.ServiceManagedIdentityResponseIdentity: Setting indicating whether the service has a managed identity associated with it.
Location string: The resource location.
Tags Dictionary<string, string>: Resource tags.

Id string: The resource identifier.
Name string: The resource name.
PrivateEndpointConnections []PrivateEndpointConnectionResponse: The list of private endpoint connections that are set up for this resource.
ProvisioningState string: The provisioning state.
PublicNetworkAccess string: Control permission for data plane traffic coming from public networks while private endpoint is enabled.
ServiceUrl string: The url of the Dicom Services.
SystemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
Type string: The resource type.
AuthenticationConfiguration DicomServiceAuthenticationConfigurationResponse: Dicom Service authentication configuration.
CorsConfiguration CorsConfigurationResponse: Dicom Service Cors configuration.
Etag string: An etag associated with the resource, used for optimistic concurrency when editing it.
Identity ServiceManagedIdentityResponseIdentity: Setting indicating whether the service has a managed identity associated with it.
Location string: The resource location.
Tags map[string]string: Resource tags.

id String: The resource identifier.
name String: The resource name.
privateEndpointConnections List<PrivateEndpointConnectionResponse>: The list of private endpoint connections that are set up for this resource.
provisioningState String: The provisioning state.
publicNetworkAccess String: Control permission for data plane traffic coming from public networks while private endpoint is enabled.
serviceUrl String: The url of the Dicom Services.
systemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
type String: The resource type.
authenticationConfiguration DicomServiceAuthenticationConfigurationResponse: Dicom Service authentication configuration.
corsConfiguration CorsConfigurationResponse: Dicom Service Cors configuration.
etag String: An etag associated with the resource, used for optimistic concurrency when editing it.
identity ServiceManagedIdentityResponseIdentity: Setting indicating whether the service has a managed identity associated with it.
location String: The resource location.
tags Map<String,String>: Resource tags.

id string: The resource identifier.
name string: The resource name.
privateEndpointConnections PrivateEndpointConnectionResponse[]: The list of private endpoint connections that are set up for this resource.
provisioningState string: The provisioning state.
publicNetworkAccess string: Control permission for data plane traffic coming from public networks while private endpoint is enabled.
serviceUrl string: The url of the Dicom Services.
systemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
type string: The resource type.
authenticationConfiguration DicomServiceAuthenticationConfigurationResponse: Dicom Service authentication configuration.
corsConfiguration CorsConfigurationResponse: Dicom Service Cors configuration.
etag string: An etag associated with the resource, used for optimistic concurrency when editing it.
identity ServiceManagedIdentityResponseIdentity: Setting indicating whether the service has a managed identity associated with it.
location string: The resource location.
tags {[key: string]: string}: Resource tags.

id str: The resource identifier.
name str: The resource name.
private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]: The list of private endpoint connections that are set up for this resource.
provisioning_state str: The provisioning state.
public_network_access str: Control permission for data plane traffic coming from public networks while private endpoint is enabled.
service_url str: The url of the Dicom Services.
system_data SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
type str: The resource type.
authentication_configuration DicomServiceAuthenticationConfigurationResponse: Dicom Service authentication configuration.
cors_configuration CorsConfigurationResponse: Dicom Service Cors configuration.
etag str: An etag associated with the resource, used for optimistic concurrency when editing it.
identity ServiceManagedIdentityResponseIdentity: Setting indicating whether the service has a managed identity associated with it.
location str: The resource location.
tags Mapping[str, str]: Resource tags.

id String: The resource identifier.
name String: The resource name.
privateEndpointConnections List<Property Map>: The list of private endpoint connections that are set up for this resource.
provisioningState String: The provisioning state.
publicNetworkAccess String: Control permission for data plane traffic coming from public networks while private endpoint is enabled.
serviceUrl String: The url of the Dicom Services.
systemData Property Map: Metadata pertaining to creation and last modification of the resource.
type String: The resource type.
authenticationConfiguration Property Map: Dicom Service authentication configuration.
corsConfiguration Property Map: Dicom Service Cors configuration.
etag String: An etag associated with the resource, used for optimistic concurrency when editing it.
identity Property Map: Setting indicating whether the service has a managed identity associated with it.
location String: The resource location.
tags Map<String>: Resource tags.

Supporting Types

CorsConfigurationResponse

AllowCredentials bool: If credentials are allowed via CORS.
Headers List<string>: The headers to be allowed via CORS.
MaxAge int: The max age to be allowed via CORS.
Methods List<string>: The methods to be allowed via CORS.
Origins List<string>: The origins to be allowed via CORS.

AllowCredentials bool: If credentials are allowed via CORS.
Headers []string: The headers to be allowed via CORS.
MaxAge int: The max age to be allowed via CORS.
Methods []string: The methods to be allowed via CORS.
Origins []string: The origins to be allowed via CORS.

allowCredentials Boolean: If credentials are allowed via CORS.
headers List<String>: The headers to be allowed via CORS.
maxAge Integer: The max age to be allowed via CORS.
methods List<String>: The methods to be allowed via CORS.
origins List<String>: The origins to be allowed via CORS.

allowCredentials boolean: If credentials are allowed via CORS.
headers string[]: The headers to be allowed via CORS.
maxAge number: The max age to be allowed via CORS.
methods string[]: The methods to be allowed via CORS.
origins string[]: The origins to be allowed via CORS.

allow_credentials bool: If credentials are allowed via CORS.
headers Sequence[str]: The headers to be allowed via CORS.
max_age int: The max age to be allowed via CORS.
methods Sequence[str]: The methods to be allowed via CORS.
origins Sequence[str]: The origins to be allowed via CORS.

allowCredentials Boolean: If credentials are allowed via CORS.
headers List<String>: The headers to be allowed via CORS.
maxAge Number: The max age to be allowed via CORS.
methods List<String>: The methods to be allowed via CORS.
origins List<String>: The origins to be allowed via CORS.

DicomServiceAuthenticationConfigurationResponse

Audiences List<string>: The audiences for the service
Authority string: The authority url for the service

Audiences []string: The audiences for the service
Authority string: The authority url for the service

audiences List<String>: The audiences for the service
authority String: The authority url for the service

audiences string[]: The audiences for the service
authority string: The authority url for the service

audiences Sequence[str]: The audiences for the service
authority str: The authority url for the service

audiences List<String>: The audiences for the service
authority String: The authority url for the service

PrivateEndpointConnectionResponse

Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string: The name of the resource
PrivateLinkServiceConnectionState Pulumi.AzureNative.HealthcareApis.Inputs.PrivateLinkServiceConnectionStateResponse: A collection of information about the state of the connection between service consumer and provider.
ProvisioningState string: The provisioning state of the private endpoint connection resource.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
PrivateEndpoint Pulumi.AzureNative.HealthcareApis.Inputs.PrivateEndpointResponse: The resource of private end point.

Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string: The name of the resource
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse: A collection of information about the state of the connection between service consumer and provider.
ProvisioningState string: The provisioning state of the private endpoint connection resource.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
PrivateEndpoint PrivateEndpointResponse: The resource of private end point.

id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String: The name of the resource
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse: A collection of information about the state of the connection between service consumer and provider.
provisioningState String: The provisioning state of the private endpoint connection resource.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateEndpoint PrivateEndpointResponse: The resource of private end point.

id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string: The name of the resource
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse: A collection of information about the state of the connection between service consumer and provider.
provisioningState string: The provisioning state of the private endpoint connection resource.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateEndpoint PrivateEndpointResponse: The resource of private end point.

id str: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str: The name of the resource
private_link_service_connection_state PrivateLinkServiceConnectionStateResponse: A collection of information about the state of the connection between service consumer and provider.
provisioning_state str: The provisioning state of the private endpoint connection resource.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
private_endpoint PrivateEndpointResponse: The resource of private end point.

id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String: The name of the resource
privateLinkServiceConnectionState Property Map: A collection of information about the state of the connection between service consumer and provider.
provisioningState String: The provisioning state of the private endpoint connection resource.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateEndpoint Property Map: The resource of private end point.

PrivateEndpointResponse

Id string: The ARM identifier for Private Endpoint

Id string: The ARM identifier for Private Endpoint

id String: The ARM identifier for Private Endpoint

id string: The ARM identifier for Private Endpoint

id str: The ARM identifier for Private Endpoint

id String: The ARM identifier for Private Endpoint

PrivateLinkServiceConnectionStateResponse

ActionsRequired string: A message indicating if changes on the service provider require any updates on the consumer.
Description string: The reason for approval/rejection of the connection.
Status string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

ActionsRequired string: A message indicating if changes on the service provider require any updates on the consumer.
Description string: The reason for approval/rejection of the connection.
Status string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

actionsRequired String: A message indicating if changes on the service provider require any updates on the consumer.
description String: The reason for approval/rejection of the connection.
status String: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

actionsRequired string: A message indicating if changes on the service provider require any updates on the consumer.
description string: The reason for approval/rejection of the connection.
status string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

actions_required str: A message indicating if changes on the service provider require any updates on the consumer.
description str: The reason for approval/rejection of the connection.
status str: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

actionsRequired String: A message indicating if changes on the service provider require any updates on the consumer.
description String: The reason for approval/rejection of the connection.
status String: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

ServiceManagedIdentityResponseIdentity

PrincipalId string: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId string: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type string: Type of identity being specified, currently SystemAssigned and None are allowed.
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.HealthcareApis.Inputs.UserAssignedIdentityResponse>: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

PrincipalId string: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId string: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type string: Type of identity being specified, currently SystemAssigned and None are allowed.
UserAssignedIdentities map[string]UserAssignedIdentityResponse: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

principalId String: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId String: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type String: Type of identity being specified, currently SystemAssigned and None are allowed.
userAssignedIdentities Map<String,UserAssignedIdentityResponse>: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

principalId string: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId string: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type string: Type of identity being specified, currently SystemAssigned and None are allowed.
userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

principal_id str: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenant_id str: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type str: Type of identity being specified, currently SystemAssigned and None are allowed.
user_assigned_identities Mapping[str, UserAssignedIdentityResponse]: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

principalId String: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId String: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type String: Type of identity being specified, currently SystemAssigned and None are allowed.
userAssignedIdentities Map<Property Map>: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

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 last 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 last 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 last 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 last 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 last 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 last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

UserAssignedIdentityResponse

ClientId string: The client ID of the assigned identity.
PrincipalId string: The principal ID of the assigned identity.

ClientId string: The client ID of the assigned identity.
PrincipalId string: The principal ID of the assigned identity.

clientId String: The client ID of the assigned identity.
principalId String: The principal ID of the assigned identity.

clientId string: The client ID of the assigned identity.
principalId string: The principal ID of the assigned identity.

client_id str: The client ID of the assigned identity.
principal_id str: The principal ID of the assigned identity.

clientId String: The client ID of the assigned identity.
principalId String: The principal ID of the assigned identity.

Package Details

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