Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 65 additions & 20 deletions src/eventgrid/azext_eventgrid/_help.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@
short-summary: Create a domain.
parameters:
- name: --inbound-ip-rules
short-summary: List of inbound ip rules specifying IP Address in CIDR notation e.g., 10.0.0.0/8 along with corresponding Action to perform based on the match or no match of the IpMask. Possible values include - Allow.
long-summary: List of inbound ip rules specifying IP Address in CIDR notation e.g., 10.0.0.0/8 along with corresponding Action to perform based on the match or no match of the IpMask. Possible values include - Allow.
short-summary: List of inbound IP rules.
long-summary: |
List of inbound IP rules specifying IP Address in CIDR notation e.g., 10.0.0.0/8 along with corresponding Action to perform based on the match or no match of the IpMask. Possible values include - Allow.
examples:
- name: Create a new domain.
text: az eventgrid domain create -g rg1 --name domain1 -l westus2
Expand All @@ -32,7 +33,7 @@
- name: Create a new domain that accepts events published in CloudEvents V1.0 schema and maps a property mytopicfield to the topic name.
text: az eventgrid domain create -g rg1 --name domain1 -l westus2 --input-schema cloudeventschemav1_0 --input-mapping-fields topic=mytopicfield
- name: Create a new domain which allows specific inbound ip rules.
text: az eventgrid domain create -g rg1 --name domain1 -l westus2 --public-network-access disabled --inbound-ip-rules 10.0.0.0/8 Allow --inbound-ip-rules 10.2.0.0/8 Allow
text: az eventgrid domain create -g rg1 --name domain1 -l westus2 --public-network-access enabled --inbound-ip-rules 10.0.0.0/8 Allow --inbound-ip-rules 10.2.0.0/8 Allow --sku basic

"""

Expand Down Expand Up @@ -73,6 +74,22 @@
text: az eventgrid domain private-endpoint-connection list -g rg1 -n domain1
"""

helps['eventgrid domain private-endpoint-connection approve'] = """
type: command
short-summary: Approve a private endpoint connection request for a domain.
examples:
- name: Approve a private endpoint connection for a domain.
text: az eventgrid domain private-endpoint-connection approve -g rg1 --domain-name domain1 -n domain1-PrivateEndpoint.6d90cf76-a022-452c-9994-6dac62a50c99 --description "Sample approval description"
"""

helps['eventgrid domain private-endpoint-connection reject'] = """
type: command
short-summary: Reject a private endpoint connection request for a domain.
examples:
- name: Reject a private endpoint connection for a domain.
text: az eventgrid domain private-endpoint-connection reject -g rg1 --domain-name domain1 -n domain1-PrivateEndpoint.6d90cf76-a022-452c-9994-6dac62a50c99 --description "Sample rejection description"
"""

helps['eventgrid domain private-link-resource'] = """
type: group
short-summary: Manage private link resource of a domain.
Expand All @@ -83,15 +100,15 @@
short-summary: Display the properties of a private link resource for a domain.
examples:
- name: Show a private endpoint connection for a domain.
text: az eventgrid domain private-link-resource show -g rg1 --domain-name domain1 -n linkName1
text: az eventgrid domain private-link-resource show -g rg1 --domain-name domain1 -n domain
"""

helps['eventgrid domain private-link-resource list'] = """
type: command
short-summary: List the properties of all the private link resources for a domain.
examples:
- name: Show a private endpoint connection for a domain.
text: az eventgrid domain private-link-resource list -g rg1 -n domain1
text: az eventgrid domain private-link-resource list -g rg1 --domain-name domain1
"""


