DeploymentsOperations クラス
警告
このクラスを直接インスタンス化しないでください。
代わりに、次の操作にアクセスする必要があります。
<xref:deployments> 属性を使用する。
- 継承
-
builtins.objectDeploymentsOperations
コンストラクター
DeploymentsOperations(*args, **kwargs)メソッド
| begin_create_or_update |
リソースをリソース グループにデプロイします。 テンプレートとパラメーターは、要求または JSON ファイルへのリンクで直接指定できます。 |
| begin_delete |
デプロイ履歴からデプロイを削除します。 現在実行中のテンプレート デプロイは削除できません。 テンプレート デプロイを削除すると、関連付けられているデプロイ操作が削除されます。 テンプレート デプロイを削除しても、リソース グループの状態に影響はありません。 これは、テンプレートのデプロイが正常に削除されるまで、状態 202 を返す非同期操作です。 Location 応答ヘッダーには、プロセスの状態を取得するために使用される URI が含まれています。 プロセスの実行中に、Location ヘッダーの URI を呼び出すと、状態が 202 になります。 プロセスが完了すると、Location ヘッダーの URI は成功すると 204 の状態を返します。 非同期要求が失敗した場合、Location ヘッダーの URI はエラー レベルの状態コードを返します。 |
| calculate_template_hash |
指定されたテンプレートのハッシュを計算します。 |
| cancel |
現在実行中のテンプレートのデプロイを取り消します。 デプロイを取り消すことができるのは、provisioningState が Accepted または Running の場合のみです。 デプロイが取り消されると、provisioningState が Canceled に設定されます。 テンプレートのデプロイをキャンセルすると、現在実行中のテンプレートのデプロイは停止し、リソース グループは部分的にデプロイされたままになります。 |
| check_existence |
デプロイが存在するかどうかを確認します。 |
| export_template |
指定したデプロイに使用されるテンプレートをエクスポートします。 |
| get |
デプロイを取得します。 |
| list_by_resource_group |
リソース グループに対して行われたすべてのデプロイを取得します。 |
| validate |
指定したテンプレートが構文的に正しく、Azure Resource Manager によって受け入れられるかどうかを検証します。 |
begin_create_or_update
リソースをリソース グループにデプロイします。
テンプレートとパラメーターは、要求または JSON ファイルへのリンクで直接指定できます。
begin_create_or_update(resource_group_name: str, deployment_name: str, parameters: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DeploymentExtended]パラメーター
- resource_group_name
- str
リソースをデプロイするリソース グループの名前。 名前の大文字と小文字は区別されます。 このリソース グループは、既に存在している必要があります。 必須。
- content_type
- str
Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。
- cls
- callable
直接応答に渡されるカスタム型または関数
- continuation_token
- str
保存された状態からポーリングを再開するための継続トークン。
- polling
- bool または PollingMethod
既定では、ポーリング メソッドは ARMPolling になります。 この操作でポーリングしない場合は False を渡すか、個人のポーリング戦略に対して独自に初期化されたポーリング オブジェクトを渡します。
- polling_interval
- int
Retry-After ヘッダーが存在しない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。
戻り値
DeploymentExtended または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
begin_delete
デプロイ履歴からデプロイを削除します。
現在実行中のテンプレート デプロイは削除できません。 テンプレート デプロイを削除すると、関連付けられているデプロイ操作が削除されます。 テンプレート デプロイを削除しても、リソース グループの状態に影響はありません。 これは、テンプレートのデプロイが正常に削除されるまで、状態 202 を返す非同期操作です。 Location 応答ヘッダーには、プロセスの状態を取得するために使用される URI が含まれています。 プロセスの実行中に、Location ヘッダーの URI を呼び出すと、状態が 202 になります。 プロセスが完了すると、Location ヘッダーの URI は成功すると 204 の状態を返します。 非同期要求が失敗した場合、Location ヘッダーの URI はエラー レベルの状態コードを返します。
begin_delete(resource_group_name: str, deployment_name: str, **kwargs: Any) -> LROPoller[None]パラメーター
- cls
- callable
直接応答に渡されるカスタム型または関数
- continuation_token
- str
保存された状態からポーリングを再開するための継続トークン。
- polling
- bool または PollingMethod
既定では、ポーリング メソッドは ARMPolling になります。 この操作でポーリングしない場合は False を渡すか、個人のポーリング戦略に対して独自に初期化されたポーリング オブジェクトを渡します。
- polling_interval
- int
Retry-After ヘッダーが存在しない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。
戻り値
None または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
calculate_template_hash
指定されたテンプレートのハッシュを計算します。
calculate_template_hash(template: MutableMapping[str, Any], **kwargs: Any) -> TemplateHashResultパラメーター
- template
- <xref:JSON>
ハッシュを計算するために提供されるテンプレート。 必須。
- cls
- callable
直接応答に渡されるカスタム型または関数
戻り値
TemplateHashResult または cls(response) の結果
の戻り値の型 :
例外
cancel
現在実行中のテンプレートのデプロイを取り消します。
デプロイを取り消すことができるのは、provisioningState が Accepted または Running の場合のみです。 デプロイが取り消されると、provisioningState が Canceled に設定されます。 テンプレートのデプロイをキャンセルすると、現在実行中のテンプレートのデプロイは停止し、リソース グループは部分的にデプロイされたままになります。
cancel(resource_group_name: str, deployment_name: str, **kwargs: Any) -> Noneパラメーター
- cls
- callable
直接応答に渡されるカスタム型または関数
戻り値
なし、または cls(response) の結果
の戻り値の型 :
例外
check_existence
デプロイが存在するかどうかを確認します。
check_existence(resource_group_name: str, deployment_name: str, **kwargs: Any) -> boolパラメーター
- cls
- callable
直接応答に渡されるカスタム型または関数
戻り値
bool または cls(response) の結果
の戻り値の型 :
例外
export_template
指定したデプロイに使用されるテンプレートをエクスポートします。
export_template(resource_group_name: str, deployment_name: str, **kwargs: Any) -> DeploymentExportResultパラメーター
- cls
- callable
直接応答に渡されるカスタム型または関数
戻り値
DeploymentExportResult または cls(response) の結果
の戻り値の型 :
例外
get
デプロイを取得します。
get(resource_group_name: str, deployment_name: str, **kwargs: Any) -> DeploymentExtendedパラメーター
- cls
- callable
直接応答に渡されるカスタム型または関数
戻り値
DeploymentExtended または cls(response) の結果
の戻り値の型 :
例外
list_by_resource_group
リソース グループに対して行われたすべてのデプロイを取得します。
list_by_resource_group(resource_group_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[DeploymentExtended]パラメーター
- cls
- callable
直接応答に渡されるカスタム型または関数
戻り値
DeploymentExtended または cls(response) の結果のいずれかのインスタンスのような反復子
の戻り値の型 :
例外
validate
指定したテンプレートが構文的に正しく、Azure Resource Manager によって受け入れられるかどうかを検証します。
validate(resource_group_name: str, deployment_name: str, parameters: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DeploymentValidateResultパラメーター
- content_type
- str
Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。
- cls
- callable
直接応答に渡されるカスタム型または関数
戻り値
DeploymentValidateResult または cls(response) の結果
の戻り値の型 :
例外
属性
models
models = <module 'azure.mgmt.resource.resources.v2018_02_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2018_02_01\\models\\__init__.py'>
Azure SDK for Python