Dicom Services - Get

Referencia

Szolgáltatás:: Healthcare Apis

API-verzió:: 2022-06-01

Lekéri a megadott DICOM-szolgáltatás tulajdonságait.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/dicomservices/{dicomServiceName}?api-version=2022-06-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
dicomServiceName	path	True	string minLength: 3 maxLength: 24	A DICOM-szolgáltatás erőforrásának neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	A szolgáltatáspéldányt tartalmazó erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés azonosítója.
workspaceName	path	True	string minLength: 3 maxLength: 24	A munkaterület-erőforrás neve.
api-version	query	True	string	Ügyfél API-verziója.

Válaszok

Name	Típus	Description
200 OK	DicomService	A kérés sikeres volt; a kérelem megfelelően alakult és megfelelően érkezett.
Other Status Codes	ErrorDetails	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Get a dicomservice

Mintakérelem

GET https://management.azure.com/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/dicomservices/blue?api-version=2022-06-01

from azure.identity import DefaultAzureCredential
from azure.mgmt.healthcareapis import HealthcareApisManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-healthcareapis
# USAGE
    python dicom_services_get.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 = HealthcareApisManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.dicom_services.get(
        resource_group_name="testRG",
        workspace_name="workspace1",
        dicom_service_name="blue",
    )
    print(response)


# x-ms-original-file: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2022-06-01/examples/dicomservices/DicomServices_Get.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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.HealthcareApis;
using Azure.ResourceManager.HealthcareApis.Models;

// Generated from example definition: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2022-06-01/examples/dicomservices/DicomServices_Get.json
// this example is just showing the usage of "DicomServices_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 DicomServiceResource created on azure
// for more information of creating DicomServiceResource, please refer to the document of DicomServiceResource
string subscriptionId = "subid";
string resourceGroupName = "testRG";
string workspaceName = "workspace1";
string dicomServiceName = "blue";
ResourceIdentifier dicomServiceResourceId = DicomServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName, dicomServiceName);
DicomServiceResource dicomService = client.GetDicomServiceResource(dicomServiceResourceId);

// invoke the operation
DicomServiceResource result = await dicomService.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
DicomServiceData 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

Mintaválasz

Állapotkód:: 200

{
  "name": "blue",
  "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/dicomservices/blue",
  "type": "Microsoft.HealthcareApis/workspaces/dicomservices",
  "properties": {
    "authenticationConfiguration": {
      "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc",
      "audiences": [
        "https://azurehealthcareapis.com/",
        "https://azurehealthcareapis.com"
      ]
    },
    "corsConfiguration": {
      "origins": [
        "*"
      ],
      "headers": [
        "*"
      ],
      "methods": [
        "DELETE",
        "GET",
        "OPTIONS",
        "PATCH",
        "POST",
        "PUT"
      ],
      "maxAge": 1440,
      "allowCredentials": false
    },
    "provisioningState": "Succeeded",
    "serviceUrl": "https://workspace1-blue.dicom.azurehealthcareapis.com"
  }
}

Definíciók

Name	Description
CorsConfiguration	A szolgáltatáspéldány CORS-konfigurációjának beállításai.
createdByType	Az erőforrást létrehozó identitás típusa.
DicomService	A Dicom Szolgáltatás leírása
DicomServiceAuthenticationConfiguration	Hitelesítési konfigurációs információk
ErrorDetails	Hiba részletei.
ErrorDetailsInternal	Hiba részletei.
Identity	Beállítás, amely azt jelzi, hogy a szolgáltatáshoz van-e hozzárendelve felügyelt identitás.
PrivateEndpoint	A privát végpont erőforrása.
PrivateEndpointConnection	A privát végpont kapcsolati erőforrása.
PrivateEndpointConnectionProvisioningState	Az aktuális kiépítési állapot.
PrivateEndpointServiceConnectionStatus	A privát végpont kapcsolatának állapota.
PrivateLinkServiceConnectionState	A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.
provisioningState	A kiépítési állapot.
PublicNetworkAccess	A nyilvános hálózatokról érkező adatsík-forgalom vezérlése, miközben a privát végpont engedélyezve van.
ServiceManagedIdentityType	A megadott identitás típusa, jelenleg a SystemAssigned és a None érték engedélyezett.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
UserAssignedIdentity	Felhasználó által hozzárendelt identitástulajdonságok

CorsConfiguration

Objektum

A szolgáltatáspéldány CORS-konfigurációjának beállításai.

Name	Típus	Description
allowCredentials	boolean	Ha a hitelesítő adatok a CORS-on keresztül engedélyezettek.
headers	string[]	A CORS-on keresztül engedélyezendő fejlécek.
maxAge	integer (int32) minimum: 0 maximum: 99999	A CORS-on keresztül engedélyezett maximális életkor.
methods	string[]	A CORS-on keresztül engedélyezendő módszerek.
origins	string[] pattern: ^(?:(?:(?:[hH][tT][tT][pP](?:[sS]\|))\:\/\/(?:[a-zA-Z0-9-]+[.]?)+(?:\:[0-9]{1,5})?\|[*]))$	A CORS-on keresztül engedélyezendő források.

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