Expand Down Expand Up @@ -184,11 +201,12 @@
short-summary: Update a domain.
parameters:
- name: --inbound-ip-rules
short-summary: List of inbound ip rules specifying IP Address in CIDR notation e.g., 10.0.0.0/8 along with corresponding Action to perform based on the match or no match of the IpMask. Possible values include - Allow.
long-summary: List of inbound ip rules specifying IP Address in CIDR notation e.g., 10.0.0.0/8 along with corresponding Action to perform based on the match or no match of the IpMask. Possible values include - Allow.
short-summary: List of inbound IP rules.
long-summary: |
List of inbound IP rules specifying IP Address in CIDR notation e.g., 10.0.0.0/8 along with corresponding Action to perform based on the match or no match of the IpMask. Possible values include - Allow.
examples:
- name: Update the properties of an existing domain.
text: az eventgrid domain update -g rg1 --name domain1 --sku Basic --identity noidentity --public-network-access Disabled --inbound-ip-rules 10.0.0.0/8 Allow --inbound-ip-rules 10.2.0.0/8 Allow --tags Dept=IT
text: az eventgrid domain update -g rg1 --name domain1 --sku Basic --identity noidentity --public-network-access enabled --inbound-ip-rules 10.0.0.0/8 Allow --inbound-ip-rules 10.2.0.0/8 Allow --tags Dept=IT --sku basic
"""

helps['eventgrid partner'] = """
Expand Down Expand Up @@ -793,6 +811,8 @@
Example: --deadletter-endpoint /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/sa1/blobServices/default/containers/containerName
- name: --endpoint-type
short-summary: The type of the destination endpoint.
- name: --delivery-identity-endpoint-type
short-summary: The type of the destination endpoint with resource identity.
examples:
- name: Create a new event subscription for an Event Grid topic, using default filters.
text: |
Expand Down Expand Up @@ -888,6 +908,12 @@
--source-resource-id /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/topics/topic1 \\
--endpoint /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Web/sites/{functionappname}/functions/{functionname} --endpoint-type azurefunction

- name: Create a new event subscription for an Event Grid topic, using Eventhub with systemassigned MSI identity as destination and with deadletter with MSI identity
text: |
az eventgrid event-subscription create --source-resource-id /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/topics/topic1 \\
--delivery-identity-endpoint-type eventhub --delivery-identity systemassigned --delivery-identity-endpoint /subscriptions/{SubId2|}/resourceGroups/{RG2}/providers/Microsoft.eventhub/namespaces/{EventHubNamespace}/eventhubs/{EventhubName} \\
--deadletter-identity-endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/s2/blobServices/default/containers/blobcontainer1 --deadletter-identity systemassigned -n {EventSubscriptionName}

"""

helps['eventgrid event-subscription delete'] = """
Expand Down Expand Up @@ -1049,6 +1075,8 @@
For EventGrid domain topic: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft.EventGrid/domains/d1/topics/t1
- name: --endpoint-type
short-summary: The type of the destination endpoint.
- name: --delivery-identity-endpoint-type
short-summary: The type of the destination endpoint with resource identity.
- name: --advanced-filter
short-summary: An advanced filter enables filtering of events based on a specific event property.
long-summary: |
Expand Down Expand Up @@ -1126,8 +1154,9 @@
short-summary: Create a topic.
parameters:
- name: --inbound-ip-rules
short-summary: List of inbound ip rules specifying IP Address in CIDR notation e.g., 10.0.0.0/8 along with corresponding Action to perform based on the match or no match of the IpMask. Possible values include - Allow.
long-summary: List of inbound ip rules specifying IP Address in CIDR notation e.g., 10.0.0.0/8 along with corresponding Action to perform based on the match or no match of the IpMask. Possible values include - Allow.
short-summary: List of inbound IP rules.
long-summary: |
List of inbound IP rules specifying IP Address in CIDR notation e.g., 10.0.0.0/8 along with corresponding Action to perform based on the match or no match of the IpMask. Possible values include - Allow.
examples:
- name: Create a new topic.
text: az eventgrid topic create -g rg1 --name topic1 -l westus2
Expand All @@ -1136,7 +1165,7 @@
- name: Create a new topic that accepts events published in CloudEvents V1.0 schema.
text: az eventgrid topic create -g rg1 --name topic1 -l westus2 --input-schema cloudeventschemav1_0
- name: Create a new topic which allows specific inbound ip rules with Basic Sku and system assigned identity
text: az eventgrid topic create -g rg1 --name topic1 -l westus2 --public-network-access Disabled --inbound-ip-rules 10.0.0.0/8 Allow --inbound-ip-rules 10.2.0.0/8 Allow --sku Basic --identity systemassigned
text: az eventgrid topic create -g rg1 --name topic1 -l westus2 --public-network-access enabled --inbound-ip-rules 10.0.0.0/8 Allow --inbound-ip-rules 10.2.0.0/8 Allow --sku Basic --identity systemassigned
"""

helps['eventgrid topic delete'] = """
Expand All @@ -1149,7 +1178,7 @@

