次の方法で共有


Deployments interface

デプロイを表すインターフェイス。

メソッド

beginCreateOrUpdate(string, string, Deployment, DeploymentsCreateOrUpdateOptionalParams)

テンプレートとパラメーターは、要求内で直接指定することも、JSON ファイルにリンクすることもできます。

beginCreateOrUpdateAndWait(string, string, Deployment, DeploymentsCreateOrUpdateOptionalParams)

テンプレートとパラメーターは、要求内で直接指定することも、JSON ファイルにリンクすることもできます。

beginCreateOrUpdateAtManagementGroupScope(string, string, ScopedDeployment, DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams)

テンプレートとパラメーターは、要求内で直接指定することも、JSON ファイルにリンクすることもできます。

beginCreateOrUpdateAtManagementGroupScopeAndWait(string, string, ScopedDeployment, DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams)

テンプレートとパラメーターは、要求内で直接指定することも、JSON ファイルにリンクすることもできます。

beginCreateOrUpdateAtScope(string, string, Deployment, DeploymentsCreateOrUpdateAtScopeOptionalParams)

テンプレートとパラメーターは、要求内で直接指定することも、JSON ファイルにリンクすることもできます。

beginCreateOrUpdateAtScopeAndWait(string, string, Deployment, DeploymentsCreateOrUpdateAtScopeOptionalParams)

テンプレートとパラメーターは、要求内で直接指定することも、JSON ファイルにリンクすることもできます。

beginCreateOrUpdateAtSubscriptionScope(string, Deployment, DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams)

テンプレートとパラメーターは、要求内で直接指定することも、JSON ファイルにリンクすることもできます。

beginCreateOrUpdateAtSubscriptionScopeAndWait(string, Deployment, DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams)

テンプレートとパラメーターは、要求内で直接指定することも、JSON ファイルにリンクすることもできます。

beginCreateOrUpdateAtTenantScope(string, ScopedDeployment, DeploymentsCreateOrUpdateAtTenantScopeOptionalParams)

テンプレートとパラメーターは、要求内で直接指定することも、JSON ファイルにリンクすることもできます。

beginCreateOrUpdateAtTenantScopeAndWait(string, ScopedDeployment, DeploymentsCreateOrUpdateAtTenantScopeOptionalParams)

テンプレートとパラメーターは、要求内で直接指定することも、JSON ファイルにリンクすることもできます。

beginDelete(string, string, DeploymentsDeleteOptionalParams)

現在実行中のテンプレートのデプロイは削除できません。 テンプレートのデプロイを削除すると、関連付けられているデプロイ操作が削除されます。 テンプレートのデプロイを削除しても、リソース グループの状態には影響しません。 これは、テンプレートのデプロイが正常に削除されるまで、状態 202 を返す非同期操作です。 Location 応答ヘッダーには、プロセスの状態を取得するために使用される URI が含まれています。 プロセスの実行中に、Location ヘッダーの URI を呼び出すと、状態 202 が返されます。 プロセスが完了すると、Location ヘッダーの URI は成功すると状態 204 を返します。 非同期要求が失敗した場合、Location ヘッダーの URI はエラー レベルの状態コードを返します。

beginDeleteAndWait(string, string, DeploymentsDeleteOptionalParams)

現在実行中のテンプレートのデプロイは削除できません。 テンプレートのデプロイを削除すると、関連付けられているデプロイ操作が削除されます。 テンプレートのデプロイを削除しても、リソース グループの状態には影響しません。 これは、テンプレートのデプロイが正常に削除されるまで、状態 202 を返す非同期操作です。 Location 応答ヘッダーには、プロセスの状態を取得するために使用される URI が含まれています。 プロセスの実行中に、Location ヘッダーの URI を呼び出すと、状態 202 が返されます。 プロセスが完了すると、Location ヘッダーの URI は成功すると状態 204 を返します。 非同期要求が失敗した場合、Location ヘッダーの URI はエラー レベルの状態コードを返します。

beginDeleteAtManagementGroupScope(string, string, DeploymentsDeleteAtManagementGroupScopeOptionalParams)

現在実行中のテンプレートのデプロイは削除できません。 テンプレートのデプロイを削除すると、関連付けられているデプロイ操作が削除されます。 これは、テンプレートのデプロイが正常に削除されるまで、状態 202 を返す非同期操作です。 Location 応答ヘッダーには、プロセスの状態を取得するために使用される URI が含まれています。 プロセスの実行中に、Location ヘッダーの URI を呼び出すと、状態 202 が返されます。 プロセスが完了すると、Location ヘッダーの URI は成功すると状態 204 を返します。 非同期要求が失敗した場合、Location ヘッダーの URI はエラー レベルの状態コードを返します。

beginDeleteAtManagementGroupScopeAndWait(string, string, DeploymentsDeleteAtManagementGroupScopeOptionalParams)

現在実行中のテンプレートのデプロイは削除できません。 テンプレートのデプロイを削除すると、関連付けられているデプロイ操作が削除されます。 これは、テンプレートのデプロイが正常に削除されるまで、状態 202 を返す非同期操作です。 Location 応答ヘッダーには、プロセスの状態を取得するために使用される URI が含まれています。 プロセスの実行中に、Location ヘッダーの URI を呼び出すと、状態 202 が返されます。 プロセスが完了すると、Location ヘッダーの URI は成功すると状態 204 を返します。 非同期要求が失敗した場合、Location ヘッダーの URI はエラー レベルの状態コードを返します。

beginDeleteAtScope(string, string, DeploymentsDeleteAtScopeOptionalParams)

現在実行中のテンプレートのデプロイは削除できません。 テンプレートのデプロイを削除すると、関連付けられているデプロイ操作が削除されます。 これは、テンプレートのデプロイが正常に削除されるまで、状態 202 を返す非同期操作です。 Location 応答ヘッダーには、プロセスの状態を取得するために使用される URI が含まれています。 プロセスの実行中に、Location ヘッダーの URI を呼び出すと、状態 202 が返されます。 プロセスが完了すると、Location ヘッダーの URI は成功すると状態 204 を返します。 非同期要求が失敗した場合、Location ヘッダーの URI はエラー レベルの状態コードを返します。

beginDeleteAtScopeAndWait(string, string, DeploymentsDeleteAtScopeOptionalParams)

現在実行中のテンプレートのデプロイは削除できません。 テンプレートのデプロイを削除すると、関連付けられているデプロイ操作が削除されます。 これは、テンプレートのデプロイが正常に削除されるまで、状態 202 を返す非同期操作です。 Location 応答ヘッダーには、プロセスの状態を取得するために使用される URI が含まれています。 プロセスの実行中に、Location ヘッダーの URI を呼び出すと、状態 202 が返されます。 プロセスが完了すると、Location ヘッダーの URI は成功すると状態 204 を返します。 非同期要求が失敗した場合、Location ヘッダーの URI はエラー レベルの状態コードを返します。

beginDeleteAtSubscriptionScope(string, DeploymentsDeleteAtSubscriptionScopeOptionalParams)

現在実行中のテンプレートのデプロイは削除できません。 テンプレートのデプロイを削除すると、関連付けられているデプロイ操作が削除されます。 これは、テンプレートのデプロイが正常に削除されるまで、状態 202 を返す非同期操作です。 Location 応答ヘッダーには、プロセスの状態を取得するために使用される URI が含まれています。 プロセスの実行中に、Location ヘッダーの URI を呼び出すと、状態 202 が返されます。 プロセスが完了すると、Location ヘッダーの URI は成功すると状態 204 を返します。 非同期要求が失敗した場合、Location ヘッダーの URI はエラー レベルの状態コードを返します。

beginDeleteAtSubscriptionScopeAndWait(string, DeploymentsDeleteAtSubscriptionScopeOptionalParams)

現在実行中のテンプレートのデプロイは削除できません。 テンプレートのデプロイを削除すると、関連付けられているデプロイ操作が削除されます。 これは、テンプレートのデプロイが正常に削除されるまで、状態 202 を返す非同期操作です。 Location 応答ヘッダーには、プロセスの状態を取得するために使用される URI が含まれています。 プロセスの実行中に、Location ヘッダーの URI を呼び出すと、状態 202 が返されます。 プロセスが完了すると、Location ヘッダーの URI は成功すると状態 204 を返します。 非同期要求が失敗した場合、Location ヘッダーの URI はエラー レベルの状態コードを返します。