DicomService

Objektum

A Dicom Szolgáltatás leírása

Name	Típus	Description
etag	string	Az erőforráshoz társított etag, amely az optimista egyidejűséghez használható szerkesztéskor.
id	string	Az erőforrás azonosítója.
identity	Identity	Beállítás, amely azt jelzi, hogy a szolgáltatáshoz van-e hozzárendelve felügyelt identitás.
location	string	Az erőforrás helye.
name	string pattern: ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$	Az erőforrás neve.
properties.authenticationConfiguration	DicomServiceAuthenticationConfiguration	A Dicom Szolgáltatás hitelesítési konfigurációja.
properties.corsConfiguration	CorsConfiguration	A Dicom Service Cors konfigurációja.
properties.privateEndpointConnections	PrivateEndpointConnection[]	Az erőforráshoz beállított privát végpontkapcsolatok listája.
properties.provisioningState	provisioningState	A kiépítési állapot.
properties.publicNetworkAccess	PublicNetworkAccess	A nyilvános hálózatokról érkező adatsík-forgalom vezérlése, miközben a privát végpont engedélyezve van.
properties.serviceUrl	string	A Dicom Services URL-címe.
systemData	systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
tags	object	Erőforráscímkék.
type	string	Az erőforrás típusa.

DicomServiceAuthenticationConfiguration

Objektum

Hitelesítési konfigurációs információk

Name	Típus	Description
audiences	string[]	A szolgáltatás célközönségei
authority	string	A szolgáltatás szolgáltatói URL-címe

ErrorDetails

Objektum

Hiba részletei.

Name	Típus	Description
error	ErrorDetailsInternal	Hiba részletei

ErrorDetailsInternal

Objektum

Hiba részletei.

Name	Típus	Description
code	string	A hibakód.
message	string	A hibaüzenet.
target	string	Az adott hiba célja.

Identity

Objektum

Beállítás, amely azt jelzi, hogy a szolgáltatáshoz van-e hozzárendelve felügyelt identitás.

Name	Típus	Description
principalId	string (uuid)	A rendszer által hozzárendelt identitás szolgáltatásnév-azonosítója. Ez a tulajdonság csak a rendszer által hozzárendelt identitáshoz lesz megadva.
tenantId	string (uuid)	A rendszer által hozzárendelt identitás bérlőazonosítója. Ez a tulajdonság csak a rendszer által hozzárendelt identitáshoz lesz megadva.
type	ServiceManagedIdentityType	A megadott identitás típusa, jelenleg a SystemAssigned és a None érték engedélyezett.
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned identitások Az erőforráshoz társított felhasználó által hozzárendelt identitások készlete. A userAssignedIdentities szótárkulcsok arm-erőforrásazonosítók lesznek a következő formában: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. A szótár értékei lehetnek üres objektumok ({}) a kérelmekben.

PrivateEndpoint

Objektum

A privát végpont erőforrása.

Name	Típus	Description
id	string	A privát végpont ARM-azonosítója

PrivateEndpointConnection

Objektum

A privát végpont kapcsolati erőforrása.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.privateEndpoint	PrivateEndpoint	A privát végpont erőforrása.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	A privát végpont kapcsolati erőforrásának kiépítési állapota.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Enumerálás

Az aktuális kiépítési állapot.

Érték	Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Enumerálás

A privát végpont kapcsolatának állapota.

Érték	Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Objektum

A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.

Name	Típus	Description
actionsRequired	string	Üzenet, amely jelzi, hogy a szolgáltató módosításaihoz szükség van-e a fogyasztó frissítésére.
description	string	A kapcsolat jóváhagyásának/elutasításának oka.
status	PrivateEndpointServiceConnectionStatus	Azt jelzi, hogy a szolgáltatás tulajdonosa jóváhagyta/elutasította/eltávolította-e a kapcsolatot.

provisioningState

Enumerálás

A kiépítési állapot.

Érték	Description
Accepted
Canceled
Creating
Deleting
Deprovisioned
Failed
Moving
Succeeded
Suspended
SystemMaintenance
Updating
Verifying
Warned

PublicNetworkAccess

Enumerálás

A nyilvános hálózatokról érkező adatsík-forgalom vezérlése, miközben a privát végpont engedélyezve van.

Érték	Description
Disabled
Enabled

ServiceManagedIdentityType

Enumerálás

A megadott identitás típusa, jelenleg a SystemAssigned és a None érték engedélyezett.

Érték	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

UserAssignedIdentity

Objektum

Felhasználó által hozzárendelt identitástulajdonságok

Name	Típus	Description
clientId	string (uuid)	A hozzárendelt identitás ügyfélazonosítója.
principalId	string (uuid)	A hozzárendelt identitás egyszerű azonosítója.

Megosztás a következőn keresztül:

Dicom Services - Get

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

Get a dicomservice

Mintakérelem

Mintaválasz

Definíciók

CorsConfiguration

createdByType

DicomService

DicomServiceAuthenticationConfiguration

ErrorDetails

ErrorDetailsInternal

Identity

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

provisioningState

PublicNetworkAccess

ServiceManagedIdentityType

systemData

UserAssignedIdentity