helps['eventgrid topic private-endpoint-connection'] = """
type: group
short-summary: Manage private endpoint connection resources of a topic.
short-summary: Manage private endpoint connections of a topic.
"""


Expand All @@ -1173,8 +1202,24 @@
type: command
short-summary: List the properties of all the private endpoint connections for a topic.
examples:
- name: Show a private endpoint connection for a topic.
text: az eventgrid topic private-endpoint-connection list -g rg1 -n topic1
- name: List private endpoint connections for a topic.
text: az eventgrid topic private-endpoint-connection list -g rg1 --topic-name topic1
"""

helps['eventgrid topic private-endpoint-connection approve'] = """
type: command
short-summary: Approve a private endpoint connection request for a topic.
examples:
- name: Approve a private endpoint connection for a topic.
text: az eventgrid topic private-endpoint-connection approve -g rg1 --topic-name topic1 -n topic1-PrivateEndpoint.6d90cf76-a022-452c-9994-6dac62a50c99 --description "Sample approval description"
"""

helps['eventgrid topic private-endpoint-connection reject'] = """
type: command
short-summary: Reject a private endpoint connection request for a topic.
examples:
- name: Reject a private endpoint connection for a topic.
text: az eventgrid topic private-endpoint-connection reject -g rg1 --topic-name topic1 -n topic1-PrivateEndpoint.6d90cf76-a022-452c-9994-6dac62a50c99 --description "Sample rejection description"
"""

helps['eventgrid topic private-link-resource'] = """
Expand All @@ -1187,15 +1232,15 @@
short-summary: Display the properties of a private link resource for a topic.
examples:
- name: Show a private endpoint connection for a topic.
text: az eventgrid topic private-link-resource show -g rg1 --topic-name topic1 -n linkName1
text: az eventgrid topic private-link-resource show -g rg1 --topic-name topic1 -n topic
"""

helps['eventgrid topic private-link-resource list'] = """
type: command
short-summary: List the properties of all the private link resources for a topic.
examples:
- name: Show a private endpoint connection for a topic.
text: az eventgrid topic private-link-resource list -g rg1 -n topic1
text: az eventgrid topic private-link-resource list -g rg1 --topic-name topic1
"""

helps['eventgrid topic key'] = """
Expand Down Expand Up @@ -1246,11 +1291,11 @@
short-summary: Update a topic.
parameters:
- name: --inbound-ip-rules
short-summary: List of inbound ip rules specifying IP Address in CIDR notation e.g., 10.0.0.0/8 along with corresponding Action to perform based on the match or no match of the IpMask. Possible values include - Allow.
long-summary: List of inbound ip rules specifying IP Address in CIDR notation e.g., 10.0.0.0/8 along with corresponding Action to perform based on the match or no match of the IpMask. Possible values include - Allow.
short-summary: List of inbound IP rules specifying IP Address in CIDR notation e.g., 10.0.0.0/8 along with corresponding Action to perform based on the match or no match of the IpMask. Possible values include - Allow.
long-summary: List of inbound IP rules specifying IP Address in CIDR notation e.g., 10.0.0.0/8 along with corresponding Action to perform based on the match or no match of the IpMask. Possible values include - Allow.
examples:
- name: Update the properties of an existing topic.
text: az eventgrid topic update -g rg1 --name topic1 --sku Premium --identity systemassigned --public-network-access Disabled --inbound-ip-rules 10.0.0.0/8 Allow --inbound-ip-rules 10.2.0.0/8 Allow --tags Dept=IT
- name: Update the properties of an existing topic with new sku, identity and public network access information.
text: az eventgrid topic update -g rg1 --name topic1 --sku Premium --identity systemassigned --public-network-access enabled --inbound-ip-rules 10.0.0.0/8 Allow --inbound-ip-rules 10.2.0.0/8 Allow --tags Dept=IT --sku basic
"""

helps['eventgrid topic-type'] = """
Expand Down
Loading