Workspaces - Get

サービス:

Desktop Virtualization

API バージョン:

2024-04-03

ワークスペースを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}?api-version=2024-04-03

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前では大文字と小文字が区別されません。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
workspaceName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	ワークスペースの名前
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	Workspace	ワークスペースが正常に取得されました。
Other Status Codes	CloudError	操作が失敗した理由を説明するオートメーション エラー応答。

例

Workspace_Get

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1?api-version=2024-04-03

Java

/**
 * Samples for Workspaces GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/
     * Workspace_Get.json
     */
    /**
     * Sample code: Workspace_Get.
     * 
     * @param manager Entry point to DesktopVirtualizationManager.
     */
    public static void
        workspaceGet(com.azure.resourcemanager.desktopvirtualization.DesktopVirtualizationManager manager) {
        manager.workspaces().getByResourceGroupWithResponse("resourceGroup1", "workspace1",
            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.desktopvirtualization import DesktopVirtualizationMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-desktopvirtualization
# USAGE
    python workspace_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 = DesktopVirtualizationMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="daefabc0-95b4-48b3-b645-8a753a63c4fa",
    )

    response = client.workspaces.get(
        resource_group_name="resourceGroup1",
        workspace_name="workspace1",
    )
    print(response)


# x-ms-original-file: specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/Workspace_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

Go

package armdesktopvirtualization_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/desktopvirtualization/armdesktopvirtualization/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4883fa5dbf6f2c9093fac8ce334547e9dfac68fa/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/Workspace_Get.json
func ExampleWorkspacesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdesktopvirtualization.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWorkspacesClient().Get(ctx, "resourceGroup1", "workspace1", 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.Workspace = armdesktopvirtualization.Workspace{
	// 	Name: to.Ptr("workspace1"),
	// 	Type: to.Ptr("Microsoft.DesktopVirtualization/workspaces"),
	// 	ID: to.Ptr("/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1"),
	// 	SystemData: &armdesktopvirtualization.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
	// 		CreatedBy: to.Ptr("user1"),
	// 		CreatedByType: to.Ptr(armdesktopvirtualization.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("user2"),
	// 		LastModifiedByType: to.Ptr(armdesktopvirtualization.CreatedByTypeUser),
	// 	},
	// 	Location: to.Ptr("centralus"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 		"key2": to.Ptr("value2"),
	// 	},
	// 	Properties: &armdesktopvirtualization.WorkspaceProperties{
	// 		Description: to.Ptr("des1"),
	// 		CloudPcResource: to.Ptr(false),
	// 		FriendlyName: to.Ptr("friendly"),
	// 		ObjectID: to.Ptr("7877fb31-4bde-49fd-9df3-c046e0ec5325"),
	// 	},
	// }
}

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 { DesktopVirtualizationAPIClient } = require("@azure/arm-desktopvirtualization");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get a workspace.
 *
 * @summary Get a workspace.
 * x-ms-original-file: specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/Workspace_Get.json
 */
async function workspaceGet() {
  const subscriptionId =
    process.env["DESKTOPVIRTUALIZATION_SUBSCRIPTION_ID"] || "daefabc0-95b4-48b3-b645-8a753a63c4fa";
  const resourceGroupName = process.env["DESKTOPVIRTUALIZATION_RESOURCE_GROUP"] || "resourceGroup1";
  const workspaceName = "workspace1";
  const credential = new DefaultAzureCredential();
  const client = new DesktopVirtualizationAPIClient(credential, subscriptionId);
  const result = await client.workspaces.get(resourceGroupName, workspaceName);
  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.DesktopVirtualization.Models;
using Azure.ResourceManager.DesktopVirtualization;

// Generated from example definition: specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/Workspace_Get.json
// this example is just showing the usage of "Workspaces_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 VirtualWorkspaceResource created on azure
// for more information of creating VirtualWorkspaceResource, please refer to the document of VirtualWorkspaceResource
string subscriptionId = "daefabc0-95b4-48b3-b645-8a753a63c4fa";
string resourceGroupName = "resourceGroup1";
string workspaceName = "workspace1";
ResourceIdentifier virtualWorkspaceResourceId = VirtualWorkspaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName);
VirtualWorkspaceResource virtualWorkspace = client.GetVirtualWorkspaceResource(virtualWorkspaceResourceId);

// invoke the operation
VirtualWorkspaceResource result = await virtualWorkspace.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
VirtualWorkspaceData 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

応答のサンプル

状態コード:

200

{
  "name": "workspace1",
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1",
  "type": "Microsoft.DesktopVirtualization/workspaces",
  "location": "centralus",
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325",
    "description": "des1",
    "friendlyName": "friendly",
    "cloudPcResource": false
  }
}

定義

名前	説明
CloudError	クラウド エラー オブジェクト。
CloudErrorProperties	クラウド エラー オブジェクトのプロパティ。
createdByType	リソースを作成した ID の種類。
Identity
Plan
PrivateEndpoint	プライベート エンドポイント リソース。
PrivateEndpointConnection	プライベート エンドポイント接続リソース。
PrivateEndpointConnectionProvisioningState	現在のプロビジョニング状態。
PrivateEndpointServiceConnectionStatus	プライベート エンドポイント接続の状態。
PrivateLinkServiceConnectionState	サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
PublicNetworkAccess	有効にすると、パブリック ネットワークとプライベート ネットワークの両方からこのリソースにアクセスできます。無効にすると、このリソースはプライベート エンドポイント経由でのみアクセスできます
ResourceIdentityType	ID の種類。
Sku
SkuTier	このフィールドは、サービスに複数のレベルがあるが PUT では必要ない場合に、リソース プロバイダーによって実装される必要があります。
systemData	リソースの作成と最後の変更に関連するメタデータ。
Workspace	ワークスペース定義を表します。

CloudError

Object

クラウド エラー オブジェクト。

名前	型	説明
error	CloudErrorProperties	クラウド エラー オブジェクトのプロパティ。

CloudErrorProperties

Object

クラウド エラー オブジェクトのプロパティ。

名前	型	説明
code	string	エラー コード
message	string	操作が失敗した理由を示すエラー メッセージ。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

Identity

Object

名前	型	説明
principalId	string (uuid)	リソース ID のプリンシパル ID。 値は UUID である必要があります。
tenantId	string (uuid)	リソースのテナント ID。 値は UUID である必要があります。
type	ResourceIdentityType	ID の種類。

Plan

Object

名前	型	説明
name	string	調達中のサード パーティ成果物のユーザー定義名。
product	string	調達中のサード パーティの成果物。 例: NewRelic。 製品は、Data Market のオンボード時に成果物に指定された OfferID にマップされます。
promotionCode	string	パブリッシャーは、その製品/成果物に対して Data Market でプロビジョニングされたプロモーション コードを提供しました。
publisher	string	購入中のサード パーティ成果物の発行元。 例: NewRelic
version	string	目的の製品/成果物のバージョン。

PrivateEndpoint

Object

プライベート エンドポイント リソース。

名前	型	説明
id	string	プライベート エンドポイントの ARM 識別子。

PrivateEndpointConnection

Object

プライベート エンドポイント接続リソース。

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.groupIds	string[]	プライベート エンドポイント リソースのグループ ID。
properties.privateEndpoint	PrivateEndpoint	プライベート エンドポイント リソース。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	プライベート エンドポイント接続リソースのプロビジョニング状態。
systemData	systemData	createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

列挙

現在のプロビジョニング状態。

値	説明
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

列挙

プライベート エンドポイント接続の状態。

値	説明
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。

名前	型	説明
actionsRequired	string	サービス プロバイダーの変更にコンシューマーの更新が必要かどうかを示すメッセージ。
description	string	接続の承認/拒否の理由。
status	PrivateEndpointServiceConnectionStatus	接続がサービスの所有者によって承認/拒否/削除されたかどうかを示します。

PublicNetworkAccess

列挙

有効にすると、パブリック ネットワークとプライベート ネットワークの両方からこのリソースにアクセスできます。無効にすると、このリソースはプライベート エンドポイント経由でのみアクセスできます

値	説明
Disabled
Enabled

ResourceIdentityType

列挙

ID の種類。

値	説明
SystemAssigned

Sku

Object

名前	型	説明
capacity	integer (int32)	SKU でスケールアウト/インがサポートされている場合は、容量の整数を含める必要があります。 リソースに対してスケールアウト/インができない場合は、これを省略できます。
family	string	同じ SKU に対して、サービスの世代が異なるハードウェアがある場合は、ここでキャプチャできます。
name	string	SKU の名前。 例: P3。 通常は文字 + 数字のコードです
size	string	SKU サイズ。 名前フィールドが層と他の値の組み合わせである場合、これはスタンドアロン コードになります。
tier	SkuTier	このフィールドは、サービスに複数のレベルがあるが PUT では必要ない場合に、リソース プロバイダーによって実装される必要があります。

SkuTier

列挙

このフィールドは、サービスに複数のレベルがあるが PUT では必要ない場合に、リソース プロバイダーによって実装される必要があります。

値	説明
Basic
Free
Premium
Standard

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

Workspace

Object

ワークスペース定義を表します。

名前	型	説明
etag	string	etag フィールドは 必要ありません。 応答本文で指定する場合は、通常の etag 規則に従ってヘッダーとしても指定する必要があります。 エンティティ タグは、同じ要求されたリソースから 2 つ以上のエンティティを比較するために使用されます。 HTTP/1.1 では、etag (セクション 14.19)、If-Match (セクション 14.24)、If-None-Match (セクション 14.26)、および If-Range (セクション 14.27) ヘッダー フィールドのエンティティ タグを使用します。
id	string (arm-id)	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	Identity
kind	string pattern: ^[-\w\._,\(\)]+$	同じ種類のリソースに対して異なる UX エクスペリエンスをレンダリングするためにポータルやツールなどで使用されるメタデータ。 たとえば、ApiApps は一種の Microsoft.Web/sites 型です。 サポートされている場合、リソース プロバイダーはこの値を検証して保持する必要があります。
location	string	リソースが存在する地理的な場所
managedBy	string	このリソースを管理するリソースの完全修飾リソース ID。 このリソースが別の Azure リソースによって管理されているかどうかを示します。 これが存在する場合、完全モードのデプロイでは、別のリソースによって管理されているため、テンプレートから削除された場合、リソースは削除されません。
name	string	リソースの名前
plan	Plan
properties.applicationGroupReferences	string[]	applicationGroup リソース ID の一覧。
properties.cloudPcResource	boolean	クラウド PC リソースです。
properties.description	string	ワークスペースの説明。
properties.friendlyName	string	ワークスペースのフレンドリ名。
properties.objectId	string	ワークスペースの ObjectId。 (内部使用)
properties.privateEndpointConnections	PrivateEndpointConnection[]	指定したリソースに関連付けられているプライベート エンドポイント接続の一覧
properties.publicNetworkAccess	PublicNetworkAccess	有効にすると、パブリック ネットワークとプライベート ネットワークの両方からこのリソースにアクセスできます。無効にすると、このリソースはプライベート エンドポイント経由でのみアクセスできます
sku	Sku
systemData	systemData	リソースの作成と最後の変更に関連するメタデータ。
tags	object	リソース タグ。
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"