QueueServiceClient クラス

このメソッドは、クライアントによって開かれたソケットを閉じる方法です。 コンテキスト マネージャーで を使用する場合は使用する必要はありません。

close()

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

同じ名前のキューが既に存在する場合、操作は失敗します。 新しく作成されたキューと対話するクライアントを返します。

create_queue(name: str, metadata: Dict[str, str] | None = None, **kwargs: Any) -> QueueClient

パラメーター

戻り値

新しく作成された Queue の QueueClient。

の戻り値の型 :

例

サービスにキューを作成します。

   queue_service.create_queue("myqueue1")

指定したキューとそのキューに含まれるすべてのメッセージを削除します。

キューが正常に削除されると、キューはすぐに削除対象としてマークされ、クライアントからアクセスできなくなります。 このキューは、後でガベージ コレクション中にキュー サービスから削除されます。

キューの削除が完了するまでに少なくとも 40 秒かかる可能性があることに注意してください。 削除中にキューに対して操作が試行されると、 <xref:azure.storage.queue.HttpResponseError> がスローされます。

delete_queue(queue: QueueProperties | str, **kwargs: Any) -> None

パラメーター

の戻り値の型 :

例

サービス内のキューを削除します。

   queue_service.delete_queue("myqueue1")

接続文字列から QueueServiceClient を作成します。

