diff --git a/docs-ref-autogen/@azure/arm-eventgrid/AzureFunctionEventSubscriptionDestination.yml b/docs-ref-autogen/@azure/arm-eventgrid/AzureFunctionEventSubscriptionDestination.yml
index 45dfa8b66659..7798bc44ab68 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/AzureFunctionEventSubscriptionDestination.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/AzureFunctionEventSubscriptionDestination.yml
@@ -41,7 +41,7 @@ properties:
uid: >-
@azure/arm-eventgrid.AzureFunctionEventSubscriptionDestination.maxEventsPerBatch
package: '@azure/arm-eventgrid'
- summary: Maximum number of events per batch.
+ summary: 'Maximum number of events per batch. Default value: 1.'
fullName: maxEventsPerBatch
remarks: ''
isPreview: false
@@ -55,7 +55,7 @@ properties:
uid: >-
@azure/arm-eventgrid.AzureFunctionEventSubscriptionDestination.preferredBatchSizeInKilobytes
package: '@azure/arm-eventgrid'
- summary: Preferred batch size in Kilobytes.
+ summary: 'Preferred batch size in Kilobytes. Default value: 64.'
fullName: preferredBatchSizeInKilobytes
remarks: ''
isPreview: false
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/Domain.yml b/docs-ref-autogen/@azure/arm-eventgrid/Domain.yml
index 3e5a43aaa3f2..02ffe8826004 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/Domain.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/Domain.yml
@@ -9,11 +9,120 @@ isPreview: false
isDeprecated: false
type: interface
properties:
+ - name: autoCreateTopicWithFirstSubscription
+ uid: '@azure/arm-eventgrid.Domain.autoCreateTopicWithFirstSubscription'
+ package: '@azure/arm-eventgrid'
+ summary: >-
+ This Boolean is used to specify the creation mechanism for 'all' the Event
+ Grid Domain Topics
+
+ associated with this Event Grid Domain resource.
+
+ In this context, creation of domain topic can be auto-managed (when true)
+ or self-managed
+
+ (when false). The default value for this property is true.
+
+ When this property is null or set to true, Event Grid is responsible of
+ automatically creating
+
+ the domain topic when the first event subscription is
+
+ created at the scope of the domain topic. If this property is set to
+ false, then creating the
+
+ first event subscription will require creating a domain topic
+
+ by the user. The self-management mode can be used if the user wants full
+ control of when the
+
+ domain topic is created, while auto-managed mode provides the
+
+ flexibility to perform less operations and manage fewer resources by the
+ user. Also, note that
+
+ in auto-managed creation mode, user is allowed to create the
+
+ domain topic on demand if needed. Default value: true.
+ fullName: autoCreateTopicWithFirstSubscription
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'autoCreateTopicWithFirstSubscription?: undefined | false | true'
+ return:
+ type: undefined | false | true
+ description: ''
+ - name: autoDeleteTopicWithLastSubscription
+ uid: '@azure/arm-eventgrid.Domain.autoDeleteTopicWithLastSubscription'
+ package: '@azure/arm-eventgrid'
+ summary: >-
+ This Boolean is used to specify the deletion mechanism for 'all' the Event
+ Grid Domain Topics
+
+ associated with this Event Grid Domain resource.
+
+ In this context, deletion of domain topic can be auto-managed (when true)
+ or self-managed
+
+ (when false). The default value for this property is true.
+
+ When this property is set to true, Event Grid is responsible of
+ automatically deleting the
+
+ domain topic when the last event subscription at the scope
+
+ of the domain topic is deleted. If this property is set to false, then the
+ user needs to
+
+ manually delete the domain topic when it is no longer needed
+
+ (e.g., when last event subscription is deleted and the resource needs to
+ be cleaned up). The
+
+ self-management mode can be used if the user wants full
+
+ control of when the domain topic needs to be deleted, while auto-managed
+ mode provides the
+
+ flexibility to perform less operations and manage fewer
+
+ resources by the user. Default value: true.
+ fullName: autoDeleteTopicWithLastSubscription
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'autoDeleteTopicWithLastSubscription?: undefined | false | true'
+ return:
+ type: undefined | false | true
+ description: ''
+ - name: disableLocalAuth
+ uid: '@azure/arm-eventgrid.Domain.disableLocalAuth'
+ package: '@azure/arm-eventgrid'
+ summary: >-
+ This boolean is used to enable or disable local auth. Default value is
+ false. When the
+
+ property is set to true, only AAD token will be used to authenticate if
+ user is allowed to
+
+ publish to the domain. Default value: false.
+ fullName: disableLocalAuth
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'disableLocalAuth?: undefined | false | true'
+ return:
+ type: undefined | false | true
+ description: ''
- name: endpoint
uid: '@azure/arm-eventgrid.Domain.endpoint'
package: '@azure/arm-eventgrid'
summary: >-
- Endpoint for the domain.
+ Endpoint for the Event Grid Domain Resource which is used for publishing
+ the events.
**NOTE: This property will not be serialized. It can only be populated by
the server.**
@@ -46,7 +155,7 @@ properties:
- name: identity
uid: '@azure/arm-eventgrid.Domain.identity'
package: '@azure/arm-eventgrid'
- summary: Identity information for the resource.
+ summary: Identity information for the Event Grid Domain resource.
fullName: identity
remarks: ''
isPreview: false
@@ -80,7 +189,8 @@ properties:
This determines the format that Event Grid should expect for incoming
events published to the
- domain. Possible values include: 'EventGridSchema', 'CustomEventSchema',
+ Event Grid Domain Resource. Possible values include: 'EventGridSchema',
+ 'CustomEventSchema',
'CloudEventSchemaV1_0'. Default value: 'EventGridSchema'.
fullName: inputSchema
@@ -124,7 +234,7 @@ properties:
uid: '@azure/arm-eventgrid.Domain.metricResourceId'
package: '@azure/arm-eventgrid'
summary: >-
- Metric resource id for the domain.
+ Metric resource id for the Event Grid Domain Resource.
**NOTE: This property will not be serialized. It can only be populated by
the server.**
@@ -157,7 +267,11 @@ properties:
- name: privateEndpointConnections
uid: '@azure/arm-eventgrid.Domain.privateEndpointConnections'
package: '@azure/arm-eventgrid'
- summary: List of private endpoint connections.
+ summary: >-
+ List of private endpoint connections.
+
+ **NOTE: This property will not be serialized. It can only be populated by
+ the server.**
fullName: privateEndpointConnections
remarks: ''
isPreview: false
@@ -171,10 +285,10 @@ properties:
uid: '@azure/arm-eventgrid.Domain.provisioningState'
package: '@azure/arm-eventgrid'
summary: >-
- Provisioning state of the domain. Possible values include: 'Creating',
- 'Updating', 'Deleting',
+ Provisioning state of the Event Grid Domain Resource. Possible values
+ include: 'Creating',
- 'Succeeded', 'Canceled', 'Failed'
+ 'Updating', 'Deleting', 'Succeeded', 'Canceled', 'Failed'
**NOTE: This property will not be serialized. It can only be populated by
the server.**
@@ -198,7 +312,8 @@ properties:
cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules"
- />. Possible values include: 'Enabled', 'Disabled'
+ />. Possible values include: 'Enabled', 'Disabled'. Default value:
+ 'Enabled'.
fullName: publicNetworkAccess
remarks: ''
isPreview: false
@@ -211,7 +326,7 @@ properties:
- name: sku
uid: '@azure/arm-eventgrid.Domain.sku'
package: '@azure/arm-eventgrid'
- summary: The Sku pricing tier for the domain.
+ summary: The Sku pricing tier for the Event Grid Domain resource.
fullName: sku
remarks: ''
isPreview: false
@@ -221,6 +336,23 @@ properties:
return:
type:
description: ''
+ - name: systemData
+ uid: '@azure/arm-eventgrid.Domain.systemData'
+ package: '@azure/arm-eventgrid'
+ summary: >-
+ The system metadata relating to the Event Grid Domain resource.
+
+ **NOTE: This property will not be serialized. It can only be populated by
+ the server.**
+ fullName: systemData
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'systemData?: SystemData'
+ return:
+ type:
+ description: ''
- name: tags
uid: '@azure/arm-eventgrid.Domain.tags'
package: '@azure/arm-eventgrid'
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/DomainTopic.yml b/docs-ref-autogen/@azure/arm-eventgrid/DomainTopic.yml
index 33bab921236f..fb3624fd41ea 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/DomainTopic.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/DomainTopic.yml
@@ -51,6 +51,9 @@ properties:
'Creating', 'Updating',
'Deleting', 'Succeeded', 'Canceled', 'Failed'
+
+ **NOTE: This property will not be serialized. It can only be populated by
+ the server.**
fullName: provisioningState
remarks: ''
isPreview: false
@@ -60,6 +63,23 @@ properties:
return:
type:
description: ''
+ - name: systemData
+ uid: '@azure/arm-eventgrid.DomainTopic.systemData'
+ package: '@azure/arm-eventgrid'
+ summary: >-
+ The system metadata relating to Domain Topic resource.
+
+ **NOTE: This property will not be serialized. It can only be populated by
+ the server.**
+ fullName: systemData
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'systemData?: SystemData'
+ return:
+ type:
+ description: ''
- name: type
uid: '@azure/arm-eventgrid.DomainTopic.type'
package: '@azure/arm-eventgrid'
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/DomainTopicsListResult.yml b/docs-ref-autogen/@azure/arm-eventgrid/DomainTopicsListResult.yml
index 0b229d06ef8e..eecc54afd136 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/DomainTopicsListResult.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/DomainTopicsListResult.yml
@@ -40,7 +40,7 @@ properties:
- name: nextLink
uid: '@azure/arm-eventgrid.DomainTopicsListResult.nextLink'
package: '@azure/arm-eventgrid'
- summary: A link for the next page of domain topics
+ summary: A link for the next page of domain topics.
fullName: nextLink
remarks: ''
isPreview: false
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/DomainUpdateParameters.yml b/docs-ref-autogen/@azure/arm-eventgrid/DomainUpdateParameters.yml
index eece48da0bc5..392ef987e501 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/DomainUpdateParameters.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/DomainUpdateParameters.yml
@@ -9,6 +9,116 @@ isPreview: false
isDeprecated: false
type: interface
properties:
+ - name: autoCreateTopicWithFirstSubscription
+ uid: >-
+ @azure/arm-eventgrid.DomainUpdateParameters.autoCreateTopicWithFirstSubscription
+ package: '@azure/arm-eventgrid'
+ summary: >-
+ This Boolean is used to specify the creation mechanism for 'all' the Event
+ Grid Domain Topics
+
+ associated with this Event Grid Domain resource.
+
+ In this context, creation of domain topic can be auto-managed (when true)
+ or self-managed
+
+ (when false). The default value for this property is true.
+
+ When this property is null or set to true, Event Grid is responsible of
+ automatically creating
+
+ the domain topic when the first event subscription is
+
+ created at the scope of the domain topic. If this property is set to
+ false, then creating the
+
+ first event subscription will require creating a domain topic
+
+ by the user. The self-management mode can be used if the user wants full
+ control of when the
+
+ domain topic is created, while auto-managed mode provides the
+
+ flexibility to perform less operations and manage fewer resources by the
+ user. Also, note that
+
+ in auto-managed creation mode, user is allowed to create the
+
+ domain topic on demand if needed.
+ fullName: autoCreateTopicWithFirstSubscription
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'autoCreateTopicWithFirstSubscription?: undefined | false | true'
+ return:
+ type: undefined | false | true
+ description: ''
+ - name: autoDeleteTopicWithLastSubscription
+ uid: >-
+ @azure/arm-eventgrid.DomainUpdateParameters.autoDeleteTopicWithLastSubscription
+ package: '@azure/arm-eventgrid'
+ summary: >-
+ This Boolean is used to specify the deletion mechanism for 'all' the Event
+ Grid Domain Topics
+
+ associated with this Event Grid Domain resource.
+
+ In this context, deletion of domain topic can be auto-managed (when true)
+ or self-managed
+
+ (when false). The default value for this property is true.
+
+ When this property is set to true, Event Grid is responsible of
+ automatically deleting the
+
+ domain topic when the last event subscription at the scope
+
+ of the domain topic is deleted. If this property is set to false, then the
+ user needs to
+
+ manually delete the domain topic when it is no longer needed
+
+ (e.g., when last event subscription is deleted and the resource needs to
+ be cleaned up). The
+
+ self-management mode can be used if the user wants full
+
+ control of when the domain topic needs to be deleted, while auto-managed
+ mode provides the
+
+ flexibility to perform less operations and manage fewer
+
+ resources by the user.
+ fullName: autoDeleteTopicWithLastSubscription
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'autoDeleteTopicWithLastSubscription?: undefined | false | true'
+ return:
+ type: undefined | false | true
+ description: ''
+ - name: disableLocalAuth
+ uid: '@azure/arm-eventgrid.DomainUpdateParameters.disableLocalAuth'
+ package: '@azure/arm-eventgrid'
+ summary: >-
+ This boolean is used to enable or disable local auth. Default value is
+ false. When the
+
+ property is set to true, only AAD token will be used to authenticate if
+ user is allowed to
+
+ publish to the domain.
+ fullName: disableLocalAuth
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'disableLocalAuth?: undefined | false | true'
+ return:
+ type: undefined | false | true
+ description: ''
- name: identity
uid: '@azure/arm-eventgrid.DomainUpdateParameters.identity'
package: '@azure/arm-eventgrid'
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/EventChannel.yml b/docs-ref-autogen/@azure/arm-eventgrid/EventChannel.yml
index 5cf558946df0..6ac58210028e 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/EventChannel.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/EventChannel.yml
@@ -172,7 +172,7 @@ properties:
uid: '@azure/arm-eventgrid.EventChannel.systemData'
package: '@azure/arm-eventgrid'
summary: >-
- The system metadata relating to this resource.
+ The system metadata relating to Event Channel resource.
**NOTE: This property will not be serialized. It can only be populated by
the server.**
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/EventChannelFilter.yml b/docs-ref-autogen/@azure/arm-eventgrid/EventChannelFilter.yml
index 6ba32545cd16..d68427a45fec 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/EventChannelFilter.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/EventChannelFilter.yml
@@ -29,7 +29,8 @@ properties:
Allows advanced filters to be evaluated against an array of values instead
of expecting a
- singular value.
+ singular value. The default value is either false or null. Default value:
+ false.
fullName: enableAdvancedFilteringOnArrays
remarks: ''
isPreview: false
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/EventGridManagementClient.yml b/docs-ref-autogen/@azure/arm-eventgrid/EventGridManagementClient.yml
index 6f0d838e5d13..0a7bd64571aa 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/EventGridManagementClient.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/EventGridManagementClient.yml
@@ -10,8 +10,8 @@ isDeprecated: false
type: class
constructors:
- name: >-
- EventGridManagementClient(ServiceClientCredentials, string,
- Models.EventGridManagementClientOptions)
+ EventGridManagementClient(ServiceClientCredentials | TokenCredential,
+ string, Models.EventGridManagementClientOptions)
uid: '@azure/arm-eventgrid.EventGridManagementClient.constructor'
package: '@azure/arm-eventgrid'
summary: Initializes a new instance of the EventGridManagementClient class.
@@ -20,13 +20,25 @@ constructors:
isDeprecated: false
syntax:
content: >-
- new EventGridManagementClient(credentials: ServiceClientCredentials,
- subscriptionId: string, options?:
+ new EventGridManagementClient(credentials: ServiceClientCredentials |
+ TokenCredential, subscriptionId: string, options?:
Models.EventGridManagementClientOptions)
parameters:
- id: credentials
- type: ServiceClientCredentials
- description: Credentials needed for the client to connect to Azure.
+ type: ServiceClientCredentials | TokenCredential
+ description: >-
+ Credentials needed for the client to connect to Azure. Credentials
+
+ implementing the TokenCredential interface from the @azure/identity
+ package are recommended. For
+
+ more information about these credentials, see
+
+ .
+ Credentials implementing the
+
+ ServiceClientCredentials interface from the older packages
+ @azure/ms-rest-nodeauth and
- id: subscriptionId
type: string
description: >-
@@ -73,9 +85,9 @@ properties:
isPreview: false
isDeprecated: false
syntax:
- content: 'credentials: ServiceClientCredentials'
+ content: 'credentials: ServiceClientCredentials | TokenCredential'
return:
- type: ServiceClientCredentials
+ type: ServiceClientCredentials | TokenCredential
description: ''
- name: domains
uid: '@azure/arm-eventgrid.EventGridManagementClient.domains'
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/EventGridManagementClientContext.yml b/docs-ref-autogen/@azure/arm-eventgrid/EventGridManagementClientContext.yml
index f5f8f706fb1d..bed074d43448 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/EventGridManagementClientContext.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/EventGridManagementClientContext.yml
@@ -10,8 +10,8 @@ isDeprecated: false
type: class
constructors:
- name: >-
- EventGridManagementClientContext(ServiceClientCredentials, string,
- Models.EventGridManagementClientOptions)
+ EventGridManagementClientContext(ServiceClientCredentials |
+ TokenCredential, string, Models.EventGridManagementClientOptions)
uid: '@azure/arm-eventgrid.EventGridManagementClientContext.constructor'
package: '@azure/arm-eventgrid'
summary: Initializes a new instance of the EventGridManagementClient class.
@@ -21,12 +21,24 @@ constructors:
syntax:
content: >-
new EventGridManagementClientContext(credentials:
- ServiceClientCredentials, subscriptionId: string, options?:
- Models.EventGridManagementClientOptions)
+ ServiceClientCredentials | TokenCredential, subscriptionId: string,
+ options?: Models.EventGridManagementClientOptions)
parameters:
- id: credentials
- type: ServiceClientCredentials
- description: Credentials needed for the client to connect to Azure.
+ type: ServiceClientCredentials | TokenCredential
+ description: >-
+ Credentials needed for the client to connect to Azure. Credentials
+
+ implementing the TokenCredential interface from the @azure/identity
+ package are recommended. For
+
+ more information about these credentials, see
+
+ .
+ Credentials implementing the
+
+ ServiceClientCredentials interface from the older packages
+ @azure/ms-rest-nodeauth and
- id: subscriptionId
type: string
description: >-
@@ -73,9 +85,9 @@ properties:
isPreview: false
isDeprecated: false
syntax:
- content: 'credentials: ServiceClientCredentials'
+ content: 'credentials: ServiceClientCredentials | TokenCredential'
return:
- type: ServiceClientCredentials
+ type: ServiceClientCredentials | TokenCredential
description: ''
- name: longRunningOperationRetryTimeout
uid: >-
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/EventSubscription.yml b/docs-ref-autogen/@azure/arm-eventgrid/EventSubscription.yml
index 1bb7ca63d3b9..b010dde144ae 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/EventSubscription.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/EventSubscription.yml
@@ -104,7 +104,10 @@ properties:
The event delivery schema for the event subscription. Possible values
include:
- 'EventGridSchema', 'CustomInputSchema', 'CloudEventSchemaV1_0'
+ 'EventGridSchema', 'CustomInputSchema', 'CloudEventSchemaV1_0'. Default
+ value:
+
+ 'EventGridSchema'.
fullName: eventDeliverySchema
remarks: ''
isPreview: false
@@ -228,7 +231,7 @@ properties:
uid: '@azure/arm-eventgrid.EventSubscription.systemData'
package: '@azure/arm-eventgrid'
summary: >-
- The system metadata relating to this resource.
+ The system metadata relating to Event Subscription resource.
**NOTE: This property will not be serialized. It can only be populated by
the server.**
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/Operation.yml b/docs-ref-autogen/@azure/arm-eventgrid/Operation.yml
index ded15d4dea91..40e13071c3f9 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/Operation.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/Operation.yml
@@ -22,6 +22,21 @@ properties:
return:
type:
description: ''
+ - name: isDataAction
+ uid: '@azure/arm-eventgrid.Operation.isDataAction'
+ package: '@azure/arm-eventgrid'
+ summary: >-
+ This Boolean is used to determine if the operation is a data plane action
+ or not.
+ fullName: isDataAction
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isDataAction?: undefined | false | true'
+ return:
+ type: undefined | false | true
+ description: ''
- name: name
uid: '@azure/arm-eventgrid.Operation.name'
package: '@azure/arm-eventgrid'
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/ParentType.yml b/docs-ref-autogen/@azure/arm-eventgrid/ParentType.yml
index 8f55e588c988..01bdc2e0194f 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/ParentType.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/ParentType.yml
@@ -4,9 +4,9 @@ uid: '@azure/arm-eventgrid.ParentType'
package: '@azure/arm-eventgrid'
summary: |-
Defines values for ParentType.
- Possible values include: 'topics', 'domains'
+ Possible values include: 'topics', 'domains', 'partnerNamespaces'
fullName: ParentType
remarks: ''
isPreview: false
isDeprecated: false
-syntax: type ParentType = "topics" | "domains"
+syntax: type ParentType = "topics" | "domains" | "partnerNamespaces"
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/ParentType1.yml b/docs-ref-autogen/@azure/arm-eventgrid/ParentType1.yml
index 33386d1a9a63..681eb731374b 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/ParentType1.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/ParentType1.yml
@@ -4,9 +4,9 @@ uid: '@azure/arm-eventgrid.ParentType1'
package: '@azure/arm-eventgrid'
summary: |-
Defines values for ParentType1.
- Possible values include: 'topics', 'domains'
+ Possible values include: 'topics', 'domains', 'partnerNamespaces'
fullName: ParentType1
remarks: ''
isPreview: false
isDeprecated: false
-syntax: type ParentType1 = "topics" | "domains"
+syntax: type ParentType1 = "topics" | "domains" | "partnerNamespaces"
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/ParentType2.yml b/docs-ref-autogen/@azure/arm-eventgrid/ParentType2.yml
index 1df829fd6dd9..d468fb68825e 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/ParentType2.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/ParentType2.yml
@@ -4,9 +4,9 @@ uid: '@azure/arm-eventgrid.ParentType2'
package: '@azure/arm-eventgrid'
summary: |-
Defines values for ParentType2.
- Possible values include: 'topics', 'domains'
+ Possible values include: 'topics', 'domains', 'partnerNamespaces'
fullName: ParentType2
remarks: ''
isPreview: false
isDeprecated: false
-syntax: type ParentType2 = "topics" | "domains"
+syntax: type ParentType2 = "topics" | "domains" | "partnerNamespaces"
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/ParentType3.yml b/docs-ref-autogen/@azure/arm-eventgrid/ParentType3.yml
index 3f7caf4ad11d..a0b6d9084072 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/ParentType3.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/ParentType3.yml
@@ -4,9 +4,9 @@ uid: '@azure/arm-eventgrid.ParentType3'
package: '@azure/arm-eventgrid'
summary: |-
Defines values for ParentType3.
- Possible values include: 'topics', 'domains'
+ Possible values include: 'topics', 'domains', 'partnerNamespaces'
fullName: ParentType3
remarks: ''
isPreview: false
isDeprecated: false
-syntax: type ParentType3 = "topics" | "domains"
+syntax: type ParentType3 = "topics" | "domains" | "partnerNamespaces"
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/PartnerNamespace.yml b/docs-ref-autogen/@azure/arm-eventgrid/PartnerNamespace.yml
index b3f265971c42..e03dc06b36ba 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/PartnerNamespace.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/PartnerNamespace.yml
@@ -9,6 +9,26 @@ isPreview: false
isDeprecated: false
type: interface
properties:
+ - name: disableLocalAuth
+ uid: '@azure/arm-eventgrid.PartnerNamespace.disableLocalAuth'
+ package: '@azure/arm-eventgrid'
+ summary: >-
+ This boolean is used to enable or disable local auth. Default value is
+ false. When the
+
+ property is set to true, only AAD token will be used to authenticate if
+ user is allowed to
+
+ publish to the partner namespace. Default value: false.
+ fullName: disableLocalAuth
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'disableLocalAuth?: undefined | false | true'
+ return:
+ type: undefined | false | true
+ description: ''
- name: endpoint
uid: '@azure/arm-eventgrid.PartnerNamespace.endpoint'
package: '@azure/arm-eventgrid'
@@ -43,6 +63,23 @@ properties:
return:
type: undefined | string
description: ''
+ - name: inboundIpRules
+ uid: '@azure/arm-eventgrid.PartnerNamespace.inboundIpRules'
+ package: '@azure/arm-eventgrid'
+ summary: >-
+ This can be used to restrict traffic from specific IPs instead of all IPs.
+ Note: These are
+
+ considered only if PublicNetworkAccess is enabled.
+ fullName: inboundIpRules
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'inboundIpRules?: InboundIpRule[]'
+ return:
+ type: '[]'
+ description: ''
- name: location
uid: '@azure/arm-eventgrid.PartnerNamespace.location'
package: '@azure/arm-eventgrid'
@@ -92,6 +129,21 @@ properties:
return:
type: undefined | string
description: ''
+ - name: privateEndpointConnections
+ uid: '@azure/arm-eventgrid.PartnerNamespace.privateEndpointConnections'
+ package: '@azure/arm-eventgrid'
+ summary: >-
+ **NOTE: This property will not be serialized. It can only be populated by
+ the server.**
+ fullName: privateEndpointConnections
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'privateEndpointConnections?: PrivateEndpointConnection[]'
+ return:
+ type: '[]'
+ description: ''
- name: provisioningState
uid: '@azure/arm-eventgrid.PartnerNamespace.provisioningState'
package: '@azure/arm-eventgrid'
@@ -112,11 +164,33 @@ properties:
return:
type:
description: ''
+ - name: publicNetworkAccess
+ uid: '@azure/arm-eventgrid.PartnerNamespace.publicNetworkAccess'
+ package: '@azure/arm-eventgrid'
+ summary: >-
+ This determines if traffic is allowed over public network. By default it
+ is enabled.
+
+ You can further restrict to specific IPs by configuring . Possible values include: 'Enabled', 'Disabled'. Default value:
+ 'Enabled'.
+ fullName: publicNetworkAccess
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'publicNetworkAccess?: PublicNetworkAccess'
+ return:
+ type:
+ description: ''
- name: systemData
uid: '@azure/arm-eventgrid.PartnerNamespace.systemData'
package: '@azure/arm-eventgrid'
summary: >-
- The system metadata relating to this resource.
+ The system metadata relating to Partner Namespace resource.
**NOTE: This property will not be serialized. It can only be populated by
the server.**
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/PartnerNamespaceUpdateParameters.yml b/docs-ref-autogen/@azure/arm-eventgrid/PartnerNamespaceUpdateParameters.yml
index e20900d96a59..9db46983d655 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/PartnerNamespaceUpdateParameters.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/PartnerNamespaceUpdateParameters.yml
@@ -9,6 +9,64 @@ isPreview: false
isDeprecated: false
type: interface
properties:
+ - name: disableLocalAuth
+ uid: '@azure/arm-eventgrid.PartnerNamespaceUpdateParameters.disableLocalAuth'
+ package: '@azure/arm-eventgrid'
+ summary: >-
+ This boolean is used to enable or disable local auth. Default value is
+ false. When the
+
+ property is set to true, only AAD token will be used to authenticate if
+ user is allowed to
+
+ publish to the partner namespace.
+ fullName: disableLocalAuth
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'disableLocalAuth?: undefined | false | true'
+ return:
+ type: undefined | false | true
+ description: ''
+ - name: inboundIpRules
+ uid: '@azure/arm-eventgrid.PartnerNamespaceUpdateParameters.inboundIpRules'
+ package: '@azure/arm-eventgrid'
+ summary: >-
+ This can be used to restrict traffic from specific IPs instead of all IPs.
+ Note: These are
+
+ considered only if PublicNetworkAccess is enabled.
+ fullName: inboundIpRules
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'inboundIpRules?: InboundIpRule[]'
+ return:
+ type: '[]'
+ description: ''
+ - name: publicNetworkAccess
+ uid: '@azure/arm-eventgrid.PartnerNamespaceUpdateParameters.publicNetworkAccess'
+ package: '@azure/arm-eventgrid'
+ summary: >-
+ This determines if traffic is allowed over public network. By default it
+ is enabled.
+
+ You can further restrict to specific IPs by configuring . Possible values include: 'Enabled', 'Disabled'
+ fullName: publicNetworkAccess
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'publicNetworkAccess?: PublicNetworkAccess'
+ return:
+ type:
+ description: ''
- name: tags
uid: '@azure/arm-eventgrid.PartnerNamespaceUpdateParameters.tags'
package: '@azure/arm-eventgrid'
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/PartnerRegistration.yml b/docs-ref-autogen/@azure/arm-eventgrid/PartnerRegistration.yml
index 68bc1d72919c..94448a96b148 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/PartnerRegistration.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/PartnerRegistration.yml
@@ -272,7 +272,7 @@ properties:
uid: '@azure/arm-eventgrid.PartnerRegistration.systemData'
package: '@azure/arm-eventgrid'
summary: >-
- The system metadata relating to this resource.
+ The system metadata relating to Partner Registration resource.
**NOTE: This property will not be serialized. It can only be populated by
the server.**
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/PartnerRegistrationEventTypesListResult.yml b/docs-ref-autogen/@azure/arm-eventgrid/PartnerRegistrationEventTypesListResult.yml
deleted file mode 100644
index 7052e7c73c47..000000000000
--- a/docs-ref-autogen/@azure/arm-eventgrid/PartnerRegistrationEventTypesListResult.yml
+++ /dev/null
@@ -1,37 +0,0 @@
-### YamlMime:TSType
-name: PartnerRegistrationEventTypesListResult
-uid: '@azure/arm-eventgrid.PartnerRegistrationEventTypesListResult'
-package: '@azure/arm-eventgrid'
-summary: Result of the List Partner Registration Event Types operation.
-fullName: PartnerRegistrationEventTypesListResult
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: nextLink
- uid: '@azure/arm-eventgrid.PartnerRegistrationEventTypesListResult.nextLink'
- package: '@azure/arm-eventgrid'
- summary: A link for the next page of partner registration event types.
- fullName: nextLink
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'nextLink?: undefined | string'
- return:
- type: undefined | string
- description: ''
- - name: value
- uid: '@azure/arm-eventgrid.PartnerRegistrationEventTypesListResult.value'
- package: '@azure/arm-eventgrid'
- summary: A collection of partner registration event types.
- fullName: value
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'value?: EventType[]'
- return:
- type: '[]'
- description: ''
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/PartnerRegistrations.yml b/docs-ref-autogen/@azure/arm-eventgrid/PartnerRegistrations.yml
index 77e87500f8aa..6de8e7c93e96 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/PartnerRegistrations.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/PartnerRegistrations.yml
@@ -270,59 +270,6 @@ methods:
uid="@azure/arm-eventgrid.PartnerRegistration" />>
description: |
The callback
- - name: list(msRest.RequestOptionsBase)
- uid: '@azure/arm-eventgrid.PartnerRegistrations.list'
- package: '@azure/arm-eventgrid'
- summary: List all partners registrations.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'function list(options?: msRest.RequestOptionsBase)'
- parameters:
- - id: options
- type:
- description: ''
- return:
- type: Promise<>
- description: Promise
- - name: 'list(RequestOptionsBase, ServiceCallback)'
- uid: '@azure/arm-eventgrid.PartnerRegistrations.list_2'
- package: '@azure/arm-eventgrid'
- summary: ''
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: >-
- function list(options: RequestOptionsBase, callback:
- ServiceCallback)
- parameters:
- - id: options
- type: RequestOptionsBase
- description: The optional parameters
- - id: callback
- type: >-
- ServiceCallback<>
- description: |
- The callback
- - name: list(ServiceCallback)
- uid: '@azure/arm-eventgrid.PartnerRegistrations.list_1'
- package: '@azure/arm-eventgrid'
- summary: ''
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'function list(callback: ServiceCallback)'
- parameters:
- - id: callback
- type: >-
- ServiceCallback<>
- description: |
- The callback
- name: >-
listByResourceGroup(string,
Models.PartnerRegistrationsListByResourceGroupOptionalParams)
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/PartnerRegistrationsListResponse.yml b/docs-ref-autogen/@azure/arm-eventgrid/PartnerRegistrationsListResponse.yml
deleted file mode 100644
index b90e10877649..000000000000
--- a/docs-ref-autogen/@azure/arm-eventgrid/PartnerRegistrationsListResponse.yml
+++ /dev/null
@@ -1,12 +0,0 @@
-### YamlMime:TSTypeAlias
-name: PartnerRegistrationsListResponse
-uid: '@azure/arm-eventgrid.PartnerRegistrationsListResponse'
-package: '@azure/arm-eventgrid'
-summary: Contains response data for the list operation.
-fullName: PartnerRegistrationsListResponse
-remarks: ''
-isPreview: false
-isDeprecated: false
-syntax: >-
- type PartnerRegistrationsListResponse = PartnerRegistrationsListResult & {
- _response: Object }
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/PartnerTopic.yml b/docs-ref-autogen/@azure/arm-eventgrid/PartnerTopic.yml
index 1b1c65961e00..1af2cb34a5f6 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/PartnerTopic.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/PartnerTopic.yml
@@ -65,7 +65,7 @@ properties:
- name: identity
uid: '@azure/arm-eventgrid.PartnerTopic.identity'
package: '@azure/arm-eventgrid'
- summary: Identity information for the resource.
+ summary: Identity information for the Partner Topic resource.
fullName: identity
remarks: ''
isPreview: false
@@ -166,7 +166,7 @@ properties:
uid: '@azure/arm-eventgrid.PartnerTopic.systemData'
package: '@azure/arm-eventgrid'
summary: >-
- The system metadata relating to this resource.
+ The system metadata relating to Partner Topic resource.
**NOTE: This property will not be serialized. It can only be populated by
the server.**
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/PartnerTopicType.yml b/docs-ref-autogen/@azure/arm-eventgrid/PartnerTopicType.yml
deleted file mode 100644
index ce2a7bc9768d..000000000000
--- a/docs-ref-autogen/@azure/arm-eventgrid/PartnerTopicType.yml
+++ /dev/null
@@ -1,156 +0,0 @@
-### YamlMime:TSType
-name: PartnerTopicType
-uid: '@azure/arm-eventgrid.PartnerTopicType'
-package: '@azure/arm-eventgrid'
-summary: Properties of a partner topic type.
-fullName: PartnerTopicType
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: authorizationState
- uid: '@azure/arm-eventgrid.PartnerTopicType.authorizationState'
- package: '@azure/arm-eventgrid'
- summary: >-
- Status of whether the customer has authorized a partner to create partner
- topics
-
- in the customer's subscription. Possible values include: 'NotApplicable',
- 'NotAuthorized',
-
- 'Authorized'
- fullName: authorizationState
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'authorizationState?: PartnerTopicTypeAuthorizationState'
- return:
- type:
- description: ''
- - name: description
- uid: '@azure/arm-eventgrid.PartnerTopicType.description'
- package: '@azure/arm-eventgrid'
- summary: Description of the partner topic type.
- fullName: description
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'description?: undefined | string'
- return:
- type: undefined | string
- description: ''
- - name: displayName
- uid: '@azure/arm-eventgrid.PartnerTopicType.displayName'
- package: '@azure/arm-eventgrid'
- summary: Display Name for the partner topic type.
- fullName: displayName
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'displayName?: undefined | string'
- return:
- type: undefined | string
- description: ''
- - name: id
- uid: '@azure/arm-eventgrid.PartnerTopicType.id'
- package: '@azure/arm-eventgrid'
- summary: >-
- Fully qualified identifier of the resource.
-
- **NOTE: This property will not be serialized. It can only be populated by
- the server.**
- fullName: id
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'id?: undefined | string'
- return:
- type: undefined | string
- description: ''
- - name: name
- uid: '@azure/arm-eventgrid.PartnerTopicType.name'
- package: '@azure/arm-eventgrid'
- summary: >-
- Name of the resource.
-
- **NOTE: This property will not be serialized. It can only be populated by
- the server.**
- fullName: name
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'name?: undefined | string'
- return:
- type: undefined | string
- description: ''
- - name: partnerName
- uid: '@azure/arm-eventgrid.PartnerTopicType.partnerName'
- package: '@azure/arm-eventgrid'
- summary: Official name of the partner.
- fullName: partnerName
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'partnerName?: undefined | string'
- return:
- type: undefined | string
- description: ''
- - name: setupUri
- uid: '@azure/arm-eventgrid.PartnerTopicType.setupUri'
- package: '@azure/arm-eventgrid'
- summary: >-
- URI of the partner website that can be used by Azure customers to setup
- Event Grid
-
- integration on an event source.
- fullName: setupUri
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setupUri?: undefined | string'
- return:
- type: undefined | string
- description: ''
- - name: topicTypeName
- uid: '@azure/arm-eventgrid.PartnerTopicType.topicTypeName'
- package: '@azure/arm-eventgrid'
- summary: >-
- Name of the partner topic type. This name should be unique among all
- partner topic types
-
- names.
- fullName: topicTypeName
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'topicTypeName?: undefined | string'
- return:
- type: undefined | string
- description: ''
- - name: type
- uid: '@azure/arm-eventgrid.PartnerTopicType.type'
- package: '@azure/arm-eventgrid'
- summary: >-
- Type of the resource.
-
- **NOTE: This property will not be serialized. It can only be populated by
- the server.**
- fullName: type
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'type?: undefined | string'
- return:
- type: undefined | string
- description: ''
-extends:
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/PartnerTopicTypeAuthorizationState.yml b/docs-ref-autogen/@azure/arm-eventgrid/PartnerTopicTypeAuthorizationState.yml
deleted file mode 100644
index 210345c458d1..000000000000
--- a/docs-ref-autogen/@azure/arm-eventgrid/PartnerTopicTypeAuthorizationState.yml
+++ /dev/null
@@ -1,14 +0,0 @@
-### YamlMime:TSTypeAlias
-name: PartnerTopicTypeAuthorizationState
-uid: '@azure/arm-eventgrid.PartnerTopicTypeAuthorizationState'
-package: '@azure/arm-eventgrid'
-summary: |-
- Defines values for PartnerTopicTypeAuthorizationState.
- Possible values include: 'NotApplicable', 'NotAuthorized', 'Authorized'
-fullName: PartnerTopicTypeAuthorizationState
-remarks: ''
-isPreview: false
-isDeprecated: false
-syntax: >-
- type PartnerTopicTypeAuthorizationState = "NotApplicable" | "NotAuthorized" |
- "Authorized"
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/PartnerTopicTypesListResult.yml b/docs-ref-autogen/@azure/arm-eventgrid/PartnerTopicTypesListResult.yml
deleted file mode 100644
index dc5f737949e1..000000000000
--- a/docs-ref-autogen/@azure/arm-eventgrid/PartnerTopicTypesListResult.yml
+++ /dev/null
@@ -1,24 +0,0 @@
-### YamlMime:TSType
-name: PartnerTopicTypesListResult
-uid: '@azure/arm-eventgrid.PartnerTopicTypesListResult'
-package: '@azure/arm-eventgrid'
-summary: Result of the List Partner Topic Types operation.
-fullName: PartnerTopicTypesListResult
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: value
- uid: '@azure/arm-eventgrid.PartnerTopicTypesListResult.value'
- package: '@azure/arm-eventgrid'
- summary: A collection of partner topic types.
- fullName: value
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'value?: PartnerTopicType[]'
- return:
- type: '[]'
- description: ''
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/PartnerTopicUpdateParameters.yml b/docs-ref-autogen/@azure/arm-eventgrid/PartnerTopicUpdateParameters.yml
index ca56da0957a9..67bf9069abc9 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/PartnerTopicUpdateParameters.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/PartnerTopicUpdateParameters.yml
@@ -9,10 +9,23 @@ isPreview: false
isDeprecated: false
type: interface
properties:
+ - name: identity
+ uid: '@azure/arm-eventgrid.PartnerTopicUpdateParameters.identity'
+ package: '@azure/arm-eventgrid'
+ summary: Identity information for the Partner Topic resource.
+ fullName: identity
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'identity?: IdentityInfo'
+ return:
+ type:
+ description: ''
- name: tags
uid: '@azure/arm-eventgrid.PartnerTopicUpdateParameters.tags'
package: '@azure/arm-eventgrid'
- summary: Tags of the partner topic.
+ summary: Tags of the Partner Topic resource.
fullName: tags
remarks: ''
isPreview: false
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/PrivateEndpointConnections.yml b/docs-ref-autogen/@azure/arm-eventgrid/PrivateEndpointConnections.yml
index 77899464be43..3204e028109a 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/PrivateEndpointConnections.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/PrivateEndpointConnections.yml
@@ -29,7 +29,9 @@ methods:
msRest.RequestOptionsBase)
uid: '@azure/arm-eventgrid.PrivateEndpointConnections.beginDeleteMethod'
package: '@azure/arm-eventgrid'
- summary: Delete a specific private endpoint connection under a topic or domain.
+ summary: >-
+ Delete a specific private endpoint connection under a topic, domain, or
+ partner namespace.
remarks: ''
isPreview: false
isDeprecated: false
@@ -45,17 +47,18 @@ methods:
- id: parentType
type:
description: >-
- The type of the parent resource. This can be either \'topics\' or
- \'domains\'.
+ The type of the parent resource. This can be either \'topics\',
+ \'domains\',
- Possible values include: 'topics', 'domains'
+ or \'partnerNamespaces\'. Possible values include: 'topics',
+ 'domains', 'partnerNamespaces'
- id: parentName
type: string
description: >-
- The name of the parent resource (namely, either, the topic name or
- domain
+ The name of the parent resource (namely, either, the topic name,
+ domain name,
- name).
+ or partner namespace name).
- id: privateEndpointConnectionName
type: string
description: The name of the private endpoint connection connection.
@@ -70,7 +73,9 @@ methods:
PrivateEndpointConnection, msRest.RequestOptionsBase)
uid: '@azure/arm-eventgrid.PrivateEndpointConnections.beginUpdate'
package: '@azure/arm-eventgrid'
- summary: Update a specific private endpoint connection under a topic or domain.
+ summary: >-
+ Update a specific private endpoint connection under a topic, domain or
+ partner namespace.
remarks: ''
isPreview: false
isDeprecated: false
@@ -87,17 +92,18 @@ methods:
- id: parentType
type:
description: >-
- The type of the parent resource. This can be either \'topics\' or
- \'domains\'.
+ The type of the parent resource. This can be either \'topics\',
+ \'domains\',
- Possible values include: 'topics', 'domains'
+ or \'partnerNamespaces\'. Possible values include: 'topics',
+ 'domains', 'partnerNamespaces'
- id: parentName
type: string
description: >-
- The name of the parent resource (namely, either, the topic name or
- domain
+ The name of the parent resource (namely, either, the topic name,
+ domain name,
- name).
+ or partner namespace name).
- id: privateEndpointConnectionName
type: string
description: The name of the private endpoint connection connection.
@@ -115,7 +121,9 @@ methods:
msRest.RequestOptionsBase)
uid: '@azure/arm-eventgrid.PrivateEndpointConnections.deleteMethod'
package: '@azure/arm-eventgrid'
- summary: Delete a specific private endpoint connection under a topic or domain.
+ summary: >-
+ Delete a specific private endpoint connection under a topic, domain, or
+ partner namespace.
remarks: ''
isPreview: false
isDeprecated: false
@@ -131,17 +139,18 @@ methods:
- id: parentType
type:
description: >-
- The type of the parent resource. This can be either \'topics\' or
- \'domains\'.
+ The type of the parent resource. This can be either \'topics\',
+ \'domains\',
- Possible values include: 'topics', 'domains'
+ or \'partnerNamespaces\'. Possible values include: 'topics',
+ 'domains', 'partnerNamespaces'
- id: parentName
type: string
description: >-
- The name of the parent resource (namely, either, the topic name or
- domain
+ The name of the parent resource (namely, either, the topic name,
+ domain name,
- name).
+ or partner namespace name).
- id: privateEndpointConnectionName
type: string
description: The name of the private endpoint connection connection.
@@ -154,7 +163,9 @@ methods:
- name: 'get(string, Models.ParentType, string, string, msRest.RequestOptionsBase)'
uid: '@azure/arm-eventgrid.PrivateEndpointConnections.get'
package: '@azure/arm-eventgrid'
- summary: Get a specific private endpoint connection under a topic or domain.
+ summary: >-
+ Get a specific private endpoint connection under a topic, domain, or
+ partner namespace.
remarks: ''
isPreview: false
isDeprecated: false
@@ -170,17 +181,18 @@ methods:
- id: parentType
type:
description: >-
- The type of the parent resource. This can be either \'topics\' or
- \'domains\'.
+ The type of the parent resource. This can be either \'topics\',
+ \'domains\',
- Possible values include: 'topics', 'domains'
+ or \'partnerNamespaces\'. Possible values include: 'topics',
+ 'domains', 'partnerNamespaces'
- id: parentName
type: string
description: >-
- The name of the parent resource (namely, either, the topic name or
- domain
+ The name of the parent resource (namely, either, the topic name,
+ domain name,
- name).
+ or partner namespace name).
- id: privateEndpointConnectionName
type: string
description: The name of the private endpoint connection connection.
@@ -214,17 +226,18 @@ methods:
- id: parentType
type:
description: >-
- The type of the parent resource. This can be either \'topics\' or
- \'domains\'.
+ The type of the parent resource. This can be either \'topics\',
+ \'domains\',
- Possible values include: 'topics', 'domains'
+ or \'partnerNamespaces\'. Possible values include: 'topics',
+ 'domains', 'partnerNamespaces'
- id: parentName
type: string
description: >-
- The name of the parent resource (namely, either, the topic name or
- domain
+ The name of the parent resource (namely, either, the topic name,
+ domain name,
- name).
+ or partner namespace name).
- id: privateEndpointConnectionName
type: string
description: The name of the private endpoint connection connection.
@@ -258,17 +271,18 @@ methods:
- id: parentType
type:
description: >-
- The type of the parent resource. This can be either \'topics\' or
- \'domains\'.
+ The type of the parent resource. This can be either \'topics\',
+ \'domains\',
- Possible values include: 'topics', 'domains'
+ or \'partnerNamespaces\'. Possible values include: 'topics',
+ 'domains', 'partnerNamespaces'
- id: parentName
type: string
description: >-
- The name of the parent resource (namely, either, the topic name or
- domain
+ The name of the parent resource (namely, either, the topic name,
+ domain name,
- name).
+ or partner namespace name).
- id: privateEndpointConnectionName
type: string
description: The name of the private endpoint connection connection.
@@ -283,7 +297,9 @@ methods:
Models.PrivateEndpointConnectionsListByResourceOptionalParams)
uid: '@azure/arm-eventgrid.PrivateEndpointConnections.listByResource'
package: '@azure/arm-eventgrid'
- summary: Get all private endpoint connections under a topic or domain.
+ summary: >-
+ Get all private endpoint connections under a topic, domain, or partner
+ namespace.
remarks: ''
isPreview: false
isDeprecated: false
@@ -299,17 +315,18 @@ methods:
- id: parentType
type:
description: >-
- The type of the parent resource. This can be either \'topics\' or
- \'domains\'.
+ The type of the parent resource. This can be either \'topics\',
+ \'domains\',
- Possible values include: 'topics', 'domains'
+ or \'partnerNamespaces\'. Possible values include: 'topics',
+ 'domains', 'partnerNamespaces'
- id: parentName
type: string
description: >-
- The name of the parent resource (namely, either, the topic name or
- domain
+ The name of the parent resource (namely, either, the topic name,
+ domain name,
- name).
+ or partner namespace name).
- id: options
type: >-
description: >-
- The type of the parent resource. This can be either \'topics\' or
- \'domains\'.
+ The type of the parent resource. This can be either \'topics\',
+ \'domains\',
- Possible values include: 'topics', 'domains'
+ or \'partnerNamespaces\'. Possible values include: 'topics',
+ 'domains', 'partnerNamespaces'
- id: parentName
type: string
description: >-
- The name of the parent resource (namely, either, the topic name or
- domain
+ The name of the parent resource (namely, either, the topic name,
+ domain name,
- name).
+ or partner namespace name).
- id: options
type: >-
description: >-
- The type of the parent resource. This can be either \'topics\' or
- \'domains\'.
+ The type of the parent resource. This can be either \'topics\',
+ \'domains\',
- Possible values include: 'topics', 'domains'
+ or \'partnerNamespaces\'. Possible values include: 'topics',
+ 'domains', 'partnerNamespaces'
- id: parentName
type: string
description: >-
- The name of the parent resource (namely, either, the topic name or
- domain
+ The name of the parent resource (namely, either, the topic name,
+ domain name,
- name).
+ or partner namespace name).
- id: callback
type: >-
ServiceCallback<-
+ Get all private endpoint connections under a topic, domain, or partner
+ namespace.
remarks: ''
isPreview: false
isDeprecated: false
@@ -497,7 +518,9 @@ methods:
PrivateEndpointConnection, msRest.RequestOptionsBase)
uid: '@azure/arm-eventgrid.PrivateEndpointConnections.update'
package: '@azure/arm-eventgrid'
- summary: Update a specific private endpoint connection under a topic or domain.
+ summary: >-
+ Update a specific private endpoint connection under a topic, domain or
+ partner namespace.
remarks: ''
isPreview: false
isDeprecated: false
@@ -514,17 +537,18 @@ methods:
- id: parentType
type:
description: >-
- The type of the parent resource. This can be either \'topics\' or
- \'domains\'.
+ The type of the parent resource. This can be either \'topics\',
+ \'domains\',
- Possible values include: 'topics', 'domains'
+ or \'partnerNamespaces\'. Possible values include: 'topics',
+ 'domains', 'partnerNamespaces'
- id: parentName
type: string
description: >-
- The name of the parent resource (namely, either, the topic name or
- domain
+ The name of the parent resource (namely, either, the topic name,
+ domain name,
- name).
+ or partner namespace name).
- id: privateEndpointConnectionName
type: string
description: The name of the private endpoint connection connection.
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/PrivateLinkResources.yml b/docs-ref-autogen/@azure/arm-eventgrid/PrivateLinkResources.yml
index 05754ebbe9ff..e63b44bef0d6 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/PrivateLinkResources.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/PrivateLinkResources.yml
@@ -43,15 +43,17 @@ methods:
- id: parentType
type: string
description: >-
- The type of the parent resource. This can be either \'topics\' or
- \'domains\'.
+ The type of the parent resource. This can be either \'topics\',
+ \'domains\',
+
+ or \'partnerNamespaces\'.
- id: parentName
type: string
description: >-
- The name of the parent resource (namely, either, the topic name or
- domain
+ The name of the parent resource (namely, either, the topic name,
+ domain name,
- name).
+ or partner namespace name).
- id: privateLinkResourceName
type: string
description: The name of private link resource.
@@ -82,15 +84,17 @@ methods:
- id: parentType
type: string
description: >-
- The type of the parent resource. This can be either \'topics\' or
- \'domains\'.
+ The type of the parent resource. This can be either \'topics\',
+ \'domains\',
+
+ or \'partnerNamespaces\'.
- id: parentName
type: string
description: >-
- The name of the parent resource (namely, either, the topic name or
- domain
+ The name of the parent resource (namely, either, the topic name,
+ domain name,
- name).
+ or partner namespace name).
- id: privateLinkResourceName
type: string
description: The name of private link resource.
@@ -122,15 +126,17 @@ methods:
- id: parentType
type: string
description: >-
- The type of the parent resource. This can be either \'topics\' or
- \'domains\'.
+ The type of the parent resource. This can be either \'topics\',
+ \'domains\',
+
+ or \'partnerNamespaces\'.
- id: parentName
type: string
description: >-
- The name of the parent resource (namely, either, the topic name or
- domain
+ The name of the parent resource (namely, either, the topic name,
+ domain name,
- name).
+ or partner namespace name).
- id: privateLinkResourceName
type: string
description: The name of private link resource.
@@ -145,7 +151,9 @@ methods:
Models.PrivateLinkResourcesListByResourceOptionalParams)
uid: '@azure/arm-eventgrid.PrivateLinkResources.listByResource'
package: '@azure/arm-eventgrid'
- summary: List all the private link resources under a topic or domain.
+ summary: >-
+ List all the private link resources under a topic, domain, or partner
+ namespace.
remarks: ''
isPreview: false
isDeprecated: false
@@ -161,15 +169,17 @@ methods:
- id: parentType
type: string
description: >-
- The type of the parent resource. This can be either \'topics\' or
- \'domains\'.
+ The type of the parent resource. This can be either \'topics\',
+ \'domains\',
+
+ or \'partnerNamespaces\'.
- id: parentName
type: string
description: >-
- The name of the parent resource (namely, either, the topic name or
- domain
+ The name of the parent resource (namely, either, the topic name,
+ domain name,
- name).
+ or partner namespace name).
- id: options
type: >-
-
- The type of the parent resource. This can be either \'topics\' or
- \'domains\'.
+ The type of the parent resource. This can be either \'topics\',
+ \'domains\',
+
+ or \'partnerNamespaces\'.
- id: parentName
type: string
description: >-
- The name of the parent resource (namely, either, the topic name or
- domain
+ The name of the parent resource (namely, either, the topic name,
+ domain name,
- name).
+ or partner namespace name).
- id: options
type: >-
-
- The type of the parent resource. This can be either \'topics\' or
- \'domains\'.
+ The type of the parent resource. This can be either \'topics\',
+ \'domains\',
+
+ or \'partnerNamespaces\'.
- id: parentName
type: string
description: >-
- The name of the parent resource (namely, either, the topic name or
- domain
+ The name of the parent resource (namely, either, the topic name,
+ domain name,
- name).
+ or partner namespace name).
- id: callback
type: >-
ServiceCallback<-
+ List all the private link resources under a topic, domain, or partner
+ namespace.
remarks: ''
isPreview: false
isDeprecated: false
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/ResourceSku.yml b/docs-ref-autogen/@azure/arm-eventgrid/ResourceSku.yml
index 17867196dd9a..021a54a6f72c 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/ResourceSku.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/ResourceSku.yml
@@ -16,7 +16,7 @@ properties:
The Sku name of the resource. The possible values are: Basic or Premium.
Possible values
- include: 'Basic', 'Premium'
+ include: 'Basic', 'Premium'. Default value: 'Basic'.
fullName: name
remarks: ''
isPreview: false
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/RetryPolicy.yml b/docs-ref-autogen/@azure/arm-eventgrid/RetryPolicy.yml
index 824088af6177..9f0ea5123a16 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/RetryPolicy.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/RetryPolicy.yml
@@ -12,7 +12,7 @@ properties:
- name: eventTimeToLiveInMinutes
uid: '@azure/arm-eventgrid.RetryPolicy.eventTimeToLiveInMinutes'
package: '@azure/arm-eventgrid'
- summary: Time To Live (in minutes) for events.
+ summary: 'Time To Live (in minutes) for events. Default value: 1440.'
fullName: eventTimeToLiveInMinutes
remarks: ''
isPreview: false
@@ -25,7 +25,7 @@ properties:
- name: maxDeliveryAttempts
uid: '@azure/arm-eventgrid.RetryPolicy.maxDeliveryAttempts'
package: '@azure/arm-eventgrid'
- summary: Maximum number of delivery retry attempts for events.
+ summary: 'Maximum number of delivery retry attempts for events. Default value: 30.'
fullName: maxDeliveryAttempts
remarks: ''
isPreview: false
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/SystemTopic.yml b/docs-ref-autogen/@azure/arm-eventgrid/SystemTopic.yml
index f4148639adad..9e6ff3973074 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/SystemTopic.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/SystemTopic.yml
@@ -123,7 +123,7 @@ properties:
uid: '@azure/arm-eventgrid.SystemTopic.systemData'
package: '@azure/arm-eventgrid'
summary: >-
- The system metadata relating to this resource.
+ The system metadata relating to System Topic resource.
**NOTE: This property will not be serialized. It can only be populated by
the server.**
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/Topic.yml b/docs-ref-autogen/@azure/arm-eventgrid/Topic.yml
index fb03b4c6a00e..7a617219bf86 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/Topic.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/Topic.yml
@@ -9,6 +9,26 @@ isPreview: false
isDeprecated: false
type: interface
properties:
+ - name: disableLocalAuth
+ uid: '@azure/arm-eventgrid.Topic.disableLocalAuth'
+ package: '@azure/arm-eventgrid'
+ summary: >-
+ This boolean is used to enable or disable local auth. Default value is
+ false. When the
+
+ property is set to true, only AAD token will be used to authenticate if
+ user is allowed to
+
+ publish to the topic. Default value: false.
+ fullName: disableLocalAuth
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'disableLocalAuth?: undefined | false | true'
+ return:
+ type: undefined | false | true
+ description: ''
- name: endpoint
uid: '@azure/arm-eventgrid.Topic.endpoint'
package: '@azure/arm-eventgrid'
@@ -188,7 +208,9 @@ properties:
- name: privateEndpointConnections
uid: '@azure/arm-eventgrid.Topic.privateEndpointConnections'
package: '@azure/arm-eventgrid'
- summary: ''
+ summary: >-
+ **NOTE: This property will not be serialized. It can only be populated by
+ the server.**
fullName: privateEndpointConnections
remarks: ''
isPreview: false
@@ -229,7 +251,8 @@ properties:
cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules"
- />. Possible values include: 'Enabled', 'Disabled'
+ />. Possible values include: 'Enabled', 'Disabled'. Default value:
+ 'Enabled'.
fullName: publicNetworkAccess
remarks: ''
isPreview: false
@@ -252,6 +275,23 @@ properties:
return:
type:
description: ''
+ - name: systemData
+ uid: '@azure/arm-eventgrid.Topic.systemData'
+ package: '@azure/arm-eventgrid'
+ summary: >-
+ The system metadata relating to Topic resource.
+
+ **NOTE: This property will not be serialized. It can only be populated by
+ the server.**
+ fullName: systemData
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'systemData?: SystemData'
+ return:
+ type:
+ description: ''
- name: tags
uid: '@azure/arm-eventgrid.Topic.tags'
package: '@azure/arm-eventgrid'
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/TopicUpdateParameters.yml b/docs-ref-autogen/@azure/arm-eventgrid/TopicUpdateParameters.yml
index 6447130b8e74..8ca014889aba 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/TopicUpdateParameters.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/TopicUpdateParameters.yml
@@ -9,10 +9,30 @@ isPreview: false
isDeprecated: false
type: interface
properties:
+ - name: disableLocalAuth
+ uid: '@azure/arm-eventgrid.TopicUpdateParameters.disableLocalAuth'
+ package: '@azure/arm-eventgrid'
+ summary: >-
+ This boolean is used to enable or disable local auth. Default value is
+ false. When the
+
+ property is set to true, only AAD token will be used to authenticate if
+ user is allowed to
+
+ publish to the topic.
+ fullName: disableLocalAuth
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'disableLocalAuth?: undefined | false | true'
+ return:
+ type: undefined | false | true
+ description: ''
- name: identity
uid: '@azure/arm-eventgrid.TopicUpdateParameters.identity'
package: '@azure/arm-eventgrid'
- summary: Resource identity information.
+ summary: Topic resource identity information.
fullName: identity
remarks: ''
isPreview: false
@@ -76,7 +96,7 @@ properties:
- name: tags
uid: '@azure/arm-eventgrid.TopicUpdateParameters.tags'
package: '@azure/arm-eventgrid'
- summary: Tags of the resource.
+ summary: Tags of the Topic resource.
fullName: tags
remarks: ''
isPreview: false
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/WebHookEventSubscriptionDestination.yml b/docs-ref-autogen/@azure/arm-eventgrid/WebHookEventSubscriptionDestination.yml
index 252b8f909aa8..95e4f8aa05eb 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/WebHookEventSubscriptionDestination.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/WebHookEventSubscriptionDestination.yml
@@ -108,7 +108,7 @@ properties:
- name: maxEventsPerBatch
uid: '@azure/arm-eventgrid.WebHookEventSubscriptionDestination.maxEventsPerBatch'
package: '@azure/arm-eventgrid'
- summary: Maximum number of events per batch.
+ summary: 'Maximum number of events per batch. Default value: 1.'
fullName: maxEventsPerBatch
remarks: ''
isPreview: false
@@ -122,7 +122,7 @@ properties:
uid: >-
@azure/arm-eventgrid.WebHookEventSubscriptionDestination.preferredBatchSizeInKilobytes
package: '@azure/arm-eventgrid'
- summary: Preferred batch size in Kilobytes.
+ summary: 'Preferred batch size in Kilobytes. Default value: 64.'
fullName: preferredBatchSizeInKilobytes
remarks: ''
isPreview: false
diff --git a/docs-ref-autogen/@azure/arm-eventgrid/index.yml b/docs-ref-autogen/@azure/arm-eventgrid/index.yml
index 763b2fa080b8..2d5d88c85fc5 100644
--- a/docs-ref-autogen/@azure/arm-eventgrid/index.yml
+++ b/docs-ref-autogen/@azure/arm-eventgrid/index.yml
@@ -132,7 +132,6 @@ interfaces:
- '@azure/arm-eventgrid.PartnerNamespacesListBySubscriptionOptionalParams'
- '@azure/arm-eventgrid.PartnerNamespacesListResult'
- '@azure/arm-eventgrid.PartnerRegistration'
- - '@azure/arm-eventgrid.PartnerRegistrationEventTypesListResult'
- '@azure/arm-eventgrid.PartnerRegistrationUpdateParameters'
- >-
@azure/arm-eventgrid.PartnerRegistrationsListByResourceGroupNextOptionalParams
@@ -146,8 +145,6 @@ interfaces:
@azure/arm-eventgrid.PartnerTopicEventSubscriptionsListByPartnerTopicNextOptionalParams
- >-
@azure/arm-eventgrid.PartnerTopicEventSubscriptionsListByPartnerTopicOptionalParams
- - '@azure/arm-eventgrid.PartnerTopicType'
- - '@azure/arm-eventgrid.PartnerTopicTypesListResult'
- '@azure/arm-eventgrid.PartnerTopicUpdateParameters'
- '@azure/arm-eventgrid.PartnerTopicsListByResourceGroupNextOptionalParams'
- '@azure/arm-eventgrid.PartnerTopicsListByResourceGroupOptionalParams'
@@ -305,7 +302,6 @@ typeAliases:
- '@azure/arm-eventgrid.PartnerRegistrationsListByResourceGroupResponse'
- '@azure/arm-eventgrid.PartnerRegistrationsListBySubscriptionNextResponse'
- '@azure/arm-eventgrid.PartnerRegistrationsListBySubscriptionResponse'
- - '@azure/arm-eventgrid.PartnerRegistrationsListResponse'
- '@azure/arm-eventgrid.PartnerRegistrationsUpdateResponse'
- '@azure/arm-eventgrid.PartnerTopicActivationState'
- >-
@@ -323,7 +319,6 @@ typeAliases:
- '@azure/arm-eventgrid.PartnerTopicEventSubscriptionsUpdateResponse'
- '@azure/arm-eventgrid.PartnerTopicProvisioningState'
- '@azure/arm-eventgrid.PartnerTopicReadinessState'
- - '@azure/arm-eventgrid.PartnerTopicTypeAuthorizationState'
- '@azure/arm-eventgrid.PartnerTopicsActivateResponse'
- '@azure/arm-eventgrid.PartnerTopicsDeactivateResponse'
- '@azure/arm-eventgrid.PartnerTopicsGetResponse'
diff --git a/docs-ref-autogen/@azure/arm-trafficmanager/AllowedEndpointRecordType.yml b/docs-ref-autogen/@azure/arm-trafficmanager/AllowedEndpointRecordType.yml
new file mode 100644
index 000000000000..7fe448f9344e
--- /dev/null
+++ b/docs-ref-autogen/@azure/arm-trafficmanager/AllowedEndpointRecordType.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSTypeAlias
+name: AllowedEndpointRecordType
+uid: '@azure/arm-trafficmanager.AllowedEndpointRecordType'
+package: '@azure/arm-trafficmanager'
+summary: |-
+ Defines values for AllowedEndpointRecordType.
+ Possible values include: 'DomainName', 'IPv4Address', 'IPv6Address', 'Any'
+fullName: AllowedEndpointRecordType
+remarks: ''
+isPreview: false
+isDeprecated: false
+syntax: >-
+ type AllowedEndpointRecordType = "DomainName" | "IPv4Address" | "IPv6Address"
+ | "Any"
diff --git a/docs-ref-autogen/@azure/arm-trafficmanager/Endpoint.yml b/docs-ref-autogen/@azure/arm-trafficmanager/Endpoint.yml
index 424b5693f949..7e6eaf9e5ba4 100644
--- a/docs-ref-autogen/@azure/arm-trafficmanager/Endpoint.yml
+++ b/docs-ref-autogen/@azure/arm-trafficmanager/Endpoint.yml
@@ -133,6 +133,46 @@ properties:
return:
type: undefined | number
description: ''
+ - name: minChildEndpointsIPv4
+ uid: '@azure/arm-trafficmanager.Endpoint.minChildEndpointsIPv4'
+ package: '@azure/arm-trafficmanager'
+ summary: >-
+ The minimum number of IPv4 (DNS record type A) endpoints that must be
+ available in the child
+
+ profile in order for the parent profile to be considered available. Only
+ applicable to
+
+ endpoint of type 'NestedEndpoints'.
+ fullName: minChildEndpointsIPv4
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'minChildEndpointsIPv4?: undefined | number'
+ return:
+ type: undefined | number
+ description: ''
+ - name: minChildEndpointsIPv6
+ uid: '@azure/arm-trafficmanager.Endpoint.minChildEndpointsIPv6'
+ package: '@azure/arm-trafficmanager'
+ summary: >-
+ The minimum number of IPv6 (DNS record type AAAA) endpoints that must be
+ available in the
+
+ child profile in order for the parent profile to be considered available.
+ Only applicable to
+
+ endpoint of type 'NestedEndpoints'.
+ fullName: minChildEndpointsIPv6
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'minChildEndpointsIPv6?: undefined | number'
+ return:
+ type: undefined | number
+ description: ''
- name: name
uid: '@azure/arm-trafficmanager.Endpoint.name'
package: '@azure/arm-trafficmanager'
diff --git a/docs-ref-autogen/@azure/arm-trafficmanager/Profile.yml b/docs-ref-autogen/@azure/arm-trafficmanager/Profile.yml
index 86999a40df4d..e1990b40ab8f 100644
--- a/docs-ref-autogen/@azure/arm-trafficmanager/Profile.yml
+++ b/docs-ref-autogen/@azure/arm-trafficmanager/Profile.yml
@@ -9,6 +9,19 @@ isPreview: false
isDeprecated: false
type: interface
properties:
+ - name: allowedEndpointRecordTypes
+ uid: '@azure/arm-trafficmanager.Profile.allowedEndpointRecordTypes'
+ package: '@azure/arm-trafficmanager'
+ summary: The list of allowed endpoint record types.
+ fullName: allowedEndpointRecordTypes
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'allowedEndpointRecordTypes?: AllowedEndpointRecordType[]'
+ return:
+ type: '[]'
+ description: ''
- name: dnsConfig
uid: '@azure/arm-trafficmanager.Profile.dnsConfig'
package: '@azure/arm-trafficmanager'
diff --git a/docs-ref-autogen/@azure/arm-trafficmanager/TrafficManagerManagementClient.yml b/docs-ref-autogen/@azure/arm-trafficmanager/TrafficManagerManagementClient.yml
index 3dbe736f2c85..3367e3a41a2f 100644
--- a/docs-ref-autogen/@azure/arm-trafficmanager/TrafficManagerManagementClient.yml
+++ b/docs-ref-autogen/@azure/arm-trafficmanager/TrafficManagerManagementClient.yml
@@ -10,8 +10,8 @@ isDeprecated: false
type: class
constructors:
- name: >-
- TrafficManagerManagementClient(ServiceClientCredentials, string,
- Models.TrafficManagerManagementClientOptions)
+ TrafficManagerManagementClient(ServiceClientCredentials | TokenCredential,
+ string, Models.TrafficManagerManagementClientOptions)
uid: '@azure/arm-trafficmanager.TrafficManagerManagementClient.constructor'
package: '@azure/arm-trafficmanager'
summary: Initializes a new instance of the TrafficManagerManagementClient class.
@@ -20,13 +20,25 @@ constructors:
isDeprecated: false
syntax:
content: >-
- new TrafficManagerManagementClient(credentials:
- ServiceClientCredentials, subscriptionId: string, options?:
+ new TrafficManagerManagementClient(credentials: ServiceClientCredentials
+ | TokenCredential, subscriptionId: string, options?:
Models.TrafficManagerManagementClientOptions)
parameters:
- id: credentials
- type: ServiceClientCredentials
- description: Credentials needed for the client to connect to Azure.
+ type: ServiceClientCredentials | TokenCredential
+ description: >-
+ Credentials needed for the client to connect to Azure. Credentials
+
+ implementing the TokenCredential interface from the @azure/identity
+ package are recommended. For
+
+ more information about these credentials, see
+
+ .
+ Credentials implementing the
+
+ ServiceClientCredentials interface from the older packages
+ @azure/ms-rest-nodeauth and
- id: subscriptionId
type: string
description: >-
@@ -74,9 +86,9 @@ properties:
isPreview: false
isDeprecated: false
syntax:
- content: 'credentials: ServiceClientCredentials'
+ content: 'credentials: ServiceClientCredentials | TokenCredential'
return:
- type: ServiceClientCredentials
+ type: ServiceClientCredentials | TokenCredential
description: ''
- name: endpoints
uid: '@azure/arm-trafficmanager.TrafficManagerManagementClient.endpoints'
diff --git a/docs-ref-autogen/@azure/arm-trafficmanager/TrafficManagerManagementClientContext.yml b/docs-ref-autogen/@azure/arm-trafficmanager/TrafficManagerManagementClientContext.yml
index e8b5d07910d9..54c77a208b43 100644
--- a/docs-ref-autogen/@azure/arm-trafficmanager/TrafficManagerManagementClientContext.yml
+++ b/docs-ref-autogen/@azure/arm-trafficmanager/TrafficManagerManagementClientContext.yml
@@ -10,8 +10,8 @@ isDeprecated: false
type: class
constructors:
- name: >-
- TrafficManagerManagementClientContext(ServiceClientCredentials, string,
- Models.TrafficManagerManagementClientOptions)
+ TrafficManagerManagementClientContext(ServiceClientCredentials |
+ TokenCredential, string, Models.TrafficManagerManagementClientOptions)
uid: >-
@azure/arm-trafficmanager.TrafficManagerManagementClientContext.constructor
package: '@azure/arm-trafficmanager'
@@ -22,12 +22,24 @@ constructors:
syntax:
content: >-
new TrafficManagerManagementClientContext(credentials:
- ServiceClientCredentials, subscriptionId: string, options?:
- Models.TrafficManagerManagementClientOptions)
+ ServiceClientCredentials | TokenCredential, subscriptionId: string,
+ options?: Models.TrafficManagerManagementClientOptions)
parameters:
- id: credentials
- type: ServiceClientCredentials
- description: Credentials needed for the client to connect to Azure.
+ type: ServiceClientCredentials | TokenCredential
+ description: >-
+ Credentials needed for the client to connect to Azure. Credentials
+
+ implementing the TokenCredential interface from the @azure/identity
+ package are recommended. For
+
+ more information about these credentials, see
+
+ .
+ Credentials implementing the
+
+ ServiceClientCredentials interface from the older packages
+ @azure/ms-rest-nodeauth and
- id: subscriptionId
type: string
description: >-
@@ -77,9 +89,9 @@ properties:
isPreview: false
isDeprecated: false
syntax:
- content: 'credentials: ServiceClientCredentials'
+ content: 'credentials: ServiceClientCredentials | TokenCredential'
return:
- type: ServiceClientCredentials
+ type: ServiceClientCredentials | TokenCredential
description: ''
- name: longRunningOperationRetryTimeout
uid: >-
diff --git a/docs-ref-autogen/@azure/arm-trafficmanager/index.yml b/docs-ref-autogen/@azure/arm-trafficmanager/index.yml
index ccfe3fcf7a97..649424e9a278 100644
--- a/docs-ref-autogen/@azure/arm-trafficmanager/index.yml
+++ b/docs-ref-autogen/@azure/arm-trafficmanager/index.yml
@@ -30,6 +30,7 @@ interfaces:
- '@azure/arm-trafficmanager.TrafficManagerNameAvailability'
- '@azure/arm-trafficmanager.UserMetricsModel'
typeAliases:
+ - '@azure/arm-trafficmanager.AllowedEndpointRecordType'
- '@azure/arm-trafficmanager.EndpointMonitorStatus'
- '@azure/arm-trafficmanager.EndpointStatus'
- '@azure/arm-trafficmanager.EndpointsCreateOrUpdateResponse'
diff --git a/docs-ref-autogen/durable-functions/DummyOrchestrationContext.yml b/docs-ref-autogen/durable-functions/DummyOrchestrationContext.yml
new file mode 100644
index 000000000000..dd979201907c
--- /dev/null
+++ b/docs-ref-autogen/durable-functions/DummyOrchestrationContext.yml
@@ -0,0 +1,229 @@
+### YamlMime:TSType
+name: DummyOrchestrationContext
+uid: durable-functions.DummyOrchestrationContext
+package: durable-functions
+summary: >-
+ An orchestration context with dummy default values to facilitate
+ mocking/stubbing the
+
+ Durable Functions API.
+fullName: DummyOrchestrationContext
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: class
+constructors:
+ - name: >-
+ DummyOrchestrationContext(string, HistoryEvent[] | undefined, any, Date,
+ boolean, string)
+ uid: durable-functions.DummyOrchestrationContext.constructor
+ package: durable-functions
+ summary: |-
+ Creates a new instance of a dummy orchestration context.
+ All parameters are optional but are exposed to enable flexibility
+ in the testing process.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ new DummyOrchestrationContext(instanceId?: string, history?:
+ HistoryEvent[] | undefined, input?: any, currentUtcDateTime?: Date,
+ isReplaying?: boolean, parentInstanceId?: string)
+ parameters:
+ - id: instanceId
+ type: string
+ description: The instanceId of the orchestration
+ - id: history
+ type: 'HistoryEvent[] | undefined'
+ description: The history events array of the orchestration
+ - id: input
+ type: any
+ description: The input to the orchestration
+ - id: currentUtcDateTime
+ type: Date
+ description: The deterministic date at the beginning of orchestration replay
+ - id: isReplaying
+ type: boolean
+ description: >-
+ Whether the orchestration is to be marked as isReplaying the its
+ first event
+ - id: parentInstanceId
+ type: string
+ description: >
+ The instanceId of the orchestration's parent, if this is a
+ sub-orchestration
+properties:
+ - name: bindingData
+ uid: durable-functions.DummyOrchestrationContext.bindingData
+ package: durable-functions
+ summary: ''
+ fullName: bindingData
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'bindingData: ContextBindingData'
+ return:
+ type: ContextBindingData
+ description: ''
+ - name: bindingDefinitions
+ uid: durable-functions.DummyOrchestrationContext.bindingDefinitions
+ package: durable-functions
+ summary: ''
+ fullName: bindingDefinitions
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'bindingDefinitions: BindingDefinition[]'
+ return:
+ type: 'BindingDefinition[]'
+ description: ''
+ - name: bindings
+ uid: durable-functions.DummyOrchestrationContext.bindings
+ package: durable-functions
+ summary: ''
+ fullName: bindings
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'bindings: ContextBindings'
+ return:
+ type: ContextBindings
+ description: ''
+ - name: df
+ uid: durable-functions.DummyOrchestrationContext.df
+ package: durable-functions
+ summary: ''
+ fullName: df
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'df: DurableOrchestrationContext'
+ return:
+ type:
+ description: ''
+ - name: doneValue
+ uid: durable-functions.DummyOrchestrationContext.doneValue
+ package: durable-functions
+ summary: ''
+ fullName: doneValue
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'doneValue: IOrchestratorState | undefined'
+ return:
+ type: IOrchestratorState | undefined
+ description: ''
+ - name: err
+ uid: durable-functions.DummyOrchestrationContext.err
+ package: durable-functions
+ summary: ''
+ fullName: err
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'err: string | Error | null | undefined'
+ return:
+ type: string | Error | null | undefined
+ description: ''
+ - name: executionContext
+ uid: durable-functions.DummyOrchestrationContext.executionContext
+ package: durable-functions
+ summary: ''
+ fullName: executionContext
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'executionContext: ExecutionContext'
+ return:
+ type: ExecutionContext
+ description: ''
+ - name: invocationId
+ uid: durable-functions.DummyOrchestrationContext.invocationId
+ package: durable-functions
+ summary: ''
+ fullName: invocationId
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'invocationId: string'
+ return:
+ type: string
+ description: ''
+ - name: log
+ uid: durable-functions.DummyOrchestrationContext.log
+ package: durable-functions
+ summary: ''
+ fullName: log
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'log: Logger'
+ return:
+ type: Logger
+ description: ''
+ - name: req
+ uid: durable-functions.DummyOrchestrationContext.req
+ package: durable-functions
+ summary: ''
+ fullName: req
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'req?: HttpRequest'
+ return:
+ type: HttpRequest
+ description: ''
+ - name: res
+ uid: durable-functions.DummyOrchestrationContext.res
+ package: durable-functions
+ summary: ''
+ fullName: res
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'res?: [key: string]: any'
+ return:
+ type: '[key: string]\: any'
+ description: ''
+ - name: traceContext
+ uid: durable-functions.DummyOrchestrationContext.traceContext
+ package: durable-functions
+ summary: ''
+ fullName: traceContext
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'traceContext: TraceContext'
+ return:
+ type: TraceContext
+ description: ''
+methods:
+ - name: 'done(string | Error, any)'
+ uid: durable-functions.DummyOrchestrationContext.done
+ package: durable-functions
+ summary: ''
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'function done(err?: string | Error, result?: any)'
+ parameters:
+ - id: err
+ type: string | Error
+ description: ''
+ - id: result
+ type: any
+ description: ''
diff --git a/docs-ref-autogen/durable-functions/DurableEntityContext.yml b/docs-ref-autogen/durable-functions/DurableEntityContext.yml
index 2dd3c8f58ca6..c3716ebfff1a 100644
--- a/docs-ref-autogen/durable-functions/DurableEntityContext.yml
+++ b/docs-ref-autogen/durable-functions/DurableEntityContext.yml
@@ -1,180 +1,18 @@
-### YamlMime:TSType
+### YamlMime:TSTypeAlias
name: DurableEntityContext
uid: durable-functions.DurableEntityContext
package: durable-functions
summary: |-
Provides functionality for application code implementing an entity
operation.
-fullName: DurableEntityContext
+fullName: DurableEntityContext
remarks: ''
isPreview: false
isDeprecated: false
-type: class
-properties:
- - name: entityId
- uid: durable-functions.DurableEntityContext.entityId
- package: durable-functions
- summary: Gets the id of the currently executing entity.
- fullName: entityId
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'entityId: EntityId'
- return:
- type:
- description: ''
- - name: entityKey
- uid: durable-functions.DurableEntityContext.entityKey
- package: durable-functions
- summary: Gets the key of the currently executing entity.
- fullName: entityKey
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'entityKey: string'
- return:
- type: string
- description: ''
- - name: entityName
- uid: durable-functions.DurableEntityContext.entityName
- package: durable-functions
- summary: Gets the name of the currently executing entity.
- fullName: entityName
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'entityName: string'
- return:
- type: string
- description: ''
- - name: isNewlyConstructed
- uid: durable-functions.DurableEntityContext.isNewlyConstructed
- package: durable-functions
- summary: |-
- Whether this entity is freshly constructed, i.e. did not exist prior to
- this operation being called.
- fullName: isNewlyConstructed
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'isNewlyConstructed: boolean'
- return:
- type: boolean
- description: ''
- - name: operationName
- uid: durable-functions.DurableEntityContext.operationName
- package: durable-functions
- summary: |
- Gets the name of the operation that was called.
- An operation invocation on an entity includes an operation name, which
- states what operation to perform, and optionally an operation input.
- fullName: operationName
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'operationName: string | undefined'
- return:
- type: string | undefined
- description: ''
-methods:
- - name: destructOnExit()
- uid: durable-functions.DurableEntityContext.destructOnExit
- package: durable-functions
- summary: Deletes this entity after this operation completes.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: function destructOnExit()
- - name: getInput()
- uid: durable-functions.DurableEntityContext.getInput
- package: durable-functions
- summary: |
- Gets the input for this operation.
- An operation invocation on an entity includes an operation name, which
- states what operation to perform, and optionally an operation input.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: function getInput()
- return:
- type: unknown | undefined
- description: 'The operation input, or undefined if none.'
- - name: getState(() => unknown)
- uid: durable-functions.DurableEntityContext.getState
- package: durable-functions
- summary: 'Gets the current state of this entity, for reading and/or writing.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'function getState(initializer?: () => unknown)'
- parameters:
- - id: initializer
- type: () => unknown
- description: |-
- Provides an initial value to use for the state,
- instead of TState's default.
- return:
- type: unknown | undefined
- description: >-
- The current state of this entity, or undefined if none has been set
- yet.
- - name: return(unknown)
- uid: durable-functions.DurableEntityContext.return
- package: durable-functions
- summary: Returns the given result to the caller of this operation.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'function return(result: unknown)'
- parameters:
- - id: result
- type: unknown
- description: |
- The result to return.
- - name: setState(unknown)
- uid: durable-functions.DurableEntityContext.setState
- package: durable-functions
- summary: Sets the current state of this entity.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'function setState(state: unknown)'
- parameters:
- - id: state
- type: unknown
- description: |
- The state of the entity.
- - name: 'signalEntity(EntityId, string, unknown)'
- uid: durable-functions.DurableEntityContext.signalEntity
- package: durable-functions
- summary: |-
- Signals an entity to perform an operation, without waiting for a
- response. Any result or exception is ignored (fire and forget).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: >-
- function signalEntity(entity: EntityId, operationName: string,
- operationInput?: unknown)
- parameters:
- - id: entity
- type:
- description: The target entity.
- - id: operationName
- type: string
- description: The name of the operation.
- - id: operationInput
- type: unknown
- description: |
- The operation input.
+syntax: >-
+ type DurableEntityContext = { entityId: EntityId, entityKey: string,
+ entityName: string, isNewlyConstructed: boolean, operationName: Object,
+ destructOnExit() => void, getInput() => TInput | undefined,
+ getState(initializer?: () => TState) => TState | undefined, return(result:
+ TResult) => void, setState(state: TState) => void, signalEntity(entity:
+ EntityId, operationName: string, operationInput?: unknown) => void }
diff --git a/docs-ref-autogen/durable-functions/DurableOrchestrationContext.yml b/docs-ref-autogen/durable-functions/DurableOrchestrationContext.yml
index 7f4ea944d341..0bd241b175fe 100644
--- a/docs-ref-autogen/durable-functions/DurableOrchestrationContext.yml
+++ b/docs-ref-autogen/durable-functions/DurableOrchestrationContext.yml
@@ -10,6 +10,40 @@ remarks: ''
isPreview: false
isDeprecated: false
type: class
+constructors:
+ - name: >-
+ DurableOrchestrationContext(HistoryEvent[], string, Date, boolean, string
+ | undefined, unknown)
+ uid: durable-functions.DurableOrchestrationContext.constructor
+ package: durable-functions
+ summary: ''
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ new DurableOrchestrationContext(state: HistoryEvent[], instanceId:
+ string, currentUtcDateTime: Date, isReplaying: boolean,
+ parentInstanceId: string | undefined, input: unknown)
+ parameters:
+ - id: state
+ type: 'HistoryEvent[]'
+ description: ''
+ - id: instanceId
+ type: string
+ description: ''
+ - id: currentUtcDateTime
+ type: Date
+ description: ''
+ - id: isReplaying
+ type: boolean
+ description: ''
+ - id: parentInstanceId
+ type: string | undefined
+ description: ''
+ - id: input
+ type: unknown
+ description: ''
properties:
- name: currentUtcDateTime
uid: durable-functions.DurableOrchestrationContext.currentUtcDateTime
@@ -29,6 +63,19 @@ properties:
return:
type: Date
description: ''
+ - name: customStatus
+ uid: durable-functions.DurableOrchestrationContext.customStatus
+ package: durable-functions
+ summary: ''
+ fullName: customStatus
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'customStatus: unknown'
+ return:
+ type: unknown
+ description: ''
- name: instanceId
uid: durable-functions.DurableOrchestrationContext.instanceId
package: durable-functions
@@ -166,7 +213,7 @@ methods:
syntax:
content: >-
function callEntity(entityId: EntityId, operationName: string,
- operationInput?: unknown)
+ operationInput: unknown)
parameters:
- id: entityId
type:
@@ -317,7 +364,7 @@ methods:
return:
type:
description: A TimerTask that completes when the durable timer expires.
- - name: getInput()
+ - name: getInput()
uid: durable-functions.DurableOrchestrationContext.getInput
package: durable-functions
summary: |-
@@ -327,11 +374,11 @@ methods:
isPreview: false
isDeprecated: false
syntax:
- content: function getInput()
+ content: function getInput()
return:
- type: unknown
+ type: T
description: ''
- - name: newGuid()
+ - name: newGuid(string)
uid: durable-functions.DurableOrchestrationContext.newGuid
package: durable-functions
summary: |
@@ -345,7 +392,11 @@ methods:
isPreview: false
isDeprecated: false
syntax:
- content: function newGuid()
+ content: 'function newGuid(instanceId: string)'
+ parameters:
+ - id: instanceId
+ type: string
+ description: ''
return:
type: string
description: ''
diff --git a/docs-ref-autogen/durable-functions/IEntityFunctionContext.yml b/docs-ref-autogen/durable-functions/IEntityFunctionContext.yml
index 9ee56a3bcbd2..faeeaf4570d2 100644
--- a/docs-ref-autogen/durable-functions/IEntityFunctionContext.yml
+++ b/docs-ref-autogen/durable-functions/IEntityFunctionContext.yml
@@ -3,55 +3,12 @@ name: IEntityFunctionContext
uid: durable-functions.IEntityFunctionContext
package: durable-functions
summary: ''
-fullName: IEntityFunctionContext
+fullName: IEntityFunctionContext
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- - name: bindingData
- uid: durable-functions.IEntityFunctionContext.bindingData
- package: durable-functions
- summary: Trigger metadata and function invocation data.
- fullName: bindingData
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'bindingData: ContextBindingData'
- return:
- type: ContextBindingData
- description: ''
- - name: bindingDefinitions
- uid: durable-functions.IEntityFunctionContext.bindingDefinitions
- package: durable-functions
- summary: 'Bindings your function uses, as defined in function.json.'
- fullName: bindingDefinitions
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'bindingDefinitions: BindingDefinition[]'
- return:
- type: 'BindingDefinition[]'
- description: ''
- - name: bindings
- uid: durable-functions.IEntityFunctionContext.bindings
- package: durable-functions
- summary: >-
- Input and trigger binding data, as defined in function.json. Properties on
- this object are dynamically
-
- generated and named based off of the "name" property in function.json.
- fullName: bindings
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'bindings: ContextBindings'
- return:
- type: ContextBindings
- description: ''
- name: df
uid: durable-functions.IEntityFunctionContext.df
package: durable-functions
@@ -61,119 +18,8 @@ properties:
isPreview: false
isDeprecated: false
syntax:
- content: 'df: DurableEntityContext'
- return:
- type:
- description: ''
- - name: executionContext
- uid: durable-functions.IEntityFunctionContext.executionContext
- package: durable-functions
- summary: Function execution metadata.
- fullName: executionContext
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'executionContext: ExecutionContext'
- return:
- type: ExecutionContext
- description: ''
- - name: invocationId
- uid: durable-functions.IEntityFunctionContext.invocationId
- package: durable-functions
- summary: A unique GUID per function invocation.
- fullName: invocationId
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'invocationId: string'
- return:
- type: string
- description: ''
- - name: log
- uid: durable-functions.IEntityFunctionContext.log
- package: durable-functions
- summary: >-
- Allows you to write streaming function logs. Calling directly allows you
- to write streaming function logs
-
- at the default trace level.
- fullName: log
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'log: Logger'
- return:
- type: Logger
- description: ''
- - name: req
- uid: durable-functions.IEntityFunctionContext.req
- package: durable-functions
- summary: HTTP request object. Provided to your function when using HTTP Bindings.
- fullName: req
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'req?: HttpRequest'
- return:
- type: HttpRequest
- description: ''
- - name: res
- uid: durable-functions.IEntityFunctionContext.res
- package: durable-functions
- summary: HTTP response object. Provided to your function when using HTTP Bindings.
- fullName: res
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'res?: [key: string]: any'
+ content: 'df: DurableEntityContext'
return:
- type: '[key: string]\: any'
+ type: <T>
description: ''
- - name: traceContext
- uid: durable-functions.IEntityFunctionContext.traceContext
- package: durable-functions
- summary: TraceContext information to enable distributed tracing scenarios.
- fullName: traceContext
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'traceContext: TraceContext'
- return:
- type: TraceContext
- description: ''
-methods:
- - name: 'done(Error | string | null, any)'
- uid: durable-functions.IEntityFunctionContext.done
- package: durable-functions
- summary: >-
- A callback function that signals to the runtime that your code has
- completed. If your function is synchronous,
-
- you must call context.done at the end of execution. If your function is
- asynchronous, you should not use this
-
- callback.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'function done(err?: Error | string | null, result?: any)'
- parameters:
- - id: err
- type: Error | string | null
- description: >-
- A user-defined error to pass back to the runtime. If present, your
- function execution will fail.
- - id: result
- type: any
- description: >
- An object containing output binding data. `result` will be passed to
- JSON.stringify unless it is
- a string, Buffer, ArrayBufferView, or number.
-extends: Context
+extends: any
diff --git a/docs-ref-autogen/durable-functions/IOrchestrationFunctionContext.yml b/docs-ref-autogen/durable-functions/IOrchestrationFunctionContext.yml
index 13d1dfb39258..42010d7c479a 100644
--- a/docs-ref-autogen/durable-functions/IOrchestrationFunctionContext.yml
+++ b/docs-ref-autogen/durable-functions/IOrchestrationFunctionContext.yml
@@ -9,49 +9,6 @@ isPreview: false
isDeprecated: false
type: interface
properties:
- - name: bindingData
- uid: durable-functions.IOrchestrationFunctionContext.bindingData
- package: durable-functions
- summary: Trigger metadata and function invocation data.
- fullName: bindingData
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'bindingData: ContextBindingData'
- return:
- type: ContextBindingData
- description: ''
- - name: bindingDefinitions
- uid: durable-functions.IOrchestrationFunctionContext.bindingDefinitions
- package: durable-functions
- summary: 'Bindings your function uses, as defined in function.json.'
- fullName: bindingDefinitions
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'bindingDefinitions: BindingDefinition[]'
- return:
- type: 'BindingDefinition[]'
- description: ''
- - name: bindings
- uid: durable-functions.IOrchestrationFunctionContext.bindings
- package: durable-functions
- summary: >-
- Input and trigger binding data, as defined in function.json. Properties on
- this object are dynamically
-
- generated and named based off of the "name" property in function.json.
- fullName: bindings
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'bindings: ContextBindings'
- return:
- type: ContextBindings
- description: ''
- name: df
uid: durable-functions.IOrchestrationFunctionContext.df
package: durable-functions
@@ -65,115 +22,4 @@ properties:
return:
type:
description: ''
- - name: executionContext
- uid: durable-functions.IOrchestrationFunctionContext.executionContext
- package: durable-functions
- summary: Function execution metadata.
- fullName: executionContext
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'executionContext: ExecutionContext'
- return:
- type: ExecutionContext
- description: ''
- - name: invocationId
- uid: durable-functions.IOrchestrationFunctionContext.invocationId
- package: durable-functions
- summary: A unique GUID per function invocation.
- fullName: invocationId
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'invocationId: string'
- return:
- type: string
- description: ''
- - name: log
- uid: durable-functions.IOrchestrationFunctionContext.log
- package: durable-functions
- summary: >-
- Allows you to write streaming function logs. Calling directly allows you
- to write streaming function logs
-
- at the default trace level.
- fullName: log
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'log: Logger'
- return:
- type: Logger
- description: ''
- - name: req
- uid: durable-functions.IOrchestrationFunctionContext.req
- package: durable-functions
- summary: HTTP request object. Provided to your function when using HTTP Bindings.
- fullName: req
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'req?: HttpRequest'
- return:
- type: HttpRequest
- description: ''
- - name: res
- uid: durable-functions.IOrchestrationFunctionContext.res
- package: durable-functions
- summary: HTTP response object. Provided to your function when using HTTP Bindings.
- fullName: res
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'res?: [key: string]: any'
- return:
- type: '[key: string]\: any'
- description: ''
- - name: traceContext
- uid: durable-functions.IOrchestrationFunctionContext.traceContext
- package: durable-functions
- summary: TraceContext information to enable distributed tracing scenarios.
- fullName: traceContext
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'traceContext: TraceContext'
- return:
- type: TraceContext
- description: ''
-methods:
- - name: 'done(Error | string | null, any)'
- uid: durable-functions.IOrchestrationFunctionContext.done
- package: durable-functions
- summary: >-
- A callback function that signals to the runtime that your code has
- completed. If your function is synchronous,
-
- you must call context.done at the end of execution. If your function is
- asynchronous, you should not use this
-
- callback.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'function done(err?: Error | string | null, result?: any)'
- parameters:
- - id: err
- type: Error | string | null
- description: >-
- A user-defined error to pass back to the runtime. If present, your
- function execution will fail.
- - id: result
- type: any
- description: >
- An object containing output binding data. `result` will be passed to
- JSON.stringify unless it is
- a string, Buffer, ArrayBufferView, or number.
-extends: Context
+extends: any
diff --git a/docs-ref-autogen/durable-functions/index.yml b/docs-ref-autogen/durable-functions/index.yml
index 653457a8e754..cd5d30ffa5e8 100644
--- a/docs-ref-autogen/durable-functions/index.yml
+++ b/docs-ref-autogen/durable-functions/index.yml
@@ -5,7 +5,6 @@ summary: ''
type: package
classes:
- durable-functions.AggregatedError
- - durable-functions.DurableEntityContext
- durable-functions.DurableError
- durable-functions.DurableHttpRequest
- durable-functions.DurableHttpResponse
@@ -19,7 +18,11 @@ classes:
- durable-functions.RetryOptions
- durable-functions.Task
- durable-functions.TimerTask
+ - durable-functions.DummyOrchestrationContext
- durable-functions.ManagedIdentityTokenSource
+typeAliases:
+ - durable-functions.DurableEntityContext
+ - durable-functions.TokenSource
functions:
- name: getClient(unknown)
uid: durable-functions.getClient
@@ -39,7 +42,7 @@ functions:
return:
type:
description: ''
- - name: 'entity((context: IEntityFunctionContext) => unknown)'
+ - name: 'entity((context: IEntityFunctionContext) => void)'
uid: durable-functions.entity
package: durable-functions
summary: ''
@@ -47,13 +50,13 @@ functions:
isPreview: false
isDeprecated: false
syntax:
- content: 'function entity(fn: (context: IEntityFunctionContext) => unknown)'
+ content: 'function entity(fn: (context: IEntityFunctionContext) => void)'
parameters:
- id: fn
- type: '(context: IEntityFunctionContext) => unknown'
+ type: '(context: IEntityFunctionContext<T>) => void'
description: ''
return:
- type: '(context: IEntityFunctionContext) => void'
+ type: '(context: IEntityFunctionContext<T>) => void'
description: ''
- name: >-
orchestrator((context: IOrchestrationFunctionContext) =>
@@ -87,5 +90,3 @@ interfaces:
- durable-functions.ITaskMethods
enums:
- durable-functions.OrchestrationRuntimeStatus
-typeAliases:
- - durable-functions.TokenSource
diff --git a/docs-ref-autogen/toc.yml b/docs-ref-autogen/toc.yml
index aa313c70b8d3..367e42ff4268 100644
--- a/docs-ref-autogen/toc.yml
+++ b/docs-ref-autogen/toc.yml
@@ -27876,9 +27876,6 @@
- uid: '@azure/arm-eventgrid.PartnerRegistration'
name: PartnerRegistration
items: []
- - uid: '@azure/arm-eventgrid.PartnerRegistrationEventTypesListResult'
- name: PartnerRegistrationEventTypesListResult
- items: []
- uid: '@azure/arm-eventgrid.PartnerRegistrationProvisioningState'
name: PartnerRegistrationProvisioningState
items: []
@@ -27919,9 +27916,6 @@
- uid: '@azure/arm-eventgrid.PartnerRegistrationsListBySubscriptionResponse'
name: PartnerRegistrationsListBySubscriptionResponse
items: []
- - uid: '@azure/arm-eventgrid.PartnerRegistrationsListResponse'
- name: PartnerRegistrationsListResponse
- items: []
- uid: '@azure/arm-eventgrid.PartnerRegistrationsListResult'
name: PartnerRegistrationsListResult
items: []
@@ -28031,15 +28025,6 @@
- uid: '@azure/arm-eventgrid.PartnerTopicsUpdateResponse'
name: PartnerTopicsUpdateResponse
items: []
- - uid: '@azure/arm-eventgrid.PartnerTopicType'
- name: PartnerTopicType
- items: []
- - uid: '@azure/arm-eventgrid.PartnerTopicTypeAuthorizationState'
- name: PartnerTopicTypeAuthorizationState
- items: []
- - uid: '@azure/arm-eventgrid.PartnerTopicTypesListResult'
- name: PartnerTopicTypesListResult
- items: []
- uid: '@azure/arm-eventgrid.PartnerTopicUpdateParameters'
name: PartnerTopicUpdateParameters
items: []
@@ -64152,6 +64137,9 @@
items:
- name: Overview
uid: '@azure/arm-trafficmanager'
+ - uid: '@azure/arm-trafficmanager.AllowedEndpointRecordType'
+ name: AllowedEndpointRecordType
+ items: []
- uid: >-
@azure/arm-trafficmanager.CheckTrafficManagerRelativeDnsNameAvailabilityParameters
name: CheckTrafficManagerRelativeDnsNameAvailabilityParameters
@@ -85955,6 +85943,9 @@
- uid: durable-functions.AggregatedError
name: AggregatedError
items: []
+ - uid: durable-functions.DummyOrchestrationContext
+ name: DummyOrchestrationContext
+ items: []
- uid: durable-functions.DurableEntityContext
name: DurableEntityContext
items: []