Unregister-AzStorageSyncServer

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

警告: サーバーの登録を解除すると、このサーバー上のすべてのサーバー エンドポイントが連鎖的に削除されます。 このコマンドは、サーバーのストレージ同期サービスからサーバーの登録を解除します。

構文

Unregister-AzStorageSyncServer
          [-ResourceGroupName] <String>
          [-StorageSyncServiceName] <String>
          [-ServerId] <Guid>
          [-Force]
          [-PassThru]
          [-AsJob]
          [-DefaultProfile <IAzureContextContainer>]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]
Unregister-AzStorageSyncServer
          [-InputObject] <PSRegisteredServer>
          [-Force]
          [-PassThru]
          [-AsJob]
          [-DefaultProfile <IAzureContextContainer>]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]
Unregister-AzStorageSyncServer
          [-ResourceId] <String>
          [-Force]
          [-PassThru]
          [-AsJob]
          [-DefaultProfile <IAzureContextContainer>]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]

説明

このコマンドは、ストレージ同期サービスからサーバーの登録を解除します。 警告: サーバーの登録を解除すると、このサーバー上のすべてのサーバー エンドポイントが連鎖的に削除されます。 このサーバー上のパスが同期されなくなったことが確実な場合にのみ呼び出す必要があります。

例

例 1

$RegisteredServer = Get-AzStorageSyncServer -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName"
Unregister-AzStorageSyncServer -Force -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" -ServerId $RegisteredServer.ServerId

このコマンドを実行すると、サーバーの登録が解除され、このサーバー上のすべてのサーバー エンドポイントが連鎖的に削除されます。

パラメーター

-AsJob

バックグラウンドでコマンドレットを実行する

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

-Confirm

コマンドレットの実行前に確認メッセージを表示します。

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

-DefaultProfile

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

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

-Force

このコマンドの確認をスキップするには、-Force を指定します。

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

-InputObject

RegisteredServer Input オブジェクト。通常はパイプラインを介して渡されます。

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

-PassThru

通常の実行では、このコマンドレットは成功しても値を返しません。 PassThru パラメーターを指定すると、コマンドレットは正常に実行された後にパイプラインに値を書き込みます。

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

-ResourceGroupName

リソース グループ名。

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

-ResourceId

RegisteredServer リソース ID

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

-ServerId

RegisteredServer の名前。

Type:Guid
Aliases:RegisteredServerName
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-StorageSyncServiceName

StorageSyncService の名前。

Type:String
Aliases:ParentName
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

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

入力

PSRegisteredServer

String

SwitchParameter

出力

Object