from_connection_string(conn_str: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

パラメーター

戻り値

キュー サービス クライアント。

の戻り値の型 :

例

接続文字列を使用した QueueServiceClient の作成。

   from azure.storage.queue import QueueServiceClient
   queue_service = QueueServiceClient.from_connection_string(conn_str=self.connection_string)

指定したキューと対話するクライアントを取得します。

キューがまだ存在している必要はありません。

get_queue_client(queue: QueueProperties | str, **kwargs: Any) -> QueueClient

パラメーター

戻り値

QueueClient オブジェクト。

の戻り値の型 :

例

キュー クライアントを取得します。

   # Get the queue client to interact with a specific queue
   queue = queue_service.get_queue_client(queue="myqueue2")

Azure Storage Analyticsを含むストレージ アカウントの Queue サービスのプロパティを取得します。

get_service_properties(**kwargs: Any) -> Dict[str, Any]

パラメーター

戻り値

分析ログ、時間/分のメトリック、cors ルールなど、キュー サービスのプロパティを含むオブジェクト。

の戻り値の型 :

例

キュー サービスのプロパティの取得。

   properties = queue_service.get_service_properties()

キュー サービスのレプリケーションに関連する統計情報を取得します。

これは、ストレージ アカウントに対して読み取りアクセス geo 冗長レプリケーションが有効になっている場合にのみ使用できます。

地理冗長レプリケーションでは、Azure ストレージによって 2 か所でデータの持続性が維持されます。 両方の場所で、Azure ストレージは継続的にデータの複数の正常なレプリカを維持します。 データの読み取り、作成、更新、または削除を行う場所は、1 次ストレージ アカウント拠点です。 プライマリの場所は、Azure Management Azure クラシック ポータル (米国中北部など) を使用してアカウントを作成するときに選択したリージョンに存在します。 データのレプリケート先の場所が、2 次拠点です。 2 次拠点は 1 次拠点の場所に基づいて自動的に決められ、1 次拠点と同じ地域にある 2 つ目のデータ センター内に設定されます。 読み取りアクセスの地理冗長レプリケーションがストレージ アカウントで有効な場合は、2 次拠点から読み取り専用アクセスを使用できます。

get_service_stats(**kwargs: Any) -> Dict[str, Any]

パラメーター

戻り値

Queue サービスの統計情報です。

の戻り値の型 :

指定したアカウントのキューを一覧表示するジェネレーターを返します。

ジェネレーターは、サービスによって返された継続トークンに遅れて従い、すべてのキューが返されたときに停止します。

list_queues(name_starts_with: str | None = None, include_metadata: bool | None = False, **kwargs: Any) -> ItemPaged[QueueProperties]

パラメーター

戻り値

QueueProperties の iterable (自動ページング) です。

の戻り値の型 :

例

サービス内のキューを一覧表示します。

   # List all the queues in the service
   list_queues = queue_service.list_queues()
   for queue in list_queues:
       print(queue)

   # List the queues in the service that start with the name "my"
   list_my_queues = queue_service.list_queues(name_starts_with="my")
   for queue in list_my_queues:
       print(queue)

Azure Storage Analyticsを含むストレージ アカウントの Queue サービスのプロパティを設定します。

要素 (analytics_logging など) が None のままの場合、その機能に対するサービスの既存の設定は保持されます。

set_service_properties(analytics_logging: QueueAnalyticsLogging | None = None, hour_metrics: Metrics | None = None, minute_metrics: Metrics | None = None, cors: List[CorsRule] | None = None, **kwargs: Any) -> None

パラメーター

例

キュー サービスのプロパティの設定。

   # Create service properties
   from azure.storage.queue import QueueAnalyticsLogging, Metrics, CorsRule, RetentionPolicy

   # Create logging settings
   logging = QueueAnalyticsLogging(read=True, write=True, delete=True, retention_policy=RetentionPolicy(enabled=True, days=5))

   # Create metrics for requests statistics
   hour_metrics = Metrics(enabled=True, include_apis=True, retention_policy=RetentionPolicy(enabled=True, days=5))
   minute_metrics = Metrics(enabled=True, include_apis=True, retention_policy=RetentionPolicy(enabled=True, days=5))

   # Create CORS rules
   cors_rule1 = CorsRule(['www.xyz.com'], ['GET'])
   allowed_origins = ['www.xyz.com', "www.ab.com", "www.bc.com"]
   allowed_methods = ['GET', 'PUT']
   max_age_in_seconds = 500
   exposed_headers = ["x-ms-meta-data*", "x-ms-meta-source*", "x-ms-meta-abc", "x-ms-meta-bcd"]
   allowed_headers = ["x-ms-meta-data*", "x-ms-meta-target*", "x-ms-meta-xyz", "x-ms-meta-foo"]
   cors_rule2 = CorsRule(
       allowed_origins,
       allowed_methods,
       max_age_in_seconds=max_age_in_seconds,
       exposed_headers=exposed_headers,
       allowed_headers=allowed_headers
   )

   cors = [cors_rule1, cors_rule2]

   # Set the service properties
   queue_service.set_service_properties(logging, hour_metrics, minute_metrics, cors)

要求に使用される Storage API のバージョン。

の戻り値の型 :

クライアントが現在使用している場所モード。

既定では、これは "プライマリ" になります。 オプションには、"primary" と "secondary" が含まれます。

の戻り値の型 :

完全なプライマリ エンドポイント URL。

の戻り値の型 :

プライマリ エンドポイントのホスト名。

の戻り値の型 :

完全なセカンダリ エンドポイント URL (構成されている場合)。

使用できない場合は、ValueError が発生します。 セカンダリ ホスト名を明示的に指定するには、インスタンス化時に省略可能な secondary_hostname キーワード (keyword) 引数を使用します。

の戻り値の型 :

例外

セカンダリ エンドポイントのホスト名。

使用できない場合、これは None になります。 セカンダリ ホスト名を明示的に指定するには、インスタンス化時に省略可能な secondary_hostname キーワード (keyword) 引数を使用します。

の戻り値の型 :

SAS トークン (使用されている場合) を含む、このエンティティへの完全なエンドポイント URL。

これは、現在 location_modeの に応じて、プライマリ エンドポイントまたはセカンダリ エンドポイントのいずれかになります。 :returns: SAS トークン (使用されている場合) を含む、このエンティティへの完全なエンドポイント URL。 :rtype: str