Organization - List By Subscription

Service:

Confluent

API Version:

2024-02-13

A megadott előfizetéshez tartozó összes szervezet listázása.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Confluent/organizations?api-version=2024-02-13

URI-paraméterek

Name	In	Kötelező	Típus	Description
subscriptionId	path	True	string	Microsoft Azure-előfizetés azonosítója
api-version	query	True	string	Client API-verzió.

Válaszok

Name	Típus	Description
200 OK	OrganizationResourceListResult	Siker
Other Status Codes	ResourceProviderDefaultErrorResponse	Alapértelmezett hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Példák

Organization_ListBySubscription

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Confluent/organizations?api-version=2024-02-13

Java

/**
 * Samples for Organization List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/confluent/resource-manager/Microsoft.Confluent/stable/2024-02-13/examples/
     * Organization_ListBySubscription.json
     */
    /**
     * Sample code: Organization_ListBySubscription.
     * 
     * @param manager Entry point to ConfluentManager.
     */
    public static void organizationListBySubscription(com.azure.resourcemanager.confluent.ConfluentManager manager) {
        manager.organizations().list(com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.confluent import ConfluentManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-confluent
# USAGE
    python organization_list_by_subscription.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ConfluentManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.organization.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/confluent/resource-manager/Microsoft.Confluent/stable/2024-02-13/examples/Organization_ListBySubscription.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armconfluent_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/confluent/armconfluent"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/confluent/resource-manager/Microsoft.Confluent/stable/2024-02-13/examples/Organization_ListBySubscription.json
func ExampleOrganizationClient_NewListBySubscriptionPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armconfluent.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewOrganizationClient().NewListBySubscriptionPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.OrganizationResourceListResult = armconfluent.OrganizationResourceListResult{
		// 	Value: []*armconfluent.OrganizationResource{
		// 		{
		// 			Name: to.Ptr("myOrganizations"),
		// 			Type: to.Ptr("Microsoft.Confluent/organizations"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganizations"),
		// 			Location: to.Ptr("West US"),
		// 			Properties: &armconfluent.OrganizationResourceProperties{
		// 				CreatedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-05-09T14:28:47.284Z"); return t}()),
		// 				OfferDetail: &armconfluent.OfferDetail{
		// 					ID: to.Ptr("string"),
		// 					PlanID: to.Ptr("string"),
		// 					PlanName: to.Ptr("string"),
		// 					PrivateOfferID: to.Ptr("string"),
		// 					PrivateOfferIDs: []*string{
		// 						to.Ptr("string")},
		// 						PublisherID: to.Ptr("string"),
		// 						Status: to.Ptr(armconfluent.SaaSOfferStatusStarted),
		// 						TermUnit: to.Ptr("string"),
		// 					},
		// 					OrganizationID: to.Ptr("string"),
		// 					ProvisioningState: to.Ptr(armconfluent.ProvisionStateSucceeded),
		// 					SsoURL: to.Ptr("string"),
		// 					UserDetail: &armconfluent.UserDetail{
		// 						AADEmail: to.Ptr("contoso@microsoft.com"),
		// 						EmailAddress: to.Ptr("contoso@microsoft.com"),
		// 						FirstName: to.Ptr("string"),
		// 						LastName: to.Ptr("string"),
		// 						UserPrincipalName: to.Ptr("contoso@microsoft.com"),
		// 					},
		// 				},
		// 				Tags: map[string]*string{
		// 					"Environment": to.Ptr("Dev"),
		// 				},
		// 		}},
		// 	}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ConfluentManagementClient } = require("@azure/arm-confluent");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List all organizations under the specified subscription.
 *
 * @summary List all organizations under the specified subscription.
 * x-ms-original-file: specification/confluent/resource-manager/Microsoft.Confluent/stable/2024-02-13/examples/Organization_ListBySubscription.json
 */
async function organizationListBySubscription() {
  const subscriptionId =
    process.env["CONFLUENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new ConfluentManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.organization.listBySubscription()) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Confluent;
using Azure.ResourceManager.Confluent.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/confluent/resource-manager/Microsoft.Confluent/stable/2024-02-13/examples/Organization_ListBySubscription.json
// this example is just showing the usage of "Organization_ListBySubscription" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (ConfluentOrganizationResource item in subscriptionResource.GetConfluentOrganizationsAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ConfluentOrganizationData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganizations",
      "name": "myOrganizations",
      "type": "Microsoft.Confluent/organizations",
      "properties": {
        "createdTime": "2020-05-09T14:28:47.284Z",
        "provisioningState": "Accepted",
        "organizationId": "string",
        "ssoUrl": "string",
        "offerDetail": {
          "publisherId": "string",
          "id": "string",
          "planId": "string",
          "planName": "string",
          "termUnit": "string",
          "privateOfferId": "string",
          "privateOfferIds": [
            "string"
          ],
          "status": "Started"
        },
        "userDetail": {
          "firstName": "string",
          "lastName": "string",
          "emailAddress": "contoso@microsoft.com",
          "userPrincipalName": "contoso@microsoft.com",
          "aadEmail": "contoso@microsoft.com"
        }
      },
      "tags": {
        "Environment": "Dev"
      },
      "location": "West US"
    }
  ],
  "nextLink": "string"
}

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorResponseBody	ErrorResponseBody
LinkOrganization	Meglévő Confluent-szervezet csatolása
OfferDetail	A Confluent-ajánlat részletei
OrganizationResource	Szervezeti erőforrás.
OrganizationResourceListResult	Egy listaművelet válasza.
ProvisionState	ProvisioningState
ResourceProviderDefaultErrorResponse	ResourceProviderDefaultErrorResponse
SaaSOfferStatus	SaaSOfferStatus
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
UserDetail	Előfizetői adatok

createdByType

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

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorResponseBody

ErrorResponseBody

Name	Típus	Description
code	string	Hibakód
details	ErrorResponseBody[]	Hiba részletei
message	string	Hibaüzenet
target	string	Hibacél

LinkOrganization

Meglévő Confluent-szervezet csatolása

Name	Típus	Description
token	string	Felhasználói hitelesítési jogkivonat

OfferDetail

A Confluent-ajánlat részletei

Name	Típus	Description
id	string	Ajánlat azonosítója
planId	string	Ajánlatcsomag azonosítója
planName	string	Ajánlatcsomag neve
privateOfferId	string	Privát ajánlat azonosítója
privateOfferIds	string[]	Magánajánlat-azonosítók tömbje
publisherId	string	Közzétevő azonosítója
status	SaaSOfferStatus	SaaSOfferStatus SaaS-ajánlat állapota
termId	string	Ajánlatterv kifejezésazonosítója
termUnit	string	Ajánlatterv kifejezésegysége

OrganizationResource

Szervezeti erőforrás.

Name	Típus	Description
id	string	Az erőforrás ARM-azonosítója.
location	string	A szervezeti erőforrás helye
name	string	Az erőforrás neve.
properties.createdTime	string	Az erőforrás létrehozási ideje.
properties.linkOrganization	LinkOrganization	Meglévő Confluent-szervezet csatolása
properties.offerDetail	OfferDetail	Confluent-ajánlat részletei
properties.organizationId	string	A Confluent-szervezet azonosítója.
properties.provisioningState	ProvisionState	ProvisioningState Kiépítési állapotok a párhuzamos RP-hez
properties.ssoUrl	string	A Confluent-szervezet SSO URL-címe.
properties.userDetail	UserDetail	Előfizetői adatok
systemData	systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok
tags	object	Szervezeti erőforráscímkék
type	string	Az erőforrás típusa.

OrganizationResourceListResult

Egy listaművelet válasza.

Name	Típus	Description
nextLink	string	Csatolja a következő találatkészletet, ha van ilyen.
value	OrganizationResource[]	Listaművelet eredménye.

ProvisionState

ProvisioningState

Name	Típus	Description
Accepted	string
Canceled	string
Creating	string
Deleted	string
Deleting	string
Failed	string
NotSpecified	string
Succeeded	string
Updating	string

ResourceProviderDefaultErrorResponse

ResourceProviderDefaultErrorResponse

Name	Típus	Description
error	ErrorResponseBody	ErrorResponseBody A hiba választörzse

SaaSOfferStatus

SaaSOfferStatus

Name	Típus	Description
Failed	string
InProgress	string
PendingFulfillmentStart	string
Reinstated	string
Started	string
Subscribed	string
Succeeded	string
Suspended	string
Unsubscribed	string
Updating	string

systemData

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

Name	Típus	Description
createdAt	string	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	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást utoljára módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

UserDetail

Előfizetői adatok

Name	Típus	Description
aadEmail	string	AAD e-mail-cím
emailAddress	string	E-mail-cím
firstName	string	Utónév
lastName	string	Vezetéknév
userPrincipalName	string	Egyszerű felhasználónév