Queue class

キューを表すクラス。

コンストラクター

Queue(StorageClientContext)

キューを作成します。

メソッド

create(Models.QueueCreateOptionalParams)

は、指定されたアカウントの下に新しいキューを作成します。

create(QueueCreateOptionalParams, ServiceCallback<void>)
create(ServiceCallback<void>)
deleteMethod(Models.QueueDeleteMethodOptionalParams)

指定したキューを完全に削除する操作

deleteMethod(QueueDeleteMethodOptionalParams, ServiceCallback<void>)
deleteMethod(ServiceCallback<void>)
getAccessPolicy(Models.QueueGetAccessPolicyOptionalParams)

は、Shared Access Signature で使用できるキューで指定された保存されているアクセス ポリシーに関する詳細を返します。

getAccessPolicy(QueueGetAccessPolicyOptionalParams, ServiceCallback<SignedIdentifier[]>)
getAccessPolicy(ServiceCallback<SignedIdentifier[]>)
getProperties(Models.QueueGetPropertiesOptionalParams)

指定したキューのユーザー定義メタデータとキュー プロパティを取得します。 メタデータは、名前と値のペアとしてキューに関連付けられます。

getProperties(QueueGetPropertiesOptionalParams, ServiceCallback<void>)
getProperties(ServiceCallback<void>)
setAccessPolicy(Models.QueueSetAccessPolicyOptionalParams)

は、Shared Access Signature で使用できるキューの格納されたアクセス ポリシーを設定します

setAccessPolicy(QueueSetAccessPolicyOptionalParams, ServiceCallback<void>)
setAccessPolicy(ServiceCallback<void>)
setMetadata(Models.QueueSetMetadataOptionalParams)

は、指定したキューにユーザー定義メタデータを設定します。 メタデータは、名前と値のペアとしてキューに関連付けられます。

setMetadata(QueueSetMetadataOptionalParams, ServiceCallback<void>)
setMetadata(ServiceCallback<void>)

コンストラクターの詳細

Queue(StorageClientContext)

キューを作成します。

new Queue(client: StorageClientContext)

パラメーター

client
StorageClientContext

サービス クライアントへの参照。

メソッドの詳細

create(Models.QueueCreateOptionalParams)

は、指定されたアカウントの下に新しいキューを作成します。

function create(options?: Models.QueueCreateOptionalParams)

パラメーター

options
Models.QueueCreateOptionalParams

戻り値

Promise<Models.QueueCreateResponse>

Promise<Models.QueueCreateResponse応答>

create(QueueCreateOptionalParams, ServiceCallback<void>)

function create(options: QueueCreateOptionalParams, callback: ServiceCallback<void>)

パラメーター

options
QueueCreateOptionalParams

省略可能なパラメーター

callback

ServiceCallback<void>

コールバック

create(ServiceCallback<void>)

function create(callback: ServiceCallback<void>)

パラメーター

callback

ServiceCallback<void>

コールバック

deleteMethod(Models.QueueDeleteMethodOptionalParams)

指定したキューを完全に削除する操作

function deleteMethod(options?: Models.QueueDeleteMethodOptionalParams)

パラメーター

options
Models.QueueDeleteMethodOptionalParams

戻り値

Promise<Models.QueueDeleteResponse>

Promise<Models.QueueDeleteResponse応答>

deleteMethod(QueueDeleteMethodOptionalParams, ServiceCallback<void>)

function deleteMethod(options: QueueDeleteMethodOptionalParams, callback: ServiceCallback<void>)

パラメーター

options
QueueDeleteMethodOptionalParams

省略可能なパラメーター

callback

ServiceCallback<void>

コールバック

deleteMethod(ServiceCallback<void>)

function deleteMethod(callback: ServiceCallback<void>)

パラメーター

callback

ServiceCallback<void>

コールバック

getAccessPolicy(Models.QueueGetAccessPolicyOptionalParams)

は、Shared Access Signature で使用できるキューで指定された保存されているアクセス ポリシーに関する詳細を返します。

