次の方法で共有

EntitiesOperations クラス

  • リファレンス

EntitiesOperations 操作。

このクラスを直接インスタンス化しないでください。 代わりに、インスタンス化して属性としてアタッチするクライアント インスタンスを作成する必要があります。

継承
builtins.object
EntitiesOperations

コンストラクター

EntitiesOperations(client, config, serializer, deserializer)

パラメーター

client
必須

サービス要求のクライアント。

config
必須

サービス クライアントの構成。

serializer
必須

オブジェクト モデル シリアライザー。

deserializer
必須

オブジェクト モデル逆シリアライザー。

変数

models

この操作グループで使用されるモデル クラスの別名。

メソッド

list

認証済みユーザーのすべてのエンティティ (管理グループ、サブスクリプションなど) を一覧表示します。

list

認証済みユーザーのすべてのエンティティ (管理グループ、サブスクリプションなど) を一覧表示します。

list(skiptoken: str | None = None, skip: int | None = None, top: int | None = None, select: str | None = None, search: str | '_models.Enum2' | None = None, filter: str | None = None, view: str | '_models.Enum3' | None = None, group_name: str | None = None, cache_control: str | None = 'no-cache', **kwargs: Any) -> Iterable['_models.EntityListResult']

パラメーター

skiptoken
str
既定値: None

ページ継続トークンは、前の操作で部分的な結果が返された場合にのみ使用されます。 前の応答に nextLink 要素が含まれている場合、nextLink 要素の値には、後続の呼び出しに使用する開始点を指定するトークン パラメーターが含まれます。

skip
int
既定値: None

結果を取得するときにスキップするエンティティの数。 これを渡すと、$skipTokenがオーバーライドされます。

top
int
既定値: None

結果を取得するときに返す要素の数。 これを渡すと、$skipTokenがオーバーライドされます。

select
str
既定値: None

このパラメーターは、応答に含めるフィールドを指定します。 Name、DisplayName、Type、ParentDisplayNameChain、ParentChain の任意の組み合わせを含めることができます(例: '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain' など)。 指定した場合、$select パラメーターは、$skipTokenの選択をオーバーライドできます。

search
str または Enum2
既定値: None

$search パラメーターは、渡されたパラメーターに応じて 3 つの異なる出力を返すために、$filter パラメーターと組み合わせて使用されます。 $search=AllowedParents を使用すると、API は、ユーザーのアクセス許可によって決定された、要求されたエンティティが再親できるすべてのグループのエンティティ情報を返します。 $search=AllowedChildren では、API は要求されたエンティティの子として追加できるすべてのエンティティのエンティティ情報を返します。 $search=ParentAndFirstLevelChildren を使用すると、API は、ユーザーが直接アクセスできる子の親レベルと第 1 レベルの子、またはその子孫のいずれかを介した間接アクセスを返します。 $search=ParentOnly では、ユーザーがグループの少なくとも 1 つの子孫にアクセスできる場合、API はグループのみを返します。 $search=ChildrenOnly では、API は、$filterで指定されたグループ エンティティ情報の最初のレベルの子のみを返します。 結果に表示するには、ユーザーが子エンティティまたはその子孫に直接アクセスできる必要があります。

filter
str
既定値: None

filter パラメーターを使用すると、名前フィールドまたは表示名フィールドをフィルター処理できます。 名前フィールド (例: name eq '{entityName}') で等しいかどうかを確認できます。また、名前フィールドまたは表示名フィールド (例: contains(name, '{substringToSearch}'))、 contains(displayName, '{substringToSearch')) の部分文字列を確認できます。 '{entityName}' フィールドと '{substringToSearch}' フィールドは大文字と小文字が区別されずにチェックされることに注意してください。

view
str または Enum3
既定値: None

view パラメーターを使用すると、クライアントは getEntities 呼び出しによって返されるデータの種類をフィルター処理できます。

group_name
str
既定値: None

get エンティティの呼び出しが特定のグループにフォーカスすることを許可するフィルター (つまり、"$filter=name eq 'groupName'")。

cache_control
str
既定値: no-cache

要求がキャッシュを利用する必要があるかどうかを示します。 既存のキャッシュをバイパスするには、ヘッダーに "キャッシュなし" 値を設定します。

cls
callable

直接応答に渡されるカスタム型または関数

戻り値

EntityListResult または cls(response) の結果のインスタンスのような反復子

の戻り値の型 :

ItemPaged[EntityListResult]

例外

HttpResponseError

属性

models 

models = <module 'azure.mgmt.managementgroups.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\managementgroups\\models\\__init__.py'>