beginDeleteAtTenantScope(string, DeploymentsDeleteAtTenantScopeOptionalParams)

現在実行中のテンプレートのデプロイは削除できません。 テンプレートのデプロイを削除すると、関連付けられているデプロイ操作が削除されます。 これは、テンプレートのデプロイが正常に削除されるまで、状態 202 を返す非同期操作です。 Location 応答ヘッダーには、プロセスの状態を取得するために使用される URI が含まれています。 プロセスの実行中に、Location ヘッダーの URI を呼び出すと、状態 202 が返されます。 プロセスが完了すると、Location ヘッダーの URI は成功すると状態 204 を返します。 非同期要求が失敗した場合、Location ヘッダーの URI はエラー レベルの状態コードを返します。

beginDeleteAtTenantScopeAndWait(string, DeploymentsDeleteAtTenantScopeOptionalParams)

現在実行中のテンプレートのデプロイは削除できません。 テンプレートのデプロイを削除すると、関連付けられているデプロイ操作が削除されます。 これは、テンプレートのデプロイが正常に削除されるまで、状態 202 を返す非同期操作です。 Location 応答ヘッダーには、プロセスの状態を取得するために使用される URI が含まれています。 プロセスの実行中に、Location ヘッダーの URI を呼び出すと、状態 202 が返されます。 プロセスが完了すると、Location ヘッダーの URI は成功すると状態 204 を返します。 非同期要求が失敗した場合、Location ヘッダーの URI はエラー レベルの状態コードを返します。

beginValidate(string, string, Deployment, DeploymentsValidateOptionalParams)

指定したテンプレートが構文的に正しく、Azure Resource Manager によって受け入れられるかどうかを検証します。

beginValidateAndWait(string, string, Deployment, DeploymentsValidateOptionalParams)

指定したテンプレートが構文的に正しく、Azure Resource Manager によって受け入れられるかどうかを検証します。

beginValidateAtManagementGroupScope(string, string, ScopedDeployment, DeploymentsValidateAtManagementGroupScopeOptionalParams)

指定したテンプレートが構文的に正しく、Azure Resource Manager によって受け入れられるかどうかを検証します。

beginValidateAtManagementGroupScopeAndWait(string, string, ScopedDeployment, DeploymentsValidateAtManagementGroupScopeOptionalParams)

指定したテンプレートが構文的に正しく、Azure Resource Manager によって受け入れられるかどうかを検証します。

beginValidateAtScope(string, string, Deployment, DeploymentsValidateAtScopeOptionalParams)

指定したテンプレートが構文的に正しく、Azure Resource Manager によって受け入れられるかどうかを検証します。

beginValidateAtScopeAndWait(string, string, Deployment, DeploymentsValidateAtScopeOptionalParams)

指定したテンプレートが構文的に正しく、Azure Resource Manager によって受け入れられるかどうかを検証します。

beginValidateAtSubscriptionScope(string, Deployment, DeploymentsValidateAtSubscriptionScopeOptionalParams)

指定したテンプレートが構文的に正しく、Azure Resource Manager によって受け入れられるかどうかを検証します。

beginValidateAtSubscriptionScopeAndWait(string, Deployment, DeploymentsValidateAtSubscriptionScopeOptionalParams)

指定したテンプレートが構文的に正しく、Azure Resource Manager によって受け入れられるかどうかを検証します。

beginValidateAtTenantScope(string, ScopedDeployment, DeploymentsValidateAtTenantScopeOptionalParams)

指定したテンプレートが構文的に正しく、Azure Resource Manager によって受け入れられるかどうかを検証します。

beginValidateAtTenantScopeAndWait(string, ScopedDeployment, DeploymentsValidateAtTenantScopeOptionalParams)

指定したテンプレートが構文的に正しく、Azure Resource Manager によって受け入れられるかどうかを検証します。

beginWhatIf(string, string, DeploymentWhatIf, DeploymentsWhatIfOptionalParams)

リソース グループのスコープで実行された場合にデプロイによって行われる変更を返します。

beginWhatIfAndWait(string, string, DeploymentWhatIf, DeploymentsWhatIfOptionalParams)

リソース グループのスコープで実行された場合にデプロイによって行われる変更を返します。

beginWhatIfAtManagementGroupScope(string, string, ScopedDeploymentWhatIf, DeploymentsWhatIfAtManagementGroupScopeOptionalParams)

管理グループのスコープで実行された場合にデプロイによって行われる変更を返します。

beginWhatIfAtManagementGroupScopeAndWait(string, string, ScopedDeploymentWhatIf, DeploymentsWhatIfAtManagementGroupScopeOptionalParams)

管理グループのスコープで実行された場合にデプロイによって行われる変更を返します。

beginWhatIfAtSubscriptionScope(string, DeploymentWhatIf, DeploymentsWhatIfAtSubscriptionScopeOptionalParams)

サブスクリプションのスコープで実行された場合にデプロイによって行われる変更を返します。

beginWhatIfAtSubscriptionScopeAndWait(string, DeploymentWhatIf, DeploymentsWhatIfAtSubscriptionScopeOptionalParams)

サブスクリプションのスコープで実行された場合にデプロイによって行われる変更を返します。

beginWhatIfAtTenantScope(string, ScopedDeploymentWhatIf, DeploymentsWhatIfAtTenantScopeOptionalParams)

テナント グループのスコープで実行された場合にデプロイによって行われる変更を返します。

beginWhatIfAtTenantScopeAndWait(string, ScopedDeploymentWhatIf, DeploymentsWhatIfAtTenantScopeOptionalParams)

テナント グループのスコープで実行された場合にデプロイによって行われる変更を返します。

calculateTemplateHash(Record<string, unknown>, DeploymentsCalculateTemplateHashOptionalParams)

指定されたテンプレートのハッシュを計算します。

cancel(string, string, DeploymentsCancelOptionalParams)

provisioningState が Accepted または Running の場合にのみ、デプロイを取り消すことができます。 デプロイが取り消されると、provisioningState が Canceled に設定されます。 テンプレートのデプロイをキャンセルすると、現在実行中のテンプレートのデプロイが停止し、リソース グループが部分的にデプロイされた状態になります。

cancelAtManagementGroupScope(string, string, DeploymentsCancelAtManagementGroupScopeOptionalParams)

provisioningState が Accepted または Running の場合にのみ、デプロイを取り消すことができます。 デプロイが取り消されると、provisioningState が Canceled に設定されます。 テンプレートのデプロイをキャンセルすると、現在実行中のテンプレートのデプロイが停止し、リソースが部分的にデプロイされた状態になります。

cancelAtScope(string, string, DeploymentsCancelAtScopeOptionalParams)

provisioningState が Accepted または Running の場合にのみ、デプロイを取り消すことができます。 デプロイが取り消されると、provisioningState が Canceled に設定されます。 テンプレートのデプロイをキャンセルすると、現在実行中のテンプレートのデプロイが停止し、リソースが部分的にデプロイされた状態になります。

cancelAtSubscriptionScope(string, DeploymentsCancelAtSubscriptionScopeOptionalParams)

provisioningState が Accepted または Running の場合にのみ、デプロイを取り消すことができます。 デプロイが取り消されると、provisioningState が Canceled に設定されます。 テンプレートのデプロイをキャンセルすると、現在実行中のテンプレートのデプロイが停止し、リソースが部分的にデプロイされた状態になります。

cancelAtTenantScope(string, DeploymentsCancelAtTenantScopeOptionalParams)

provisioningState が Accepted または Running の場合にのみ、デプロイを取り消すことができます。 デプロイが取り消されると、provisioningState が Canceled に設定されます。 テンプレートのデプロイをキャンセルすると、現在実行中のテンプレートのデプロイが停止し、リソースが部分的にデプロイされた状態になります。

checkExistence(string, string, DeploymentsCheckExistenceOptionalParams)

デプロイが存在するかどうかを確認します。

