Skip to content

Commit a173f7a

Browse files
authored
Merge pull request #177937 from mikefrobbins/mr-azps-confluent-102821
Added azure powershell content
2 parents 9089831 + 8506d3b commit a173f7a

File tree

2 files changed

+113
-1
lines changed

2 files changed

+113
-1
lines changed
Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
---
2+
title: Create Apache Kafka for Confluent Cloud through Azure PowerShell - Azure partner solutions
3+
description: This article describes how to use Azure PowerShell to create an instance of Apache Kafka for Confluent Cloud.
4+
ms.service: partner-services
5+
ms.topic: quickstart
6+
ms.date: 11/03/2021
7+
author: tfitzmac
8+
ms.author: tomfitz
9+
ms.custom: devx-track-azurepowershell
10+
---
11+
12+
# QuickStart: Get started with Apache Kafka for Confluent Cloud - Azure PowerShell
13+
14+
In this quickstart, you'll use the Azure Marketplace and Azure PowerShell to create an instance of Apache Kafka for Confluent Cloud.
15+
16+
## Prerequisites
17+
18+
- An Azure account. If you don't have an active Azure subscription, create a [free account](https://azure.microsoft.com/free/).
19+
- You must have the _Owner_ or _Contributor_ role for your Azure subscription. The integration between Azure and Confluent can only be set up by users with _Owner_ or _Contributor_ access. Before getting started, [confirm that you have the appropriate access](../../role-based-access-control/check-access.md).
20+
21+
## Find offer
22+
23+
Use the Azure portal to find the Apache Kafka for Confluent Cloud application.
24+
25+
1. In a web browser, go to the [Azure portal](https://portal.azure.com/) and sign in.
26+
27+
1. If you've visited the **Marketplace** in a recent session, select the icon from the available options. Otherwise, search for _Marketplace_.
28+
29+
:::image type="content" source="media/marketplace.png" alt-text="Marketplace icon.":::
30+
31+
1. From the **Marketplace** page, you have two options based on the type of plan you want. You can sign up for a pay-as-you-go plan or commitment plan. Pay-as-you-go is publicly available. The commitment plan is available to customers who have been approved for a private offer.
32+
33+
- For **pay-as-you-go** customers, search for _Apache Kafka on Confluent Cloud_. Select the offer for Apache Kafka on Confluent Cloud.
34+
35+
:::image type="content" source="media/search-pay-as-you-go.png" alt-text="search Azure Marketplace offer.":::
36+
37+
- For **commitment** customers, select the link to **View Private offers**. The commitment requires you to sign up for a minimum spend amount. Use this option only when you know you need the service for an extended time.
38+
39+
:::image type="content" source="media/view-private-offers.png" alt-text="view private offers.":::
40+
41+
Look for _Apache Kafka on Confluent Cloud_.
42+
43+
:::image type="content" source="media/select-from-private-offers.png" alt-text="select private offer.":::
44+
45+
## Create resource
46+
47+
After you've selected the offer for Apache Kafka on Confluent Cloud, you're ready to set up the application.
48+
49+
Start by preparing your environment for Azure PowerShell:
50+
51+
[!INCLUDE [azure-powershell-requirements-no-header.md](../../../includes/azure-powershell-requirements-no-header.md)]
52+
53+
> [!IMPORTANT]
54+
> While the **Az.Confluent** PowerShell module is in preview, you must install it separately using the `Install-Module` cmdlet.
55+
56+
```azurepowershell
57+
Install-Module -Name Az.Confluent -Scope CurrentUser -Repository PSGallery -Force
58+
```
59+
60+
After you sign in, use the [New-AzConfluentOrganization](/powershell/module/az.confluent/new-azconfluentorganization) cmdlet to create the new organization resource:
61+
62+
```azurepowershell
63+
$ConfluentOrgParams = @{
64+
Name = 'myOrganization'
65+
ResourceGroupName = 'myResourceGroup'
66+
Location = 'my location'
67+
OfferDetailId = 'string'
68+
OfferDetailPlanId = 'string'
69+
OfferDetailPlanName = 'string'
70+
OfferDetailPublisherId = 'string'
71+
OfferDetailTermUnit = 'string'
72+
UserDetailEmailAddress = '[email protected]'
73+
UserDetailFirstName = 'string'
74+
UserDetailLastName = 'string'
75+
Tag = @{Environment='Dev'}
76+
}
77+
78+
New-AzConfluentOrganization @ConfluentOrgParams
79+
```
80+
81+
> [!NOTE]
82+
> If you want the command to return before the create operation completes, add the optional parameter `-NoWait`. The operation continues to run until the Confluent organization is created.
83+
84+
To see a list of existing organizations, use the [Get-AzConfluentOrganization](/powershell/module/az.confluent/get-azconfluentorganization) cmdlet.
85+
86+
You can view all of the organizations in your subscription:
87+
88+
```azurepowershell
89+
Get-AzConfluentOrganization
90+
```
91+
92+
Or, view the organizations in a resource group:
93+
94+
```azurepowershell
95+
Get-AzConfluentOrganization -ResourceGroupName myResourceGroup
96+
```
97+
98+
To see the properties of a specific organization, use the `Get-AzConfluentOrganization` cmdlet with the `Name` and `ResourceGroupName` parameters.
99+
100+
You can view the organization by name:
101+
102+
```azurepowershell
103+
Get-AzConfluentOrganization -Name myOrganization -ResourceGroupName myResourceGroup
104+
```
105+
106+
If you get an error, see [Troubleshooting Apache Kafka for Confluent Cloud solutions](troubleshoot.md).
107+
108+
## Next steps
109+
110+
> [!div class="nextstepaction"]
111+
> [Manage the Confluent Cloud resource](manage.md)

articles/partner-solutions/apache-kafka-confluent-cloud/toc.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
href: create.md
1212
- name: Azure CLI
1313
href: create-cli.md
14+
- name: Azure PowerShell
15+
href: create-powershell.md
1416
displayName: Azure CLI, az confluent organization create, az confluent organization wait, az confluent organization list, az confluent organization show
1517
- name: How to
1618
items:
@@ -31,4 +33,3 @@
3133
href: /cli/azure/confluent
3234
- name: Azure PowerShell
3335
href: /powershell/module/az.confluent/#confluent
34-

0 commit comments

Comments
 (0)