Registries interface
レジストリを表すインターフェイス。
メソッド
メソッドの詳細
beginCreate(string, string, Registry, RegistriesCreateOptionalParams)
指定したパラメーターを使用してコンテナー レジストリを作成します。
function beginCreate(resourceGroupName: string, registryName: string, registry: Registry, options?: RegistriesCreateOptionalParams): Promise<SimplePollerLike<OperationState<Registry>, Registry>>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- registryName
-
string
コンテナー レジストリの名前。
- registry
- Registry
コンテナー レジストリを作成するためのパラメーター。
- options
- RegistriesCreateOptionalParams
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<Registry>, Registry>>
beginCreateAndWait(string, string, Registry, RegistriesCreateOptionalParams)
指定したパラメーターを使用してコンテナー レジストリを作成します。
function beginCreateAndWait(resourceGroupName: string, registryName: string, registry: Registry, options?: RegistriesCreateOptionalParams): Promise<Registry>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- registryName
-
string
コンテナー レジストリの名前。
- registry
- Registry
コンテナー レジストリを作成するためのパラメーター。
- options
- RegistriesCreateOptionalParams
オプション パラメーター。
戻り値
Promise<Registry>
beginDelete(string, string, RegistriesDeleteOptionalParams)
コンテナー レジストリを削除します。
function beginDelete(resourceGroupName: string, registryName: string, options?: RegistriesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- registryName
-
string
コンテナー レジストリの名前。
- options
- RegistriesDeleteOptionalParams
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, RegistriesDeleteOptionalParams)
コンテナー レジストリを削除します。
function beginDeleteAndWait(resourceGroupName: string, registryName: string, options?: RegistriesDeleteOptionalParams): Promise<void>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- registryName
-
string
コンテナー レジストリの名前。
- options
- RegistriesDeleteOptionalParams
オプション パラメーター。
戻り値
Promise<void>
beginGenerateCredentials(string, string, GenerateCredentialsParameters, RegistriesGenerateCredentialsOptionalParams)
指定したコンテナー レジストリのトークンのキーを生成します。
function beginGenerateCredentials(resourceGroupName: string, registryName: string, generateCredentialsParameters: GenerateCredentialsParameters, options?: RegistriesGenerateCredentialsOptionalParams): Promise<SimplePollerLike<OperationState<GenerateCredentialsResult>, GenerateCredentialsResult>>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- registryName
-
string
コンテナー レジストリの名前。
- generateCredentialsParameters
- GenerateCredentialsParameters
資格情報を生成するためのパラメーター。
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<GenerateCredentialsResult>, GenerateCredentialsResult>>
beginGenerateCredentialsAndWait(string, string, GenerateCredentialsParameters, RegistriesGenerateCredentialsOptionalParams)
指定したコンテナー レジストリのトークンのキーを生成します。
function beginGenerateCredentialsAndWait(resourceGroupName: string, registryName: string, generateCredentialsParameters: GenerateCredentialsParameters, options?: RegistriesGenerateCredentialsOptionalParams): Promise<GenerateCredentialsResult>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- registryName
-
string
コンテナー レジストリの名前。
- generateCredentialsParameters
- GenerateCredentialsParameters
資格情報を生成するためのパラメーター。
オプション パラメーター。
戻り値
Promise<GenerateCredentialsResult>
beginImportImage(string, string, ImportImageParameters, RegistriesImportImageOptionalParams)
指定したコンテナー レジストリからこのコンテナー レジストリにイメージをコピーします。
function beginImportImage(resourceGroupName: string, registryName: string, parameters: ImportImageParameters, options?: RegistriesImportImageOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- registryName
-
string
コンテナー レジストリの名前。
- parameters
- ImportImageParameters
コピーするイメージとソース コンテナー レジストリを指定するパラメーター。
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginImportImageAndWait(string, string, ImportImageParameters, RegistriesImportImageOptionalParams)
指定したコンテナー レジストリからこのコンテナー レジストリにイメージをコピーします。
function beginImportImageAndWait(resourceGroupName: string, registryName: string, parameters: ImportImageParameters, options?: RegistriesImportImageOptionalParams): Promise<void>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- registryName
-
string
コンテナー レジストリの名前。
- parameters
- ImportImageParameters
コピーするイメージとソース コンテナー レジストリを指定するパラメーター。
オプション パラメーター。
戻り値
Promise<void>
beginScheduleRun(string, string, RunRequestUnion, RegistriesScheduleRunOptionalParams)
要求パラメーターに基づいて新しい実行をスケジュールし、実行キューに追加します。
function beginScheduleRun(resourceGroupName: string, registryName: string, runRequest: RunRequestUnion, options?: RegistriesScheduleRunOptionalParams): Promise<SimplePollerLike<OperationState<Run>, Run>>
パラメーター
- resourceGroupName
-
string
コンテナー レジストリが属するリソース グループの名前。
- registryName
-
string
コンテナー レジストリの名前。
- runRequest
- RunRequestUnion
スケジュールする必要がある実行のパラメーター。
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<Run>, Run>>
beginScheduleRunAndWait(string, string, RunRequestUnion, RegistriesScheduleRunOptionalParams)
要求パラメーターに基づいて新しい実行をスケジュールし、実行キューに追加します。
function beginScheduleRunAndWait(resourceGroupName: string, registryName: string, runRequest: RunRequestUnion, options?: RegistriesScheduleRunOptionalParams): Promise<Run>
パラメーター
- resourceGroupName
-
string
コンテナー レジストリが属するリソース グループの名前。
- registryName
-
string
コンテナー レジストリの名前。
- runRequest
- RunRequestUnion
スケジュールする必要がある実行のパラメーター。
オプション パラメーター。
戻り値
Promise<Run>
beginUpdate(string, string, RegistryUpdateParameters, RegistriesUpdateOptionalParams)
指定されたパラメーターを使用してコンテナー レジストリを更新します。
function beginUpdate(resourceGroupName: string, registryName: string, registryUpdateParameters: RegistryUpdateParameters, options?: RegistriesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Registry>, Registry>>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- registryName
-
string
コンテナー レジストリの名前。
- registryUpdateParameters
- RegistryUpdateParameters
コンテナー レジストリを更新するためのパラメーター。
- options
- RegistriesUpdateOptionalParams
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<Registry>, Registry>>
beginUpdateAndWait(string, string, RegistryUpdateParameters, RegistriesUpdateOptionalParams)
指定されたパラメーターを使用してコンテナー レジストリを更新します。
function beginUpdateAndWait(resourceGroupName: string, registryName: string, registryUpdateParameters: RegistryUpdateParameters, options?: RegistriesUpdateOptionalParams): Promise<Registry>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- registryName
-
string
コンテナー レジストリの名前。
- registryUpdateParameters
- RegistryUpdateParameters
コンテナー レジストリを更新するためのパラメーター。
- options
- RegistriesUpdateOptionalParams
オプション パラメーター。
戻り値
Promise<Registry>
checkNameAvailability(RegistryNameCheckRequest, RegistriesCheckNameAvailabilityOptionalParams)
コンテナー レジストリ名を使用できるかどうかを確認します。 名前には英数字のみを含める必要があり、グローバルに一意で、長さは 5 ~ 50 文字にする必要があります。
function checkNameAvailability(registryNameCheckRequest: RegistryNameCheckRequest, options?: RegistriesCheckNameAvailabilityOptionalParams): Promise<RegistryNameStatus>
パラメーター
- registryNameCheckRequest
- RegistryNameCheckRequest
要求本文
オプション パラメーター。
戻り値
Promise<RegistryNameStatus>
get(string, string, RegistriesGetOptionalParams)
指定したコンテナー レジストリのプロパティを取得します。
function get(resourceGroupName: string, registryName: string, options?: RegistriesGetOptionalParams): Promise<Registry>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- registryName
-
string
コンテナー レジストリの名前。
- options
- RegistriesGetOptionalParams
オプション パラメーター。
戻り値
Promise<Registry>
getBuildSourceUploadUrl(string, string, RegistriesGetBuildSourceUploadUrlOptionalParams)
ユーザーがソースをアップロードできるアップロード場所を取得します。
function getBuildSourceUploadUrl(resourceGroupName: string, registryName: string, options?: RegistriesGetBuildSourceUploadUrlOptionalParams): Promise<SourceUploadDefinition>
パラメーター
- resourceGroupName
-
string
コンテナー レジストリが属するリソース グループの名前。
- registryName
-
string
コンテナー レジストリの名前。
オプション パラメーター。
戻り値
Promise<SourceUploadDefinition>
getPrivateLinkResource(string, string, string, RegistriesGetPrivateLinkResourceOptionalParams)
コンテナー レジストリの指定したグループ名でプライベート リンク リソースを取得します。
function getPrivateLinkResource(resourceGroupName: string, registryName: string, groupName: string, options?: RegistriesGetPrivateLinkResourceOptionalParams): Promise<PrivateLinkResource>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- registryName
-
string
コンテナー レジストリの名前。
- groupName
-
string
Azure リソースに関連付けられているプライベート リンクの名前。
オプション パラメーター。
戻り値
Promise<PrivateLinkResource>
list(RegistriesListOptionalParams)
指定したサブスクリプションのすべてのコンテナー レジストリを一覧表示します。
function list(options?: RegistriesListOptionalParams): PagedAsyncIterableIterator<Registry, Registry[], PageSettings>
パラメーター
- options
- RegistriesListOptionalParams
オプション パラメーター。
戻り値
listByResourceGroup(string, RegistriesListByResourceGroupOptionalParams)
指定したリソース グループのすべてのコンテナー レジストリを一覧表示します。
function listByResourceGroup(resourceGroupName: string, options?: RegistriesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Registry, Registry[], PageSettings>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
オプション パラメーター。
戻り値
listCredentials(string, string, RegistriesListCredentialsOptionalParams)
指定したコンテナー レジストリのログイン資格情報を一覧表示します。
function listCredentials(resourceGroupName: string, registryName: string, options?: RegistriesListCredentialsOptionalParams): Promise<RegistryListCredentialsResult>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- registryName
-
string
コンテナー レジストリの名前。
オプション パラメーター。
戻り値
Promise<RegistryListCredentialsResult>
listPrivateLinkResources(string, string, RegistriesListPrivateLinkResourcesOptionalParams)
コンテナー レジストリのプライベート リンク リソースを一覧表示します。
function listPrivateLinkResources(resourceGroupName: string, registryName: string, options?: RegistriesListPrivateLinkResourcesOptionalParams): PagedAsyncIterableIterator<PrivateLinkResource, PrivateLinkResource[], PageSettings>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- registryName
-
string
コンテナー レジストリの名前。
オプション パラメーター。
戻り値
listUsages(string, string, RegistriesListUsagesOptionalParams)
指定したコンテナー レジストリのクォータ使用量を取得します。
function listUsages(resourceGroupName: string, registryName: string, options?: RegistriesListUsagesOptionalParams): Promise<RegistryUsageListResult>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- registryName
-
string
コンテナー レジストリの名前。
オプション パラメーター。
戻り値
Promise<RegistryUsageListResult>
regenerateCredential(string, string, RegenerateCredentialParameters, RegistriesRegenerateCredentialOptionalParams)
指定したコンテナー レジストリのログイン資格情報のいずれかを再生成します。
function regenerateCredential(resourceGroupName: string, registryName: string, regenerateCredentialParameters: RegenerateCredentialParameters, options?: RegistriesRegenerateCredentialOptionalParams): Promise<RegistryListCredentialsResult>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- registryName
-
string
コンテナー レジストリの名前。
- regenerateCredentialParameters
- RegenerateCredentialParameters
再生成する必要があるパスワードの名前 (パスワードまたはパスワード 2) を指定します。
オプション パラメーター。
戻り値
Promise<RegistryListCredentialsResult>