checkExistenceAtManagementGroupScope(string, string, DeploymentsCheckExistenceAtManagementGroupScopeOptionalParams)

デプロイが存在するかどうかを確認します。

checkExistenceAtScope(string, string, DeploymentsCheckExistenceAtScopeOptionalParams)

デプロイが存在するかどうかを確認します。

checkExistenceAtSubscriptionScope(string, DeploymentsCheckExistenceAtSubscriptionScopeOptionalParams)

デプロイが存在するかどうかを確認します。

checkExistenceAtTenantScope(string, DeploymentsCheckExistenceAtTenantScopeOptionalParams)

デプロイが存在するかどうかを確認します。

exportTemplate(string, string, DeploymentsExportTemplateOptionalParams)

指定したデプロイに使用されるテンプレートをエクスポートします。

exportTemplateAtManagementGroupScope(string, string, DeploymentsExportTemplateAtManagementGroupScopeOptionalParams)

指定したデプロイに使用されるテンプレートをエクスポートします。

exportTemplateAtScope(string, string, DeploymentsExportTemplateAtScopeOptionalParams)

指定したデプロイに使用されるテンプレートをエクスポートします。

exportTemplateAtSubscriptionScope(string, DeploymentsExportTemplateAtSubscriptionScopeOptionalParams)

指定したデプロイに使用されるテンプレートをエクスポートします。

exportTemplateAtTenantScope(string, DeploymentsExportTemplateAtTenantScopeOptionalParams)

指定したデプロイに使用されるテンプレートをエクスポートします。

get(string, string, DeploymentsGetOptionalParams)

デプロイを取得します。

getAtManagementGroupScope(string, string, DeploymentsGetAtManagementGroupScopeOptionalParams)

デプロイを取得します。

getAtScope(string, string, DeploymentsGetAtScopeOptionalParams)

デプロイを取得します。

getAtSubscriptionScope(string, DeploymentsGetAtSubscriptionScopeOptionalParams)

デプロイを取得します。

getAtTenantScope(string, DeploymentsGetAtTenantScopeOptionalParams)

デプロイを取得します。

listAtManagementGroupScope(string, DeploymentsListAtManagementGroupScopeOptionalParams)

管理グループのすべてのデプロイを取得します。

listAtScope(string, DeploymentsListAtScopeOptionalParams)

特定のスコープですべてのデプロイを取得します。

listAtSubscriptionScope(DeploymentsListAtSubscriptionScopeOptionalParams)

サブスクリプションのすべてのデプロイを取得します。

listAtTenantScope(DeploymentsListAtTenantScopeOptionalParams)

テナント スコープですべてのデプロイを取得します。

listByResourceGroup(string, DeploymentsListByResourceGroupOptionalParams)

リソース グループのすべてのデプロイを取得します。

メソッドの詳細

beginCreateOrUpdate(string, string, Deployment, DeploymentsCreateOrUpdateOptionalParams)

テンプレートとパラメーターは、要求内で直接指定することも、JSON ファイルにリンクすることもできます。

