BatchAccountOperations クラス
警告
このクラスを直接インスタンス化しないでください。
代わりに、次の操作にアクセスする必要があります。
<xref:batch_account> 属性を使用する。
- 継承
-
builtins.objectBatchAccountOperations
コンストラクター
BatchAccountOperations(*args, **kwargs)メソッド
| begin_create |
指定したパラメーターを使用して、新しい Batch アカウントを作成します。 この API では既存のアカウントを更新できないため、代わりに Update Batch Account API で更新する必要があります。 |
| begin_delete |
指定した Batch アカウントを削除します。 |
| get |
指定した Batch アカウントに関する情報を取得します。 |
| get_detector |
特定の Batch アカウントの特定の検出機能に関する情報を取得します。 |
| get_keys |
指定した Batch アカウントのアカウント キーを取得します。 この操作は、'SharedKey' を含む allowedAuthenticationModes を持つ Batch アカウントにのみ適用されます。 Batch アカウントに allowedAuthenticationMode に 'SharedKey' が含まれていない場合、クライアントは認証に共有キーを使用できず、代わりに別の allowedAuthenticationModes を使用する必要があります。 この場合、キーの取得は失敗します。 |
| list |
サブスクリプションに関連付けられている Batch アカウントに関する情報を取得します。 |
| list_by_resource_group |
指定したリソース グループに関連付けられている Batch アカウントに関する情報を取得します。 |
| list_detectors |
特定の Batch アカウントで使用可能なディテクタに関する情報を取得します。 |
| list_outbound_network_dependencies_endpoints |
この Batch アカウントの Batch コンピューティング ノードが Batch サービス管理の一部として呼び出す可能性があるエンドポイントの一覧を示します。 指定した仮想ネットワーク内にプールをデプロイする場合は、ネットワークでこれらのエンドポイントへの送信アクセスが許可されていることを確認する必要があります。 これらのエンドポイントへのアクセスを許可しないと、Batch によって影響を受けるノードが使用不可としてマークされる可能性があります。 仮想ネットワーク内でのプールの作成の詳細については、「」を参照してください https://docs.microsoft.com/en-us/azure/batch/batch-virtual-network。 |
| regenerate_key |
Batch アカウントの指定したアカウント キーを再生成します。 この操作は、'SharedKey' を含む allowedAuthenticationModes を持つ Batch アカウントにのみ適用されます。 Batch アカウントに allowedAuthenticationMode に 'SharedKey' が含まれていない場合、クライアントは認証に共有キーを使用できず、代わりに別の allowedAuthenticationModes を使用する必要があります。 この場合、キーの再生成は失敗します。 |
| synchronize_auto_storage_keys |
ストレージ キー認証が使用されている場合にのみ、指定した Batch アカウント用に構成された自動ストレージ アカウントのアクセス キーを同期します。 |
| update |
既存の Batch アカウントのプロパティを更新します。 |
begin_create
指定したパラメーターを使用して、新しい Batch アカウントを作成します。 この API では既存のアカウントを更新できないため、代わりに Update Batch Account API で更新する必要があります。
async begin_create(resource_group_name: str, account_name: str, parameters: _models.BatchAccountCreateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.BatchAccount]パラメーター
- account_name
- str
リージョン内で一意である必要がある Batch アカウントの名前。 バッチ アカウント名の長さは 3 ~ 24 文字で、数字と小文字のみを使用する必要があります。 この名前は、アカウントが作成されたリージョンの Batch サービスにアクセスするために使用される DNS 名の一部として使用されます。 (例: http://accountname.region.batch.azure.com/)。 必須。
- parameters
- BatchAccountCreateParameters または IO
アカウント作成の追加パラメーター。 BatchAccountCreateParameters 型または IO 型です。 必須。
- content_type
- str
Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。
- cls
- callable
直接応答に渡されるカスタム型または関数
- continuation_token
- str
保存された状態からポーリングを再開するための継続トークン。
- polling
- bool または AsyncPollingMethod
既定では、ポーリング メソッドは AsyncARMPolling になります。 この操作でポーリングを行わない場合は False を渡すか、個人のポーリング戦略に対して独自に初期化されたポーリング オブジェクトを渡します。
- polling_interval
- int
Retry-After ヘッダーが存在しない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。
戻り値
BatchAccount または cls(response) の結果を返す AsyncLROPoller のインスタンス
の戻り値の型 :
例外
begin_delete
指定した Batch アカウントを削除します。
async begin_delete(resource_group_name: str, account_name: str, **kwargs: Any) -> AsyncLROPoller[None]パラメーター
- cls
- callable
直接応答に渡されるカスタム型または関数
- continuation_token
- str
保存された状態からポーリングを再開するための継続トークン。
- polling
- bool または AsyncPollingMethod
既定では、ポーリング メソッドは AsyncARMPolling になります。 この操作でポーリングを行わない場合は False を渡すか、個人のポーリング戦略に対して独自に初期化されたポーリング オブジェクトを渡します。
- polling_interval
- int
Retry-After ヘッダーが存在しない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。
戻り値
None または cls(response) の結果を返す AsyncLROPoller のインスタンス
の戻り値の型 :
例外
get
指定した Batch アカウントに関する情報を取得します。
async get(resource_group_name: str, account_name: str, **kwargs: Any) -> BatchAccountパラメーター
- cls
- callable
直接応答に渡されるカスタム型または関数
戻り値
BatchAccount または cls(response) の結果
の戻り値の型 :
例外
get_detector
特定の Batch アカウントの特定の検出機能に関する情報を取得します。
async get_detector(resource_group_name: str, account_name: str, detector_id: str, **kwargs: Any) -> DetectorResponseパラメーター
- cls
- callable
直接応答に渡されるカスタム型または関数
戻り値
DetectorResponse または cls(response) の結果
の戻り値の型 :
例外
get_keys
指定した Batch アカウントのアカウント キーを取得します。
この操作は、'SharedKey' を含む allowedAuthenticationModes を持つ Batch アカウントにのみ適用されます。 Batch アカウントに allowedAuthenticationMode に 'SharedKey' が含まれていない場合、クライアントは認証に共有キーを使用できず、代わりに別の allowedAuthenticationModes を使用する必要があります。 この場合、キーの取得は失敗します。
async get_keys(resource_group_name: str, account_name: str, **kwargs: Any) -> BatchAccountKeysパラメーター
- cls
- callable
直接応答に渡されるカスタム型または関数
戻り値
BatchAccountKeys または cls(response) の結果
の戻り値の型 :
例外
list
サブスクリプションに関連付けられている Batch アカウントに関する情報を取得します。
list(**kwargs: Any) -> AsyncIterable[BatchAccount]パラメーター
- cls
- callable
直接応答に渡されるカスタム型または関数
戻り値
BatchAccount のインスタンスや cls(response) の結果のような反復子
の戻り値の型 :
例外
list_by_resource_group
指定したリソース グループに関連付けられている Batch アカウントに関する情報を取得します。
list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[BatchAccount]パラメーター
- cls
- callable
直接応答に渡されるカスタム型または関数
戻り値
BatchAccount のインスタンスや cls(response) の結果のような反復子
の戻り値の型 :
例外
list_detectors
特定の Batch アカウントで使用可能なディテクタに関する情報を取得します。
list_detectors(resource_group_name: str, account_name: str, **kwargs: Any) -> AsyncIterable[DetectorResponse]パラメーター
- cls
- callable
直接応答に渡されるカスタム型または関数
戻り値
DetectorResponse または cls(response) の結果のいずれかのインスタンスのような反復子
の戻り値の型 :
例外
list_outbound_network_dependencies_endpoints
この Batch アカウントの Batch コンピューティング ノードが Batch サービス管理の一部として呼び出す可能性があるエンドポイントの一覧を示します。 指定した仮想ネットワーク内にプールをデプロイする場合は、ネットワークでこれらのエンドポイントへの送信アクセスが許可されていることを確認する必要があります。 これらのエンドポイントへのアクセスを許可しないと、Batch によって影響を受けるノードが使用不可としてマークされる可能性があります。 仮想ネットワーク内でのプールの作成の詳細については、「」を参照してください https://docs.microsoft.com/en-us/azure/batch/batch-virtual-network。
list_outbound_network_dependencies_endpoints(resource_group_name: str, account_name: str, **kwargs: Any) -> AsyncIterable[OutboundEnvironmentEndpoint]パラメーター
- cls
- callable
直接応答に渡されるカスタム型または関数
戻り値
OutboundEnvironmentEndpoint または cls(response) の結果のいずれかのインスタンスのような反復子
の戻り値の型 :
例外
regenerate_key
Batch アカウントの指定したアカウント キーを再生成します。
この操作は、'SharedKey' を含む allowedAuthenticationModes を持つ Batch アカウントにのみ適用されます。 Batch アカウントに allowedAuthenticationMode に 'SharedKey' が含まれていない場合、クライアントは認証に共有キーを使用できず、代わりに別の allowedAuthenticationModes を使用する必要があります。 この場合、キーの再生成は失敗します。
async regenerate_key(resource_group_name: str, account_name: str, parameters: _models.BatchAccountRegenerateKeyParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.BatchAccountKeysパラメーター
- parameters
- BatchAccountRegenerateKeyParameters または IO
再生成するキーの種類。 BatchAccountRegenerateKeyParameters 型または IO 型のいずれかです。 必須。
- content_type
- str
Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。
- cls
- callable
直接応答が渡されるカスタム型または関数
戻り値
BatchAccountKeys または cls(response) の結果
の戻り値の型 :
例外
synchronize_auto_storage_keys
ストレージ キー認証が使用されている場合にのみ、指定した Batch アカウント用に構成された自動ストレージ アカウントのアクセス キーを同期します。
async synchronize_auto_storage_keys(resource_group_name: str, account_name: str, **kwargs: Any) -> Noneパラメーター
- cls
- callable
直接応答が渡されるカスタム型または関数
戻り値
なしまたは cls(response) の結果
の戻り値の型 :
例外
update
既存の Batch アカウントのプロパティを更新します。
async update(resource_group_name: str, account_name: str, parameters: _models.BatchAccountUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.BatchAccountパラメーター
- parameters
- BatchAccountUpdateParameters または IO
アカウント更新の追加パラメーター。 BatchAccountUpdateParameters 型または IO 型のいずれかです。 必須。
- content_type
- str
Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。
- cls
- callable
直接応答が渡されるカスタム型または関数
戻り値
BatchAccount または cls(response) の結果
の戻り値の型 :
例外
属性
models
models = <module 'azure.mgmt.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\batch\\models\\__init__.py'>
Azure SDK for Python