CIAM Tenants - List By Resource Group

Referencia

Szolgáltatás:: Azure AD B2C

API-verzió:: 2023-05-17-preview

Szerezze be az összes Azure AD-t az ügyfelek bérlői számára egy erőforráscsoportban.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/ciamDirectories?api-version=2023-05-17-preview

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés azonosítója minden szolgáltatáshíváshoz az URI részét képezi.
api-version	query	True	string	Az ügyfélkéréshez használandó API verziója.

Válaszok

Name	Típus	Description
200 OK	CIAMTenantResourceList	Az Azure AD az erőforráscsoportban lévő ügyfelek bérlőinek listája sikeresen lekért.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

CIAMTenants_ListByResourceGroup

Mintakérelem

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/ciamDirectories?api-version=2023-05-17-preview

Mintaválasz

Állapotkód:: 200

{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/ciamDirectories/contoso",
      "name": "contoso",
      "type": "Microsoft.AzureActiveDirectory/ciamDirectories",
      "location": "United States",
      "sku": {
        "name": "Standard",
        "tier": "A0"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "createTenantProperties": {
          "displayName": "Contoso",
          "countryCode": "US"
        },
        "billingConfig": {
          "billingType": "MAU",
          "effectiveStartDateUtc": "1/1/0001 12:00:00 AM"
        },
        "domainName": "contoso.onmicrosoft.com",
        "tenantId": "00000000-0000-0000-0000-000000000000"
      },
      "tags": null,
      "systemData": {
        "createdBy": "contosoAdmin@onmicrosoft.com",
        "createdByType": "User",
        "createdAt": "2020-02-03T01:01:01.1075056Z",
        "lastModifiedBy": "contosoAdmin@onmicrosoft.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-02-04T01:01:01.1075056Z"
      }
    }
  ],
  "nextLink": null
}

Definíciók

Name	Description
ciamBillingType	A számlázás típusa. Minden új ügyfél számára MAU lesz. Nem módosítható, ha az érték "MAU". További információ az Azure AD-ről az ügyfelek számára történő számlázásról a aka.ms/b2cBilling.
CIAMResourceSKU	Az Azure AD ügyfélbérlmének termékváltozat-tulajdonságai. További információ az Azure AD-ről az ügyfeleknek történő számlázásról a https://aka.ms/ciambilling.
CIAMResourceSKUName	A bérlő termékváltozatának neve.
CIAMResourceSKUTier	A bérlő szintje.
CIAMTenantResource	Az Azure AD for customers erőforrás.
CIAMTenantResourceList	Az Azure AD az ügyfelek bérlői erőforrásainak gyűjteménye
ciamTypeValue	Az Azure AD for customers bérlői erőforrásának típusa.
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
ProvisioningState	Kiépítési állapot
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

ciamBillingType

Enumerálás

A számlázás típusa. Minden új ügyfél számára MAU lesz. Nem módosítható, ha az érték "MAU". További információ az Azure AD-ről az ügyfelek számára történő számlázásról a aka.ms/b2cBilling.

Érték	Description
MAU	Az Azure AD az ügyfelek számára való használatért egy társított Azure-előfizetéshez tartozik, és havi aktív felhasználói (MAU) számlázási modellt használ.

CIAMResourceSKU

Objektum

Az Azure AD ügyfélbérlmének termékváltozat-tulajdonságai. További információ az Azure AD-ről az ügyfeleknek történő számlázásról a https://aka.ms/ciambilling.

Name	Típus	Description
name	CIAMResourceSKUName	A bérlő termékváltozatának neve.
tier	CIAMResourceSKUTier	A bérlő szintje.

CIAMResourceSKUName

Enumerálás

A bérlő termékváltozatának neve.

Érték	Description
PremiumP1
PremiumP2
Standard

CIAMResourceSKUTier

Enumerálás

A bérlő szintje.

Érték	Description
A0	Az összes Azure AD-hez használt termékváltozat-szint az ügyfelek bérlői számára.

CIAMTenantResource

Objektum

Az Azure AD for customers erőforrás.

Name	Típus	Description
id	string	Az Azure AD ügyfél-bérlői erőforrását jelképező azonosító.
location	string	Az erőforrás helyének és az adatoknak a helye. Lehet az "Egyesült Államok", "Európa", "Ázsia csendes-óceáni" vagy "Ausztrália". További információért tekintse meg a dokumentáció .
name	string	Az Azure AD az ügyfelek bérlői erőforrásának neve.
properties.billingConfig.billingType	ciamBillingType	A számlázás típusa. Minden új ügyfél számára MAU lesz. Nem módosítható, ha az érték "MAU". További információ az Azure AD-ről az ügyfelek számára történő számlázásról a aka.ms/b2cBilling.
properties.billingConfig.effectiveStartDateUtc	string	Azok az adatok, amelyekből a számlázási típus érvénybe lépett
properties.createTenantProperties.countryCode	string	Az Azure-bérlő országkódja (pl. "USA"). Az érvényes országkódok és a megfelelő adattárolási helyek megtekintéséhez tekintse meg az https://aka.ms/ciam-data-location. Ha nem lát országkódot érvényes adattárolási helyen, válasszon egyet a listából.
properties.createTenantProperties.displayName	string	Az Azure AD ügyfélbérlésének megjelenítendő neve.
properties.domainName	string	A bérlő tartományneve
properties.provisioningState	ProvisioningState	Kiépítési állapot
properties.tenantId	string	Az Azure AD ügyfélbérlésének azonosítója.
sku	CIAMResourceSKU	Az Azure AD ügyfélbérlmének termékváltozat-tulajdonságai. További információ az Azure AD-ről az ügyfeleknek történő számlázásról a https://aka.ms/ciambilling.
systemData	systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
tags	object	Erőforráscímkék
type	ciamTypeValue	Az Azure AD for customers bérlői erőforrásának típusa.

CIAMTenantResourceList

Objektum

Az Azure AD az ügyfelek bérlői erőforrásainak gyűjteménye

Name	Típus	Description
nextLink	string	Az Azure AD következő készletének lekérésére szolgáló URL-cím az ügyfelek bérlői erőforrásaihoz.
value	CIAMTenantResource[]	Az Azure AD az ügyfelek bérlői erőforrásainak listája

ciamTypeValue

Enumerálás

Az Azure AD for customers bérlői erőforrásának típusa.

Érték	Description
Microsoft.AzureActiveDirectory/ciamDirectories	Az Azure AD ügyfél-bérlői erőforrásának erőforrástípusa.

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

ProvisioningState

Enumerálás

Kiépítési állapot

Érték	Description
Canceled
Deleted
Deleting
Failed
Provisioning
Succeeded

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

Megosztás a következőn keresztül:

CIAM Tenants - List By Resource Group

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

CIAMTenants_ListByResourceGroup

Mintakérelem

Mintaválasz

Definíciók

ciamBillingType

CIAMResourceSKU

CIAMResourceSKUName

CIAMResourceSKUTier

CIAMTenantResource

CIAMTenantResourceList

ciamTypeValue

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ProvisioningState

systemData