function getAccessPolicy(options?: Models.QueueGetAccessPolicyOptionalParams)

パラメーター

options
Models.QueueGetAccessPolicyOptionalParams

戻り値

Promise<Models.QueueGetAccessPolicyResponse>

Promise<Models.QueueGetAccessPolicyResponse応答>

getAccessPolicy(QueueGetAccessPolicyOptionalParams, ServiceCallback<SignedIdentifier[]>)

function getAccessPolicy(options: QueueGetAccessPolicyOptionalParams, callback: ServiceCallback<SignedIdentifier[]>)

パラメーター

options
QueueGetAccessPolicyOptionalParams

省略可能なパラメーター

callback

ServiceCallback<SignedIdentifier[]>

コールバック

getAccessPolicy(ServiceCallback<SignedIdentifier[]>)

function getAccessPolicy(callback: ServiceCallback<SignedIdentifier[]>)

パラメーター

callback

ServiceCallback<SignedIdentifier[]>

コールバック

getProperties(Models.QueueGetPropertiesOptionalParams)

指定したキューのユーザー定義メタデータとキュー プロパティを取得します。 メタデータは、名前と値のペアとしてキューに関連付けられます。

function getProperties(options?: Models.QueueGetPropertiesOptionalParams)

パラメーター

options
Models.QueueGetPropertiesOptionalParams

戻り値

Promise<Models.QueueGetPropertiesResponse>

Promise<Models.QueueGetPropertiesレスポンス>

getProperties(QueueGetPropertiesOptionalParams, ServiceCallback<void>)

function getProperties(options: QueueGetPropertiesOptionalParams, callback: ServiceCallback<void>)

パラメーター

options
QueueGetPropertiesOptionalParams

省略可能なパラメーター

callback

ServiceCallback<void>

コールバック

getProperties(ServiceCallback<void>)

function getProperties(callback: ServiceCallback<void>)

パラメーター

callback

ServiceCallback<void>

コールバック

setAccessPolicy(Models.QueueSetAccessPolicyOptionalParams)

は、Shared Access Signature で使用できるキューの格納されたアクセス ポリシーを設定します

function setAccessPolicy(options?: Models.QueueSetAccessPolicyOptionalParams)

パラメーター

options
Models.QueueSetAccessPolicyOptionalParams

戻り値

Promise<Models.QueueSetAccessPolicyResponse>

Promise<Models.QueueSetAccessPolicyResponse応答>

setAccessPolicy(QueueSetAccessPolicyOptionalParams, ServiceCallback<void>)

function setAccessPolicy(options: QueueSetAccessPolicyOptionalParams, callback: ServiceCallback<void>)

パラメーター

options
QueueSetAccessPolicyOptionalParams

省略可能なパラメーター

callback

ServiceCallback<void>

コールバック

setAccessPolicy(ServiceCallback<void>)

function setAccessPolicy(callback: ServiceCallback<void>)

パラメーター

callback

ServiceCallback<void>

コールバック

setMetadata(Models.QueueSetMetadataOptionalParams)

は、指定したキューにユーザー定義メタデータを設定します。 メタデータは、名前と値のペアとしてキューに関連付けられます。

function setMetadata(options?: Models.QueueSetMetadataOptionalParams)

パラメーター

options
Models.QueueSetMetadataOptionalParams

戻り値

Promise<Models.QueueSetMetadataResponse>

Promise<Models.QueueSetMetadataResponseです。>

setMetadata(QueueSetMetadataOptionalParams, ServiceCallback<void>)

function setMetadata(options: QueueSetMetadataOptionalParams, callback: ServiceCallback<void>)

パラメーター

options
QueueSetMetadataOptionalParams

省略可能なパラメーター

callback

ServiceCallback<void>

コールバック

setMetadata(ServiceCallback<void>)

function setMetadata(callback: ServiceCallback<void>)

パラメーター

callback

ServiceCallback<void>

コールバック