Organization - Get

Service:

Confluent

API Version:

2024-07-01

Get the properties of a specific Organization resource.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}?api-version=2024-07-01

URI Parameters

Name	In	Required	Type	Description
organizationName	path	True	string	Organization resource name
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	OrganizationResource	Azure operation completed successfully.
Other Status Codes	ResourceProviderDefaultErrorResponse	An unexpected error response.

Security

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	impersonate your user account

Examples

Organization_Get

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization?api-version=2024-07-01

Sample response

Status code:

200

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

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorResponseBody	Response body of Error
LinkOrganization	Link an existing Confluent organization
OfferDetail	Confluent Offer detail
OrganizationResource	Organization resource.
ProvisionState	Provision states for confluent RP
ResourceProviderDefaultErrorResponse	Default error response for resource provider
SaaSOfferStatus	SaaS Offer Status for confluent RP
systemData	Metadata pertaining to creation and last modification of the resource.
UserDetail	Subscriber detail

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorResponseBody

Object

Response body of Error

Name	Type	Description
code	string	Error code
details	ErrorResponseBody[]	Error detail
message	string	Error message
target	string	Error target

LinkOrganization

Object

Link an existing Confluent organization

Name	Type	Description
token	string (password)	User auth token

OfferDetail

Object

Confluent Offer detail

Name	Type	Description
id	string maxLength: 50	Offer Id
planId	string maxLength: 200	Offer Plan Id
planName	string maxLength: 200	Offer Plan Name
privateOfferId	string maxLength: 255	Private Offer Id
privateOfferIds	string[]	Array of Private Offer Ids
publisherId	string maxLength: 50	Publisher Id
status	SaaSOfferStatus	SaaS Offer Status
termId	string maxLength: 50	Offer Plan Term Id
termUnit	string maxLength: 25	Offer Plan Term unit

OrganizationResource

Object

Organization resource.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.createdTime	string (date-time)	The creation time of the resource.
properties.linkOrganization	LinkOrganization	Link an existing Confluent organization
properties.offerDetail	OfferDetail	Confluent offer detail
properties.organizationId	string	Id of the Confluent organization.
properties.provisioningState	ProvisionState	Provision states for confluent RP
properties.ssoUrl	string	SSO url for the Confluent organization.
properties.userDetail	UserDetail	Subscriber detail
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ProvisionState

Enumeration

Provision states for confluent RP

Value	Description
Accepted
Creating
Updating
Deleting
Succeeded
Failed
Canceled
Deleted
NotSpecified

ResourceProviderDefaultErrorResponse

Object

Default error response for resource provider

Name	Type	Description
error	ErrorResponseBody	Response body of Error

SaaSOfferStatus

Enumeration

SaaS Offer Status for confluent RP

Value	Description
Started
PendingFulfillmentStart
InProgress
Subscribed
Suspended
Reinstated
Succeeded
Failed
Unsubscribed
Updating

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UserDetail

Object

Subscriber detail

Name	Type	Description
aadEmail	string	AAD email address
emailAddress	string pattern: ^\S+@\S+\.\S+$	Email address
firstName	string maxLength: 50	First name
lastName	string maxLength: 50	Last name
userPrincipalName	string	User principal name