Get-AzStorageShare

  • リファレンス
モジュール:
Az.Storage

ファイル共有の一覧を取得します。

構文

Get-AzStorageShare
   [[-Prefix] <String>]
   [-IncludeDeleted]
   [-Context <IStorageContext>]
   [-ServerTimeoutPerRequest <Int32>]
   [-ClientTimeoutPerRequest <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-ConcurrentTaskCount <Int32>]
   [<CommonParameters>]
Get-AzStorageShare
   [-Name] <String>
   [[-SnapshotTime] <DateTimeOffset>]
   [-SkipGetProperty]
   [-Context <IStorageContext>]
   [-ServerTimeoutPerRequest <Int32>]
   [-ClientTimeoutPerRequest <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-ConcurrentTaskCount <Int32>]
   [<CommonParameters>]

説明

Get-AzStorageShare コマンドレットは、ストレージ アカウントのファイル共有の一覧を取得します。

例

例 1: ファイル共有を取得する

Get-AzStorageShare -Name "ContosoShare06"

このコマンドは、ContosoShare06 という名前のファイル共有を取得します。

例 2: 文字列で始まるすべてのファイル共有を取得する

Get-AzStorageShare -Prefix "Contoso"

このコマンドは、Contoso で始まる名前を持つすべてのファイル共有を取得します。

例 3: 指定したコンテキスト内のすべてのファイル共有を取得する

$Context = New-AzStorageContext -Local
Get-AzStorageShare -Context $Context

最初のコマンドでは、New-AzStorageContext コマンドレットを使用して Local パラメーターを使用してコンテキストを作成し、そのコンテキスト オブジェクトを$Context変数に格納します。 2 番目のコマンドは、$Contextに格納されているコンテキスト オブジェクトのファイル共有を取得します。

例 4: 特定の共有名と SnapshotTime を持つファイル共有スナップショットを取得する

Get-AzStorageShare -Name "ContosoShare06" -SnapshotTime "6/16/2017 9:48:41 AM +00:00"

このコマンドは、特定の共有名と SnapshotTime を持つファイル共有スナップショットを取得します。

例 5: OAuth 認証を使用して、共有プロパティをフェッチせずにファイル共有オブジェクトを取得する。

New-AzStorageContext -StorageAccountName "myaccountname" -UseConnectedAccount -EnableFileBackupRequestIntent
$share = Get-AzStorageShare -Name "ContosoShare06" -SkipGetProperty -Context $ctx

このコマンドは、OAuth 認証で共有プロパティを取得せずに、ファイル共有スナップショットを取得します。 API が OAuth をサポートしていないため、OAuth 認証を使用した共有プロパティの取得は失敗します。 そのため、OAuth 認証で共有オブジェクトを取得するには、フェッチ共有プロパティをスキップする必要があります。

パラメーター

-ClientTimeoutPerRequest

1 つのサービス要求に対するクライアント側のタイムアウト間隔を秒単位で指定します。 指定した間隔で前の呼び出しが失敗した場合、このコマンドレットは要求を再試行します。 間隔が経過する前にこのコマンドレットが正常な応答を受け取らない場合、このコマンドレットはエラーを返します。

Type:Nullable<T>[Int32]
Aliases:ClientTimeoutPerRequestInSeconds
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConcurrentTaskCount

同時ネットワーク呼び出しの最大数を指定します。 このパラメーターを使用すると、同時ネットワーク呼び出しの最大数を指定することで、ローカル CPU と帯域幅の使用量を調整するコンカレンシーを制限できます。 指定した値は絶対カウントであり、コア数には乗算されません。 このパラメーターは、1 秒あたり 100 キロビットなどの低帯域幅環境でのネットワーク接続の問題を減らすのに役立ちます。 既定値は 10 です。

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Context

Azure Storage コンテキストを指定します。 コンテキストを取得するには、New-AzStorageContext コマンドレットを使用します。

Type:IStorageContext
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IncludeDeleted

削除された共有を含める。既定では、共有の取得には削除された共有は含まれません

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

ファイル共有の名前を指定します。 このコマンドレットは、このパラメーターが指定するファイル共有を取得します。存在しないファイル共有の名前を指定した場合は何も取得しません。

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Prefix

ファイル共有のプレフィックスを指定します。 このコマンドレットは、このパラメーターが指定したプレフィックスと一致するファイル共有を取得します。指定したプレフィックスと一致するファイル共有がない場合はファイル共有を取得します。

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ServerTimeoutPerRequest

要求のサーバー部分のタイムアウト期間の長さを指定します。

Type:Nullable<T>[Int32]
Aliases:ServerTimeoutPerRequestInSeconds
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SkipGetProperty

サーバーから共有プロパティを取得せずにローカル共有オブジェクトのみを生成するには、このパラメーターを指定します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SnapshotTime

受信するファイル共有の SnapshotTime スナップショット。

Type:Nullable<T>[DateTimeOffset]
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

IStorageContext

出力

AzureStorageFileShare