function beginCreateOrUpdate(resourceGroupName: string, deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DeploymentExtended>, DeploymentExtended>>

パラメーター

resourceGroupName

string

リソースをデプロイするリソース グループの名前。 名前では大文字と小文字が区別されません。 リソース グループは既に存在している必要があります。

deploymentName

string

デプロイの名前。

parameters
Deployment

操作に指定された追加のパラメーター。

options
DeploymentsCreateOrUpdateOptionalParams

オプション パラメーター。

戻り値

Promise<PollerLike<@azure/core-lro.PollOperationState<DeploymentExtended>, DeploymentExtended>>

beginCreateOrUpdateAndWait(string, string, Deployment, DeploymentsCreateOrUpdateOptionalParams)

テンプレートとパラメーターは、要求内で直接指定することも、JSON ファイルにリンクすることもできます。

function beginCreateOrUpdateAndWait(resourceGroupName: string, deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateOptionalParams): Promise<DeploymentExtended>

パラメーター

resourceGroupName

string

リソースをデプロイするリソース グループの名前。 名前では大文字と小文字が区別されません。 リソース グループは既に存在している必要があります。

deploymentName

string

デプロイの名前。

parameters
Deployment

操作に指定された追加のパラメーター。

options
DeploymentsCreateOrUpdateOptionalParams

オプション パラメーター。

戻り値

beginCreateOrUpdateAtManagementGroupScope(string, string, ScopedDeployment, DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams)

テンプレートとパラメーターは、要求内で直接指定することも、JSON ファイルにリンクすることもできます。

function beginCreateOrUpdateAtManagementGroupScope(groupId: string, deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams): Promise<PollerLike<PollOperationState<DeploymentExtended>, DeploymentExtended>>

パラメーター

groupId

string

管理グループ ID。

deploymentName

string

デプロイの名前。

parameters
ScopedDeployment

操作に指定された追加のパラメーター。

options
DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams

オプション パラメーター。

戻り値

Promise<PollerLike<@azure/core-lro.PollOperationState<DeploymentExtended>, DeploymentExtended>>

beginCreateOrUpdateAtManagementGroupScopeAndWait(string, string, ScopedDeployment, DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams)

テンプレートとパラメーターは、要求内で直接指定することも、JSON ファイルにリンクすることもできます。

function beginCreateOrUpdateAtManagementGroupScopeAndWait(groupId: string, deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams): Promise<DeploymentExtended>

パラメーター

groupId

string

管理グループ ID。

deploymentName

string

デプロイの名前。

parameters
ScopedDeployment

操作に指定された追加のパラメーター。

options
DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams

オプション パラメーター。

戻り値

beginCreateOrUpdateAtScope(string, string, Deployment, DeploymentsCreateOrUpdateAtScopeOptionalParams)

テンプレートとパラメーターは、要求内で直接指定することも、JSON ファイルにリンクすることもできます。

function beginCreateOrUpdateAtScope(scope: string, deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateAtScopeOptionalParams): Promise<PollerLike<PollOperationState<DeploymentExtended>, DeploymentExtended>>

パラメーター

scope

string

リソース スコープ。

deploymentName

string

デプロイの名前。

parameters
Deployment

操作に指定された追加のパラメーター。

options
DeploymentsCreateOrUpdateAtScopeOptionalParams

オプション パラメーター。

戻り値

Promise<PollerLike<@azure/core-lro.PollOperationState<DeploymentExtended>, DeploymentExtended>>

beginCreateOrUpdateAtScopeAndWait(string, string, Deployment, DeploymentsCreateOrUpdateAtScopeOptionalParams)

テンプレートとパラメーターは、要求内で直接指定することも、JSON ファイルにリンクすることもできます。

function beginCreateOrUpdateAtScopeAndWait(scope: string, deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateAtScopeOptionalParams): Promise<DeploymentExtended>

パラメーター

scope

string

リソース スコープ。

deploymentName

string

デプロイの名前。

parameters
Deployment

操作に指定された追加のパラメーター。

options
DeploymentsCreateOrUpdateAtScopeOptionalParams

オプション パラメーター。

戻り値

beginCreateOrUpdateAtSubscriptionScope(string, Deployment, DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams)

テンプレートとパラメーターは、要求内で直接指定することも、JSON ファイルにリンクすることもできます。

function beginCreateOrUpdateAtSubscriptionScope(deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams): Promise<PollerLike<PollOperationState<DeploymentExtended>, DeploymentExtended>>

パラメーター

deploymentName

string

デプロイの名前。

parameters
Deployment

操作に指定された追加のパラメーター。

options
DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams

オプション パラメーター。

戻り値

Promise<PollerLike<@azure/core-lro.PollOperationState<DeploymentExtended>, DeploymentExtended>>

beginCreateOrUpdateAtSubscriptionScopeAndWait(string, Deployment, DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams)

テンプレートとパラメーターは、要求内で直接指定することも、JSON ファイルにリンクすることもできます。

function beginCreateOrUpdateAtSubscriptionScopeAndWait(deploymentName: string, parameters: Deployment, options?: DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams): Promise<DeploymentExtended>

パラメーター

deploymentName

string

デプロイの名前。

parameters
Deployment

操作に指定された追加のパラメーター。

options
DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams

オプション パラメーター。

戻り値

beginCreateOrUpdateAtTenantScope(string, ScopedDeployment, DeploymentsCreateOrUpdateAtTenantScopeOptionalParams)

テンプレートとパラメーターは、要求内で直接指定することも、JSON ファイルにリンクすることもできます。

function beginCreateOrUpdateAtTenantScope(deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsCreateOrUpdateAtTenantScopeOptionalParams): Promise<PollerLike<PollOperationState<DeploymentExtended>, DeploymentExtended>>

パラメーター

deploymentName

string

デプロイの名前。

parameters
ScopedDeployment

操作に指定された追加のパラメーター。

options
DeploymentsCreateOrUpdateAtTenantScopeOptionalParams

オプション パラメーター。

戻り値

Promise<PollerLike<@azure/core-lro.PollOperationState<DeploymentExtended>, DeploymentExtended>>

beginCreateOrUpdateAtTenantScopeAndWait(string, ScopedDeployment, DeploymentsCreateOrUpdateAtTenantScopeOptionalParams)

テンプレートとパラメーターは、要求内で直接指定することも、JSON ファイルにリンクすることもできます。

function beginCreateOrUpdateAtTenantScopeAndWait(deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsCreateOrUpdateAtTenantScopeOptionalParams): Promise<DeploymentExtended>

パラメーター

deploymentName

string

デプロイの名前。

parameters
ScopedDeployment

操作に指定された追加のパラメーター。

options
DeploymentsCreateOrUpdateAtTenantScopeOptionalParams

オプション パラメーター。

戻り値

beginDelete(string, string, DeploymentsDeleteOptionalParams)

現在実行中のテンプレートのデプロイは削除できません。 テンプレートのデプロイを削除すると、関連付けられているデプロイ操作が削除されます。 テンプレートのデプロイを削除しても、リソース グループの状態には影響しません。 これは、テンプレートのデプロイが正常に削除されるまで、状態 202 を返す非同期操作です。 Location 応答ヘッダーには、プロセスの状態を取得するために使用される URI が含まれています。 プロセスの実行中に、Location ヘッダーの URI を呼び出すと、状態 202 が返されます。 プロセスが完了すると、Location ヘッダーの URI は成功すると状態 204 を返します。 非同期要求が失敗した場合、Location ヘッダーの URI はエラー レベルの状態コードを返します。

function beginDelete(resourceGroupName: string, deploymentName: string, options?: DeploymentsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

パラメーター

resourceGroupName

string

削除するデプロイを含むリソース グループの名前。 名前では大文字と小文字が区別されません。

deploymentName

string

デプロイの名前。

options
DeploymentsDeleteOptionalParams

オプション パラメーター。

戻り値

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, DeploymentsDeleteOptionalParams)

現在実行中のテンプレートのデプロイは削除できません。 テンプレートのデプロイを削除すると、関連付けられているデプロイ操作が削除されます。 テンプレートのデプロイを削除しても、リソース グループの状態には影響しません。 これは、テンプレートのデプロイが正常に削除されるまで、状態 202 を返す非同期操作です。 Location 応答ヘッダーには、プロセスの状態を取得するために使用される URI が含まれています。 プロセスの実行中に、Location ヘッダーの URI を呼び出すと、状態 202 が返されます。 プロセスが完了すると、Location ヘッダーの URI は成功すると状態 204 を返します。 非同期要求が失敗した場合、Location ヘッダーの URI はエラー レベルの状態コードを返します。

function beginDeleteAndWait(resourceGroupName: string, deploymentName: string, options?: DeploymentsDeleteOptionalParams): Promise<void>

パラメーター

resourceGroupName

string

削除するデプロイを含むリソース グループの名前。 名前では大文字と小文字が区別されません。

deploymentName

string

デプロイの名前。

options
DeploymentsDeleteOptionalParams

オプション パラメーター。

戻り値

Promise<void>

beginDeleteAtManagementGroupScope(string, string, DeploymentsDeleteAtManagementGroupScopeOptionalParams)

現在実行中のテンプレートのデプロイは削除できません。 テンプレートのデプロイを削除すると、関連付けられているデプロイ操作が削除されます。 これは、テンプレートのデプロイが正常に削除されるまで、状態 202 を返す非同期操作です。 Location 応答ヘッダーには、プロセスの状態を取得するために使用される URI が含まれています。 プロセスの実行中に、Location ヘッダーの URI を呼び出すと、状態 202 が返されます。 プロセスが完了すると、Location ヘッダーの URI は成功すると状態 204 を返します。 非同期要求が失敗した場合、Location ヘッダーの URI はエラー レベルの状態コードを返します。

function beginDeleteAtManagementGroupScope(groupId: string, deploymentName: string, options?: DeploymentsDeleteAtManagementGroupScopeOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

パラメーター

groupId

string

管理グループ ID。

deploymentName

string

デプロイの名前。

options
DeploymentsDeleteAtManagementGroupScopeOptionalParams

オプション パラメーター。

戻り値

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAtManagementGroupScopeAndWait(string, string, DeploymentsDeleteAtManagementGroupScopeOptionalParams)

現在実行中のテンプレートのデプロイは削除できません。 テンプレートのデプロイを削除すると、関連付けられているデプロイ操作が削除されます。 これは、テンプレートのデプロイが正常に削除されるまで、状態 202 を返す非同期操作です。 Location 応答ヘッダーには、プロセスの状態を取得するために使用される URI が含まれています。 プロセスの実行中に、Location ヘッダーの URI を呼び出すと、状態 202 が返されます。 プロセスが完了すると、Location ヘッダーの URI は成功すると状態 204 を返します。 非同期要求が失敗した場合、Location ヘッダーの URI はエラー レベルの状態コードを返します。

function beginDeleteAtManagementGroupScopeAndWait(groupId: string, deploymentName: string, options?: DeploymentsDeleteAtManagementGroupScopeOptionalParams): Promise<void>

パラメーター

groupId

string

管理グループ ID。

deploymentName

string

デプロイの名前。

options
DeploymentsDeleteAtManagementGroupScopeOptionalParams

オプション パラメーター。

戻り値

Promise<void>

beginDeleteAtScope(string, string, DeploymentsDeleteAtScopeOptionalParams)

現在実行中のテンプレートのデプロイは削除できません。 テンプレートのデプロイを削除すると、関連付けられているデプロイ操作が削除されます。 これは、テンプレートのデプロイが正常に削除されるまで、状態 202 を返す非同期操作です。 Location 応答ヘッダーには、プロセスの状態を取得するために使用される URI が含まれています。 プロセスの実行中に、Location ヘッダーの URI を呼び出すと、状態 202 が返されます。 プロセスが完了すると、Location ヘッダーの URI は成功すると状態 204 を返します。 非同期要求が失敗した場合、Location ヘッダーの URI はエラー レベルの状態コードを返します。

function beginDeleteAtScope(scope: string, deploymentName: string, options?: DeploymentsDeleteAtScopeOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

パラメーター

scope

string

リソース スコープ。

deploymentName

string

デプロイの名前。

options
DeploymentsDeleteAtScopeOptionalParams

オプション パラメーター。

戻り値

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAtScopeAndWait(string, string, DeploymentsDeleteAtScopeOptionalParams)

現在実行中のテンプレートのデプロイは削除できません。 テンプレートのデプロイを削除すると、関連付けられているデプロイ操作が削除されます。 これは、テンプレートのデプロイが正常に削除されるまで、状態 202 を返す非同期操作です。 Location 応答ヘッダーには、プロセスの状態を取得するために使用される URI が含まれています。 プロセスの実行中に、Location ヘッダーの URI を呼び出すと、状態 202 が返されます。 プロセスが完了すると、Location ヘッダーの URI は成功すると状態 204 を返します。 非同期要求が失敗した場合、Location ヘッダーの URI はエラー レベルの状態コードを返します。

function beginDeleteAtScopeAndWait(scope: string, deploymentName: string, options?: DeploymentsDeleteAtScopeOptionalParams): Promise<void>

パラメーター

scope

string

リソース スコープ。

deploymentName

string

デプロイの名前。

options
DeploymentsDeleteAtScopeOptionalParams

オプション パラメーター。

戻り値

Promise<void>

beginDeleteAtSubscriptionScope(string, DeploymentsDeleteAtSubscriptionScopeOptionalParams)

現在実行中のテンプレートのデプロイは削除できません。 テンプレートのデプロイを削除すると、関連付けられているデプロイ操作が削除されます。 これは、テンプレートのデプロイが正常に削除されるまで、状態 202 を返す非同期操作です。 Location 応答ヘッダーには、プロセスの状態を取得するために使用される URI が含まれています。 プロセスの実行中に、Location ヘッダーの URI を呼び出すと、状態 202 が返されます。 プロセスが完了すると、Location ヘッダーの URI は成功すると状態 204 を返します。 非同期要求が失敗した場合、Location ヘッダーの URI はエラー レベルの状態コードを返します。

function beginDeleteAtSubscriptionScope(deploymentName: string, options?: DeploymentsDeleteAtSubscriptionScopeOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

パラメーター

deploymentName

string

デプロイの名前。

options
DeploymentsDeleteAtSubscriptionScopeOptionalParams

オプション パラメーター。

戻り値

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAtSubscriptionScopeAndWait(string, DeploymentsDeleteAtSubscriptionScopeOptionalParams)

現在実行中のテンプレートのデプロイは削除できません。 テンプレートのデプロイを削除すると、関連付けられているデプロイ操作が削除されます。 これは、テンプレートのデプロイが正常に削除されるまで、状態 202 を返す非同期操作です。 Location 応答ヘッダーには、プロセスの状態を取得するために使用される URI が含まれています。 プロセスの実行中に、Location ヘッダーの URI を呼び出すと、状態 202 が返されます。 プロセスが完了すると、Location ヘッダーの URI は成功すると状態 204 を返します。 非同期要求が失敗した場合、Location ヘッダーの URI はエラー レベルの状態コードを返します。

function beginDeleteAtSubscriptionScopeAndWait(deploymentName: string, options?: DeploymentsDeleteAtSubscriptionScopeOptionalParams): Promise<void>

パラメーター

deploymentName

string

デプロイの名前。

options
DeploymentsDeleteAtSubscriptionScopeOptionalParams

オプション パラメーター。

戻り値

Promise<void>

beginDeleteAtTenantScope(string, DeploymentsDeleteAtTenantScopeOptionalParams)

現在実行中のテンプレートのデプロイは削除できません。 テンプレートのデプロイを削除すると、関連付けられているデプロイ操作が削除されます。 これは、テンプレートのデプロイが正常に削除されるまで、状態 202 を返す非同期操作です。 Location 応答ヘッダーには、プロセスの状態を取得するために使用される URI が含まれています。 プロセスの実行中に、Location ヘッダーの URI を呼び出すと、状態 202 が返されます。 プロセスが完了すると、Location ヘッダーの URI は成功すると状態 204 を返します。 非同期要求が失敗した場合、Location ヘッダーの URI はエラー レベルの状態コードを返します。

function beginDeleteAtTenantScope(deploymentName: string, options?: DeploymentsDeleteAtTenantScopeOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

パラメーター

deploymentName

string

デプロイの名前。

options
DeploymentsDeleteAtTenantScopeOptionalParams

オプション パラメーター。

戻り値

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAtTenantScopeAndWait(string, DeploymentsDeleteAtTenantScopeOptionalParams)

現在実行中のテンプレートのデプロイは削除できません。 テンプレートのデプロイを削除すると、関連付けられているデプロイ操作が削除されます。 これは、テンプレートのデプロイが正常に削除されるまで、状態 202 を返す非同期操作です。 Location 応答ヘッダーには、プロセスの状態を取得するために使用される URI が含まれています。 プロセスの実行中に、Location ヘッダーの URI を呼び出すと、状態 202 が返されます。 プロセスが完了すると、Location ヘッダーの URI は成功すると状態 204 を返します。 非同期要求が失敗した場合、Location ヘッダーの URI はエラー レベルの状態コードを返します。

function beginDeleteAtTenantScopeAndWait(deploymentName: string, options?: DeploymentsDeleteAtTenantScopeOptionalParams): Promise<void>

パラメーター

deploymentName

string

デプロイの名前。

options
DeploymentsDeleteAtTenantScopeOptionalParams

オプション パラメーター。

戻り値

Promise<void>

beginValidate(string, string, Deployment, DeploymentsValidateOptionalParams)

指定したテンプレートが構文的に正しく、Azure Resource Manager によって受け入れられるかどうかを検証します。

function beginValidate(resourceGroupName: string, deploymentName: string, parameters: Deployment, options?: DeploymentsValidateOptionalParams): Promise<PollerLike<PollOperationState<DeploymentValidateResult>, DeploymentValidateResult>>

パラメーター

resourceGroupName

string

テンプレートがデプロイされるリソース グループの名前。 名前では大文字と小文字が区別されません。

deploymentName

string

デプロイの名前。

parameters
Deployment

検証するパラメーター。

options
DeploymentsValidateOptionalParams

オプション パラメーター。

戻り値

Promise<PollerLike<@azure/core-lro.PollOperationState<DeploymentValidateResult>, DeploymentValidateResult>>

beginValidateAndWait(string, string, Deployment, DeploymentsValidateOptionalParams)

指定したテンプレートが構文的に正しく、Azure Resource Manager によって受け入れられるかどうかを検証します。

function beginValidateAndWait(resourceGroupName: string, deploymentName: string, parameters: Deployment, options?: DeploymentsValidateOptionalParams): Promise<DeploymentValidateResult>

パラメーター

resourceGroupName

string

テンプレートがデプロイされるリソース グループの名前。 名前では大文字と小文字が区別されません。

deploymentName

string

デプロイの名前。

parameters
Deployment

検証するパラメーター。

options
DeploymentsValidateOptionalParams

オプション パラメーター。

戻り値

beginValidateAtManagementGroupScope(string, string, ScopedDeployment, DeploymentsValidateAtManagementGroupScopeOptionalParams)

指定したテンプレートが構文的に正しく、Azure Resource Manager によって受け入れられるかどうかを検証します。

function beginValidateAtManagementGroupScope(groupId: string, deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsValidateAtManagementGroupScopeOptionalParams): Promise<PollerLike<PollOperationState<DeploymentValidateResult>, DeploymentValidateResult>>

パラメーター

groupId

string

管理グループ ID。

deploymentName

string

デプロイの名前。

parameters
ScopedDeployment

検証するパラメーター。

options
DeploymentsValidateAtManagementGroupScopeOptionalParams

オプション パラメーター。

戻り値

Promise<PollerLike<@azure/core-lro.PollOperationState<DeploymentValidateResult>, DeploymentValidateResult>>

beginValidateAtManagementGroupScopeAndWait(string, string, ScopedDeployment, DeploymentsValidateAtManagementGroupScopeOptionalParams)

指定したテンプレートが構文的に正しく、Azure Resource Manager によって受け入れられるかどうかを検証します。

function beginValidateAtManagementGroupScopeAndWait(groupId: string, deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsValidateAtManagementGroupScopeOptionalParams): Promise<DeploymentValidateResult>

パラメーター

groupId

string

管理グループ ID。

deploymentName

string

デプロイの名前。

parameters
ScopedDeployment

検証するパラメーター。

options
DeploymentsValidateAtManagementGroupScopeOptionalParams

オプション パラメーター。

戻り値

beginValidateAtScope(string, string, Deployment, DeploymentsValidateAtScopeOptionalParams)

指定したテンプレートが構文的に正しく、Azure Resource Manager によって受け入れられるかどうかを検証します。

function beginValidateAtScope(scope: string, deploymentName: string, parameters: Deployment, options?: DeploymentsValidateAtScopeOptionalParams): Promise<PollerLike<PollOperationState<DeploymentValidateResult>, DeploymentValidateResult>>

パラメーター

scope

string

リソース スコープ。

deploymentName

string

デプロイの名前。

parameters
Deployment

検証するパラメーター。

options
DeploymentsValidateAtScopeOptionalParams

オプション パラメーター。

戻り値

Promise<PollerLike<@azure/core-lro.PollOperationState<DeploymentValidateResult>, DeploymentValidateResult>>

beginValidateAtScopeAndWait(string, string, Deployment, DeploymentsValidateAtScopeOptionalParams)

指定したテンプレートが構文的に正しく、Azure Resource Manager によって受け入れられるかどうかを検証します。

function beginValidateAtScopeAndWait(scope: string, deploymentName: string, parameters: Deployment, options?: DeploymentsValidateAtScopeOptionalParams): Promise<DeploymentValidateResult>

パラメーター

scope

string

リソース スコープ。

deploymentName

string

デプロイの名前。

parameters
Deployment

検証するパラメーター。

options
DeploymentsValidateAtScopeOptionalParams

オプション パラメーター。

戻り値

beginValidateAtSubscriptionScope(string, Deployment, DeploymentsValidateAtSubscriptionScopeOptionalParams)

指定したテンプレートが構文的に正しく、Azure Resource Manager によって受け入れられるかどうかを検証します。

function beginValidateAtSubscriptionScope(deploymentName: string, parameters: Deployment, options?: DeploymentsValidateAtSubscriptionScopeOptionalParams): Promise<PollerLike<PollOperationState<DeploymentValidateResult>, DeploymentValidateResult>>

パラメーター

deploymentName

string

デプロイの名前。

parameters
Deployment

検証するパラメーター。

options
DeploymentsValidateAtSubscriptionScopeOptionalParams

オプション パラメーター。

戻り値

Promise<PollerLike<@azure/core-lro.PollOperationState<DeploymentValidateResult>, DeploymentValidateResult>>

beginValidateAtSubscriptionScopeAndWait(string, Deployment, DeploymentsValidateAtSubscriptionScopeOptionalParams)

指定したテンプレートが構文的に正しく、Azure Resource Manager によって受け入れられるかどうかを検証します。

function beginValidateAtSubscriptionScopeAndWait(deploymentName: string, parameters: Deployment, options?: DeploymentsValidateAtSubscriptionScopeOptionalParams): Promise<DeploymentValidateResult>

パラメーター

deploymentName

string

デプロイの名前。

parameters
Deployment

検証するパラメーター。

options
DeploymentsValidateAtSubscriptionScopeOptionalParams

オプション パラメーター。

戻り値

beginValidateAtTenantScope(string, ScopedDeployment, DeploymentsValidateAtTenantScopeOptionalParams)

指定したテンプレートが構文的に正しく、Azure Resource Manager によって受け入れられるかどうかを検証します。

function beginValidateAtTenantScope(deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsValidateAtTenantScopeOptionalParams): Promise<PollerLike<PollOperationState<DeploymentValidateResult>, DeploymentValidateResult>>

パラメーター

deploymentName

string

デプロイの名前。

parameters
ScopedDeployment

検証するパラメーター。

options
DeploymentsValidateAtTenantScopeOptionalParams

オプション パラメーター。

戻り値

Promise<PollerLike<@azure/core-lro.PollOperationState<DeploymentValidateResult>, DeploymentValidateResult>>

beginValidateAtTenantScopeAndWait(string, ScopedDeployment, DeploymentsValidateAtTenantScopeOptionalParams)

指定したテンプレートが構文的に正しく、Azure Resource Manager によって受け入れられるかどうかを検証します。

function beginValidateAtTenantScopeAndWait(deploymentName: string, parameters: ScopedDeployment, options?: DeploymentsValidateAtTenantScopeOptionalParams): Promise<DeploymentValidateResult>

パラメーター

deploymentName

string

デプロイの名前。

parameters
ScopedDeployment

検証するパラメーター。

options
DeploymentsValidateAtTenantScopeOptionalParams

オプション パラメーター。

戻り値

beginWhatIf(string, string, DeploymentWhatIf, DeploymentsWhatIfOptionalParams)

リソース グループのスコープで実行された場合にデプロイによって行われる変更を返します。

function beginWhatIf(resourceGroupName: string, deploymentName: string, parameters: DeploymentWhatIf, options?: DeploymentsWhatIfOptionalParams): Promise<PollerLike<PollOperationState<WhatIfOperationResult>, WhatIfOperationResult>>

パラメーター

resourceGroupName

string

テンプレートがデプロイされるリソース グループの名前。 名前では大文字と小文字が区別されません。

deploymentName

string

デプロイの名前。

parameters
DeploymentWhatIf

検証するパラメーター。

options
DeploymentsWhatIfOptionalParams

オプション パラメーター。

戻り値

Promise<PollerLike<@azure/core-lro.PollOperationState<WhatIfOperationResult>, WhatIfOperationResult>>

beginWhatIfAndWait(string, string, DeploymentWhatIf, DeploymentsWhatIfOptionalParams)

リソース グループのスコープで実行された場合にデプロイによって行われる変更を返します。

function beginWhatIfAndWait(resourceGroupName: string, deploymentName: string, parameters: DeploymentWhatIf, options?: DeploymentsWhatIfOptionalParams): Promise<WhatIfOperationResult>

パラメーター

resourceGroupName

string

テンプレートがデプロイされるリソース グループの名前。 名前では大文字と小文字が区別されません。

deploymentName

string

デプロイの名前。

parameters
DeploymentWhatIf

検証するパラメーター。

options
DeploymentsWhatIfOptionalParams

オプション パラメーター。

戻り値

beginWhatIfAtManagementGroupScope(string, string, ScopedDeploymentWhatIf, DeploymentsWhatIfAtManagementGroupScopeOptionalParams)

管理グループのスコープで実行された場合にデプロイによって行われる変更を返します。

function beginWhatIfAtManagementGroupScope(groupId: string, deploymentName: string, parameters: ScopedDeploymentWhatIf, options?: DeploymentsWhatIfAtManagementGroupScopeOptionalParams): Promise<PollerLike<PollOperationState<WhatIfOperationResult>, WhatIfOperationResult>>

パラメーター

groupId

string

管理グループ ID。

deploymentName

string

デプロイの名前。

parameters
ScopedDeploymentWhatIf

検証するパラメーター。

options
DeploymentsWhatIfAtManagementGroupScopeOptionalParams

オプション パラメーター。

戻り値

Promise<PollerLike<@azure/core-lro.PollOperationState<WhatIfOperationResult>, WhatIfOperationResult>>

beginWhatIfAtManagementGroupScopeAndWait(string, string, ScopedDeploymentWhatIf, DeploymentsWhatIfAtManagementGroupScopeOptionalParams)

管理グループのスコープで実行された場合にデプロイによって行われる変更を返します。

function beginWhatIfAtManagementGroupScopeAndWait(groupId: string, deploymentName: string, parameters: ScopedDeploymentWhatIf, options?: DeploymentsWhatIfAtManagementGroupScopeOptionalParams): Promise<WhatIfOperationResult>

パラメーター

groupId

string

管理グループ ID。

deploymentName

string

デプロイの名前。

parameters
ScopedDeploymentWhatIf

検証するパラメーター。

options
DeploymentsWhatIfAtManagementGroupScopeOptionalParams

オプション パラメーター。

戻り値

beginWhatIfAtSubscriptionScope(string, DeploymentWhatIf, DeploymentsWhatIfAtSubscriptionScopeOptionalParams)

サブスクリプションのスコープで実行された場合にデプロイによって行われる変更を返します。

function beginWhatIfAtSubscriptionScope(deploymentName: string, parameters: DeploymentWhatIf, options?: DeploymentsWhatIfAtSubscriptionScopeOptionalParams): Promise<PollerLike<PollOperationState<WhatIfOperationResult>, WhatIfOperationResult>>

パラメーター

deploymentName

string

デプロイの名前。

parameters
DeploymentWhatIf

What If のパラメーター。

options
DeploymentsWhatIfAtSubscriptionScopeOptionalParams

オプション パラメーター。

戻り値

Promise<PollerLike<@azure/core-lro.PollOperationState<WhatIfOperationResult>, WhatIfOperationResult>>

beginWhatIfAtSubscriptionScopeAndWait(string, DeploymentWhatIf, DeploymentsWhatIfAtSubscriptionScopeOptionalParams)

サブスクリプションのスコープで実行された場合にデプロイによって行われる変更を返します。

function beginWhatIfAtSubscriptionScopeAndWait(deploymentName: string, parameters: DeploymentWhatIf, options?: DeploymentsWhatIfAtSubscriptionScopeOptionalParams): Promise<WhatIfOperationResult>

パラメーター

deploymentName

string

デプロイの名前。

parameters
DeploymentWhatIf

What If のパラメーター。

options
DeploymentsWhatIfAtSubscriptionScopeOptionalParams

オプション パラメーター。

戻り値

beginWhatIfAtTenantScope(string, ScopedDeploymentWhatIf, DeploymentsWhatIfAtTenantScopeOptionalParams)

テナント グループのスコープで実行された場合にデプロイによって行われる変更を返します。

function beginWhatIfAtTenantScope(deploymentName: string, parameters: ScopedDeploymentWhatIf, options?: DeploymentsWhatIfAtTenantScopeOptionalParams): Promise<PollerLike<PollOperationState<WhatIfOperationResult>, WhatIfOperationResult>>

パラメーター

deploymentName

string

デプロイの名前。

parameters
ScopedDeploymentWhatIf

検証するパラメーター。

options
DeploymentsWhatIfAtTenantScopeOptionalParams

オプション パラメーター。

戻り値

Promise<PollerLike<@azure/core-lro.PollOperationState<WhatIfOperationResult>, WhatIfOperationResult>>

beginWhatIfAtTenantScopeAndWait(string, ScopedDeploymentWhatIf, DeploymentsWhatIfAtTenantScopeOptionalParams)

テナント グループのスコープで実行された場合にデプロイによって行われる変更を返します。

function beginWhatIfAtTenantScopeAndWait(deploymentName: string, parameters: ScopedDeploymentWhatIf, options?: DeploymentsWhatIfAtTenantScopeOptionalParams): Promise<WhatIfOperationResult>

パラメーター

deploymentName

string

デプロイの名前。

parameters
ScopedDeploymentWhatIf

検証するパラメーター。

options
DeploymentsWhatIfAtTenantScopeOptionalParams

オプション パラメーター。

戻り値

calculateTemplateHash(Record<string, unknown>, DeploymentsCalculateTemplateHashOptionalParams)

指定されたテンプレートのハッシュを計算します。

function calculateTemplateHash(template: Record<string, unknown>, options?: DeploymentsCalculateTemplateHashOptionalParams): Promise<TemplateHashResult>

パラメーター

template

Record<string, unknown>

ハッシュを計算するために提供されるテンプレート。

options
DeploymentsCalculateTemplateHashOptionalParams

オプション パラメーター。

戻り値

cancel(string, string, DeploymentsCancelOptionalParams)

provisioningState が Accepted または Running の場合にのみ、デプロイを取り消すことができます。 デプロイが取り消されると、provisioningState が Canceled に設定されます。 テンプレートのデプロイをキャンセルすると、現在実行中のテンプレートのデプロイが停止し、リソース グループが部分的にデプロイされた状態になります。

function cancel(resourceGroupName: string, deploymentName: string, options?: DeploymentsCancelOptionalParams): Promise<void>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前では大文字と小文字が区別されません。

deploymentName

string

デプロイの名前。

options
DeploymentsCancelOptionalParams

オプション パラメーター。

戻り値

Promise<void>

cancelAtManagementGroupScope(string, string, DeploymentsCancelAtManagementGroupScopeOptionalParams)

provisioningState が Accepted または Running の場合にのみ、デプロイを取り消すことができます。 デプロイが取り消されると、provisioningState が Canceled に設定されます。 テンプレートのデプロイをキャンセルすると、現在実行中のテンプレートのデプロイが停止し、リソースが部分的にデプロイされた状態になります。

function cancelAtManagementGroupScope(groupId: string, deploymentName: string, options?: DeploymentsCancelAtManagementGroupScopeOptionalParams): Promise<void>

パラメーター

groupId

string

管理グループ ID。

deploymentName

string

デプロイの名前。

options
DeploymentsCancelAtManagementGroupScopeOptionalParams

オプション パラメーター。

戻り値

Promise<void>

cancelAtScope(string, string, DeploymentsCancelAtScopeOptionalParams)

provisioningState が Accepted または Running の場合にのみ、デプロイを取り消すことができます。 デプロイが取り消されると、provisioningState が Canceled に設定されます。 テンプレートのデプロイをキャンセルすると、現在実行中のテンプレートのデプロイが停止し、リソースが部分的にデプロイされた状態になります。

function cancelAtScope(scope: string, deploymentName: string, options?: DeploymentsCancelAtScopeOptionalParams): Promise<void>

パラメーター

scope

string

リソース スコープ。

deploymentName

string

デプロイの名前。

options
DeploymentsCancelAtScopeOptionalParams

オプション パラメーター。

戻り値

Promise<void>

cancelAtSubscriptionScope(string, DeploymentsCancelAtSubscriptionScopeOptionalParams)

provisioningState が Accepted または Running の場合にのみ、デプロイを取り消すことができます。 デプロイが取り消されると、provisioningState が Canceled に設定されます。 テンプレートのデプロイをキャンセルすると、現在実行中のテンプレートのデプロイが停止し、リソースが部分的にデプロイされた状態になります。

function cancelAtSubscriptionScope(deploymentName: string, options?: DeploymentsCancelAtSubscriptionScopeOptionalParams): Promise<void>

パラメーター

deploymentName

string

デプロイの名前。

options
DeploymentsCancelAtSubscriptionScopeOptionalParams

オプション パラメーター。

戻り値

Promise<void>

cancelAtTenantScope(string, DeploymentsCancelAtTenantScopeOptionalParams)

provisioningState が Accepted または Running の場合にのみ、デプロイを取り消すことができます。 デプロイが取り消されると、provisioningState が Canceled に設定されます。 テンプレートのデプロイをキャンセルすると、現在実行中のテンプレートのデプロイが停止し、リソースが部分的にデプロイされた状態になります。

function cancelAtTenantScope(deploymentName: string, options?: DeploymentsCancelAtTenantScopeOptionalParams): Promise<void>

パラメーター

deploymentName

string

デプロイの名前。

options
DeploymentsCancelAtTenantScopeOptionalParams

オプション パラメーター。

戻り値

Promise<void>

checkExistence(string, string, DeploymentsCheckExistenceOptionalParams)

デプロイが存在するかどうかを確認します。

function checkExistence(resourceGroupName: string, deploymentName: string, options?: DeploymentsCheckExistenceOptionalParams): Promise<DeploymentsCheckExistenceResponse>

パラメーター

resourceGroupName

string

確認するデプロイを含むリソース グループの名前。 名前では大文字と小文字が区別されません。

deploymentName

string

デプロイの名前。

options
DeploymentsCheckExistenceOptionalParams

オプション パラメーター。

戻り値

checkExistenceAtManagementGroupScope(string, string, DeploymentsCheckExistenceAtManagementGroupScopeOptionalParams)

デプロイが存在するかどうかを確認します。

function checkExistenceAtManagementGroupScope(groupId: string, deploymentName: string, options?: DeploymentsCheckExistenceAtManagementGroupScopeOptionalParams): Promise<DeploymentsCheckExistenceAtManagementGroupScopeResponse>

パラメーター

groupId

string

管理グループ ID。

deploymentName

string

デプロイの名前。

options
DeploymentsCheckExistenceAtManagementGroupScopeOptionalParams

オプション パラメーター。

戻り値

checkExistenceAtScope(string, string, DeploymentsCheckExistenceAtScopeOptionalParams)

デプロイが存在するかどうかを確認します。

function checkExistenceAtScope(scope: string, deploymentName: string, options?: DeploymentsCheckExistenceAtScopeOptionalParams): Promise<DeploymentsCheckExistenceAtScopeResponse>

パラメーター

scope

string

リソース スコープ。

deploymentName

string

デプロイの名前。

options
DeploymentsCheckExistenceAtScopeOptionalParams

オプション パラメーター。

戻り値

checkExistenceAtSubscriptionScope(string, DeploymentsCheckExistenceAtSubscriptionScopeOptionalParams)

デプロイが存在するかどうかを確認します。

function checkExistenceAtSubscriptionScope(deploymentName: string, options?: DeploymentsCheckExistenceAtSubscriptionScopeOptionalParams): Promise<DeploymentsCheckExistenceAtSubscriptionScopeResponse>

パラメーター

deploymentName

string

デプロイの名前。

options
DeploymentsCheckExistenceAtSubscriptionScopeOptionalParams

オプション パラメーター。

戻り値

checkExistenceAtTenantScope(string, DeploymentsCheckExistenceAtTenantScopeOptionalParams)

デプロイが存在するかどうかを確認します。

function checkExistenceAtTenantScope(deploymentName: string, options?: DeploymentsCheckExistenceAtTenantScopeOptionalParams): Promise<DeploymentsCheckExistenceAtTenantScopeResponse>

パラメーター

deploymentName

string

デプロイの名前。

options
DeploymentsCheckExistenceAtTenantScopeOptionalParams

オプション パラメーター。

戻り値

exportTemplate(string, string, DeploymentsExportTemplateOptionalParams)

指定したデプロイに使用されるテンプレートをエクスポートします。

function exportTemplate(resourceGroupName: string, deploymentName: string, options?: DeploymentsExportTemplateOptionalParams): Promise<DeploymentExportResult>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前では大文字と小文字が区別されません。

deploymentName

string

デプロイの名前。

options
DeploymentsExportTemplateOptionalParams

オプション パラメーター。

戻り値

exportTemplateAtManagementGroupScope(string, string, DeploymentsExportTemplateAtManagementGroupScopeOptionalParams)

指定したデプロイに使用されるテンプレートをエクスポートします。

function exportTemplateAtManagementGroupScope(groupId: string, deploymentName: string, options?: DeploymentsExportTemplateAtManagementGroupScopeOptionalParams): Promise<DeploymentExportResult>

パラメーター

groupId

string

管理グループ ID。

deploymentName

string

デプロイの名前。

options
DeploymentsExportTemplateAtManagementGroupScopeOptionalParams

オプション パラメーター。

戻り値

exportTemplateAtScope(string, string, DeploymentsExportTemplateAtScopeOptionalParams)

指定したデプロイに使用されるテンプレートをエクスポートします。

function exportTemplateAtScope(scope: string, deploymentName: string, options?: DeploymentsExportTemplateAtScopeOptionalParams): Promise<DeploymentExportResult>

パラメーター

scope

string

リソース スコープ。

deploymentName

string

デプロイの名前。

options
DeploymentsExportTemplateAtScopeOptionalParams

オプション パラメーター。

戻り値

exportTemplateAtSubscriptionScope(string, DeploymentsExportTemplateAtSubscriptionScopeOptionalParams)

指定したデプロイに使用されるテンプレートをエクスポートします。

function exportTemplateAtSubscriptionScope(deploymentName: string, options?: DeploymentsExportTemplateAtSubscriptionScopeOptionalParams): Promise<DeploymentExportResult>

パラメーター

deploymentName

string

デプロイの名前。

options
DeploymentsExportTemplateAtSubscriptionScopeOptionalParams

オプション パラメーター。

戻り値

exportTemplateAtTenantScope(string, DeploymentsExportTemplateAtTenantScopeOptionalParams)

指定したデプロイに使用されるテンプレートをエクスポートします。

function exportTemplateAtTenantScope(deploymentName: string, options?: DeploymentsExportTemplateAtTenantScopeOptionalParams): Promise<DeploymentExportResult>

パラメーター

deploymentName

string

デプロイの名前。

options
DeploymentsExportTemplateAtTenantScopeOptionalParams

オプション パラメーター。

戻り値

get(string, string, DeploymentsGetOptionalParams)

デプロイを取得します。

function get(resourceGroupName: string, deploymentName: string, options?: DeploymentsGetOptionalParams): Promise<DeploymentExtended>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前では大文字と小文字が区別されません。

deploymentName

string

デプロイの名前。

options
DeploymentsGetOptionalParams

オプション パラメーター。

戻り値

getAtManagementGroupScope(string, string, DeploymentsGetAtManagementGroupScopeOptionalParams)

デプロイを取得します。

function getAtManagementGroupScope(groupId: string, deploymentName: string, options?: DeploymentsGetAtManagementGroupScopeOptionalParams): Promise<DeploymentExtended>

パラメーター

groupId

string

管理グループ ID。

deploymentName

string

デプロイの名前。

options
DeploymentsGetAtManagementGroupScopeOptionalParams

オプション パラメーター。

戻り値

getAtScope(string, string, DeploymentsGetAtScopeOptionalParams)

デプロイを取得します。

function getAtScope(scope: string, deploymentName: string, options?: DeploymentsGetAtScopeOptionalParams): Promise<DeploymentExtended>

パラメーター

scope

string

リソース スコープ。

deploymentName

string

デプロイの名前。

options
DeploymentsGetAtScopeOptionalParams

オプション パラメーター。

戻り値

getAtSubscriptionScope(string, DeploymentsGetAtSubscriptionScopeOptionalParams)

デプロイを取得します。

function getAtSubscriptionScope(deploymentName: string, options?: DeploymentsGetAtSubscriptionScopeOptionalParams): Promise<DeploymentExtended>

パラメーター

deploymentName

string

デプロイの名前。

options
DeploymentsGetAtSubscriptionScopeOptionalParams

オプション パラメーター。

戻り値

getAtTenantScope(string, DeploymentsGetAtTenantScopeOptionalParams)

デプロイを取得します。

function getAtTenantScope(deploymentName: string, options?: DeploymentsGetAtTenantScopeOptionalParams): Promise<DeploymentExtended>

パラメーター

deploymentName

string

デプロイの名前。

options
DeploymentsGetAtTenantScopeOptionalParams

オプション パラメーター。

戻り値

listAtManagementGroupScope(string, DeploymentsListAtManagementGroupScopeOptionalParams)

管理グループのすべてのデプロイを取得します。

function listAtManagementGroupScope(groupId: string, options?: DeploymentsListAtManagementGroupScopeOptionalParams): PagedAsyncIterableIterator<DeploymentExtended, DeploymentExtended[], PageSettings>

パラメーター

groupId

string

管理グループ ID。

options
DeploymentsListAtManagementGroupScopeOptionalParams

オプション パラメーター。

戻り値

listAtScope(string, DeploymentsListAtScopeOptionalParams)

特定のスコープですべてのデプロイを取得します。

function listAtScope(scope: string, options?: DeploymentsListAtScopeOptionalParams): PagedAsyncIterableIterator<DeploymentExtended, DeploymentExtended[], PageSettings>

パラメーター

scope

string

リソース スコープ。

options
DeploymentsListAtScopeOptionalParams

オプション パラメーター。

戻り値

listAtSubscriptionScope(DeploymentsListAtSubscriptionScopeOptionalParams)

サブスクリプションのすべてのデプロイを取得します。

function listAtSubscriptionScope(options?: DeploymentsListAtSubscriptionScopeOptionalParams): PagedAsyncIterableIterator<DeploymentExtended, DeploymentExtended[], PageSettings>

パラメーター

options
DeploymentsListAtSubscriptionScopeOptionalParams

オプション パラメーター。

戻り値

listAtTenantScope(DeploymentsListAtTenantScopeOptionalParams)

テナント スコープですべてのデプロイを取得します。

function listAtTenantScope(options?: DeploymentsListAtTenantScopeOptionalParams): PagedAsyncIterableIterator<DeploymentExtended, DeploymentExtended[], PageSettings>

パラメーター

options
DeploymentsListAtTenantScopeOptionalParams

オプション パラメーター。

戻り値

listByResourceGroup(string, DeploymentsListByResourceGroupOptionalParams)

リソース グループのすべてのデプロイを取得します。

function listByResourceGroup(resourceGroupName: string, options?: DeploymentsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DeploymentExtended, DeploymentExtended[], PageSettings>

パラメーター

resourceGroupName

string

取得するデプロイを含むリソース グループの名前。 名前では大文字と小文字が区別されません。

options
DeploymentsListByResourceGroupOptionalParams

オプション パラメーター。

戻り値