ReceivedSharesClient.GetReceivedShare(String, RequestContext) メソッド

定義

名前空間:

Azure.Analytics.Purview.Share

アセンブリ:

Azure.Analytics.Purview.Share.dll

パッケージ:

Azure.Analytics.Purview.Share v1.0.3-beta.20

Source:

ReceivedSharesClient.cs

受信した共有を名前で取得します。

public virtual Azure.Response GetReceivedShare (string receivedShareName, Azure.RequestContext context = default);

abstract member GetReceivedShare : string * Azure.RequestContext -> Azure.Response
override this.GetReceivedShare : string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetReceivedShare (receivedShareName As String, Optional context As RequestContext = Nothing) As Response

パラメーター

receivedShareName

String

受信した共有の名前。

context

RequestContext

要求コンテキスト。これは、クライアント パイプラインの既定の動作を呼び出しごとにオーバーライドできます。

戻り値

Response

サービスから返された応答。 応答本文スキーマの詳細については、以下の「解説」セクションを参照してください。

例外

ArgumentNullException

receivedShareName が null です。

ArgumentException

receivedShareName は空の文字列であり、空でないと予想されていました。

RequestFailedException

サービスから成功以外の状態コードが返されました。

例

このサンプルでは、必要なパラメーターを指定して GetReceivedShare を呼び出し、結果を解析する方法を示します。

var credential = new DefaultAzureCredential();
var client = new ReceivedSharesClient("<https://my-service.azure.com>", credential);

Response response = client.GetReceivedShare("<receivedShareName>");

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("type").ToString());
Console.WriteLine(result.GetProperty("shareKind").ToString());

注釈

受信した共有を取得する

応答ペイロードの JSON スキーマを次に示します。

応答本文:

InPlaceReceivedShare

の InPlaceReceivedShareスキーマ:

{
              shareKind: InPlace, # Required. Defines the supported types for share.
              id: string, # Optional. The resource id of the resource.
              name: string, # Optional. Name of the resource.
              type: string, # Optional. Type of the resource.
              properties: {
                collection: {
                  referenceName: string, # Required. Gets or sets the reference name.
                  type: string, # Required. Gets or sets the reference type property.
                }, # Required. Reference to a Collection.
                createdAt: string (ISO 8601 Format), # Optional. Time at which the received share was created.
                expirationDate: string (ISO 8601 Format), # Optional. The expiration date of the received share.
                invitationId: string, # Required. The invitation id.
                provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource
                receivedShareStatus: "Active" | "Reinstating" | "Revoked" | "Revoking" | "RevokeFailed" | "ReinstateFailed" | "SourceDeleted", # Optional. received share status
                receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation
                receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation
                receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation
                senderEmail: string, # Optional. Email of the sender who created the sent share invitation
                senderName: string, # Optional. Name of the sender who created the sent share invitation
                senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation
                sentShareDescription: string, # Optional. Share description.
                sentShareLocation: string, # Required. Sent share location.
                sharedAt: string (ISO 8601 Format), # Optional. Time at which the sent share was shared.
                shareName: string, # Optional. Name of the share
              }, # Required. Properties of in place received share.
            }