Deid Services - Get

Service:

Health Data

API Version:

2024-09-20

Get a DeidService

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthDataAIServices/deidServices/{deidServiceName}?api-version=2024-09-20

URI Parameters

Name	In	Required	Type	Description
deidServiceName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	The name of the deid service
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	DeidService	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

DeidServices_Get - generated by [MaximumSet] rule. [stable]

Sample request

HTTP

GET https://management.azure.com/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/deidTest?api-version=2024-09-20

Java

/**
 * Samples for DeidServices GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: 2024-09-20/DeidServices_Get_MaximumSet_Gen.json
     */
    /**
     * Sample code: DeidServices_Get - generated by [MaximumSet] rule. [stable].
     * 
     * @param manager Entry point to HealthDataAIServicesManager.
     */
    public static void deidServicesGetGeneratedByMaximumSetRuleStable(
        com.azure.resourcemanager.healthdataaiservices.HealthDataAIServicesManager manager) {
        manager.deidServices().getByResourceGroupWithResponse("rgopenapi", "deidTest",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.healthdataaiservices import HealthDataAIServicesMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-healthdataaiservices
# USAGE
    python deid_services_get_maximum_set_gen.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = HealthDataAIServicesMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.deid_services.get(
        resource_group_name="rgopenapi",
        deid_service_name="deidTest",
    )
    print(response)


# x-ms-original-file: 2024-09-20/DeidServices_Get_MaximumSet_Gen.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armhealthdataaiservices_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/healthdataaiservices/armhealthdataaiservices"
)

// Generated from example definition: 2024-09-20/DeidServices_Get_MaximumSet_Gen.json
func ExampleDeidServicesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armhealthdataaiservices.NewClientFactory("F21BB31B-C214-42C0-ACF0-DACCA05D3011", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDeidServicesClient().Get(ctx, "rgopenapi", "deidTest", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armhealthdataaiservices.DeidServicesClientGetResponse{
	// 	DeidService: &armhealthdataaiservices.DeidService{
	// 		Properties: &armhealthdataaiservices.DeidServiceProperties{
	// 			ProvisioningState: to.Ptr(armhealthdataaiservices.ProvisioningStateSucceeded),
	// 			PublicNetworkAccess: to.Ptr(armhealthdataaiservices.PublicNetworkAccessEnabled),
	// 			PrivateEndpointConnections: []*armhealthdataaiservices.PrivateEndpointConnection{
	// 				{
	// 					Properties: &armhealthdataaiservices.PrivateEndpointConnectionProperties{
	// 						PrivateEndpoint: &armhealthdataaiservices.PrivateEndpoint{
	// 							ID: to.Ptr("gpnxxbbtsysdhhclm"),
	// 						},
	// 						PrivateLinkServiceConnectionState: &armhealthdataaiservices.PrivateLinkServiceConnectionState{
	// 							Status: to.Ptr(armhealthdataaiservices.PrivateEndpointServiceConnectionStatusPending),
	// 							ActionsRequired: to.Ptr("ulb"),
	// 							Description: to.Ptr("ddxuoved"),
	// 						},
	// 						GroupIDs: []*string{
	// 							to.Ptr("xbdyjqg"),
	// 						},
	// 						ProvisioningState: to.Ptr(armhealthdataaiservices.PrivateEndpointConnectionProvisioningStateSucceeded),
	// 					},
	// 					ID: to.Ptr("/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh"),
	// 					Name: to.Ptr("mdwvqjtwcjcvrh"),
	// 					Type: to.Ptr("bzxabjlpbwreez"),
	// 					SystemData: &armhealthdataaiservices.SystemData{
	// 						CreatedBy: to.Ptr("p"),
	// 						CreatedByType: to.Ptr(armhealthdataaiservices.CreatedByTypeUser),
	// 						CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-04-13T19:47:24.985Z"); return t}()),
	// 						LastModifiedBy: to.Ptr("pmbozfvwrblbknedeb"),
	// 						LastModifiedByType: to.Ptr(armhealthdataaiservices.CreatedByTypeUser),
	// 						LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-04-13T19:47:24.986Z"); return t}()),
	// 					},
	// 				},
	// 			},
	// 			ServiceURL: to.Ptr("woponotsxaippkvhwmibffywnqcfru"),
	// 		},
	// 		Identity: &armhealthdataaiservices.ManagedServiceIdentity{
	// 			Type: to.Ptr(armhealthdataaiservices.ManagedServiceIdentityTypeNone),
	// 			UserAssignedIdentities: map[string]*armhealthdataaiservices.UserAssignedIdentity{
	// 			},
	// 			PrincipalID: to.Ptr("a82361f4-5320-4a26-8d1b-45832d2164dd"),
	// 			TenantID: to.Ptr("53a6a686-ae15-4a1d-badf-3e7947918893"),
	// 		},
	// 		Tags: map[string]*string{
	// 		},
	// 		Location: to.Ptr("qwyhvdwcsjulggagdqxlmazcl"),
	// 		ID: to.Ptr("/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih"),
	// 		Name: to.Ptr("nlrthrxaukih"),
	// 		Type: to.Ptr("slyfiibvwlhfdpzjynsywhbfauexk"),
	// 		SystemData: &armhealthdataaiservices.SystemData{
	// 			CreatedBy: to.Ptr("p"),
	// 			CreatedByType: to.Ptr(armhealthdataaiservices.CreatedByTypeUser),
	// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-04-13T19:47:24.985Z"); return t}()),
	// 			LastModifiedBy: to.Ptr("pmbozfvwrblbknedeb"),
	// 			LastModifiedByType: to.Ptr(armhealthdataaiservices.CreatedByTypeUser),
	// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-04-13T19:47:24.986Z"); return t}()),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { HealthDataAIServicesClient } = require("@azure/arm-healthdataaiservices");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to get a DeidService
 *
 * @summary get a DeidService
 * x-ms-original-file: 2024-09-20/DeidServices_Get_MaximumSet_Gen.json
 */
async function deidServicesGetGeneratedByMaximumSetRuleStable() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "F21BB31B-C214-42C0-ACF0-DACCA05D3011";
  const client = new HealthDataAIServicesClient(credential, subscriptionId);
  const result = await client.deidServices.get("rgopenapi", "deidTest");
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.HealthDataAIServices.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.HealthDataAIServices;

// Generated from example definition: 2024-09-20/DeidServices_Get_MaximumSet_Gen.json
// this example is just showing the usage of "DeidService_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DeidServiceResource created on azure
// for more information of creating DeidServiceResource, please refer to the document of DeidServiceResource
string subscriptionId = "F21BB31B-C214-42C0-ACF0-DACCA05D3011";
string resourceGroupName = "rgopenapi";
string deidServiceName = "deidTest";
ResourceIdentifier deidServiceResourceId = DeidServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, deidServiceName);
DeidServiceResource deidService = client.GetDeidServiceResource(deidServiceResourceId);

// invoke the operation
DeidServiceResource result = await deidService.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DeidServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "properties": {
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "Enabled",
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {
            "id": "gpnxxbbtsysdhhclm"
          },
          "privateLinkServiceConnectionState": {
            "status": "Pending",
            "actionsRequired": "ulb",
            "description": "ddxuoved"
          },
          "groupIds": [
            "xbdyjqg"
          ],
          "provisioningState": "Succeeded"
        },
        "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh",
        "name": "mdwvqjtwcjcvrh",
        "type": "bzxabjlpbwreez",
        "systemData": {
          "createdBy": "p",
          "createdByType": "User",
          "createdAt": "2024-04-13T19:47:24.985Z",
          "lastModifiedBy": "pmbozfvwrblbknedeb",
          "lastModifiedByType": "User",
          "lastModifiedAt": "2024-04-13T19:47:24.986Z"
        }
      }
    ],
    "serviceUrl": "woponotsxaippkvhwmibffywnqcfru"
  },
  "identity": {
    "type": "None",
    "userAssignedIdentities": {},
    "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd",
    "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893"
  },
  "tags": {},
  "location": "qwyhvdwcsjulggagdqxlmazcl",
  "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih",
  "name": "nlrthrxaukih",
  "type": "slyfiibvwlhfdpzjynsywhbfauexk",
  "systemData": {
    "createdBy": "p",
    "createdByType": "User",
    "createdAt": "2024-04-13T19:47:24.985Z",
    "lastModifiedBy": "pmbozfvwrblbknedeb",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-04-13T19:47:24.986Z"
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
DeidService	A HealthDataAIServicesProviderHub resource
DeidServiceProperties	Details of the HealthDataAIServices DeidService.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
PrivateEndpoint	The private endpoint resource.
PrivateEndpointConnection	The private endpoint connection resource.
PrivateEndpointConnectionProvisioningState	The current provisioning state.
PrivateEndpointServiceConnectionStatus	The private endpoint connection status.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
ProvisioningState	The status of the current operation.
PublicNetworkAccess	State of the public network access.
systemData	Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentity	User assigned identity properties

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DeidService

Object

A HealthDataAIServicesProviderHub resource

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties	DeidServiceProperties	The resource-specific properties for this resource.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

DeidServiceProperties

Object

Details of the HealthDataAIServices DeidService.

Name	Type	Description
privateEndpointConnections	PrivateEndpointConnection[]	List of private endpoint connections.
provisioningState	ProvisioningState	The status of the last operation.
publicNetworkAccess	PublicNetworkAccess	Gets or sets allow or disallow public network access to resource
serviceUrl	string	Deid service url.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ManagedServiceIdentity

Object

Managed service identity (system assigned and/or user assigned identities)

Name	Type	Description
principalId	string (uuid)	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string (uuid)	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type	ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities	<string,  UserAssignedIdentity>	User-Assigned Identities 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.

ManagedServiceIdentityType

Enumeration

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Value	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

PrivateEndpoint

Object

The private endpoint resource.

Name	Type	Description
id	string	The ARM identifier for private endpoint.

PrivateEndpointConnection

Object

The private endpoint connection resource.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.groupIds	string[]	The group ids for the private endpoint resource.
properties.privateEndpoint	PrivateEndpoint	The private endpoint resource.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	The provisioning state of the private endpoint connection resource.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Enumeration

The current provisioning state.

Value	Description
Succeeded
Creating
Deleting
Failed

PrivateEndpointServiceConnectionStatus

Enumeration

The private endpoint connection status.

Value	Description
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Object

A collection of information about the state of the connection between service consumer and provider.

Name	Type	Description
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	PrivateEndpointServiceConnectionStatus	Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

ProvisioningState

Enumeration

The status of the current operation.

Value	Description
Succeeded	Resource has been created.
Failed	Resource creation failed.
Canceled	Resource creation was canceled.
Provisioning	The resource is being provisioned.
Updating	The resource is being updated.
Deleting	The resource is being deleted.
Accepted	The resource provisioning request has been accepted.

PublicNetworkAccess

Enumeration

State of the public network access.

Value	Description
Enabled	The public network access is enabled
Disabled	The public network access is disabled

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UserAssignedIdentity

Object

User assigned identity properties

Name	Type	Description
clientId	string (uuid)	The client ID of the assigned identity.
principalId	string (uuid)	The principal ID of the assigned identity.