Consumer Invitations - List Invitations

リファレンス

Service:: Data Share

API Version:: 2021-08-01

招待を一覧表示する
招待をListsする

GET https://management.azure.com/providers/Microsoft.DataShare/listInvitations?api-version=2021-08-01

With optional parameters:

GET https://management.azure.com/providers/Microsoft.DataShare/listInvitations?api-version=2021-08-01&$skipToken={$skipToken}

URI パラメーター

名前	/	必須	型	説明
api-version	query	True	string	使用する API バージョン。
$skipToken	query		string	継続トークン

応答

名前	型	説明
200 OK	ConsumerInvitationList	Success
Other Status Codes	DataShareError	Microsoft.DataShare リソースプロバイダーから受信したエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

ConsumerInvitations_ListInvitations

GET https://management.azure.com/providers/Microsoft.DataShare/listInvitations?api-version=2021-08-01

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DataShare;

// Generated from example definition: specification/datashare/resource-manager/Microsoft.DataShare/stable/2021-08-01/examples/ConsumerInvitations_ListInvitations.json
// this example is just showing the usage of "ConsumerInvitations_ListInvitations" 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 TenantResource created on azure
// for more information of creating TenantResource, please refer to the document of TenantResource
var tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// get the collection of this DataShareConsumerInvitationResource
DataShareConsumerInvitationCollection collection = tenantResource.GetDataShareConsumerInvitations();

// invoke the operation and iterate over the result
await foreach (DataShareConsumerInvitationResource item in collection.GetAllAsync())
{
    // the variable item 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
    DataShareConsumerInvitationData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

Date: Wed, 13 Sep 2017 17:33:55 GMT
x-ms-request-id: 8e58266a-de42-40d5-b3c4-c6a7e159cfba
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14993
x-ms-correlation-request-id: 5d862c55-4de9-4a46-969d-cf1ed3e235ed

Response Body

{
  "value": [
    {
      "properties": {
        "location": "eastus2",
        "invitationId": "4256e2cf-0f82-4865-961b-12f83333f487",
        "providerName": "John Smith",
        "providerEmail": "john.smith@microsoft.com",
        "sentAt": "2019-01-15T01:45:25.6226946Z",
        "respondedAt": "2019-01-15T02:01:51.8953054Z",
        "invitationStatus": "Accepted",
        "description": "Some share",
        "termsOfUse": "Confidential",
        "dataSetCount": 1,
        "providerTenantName": "microsoft",
        "shareName": "share1",
        "expirationDate": "2020-08-26T22:33:24.5785265Z"
      },
      "id": "providers/Microsoft.DataShare/locations/eastus2/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487",
      "name": "invitation1",
      "type": "Microsoft.DataShare/locations/consumerInvitations"
    }
  ]
}

定義

名前	説明
ConsumerInvitation	コンシューマー招待データ転送オブジェクト。
ConsumerInvitationList	get InvitationList の応答を一覧表示する
createdByType	リソースを作成した ID の種類。
DataShareError	データ共有エラーモデル。
DataShareErrorInfo	データ共有エラー本文モデル。
invitationStatus	招待の状態。
lastModifiedByType	リソースを最後に変更した ID の種類。
SystemData	リソースの作成と最後の変更に関連するメタデータ。

ConsumerInvitation

コンシューマー招待データ転送オブジェクト。

名前	型	説明
id	string	Azure リソースのリソース ID
name	string	Azure リソースの名前
properties.dataSetCount	integer	共有内のデータセットの数
properties.description	string	招待の作成時に共有された説明
properties.expirationDate	string	招待を承諾して作成された共有サブスクリプションの有効期限。
properties.invitationId	string	招待の一意の ID。
properties.invitationStatus	invitationStatus	招待の状態。
properties.location	string	招待の場所
properties.providerEmail	string	リソースを作成したプロバイダーのEmail
properties.providerName	string	リソースを作成したプロバイダーの名前
properties.providerTenantName	string	リソースを作成したプロバイダーのテナント名
properties.respondedAt	string	受信者が招待に応答した時刻。
properties.sentAt	string	招待状が送信された時刻を取得します。
properties.shareName	string	ソース共有名を取得します。
properties.termsOfUse	string	招待の作成時に共有される利用規約
properties.userEmail	string	リソースを作成したユーザーのEmail
properties.userName	string	リソースを作成したユーザーの名前
systemData	SystemData	Azure リソースのシステムデータ。
type	string	Azure リソースの種類

ConsumerInvitationList

get InvitationList の応答を一覧表示する

名前	型	説明
nextLink	string	次の結果ページの URL。
value	ConsumerInvitation[]	DataTransferObjects 型の項目のコレクション。

createdByType

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

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

DataShareError

データ共有エラーモデル。

名前	型	説明
error	DataShareErrorInfo	データ共有エラー本文

DataShareErrorInfo

データ共有エラー本文モデル。

名前	型	説明
code	string	エラーのコード
details	DataShareErrorInfo[]	エラーモデルの入れ子になった詳細
message	string	エラーのメッセージ
target	string	エラーのターゲット

invitationStatus

招待の状態。

名前	型	説明
Accepted	string
Pending	string
Rejected	string
Withdrawn	string

lastModifiedByType

リソースを最後に変更した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

SystemData

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

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