diff --git a/sdk/eventgrid/arm-eventgrid/package.json b/sdk/eventgrid/arm-eventgrid/package.json index ca2ebd4b89a4..aab72c702f5a 100644 --- a/sdk/eventgrid/arm-eventgrid/package.json +++ b/sdk/eventgrid/arm-eventgrid/package.json @@ -5,7 +5,7 @@ "version": "3.1.0", "dependencies": { "@azure/ms-rest-azure-js": "^1.3.2", - "@azure/ms-rest-js": "^1.6.0", + "@azure/ms-rest-js": "^1.8.1", "tslib": "^1.9.3" }, "keywords": [ @@ -26,7 +26,7 @@ "rollup-plugin-sourcemaps": "^0.4.2", "uglify-js": "^3.4.9" }, - "homepage": "https://github.com/azure/azure-sdk-for-js/tree/master/sdk/eventgrid/arm-eventgrid", + "homepage": "https://github.com/azure/azure-sdk-for-js", "repository": { "type": "git", "url": "https://github.com/azure/azure-sdk-for-js.git" diff --git a/sdk/eventgrid/arm-eventgrid/src/eventGridManagementClientContext.ts b/sdk/eventgrid/arm-eventgrid/src/eventGridManagementClientContext.ts index f0d54287e1a6..25489e1ed5f4 100644 --- a/sdk/eventgrid/arm-eventgrid/src/eventGridManagementClientContext.ts +++ b/sdk/eventgrid/arm-eventgrid/src/eventGridManagementClientContext.ts @@ -13,7 +13,7 @@ import * as msRest from "@azure/ms-rest-js"; import * as msRestAzure from "@azure/ms-rest-azure-js"; const packageName = "@azure/arm-eventgrid"; -const packageVersion = "3.0.1"; +const packageVersion = "3.1.0"; export class EventGridManagementClientContext extends msRestAzure.AzureServiceClient { credentials: msRest.ServiceClientCredentials; @@ -45,7 +45,7 @@ export class EventGridManagementClientContext extends msRestAzure.AzureServiceCl super(credentials, options); - this.apiVersion = '2019-02-01-preview'; + this.apiVersion = '2019-06-01'; this.acceptLanguage = 'en-US'; this.longRunningOperationRetryTimeout = 30; this.baseUri = options.baseUri || this.baseUri || "https://management.azure.com"; diff --git a/sdk/eventgrid/arm-eventgrid/src/models/domainTopicsMappers.ts b/sdk/eventgrid/arm-eventgrid/src/models/domainTopicsMappers.ts index 91dbed7b85b1..acc773d5b677 100644 --- a/sdk/eventgrid/arm-eventgrid/src/models/domainTopicsMappers.ts +++ b/sdk/eventgrid/arm-eventgrid/src/models/domainTopicsMappers.ts @@ -22,10 +22,6 @@ export { EventSubscriptionFilter, EventType, HybridConnectionEventSubscriptionDestination, - InputSchemaMapping, - JsonField, - JsonFieldWithDefault, - JsonInputSchemaMapping, NumberGreaterThanAdvancedFilter, NumberGreaterThanOrEqualsAdvancedFilter, NumberInAdvancedFilter, diff --git a/sdk/eventgrid/arm-eventgrid/src/models/domainsMappers.ts b/sdk/eventgrid/arm-eventgrid/src/models/domainsMappers.ts index 191c160034f2..6c1bc7afa22d 100644 --- a/sdk/eventgrid/arm-eventgrid/src/models/domainsMappers.ts +++ b/sdk/eventgrid/arm-eventgrid/src/models/domainsMappers.ts @@ -25,10 +25,6 @@ export { EventSubscriptionFilter, EventType, HybridConnectionEventSubscriptionDestination, - InputSchemaMapping, - JsonField, - JsonFieldWithDefault, - JsonInputSchemaMapping, NumberGreaterThanAdvancedFilter, NumberGreaterThanOrEqualsAdvancedFilter, NumberInAdvancedFilter, diff --git a/sdk/eventgrid/arm-eventgrid/src/models/eventSubscriptionsMappers.ts b/sdk/eventgrid/arm-eventgrid/src/models/eventSubscriptionsMappers.ts index ce99084c8385..a90c543e5ac5 100644 --- a/sdk/eventgrid/arm-eventgrid/src/models/eventSubscriptionsMappers.ts +++ b/sdk/eventgrid/arm-eventgrid/src/models/eventSubscriptionsMappers.ts @@ -24,10 +24,6 @@ export { EventSubscriptionUpdateParameters, EventType, HybridConnectionEventSubscriptionDestination, - InputSchemaMapping, - JsonField, - JsonFieldWithDefault, - JsonInputSchemaMapping, NumberGreaterThanAdvancedFilter, NumberGreaterThanOrEqualsAdvancedFilter, NumberInAdvancedFilter, diff --git a/sdk/eventgrid/arm-eventgrid/src/models/index.ts b/sdk/eventgrid/arm-eventgrid/src/models/index.ts index f331d33127e5..acc2ac4c77c5 100644 --- a/sdk/eventgrid/arm-eventgrid/src/models/index.ts +++ b/sdk/eventgrid/arm-eventgrid/src/models/index.ts @@ -12,125 +12,42 @@ import * as msRest from "@azure/ms-rest-js"; export { BaseResource, CloudError }; /** - * Contains the possible cases for InputSchemaMapping. - */ -export type InputSchemaMappingUnion = InputSchemaMapping | JsonInputSchemaMapping; - -/** - * By default, Event Grid expects events to be in the Event Grid event schema. Specifying an input - * schema mapping enables publishing to Event Grid using a custom input schema. Currently, the only - * supported type of InputSchemaMapping is 'JsonInputSchemaMapping'. - */ -export interface InputSchemaMapping { - /** - * Polymorphic Discriminator - */ - inputSchemaMappingType: "InputSchemaMapping"; -} - -/** - * Definition of a Resource + * Definition of a Resource. */ export interface Resource extends BaseResource { /** - * Fully qualified identifier of the resource + * Fully qualified identifier of the resource. * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly id?: string; /** - * Name of the resource + * Name of the resource. * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly name?: string; /** - * Type of the resource + * Type of the resource. * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly type?: string; } /** - * This is used to express the source of an input schema mapping for a single target field in the - * Event Grid Event schema. This is currently used in the mappings for the 'id', 'topic' and - * 'eventtime' properties. This represents a field in the input event schema. - */ -export interface JsonField { - /** - * Name of a field in the input event schema that's to be used as the source of a mapping. - */ - sourceField?: string; -} - -/** - * This is used to express the source of an input schema mapping for a single target field - * in the Event Grid Event schema. This is currently used in the mappings for the 'subject', - * 'eventtype' and 'dataversion' properties. This represents a field in the input event schema - * along with a default value to be used, and at least one of these two properties should be - * provided. - */ -export interface JsonFieldWithDefault { - /** - * Name of a field in the input event schema that's to be used as the source of a mapping. - */ - sourceField?: string; - /** - * The default value to be used for mapping when a SourceField is not provided or if there's no - * property with the specified name in the published JSON event payload. - */ - defaultValue?: string; -} - -/** - * This enables publishing to Event Grid using a custom input schema. This can be used to map - * properties from a custom input JSON schema to the Event Grid event schema. - */ -export interface JsonInputSchemaMapping { - /** - * Polymorphic Discriminator - */ - inputSchemaMappingType: "Json"; - /** - * The mapping information for the Id property of the Event Grid Event. - */ - id?: JsonField; - /** - * The mapping information for the Topic property of the Event Grid Event. - */ - topic?: JsonField; - /** - * The mapping information for the EventTime property of the Event Grid Event. - */ - eventTime?: JsonField; - /** - * The mapping information for the EventType property of the Event Grid Event. - */ - eventType?: JsonFieldWithDefault; - /** - * The mapping information for the Subject property of the Event Grid Event. - */ - subject?: JsonFieldWithDefault; - /** - * The mapping information for the DataVersion property of the Event Grid Event. - */ - dataVersion?: JsonFieldWithDefault; -} - -/** - * Definition of a Tracked Resource + * Definition of a Tracked Resource. */ export interface TrackedResource extends Resource { /** - * Location of the resource + * Location of the resource. */ location: string; /** - * Tags of the resource + * Tags of the resource. */ tags?: { [propertyName: string]: string }; } /** - * EventGrid Domain + * EventGrid Domain. */ export interface Domain extends TrackedResource { /** @@ -144,30 +61,20 @@ export interface Domain extends TrackedResource { * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly endpoint?: string; - /** - * This determines the format that Event Grid should expect for incoming events published to the - * domain. Possible values include: 'EventGridSchema', 'CustomEventSchema', - * 'CloudEventV01Schema'. Default value: 'EventGridSchema'. - */ - inputSchema?: InputSchema; - /** - * Information about the InputSchemaMapping which specified the info about mapping event payload. - */ - inputSchemaMapping?: InputSchemaMappingUnion; } /** - * Properties of the Domain update + * Properties of the Domain update. */ export interface DomainUpdateParameters { /** - * Tags of the domains resource + * Tags of the domains resource. */ tags?: { [propertyName: string]: string }; } /** - * Shared access keys of the Domain + * Shared access keys of the Domain. */ export interface DomainSharedAccessKeys { /** @@ -181,17 +88,17 @@ export interface DomainSharedAccessKeys { } /** - * Domain regenerate share access key request + * Domain regenerate share access key request. */ export interface DomainRegenerateKeyRequest { /** - * Key name to regenerate key1 or key2 + * Key name to regenerate key1 or key2. */ keyName: string; } /** - * Domain Topic + * Domain Topic. */ export interface DomainTopic extends Resource { /** @@ -239,7 +146,7 @@ export interface AdvancedFilter { } /** - * Filter for the Event Subscription + * Filter for the Event Subscription. */ export interface EventSubscriptionFilter { /** @@ -270,7 +177,7 @@ export interface EventSubscriptionFilter { } /** - * Information about the retry policy for an event subscription + * Information about the retry policy for an event subscription. */ export interface RetryPolicy { /** @@ -651,11 +558,6 @@ export interface EventSubscription extends Resource { * Expiration time of the event subscription. */ expirationTimeUtc?: Date; - /** - * The event delivery schema for the event subscription. Possible values include: - * 'EventGridSchema', 'CloudEventV01Schema', 'CustomInputSchema' - */ - eventDeliverySchema?: EventDeliverySchema; /** * The retry policy for events. This can be used to configure maximum number of delivery attempts * and time to live for events. @@ -688,11 +590,6 @@ export interface EventSubscriptionUpdateParameters { * Information about the expiration time for the event subscription. */ expirationTimeUtc?: Date; - /** - * The event delivery schema for the event subscription. Possible values include: - * 'EventGridSchema', 'CloudEventV01Schema', 'CustomInputSchema' - */ - eventDeliverySchema?: EventDeliverySchema; /** * The retry policy for events. This can be used to configure maximum number of delivery attempts * and time to live for events. @@ -773,18 +670,6 @@ export interface Topic extends TrackedResource { * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly endpoint?: string; - /** - * This determines the format that Event Grid should expect for incoming events published to the - * topic. Possible values include: 'EventGridSchema', 'CustomEventSchema', 'CloudEventV01Schema'. - * Default value: 'EventGridSchema'. - */ - inputSchema?: InputSchema; - /** - * This enables publishing using custom event schemas. An InputSchemaMapping can be specified to - * map various properties of a source schema to various required properties of the EventGridEvent - * schema. - */ - inputSchemaMapping?: InputSchemaMappingUnion; } /** @@ -879,11 +764,18 @@ export interface TopicTypeInfo extends Resource { */ export interface DomainsListBySubscriptionOptionalParams extends msRest.RequestOptionsBase { /** - * Filter the results using OData syntax. + * The query used to filter the search results using OData syntax. Filtering is permitted on the + * 'name' property only and with limited number of OData operations. These operations are: the + * 'contains' function as well as the following logical operations: not, and, or, eq (for equal), + * and ne (for not equal). No arithmetic operations are supported. The following is a valid + * filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is + * not a valid filter example: $filter=location eq 'westus'. */ filter?: string; /** - * The number of results to return. + * The number of results to return per page for the list operation. Valid range for top parameter + * is 1 to 100. If not specified, the default number of results to be returned is 20 items per + * page. */ top?: number; } @@ -893,11 +785,18 @@ export interface DomainsListBySubscriptionOptionalParams extends msRest.RequestO */ export interface DomainsListByResourceGroupOptionalParams extends msRest.RequestOptionsBase { /** - * Filter the results using OData syntax. + * The query used to filter the search results using OData syntax. Filtering is permitted on the + * 'name' property only and with limited number of OData operations. These operations are: the + * 'contains' function as well as the following logical operations: not, and, or, eq (for equal), + * and ne (for not equal). No arithmetic operations are supported. The following is a valid + * filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is + * not a valid filter example: $filter=location eq 'westus'. */ filter?: string; /** - * The number of results to return. + * The number of results to return per page for the list operation. Valid range for top parameter + * is 1 to 100. If not specified, the default number of results to be returned is 20 items per + * page. */ top?: number; } @@ -907,11 +806,18 @@ export interface DomainsListByResourceGroupOptionalParams extends msRest.Request */ export interface DomainTopicsListByDomainOptionalParams extends msRest.RequestOptionsBase { /** - * Filter the results using OData syntax. + * The query used to filter the search results using OData syntax. Filtering is permitted on the + * 'name' property only and with limited number of OData operations. These operations are: the + * 'contains' function as well as the following logical operations: not, and, or, eq (for equal), + * and ne (for not equal). No arithmetic operations are supported. The following is a valid + * filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is + * not a valid filter example: $filter=location eq 'westus'. */ filter?: string; /** - * The number of results to return. + * The number of results to return per page for the list operation. Valid range for top parameter + * is 1 to 100. If not specified, the default number of results to be returned is 20 items per + * page. */ top?: number; } @@ -921,17 +827,20 @@ export interface DomainTopicsListByDomainOptionalParams extends msRest.RequestOp */ export interface EventSubscriptionsListGlobalBySubscriptionOptionalParams extends msRest.RequestOptionsBase { /** - * Filter the results using OData syntax. + * The query used to filter the search results using OData syntax. Filtering is permitted on the + * 'name' property only and with limited number of OData operations. These operations are: the + * 'contains' function as well as the following logical operations: not, and, or, eq (for equal), + * and ne (for not equal). No arithmetic operations are supported. The following is a valid + * filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is + * not a valid filter example: $filter=location eq 'westus'. */ filter?: string; /** - * The number of results to return. + * The number of results to return per page for the list operation. Valid range for top parameter + * is 1 to 100. If not specified, the default number of results to be returned is 20 items per + * page. */ top?: number; - /** - * The label used to filter the results for event subscriptions list. - */ - label?: string; } /** @@ -939,17 +848,20 @@ export interface EventSubscriptionsListGlobalBySubscriptionOptionalParams extend */ export interface EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams extends msRest.RequestOptionsBase { /** - * Filter the results using OData syntax. + * The query used to filter the search results using OData syntax. Filtering is permitted on the + * 'name' property only and with limited number of OData operations. These operations are: the + * 'contains' function as well as the following logical operations: not, and, or, eq (for equal), + * and ne (for not equal). No arithmetic operations are supported. The following is a valid + * filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is + * not a valid filter example: $filter=location eq 'westus'. */ filter?: string; /** - * The number of results to return. + * The number of results to return per page for the list operation. Valid range for top parameter + * is 1 to 100. If not specified, the default number of results to be returned is 20 items per + * page. */ top?: number; - /** - * The label used to filter the results for event subscriptions list. - */ - label?: string; } /** @@ -957,17 +869,20 @@ export interface EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalP */ export interface EventSubscriptionsListGlobalByResourceGroupOptionalParams extends msRest.RequestOptionsBase { /** - * Filter the results using OData syntax. + * The query used to filter the search results using OData syntax. Filtering is permitted on the + * 'name' property only and with limited number of OData operations. These operations are: the + * 'contains' function as well as the following logical operations: not, and, or, eq (for equal), + * and ne (for not equal). No arithmetic operations are supported. The following is a valid + * filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is + * not a valid filter example: $filter=location eq 'westus'. */ filter?: string; /** - * The number of results to return. + * The number of results to return per page for the list operation. Valid range for top parameter + * is 1 to 100. If not specified, the default number of results to be returned is 20 items per + * page. */ top?: number; - /** - * The label used to filter the results for event subscriptions list. - */ - label?: string; } /** @@ -975,17 +890,20 @@ export interface EventSubscriptionsListGlobalByResourceGroupOptionalParams exten */ export interface EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptionalParams extends msRest.RequestOptionsBase { /** - * Filter the results using OData syntax. + * The query used to filter the search results using OData syntax. Filtering is permitted on the + * 'name' property only and with limited number of OData operations. These operations are: the + * 'contains' function as well as the following logical operations: not, and, or, eq (for equal), + * and ne (for not equal). No arithmetic operations are supported. The following is a valid + * filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is + * not a valid filter example: $filter=location eq 'westus'. */ filter?: string; /** - * The number of results to return. + * The number of results to return per page for the list operation. Valid range for top parameter + * is 1 to 100. If not specified, the default number of results to be returned is 20 items per + * page. */ top?: number; - /** - * The label used to filter the results for event subscriptions list. - */ - label?: string; } /** @@ -993,17 +911,20 @@ export interface EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptional */ export interface EventSubscriptionsListRegionalBySubscriptionOptionalParams extends msRest.RequestOptionsBase { /** - * Filter the results using OData syntax. + * The query used to filter the search results using OData syntax. Filtering is permitted on the + * 'name' property only and with limited number of OData operations. These operations are: the + * 'contains' function as well as the following logical operations: not, and, or, eq (for equal), + * and ne (for not equal). No arithmetic operations are supported. The following is a valid + * filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is + * not a valid filter example: $filter=location eq 'westus'. */ filter?: string; /** - * The number of results to return. + * The number of results to return per page for the list operation. Valid range for top parameter + * is 1 to 100. If not specified, the default number of results to be returned is 20 items per + * page. */ top?: number; - /** - * The label used to filter the results for event subscriptions list. - */ - label?: string; } /** @@ -1011,17 +932,20 @@ export interface EventSubscriptionsListRegionalBySubscriptionOptionalParams exte */ export interface EventSubscriptionsListRegionalByResourceGroupOptionalParams extends msRest.RequestOptionsBase { /** - * Filter the results using OData syntax. + * The query used to filter the search results using OData syntax. Filtering is permitted on the + * 'name' property only and with limited number of OData operations. These operations are: the + * 'contains' function as well as the following logical operations: not, and, or, eq (for equal), + * and ne (for not equal). No arithmetic operations are supported. The following is a valid + * filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is + * not a valid filter example: $filter=location eq 'westus'. */ filter?: string; /** - * The number of results to return. + * The number of results to return per page for the list operation. Valid range for top parameter + * is 1 to 100. If not specified, the default number of results to be returned is 20 items per + * page. */ top?: number; - /** - * The label used to filter the results for event subscriptions list. - */ - label?: string; } /** @@ -1029,17 +953,20 @@ export interface EventSubscriptionsListRegionalByResourceGroupOptionalParams ext */ export interface EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams extends msRest.RequestOptionsBase { /** - * Filter the results using OData syntax. + * The query used to filter the search results using OData syntax. Filtering is permitted on the + * 'name' property only and with limited number of OData operations. These operations are: the + * 'contains' function as well as the following logical operations: not, and, or, eq (for equal), + * and ne (for not equal). No arithmetic operations are supported. The following is a valid + * filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is + * not a valid filter example: $filter=location eq 'westus'. */ filter?: string; /** - * The number of results to return. + * The number of results to return per page for the list operation. Valid range for top parameter + * is 1 to 100. If not specified, the default number of results to be returned is 20 items per + * page. */ top?: number; - /** - * The label used to filter the results for event subscriptions list. - */ - label?: string; } /** @@ -1047,17 +974,20 @@ export interface EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptiona */ export interface EventSubscriptionsListRegionalByResourceGroupForTopicTypeOptionalParams extends msRest.RequestOptionsBase { /** - * Filter the results using OData syntax. + * The query used to filter the search results using OData syntax. Filtering is permitted on the + * 'name' property only and with limited number of OData operations. These operations are: the + * 'contains' function as well as the following logical operations: not, and, or, eq (for equal), + * and ne (for not equal). No arithmetic operations are supported. The following is a valid + * filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is + * not a valid filter example: $filter=location eq 'westus'. */ filter?: string; /** - * The number of results to return. + * The number of results to return per page for the list operation. Valid range for top parameter + * is 1 to 100. If not specified, the default number of results to be returned is 20 items per + * page. */ top?: number; - /** - * The label used to filter the results for event subscriptions list. - */ - label?: string; } /** @@ -1065,17 +995,20 @@ export interface EventSubscriptionsListRegionalByResourceGroupForTopicTypeOption */ export interface EventSubscriptionsListByResourceOptionalParams extends msRest.RequestOptionsBase { /** - * Filter the results using OData syntax. + * The query used to filter the search results using OData syntax. Filtering is permitted on the + * 'name' property only and with limited number of OData operations. These operations are: the + * 'contains' function as well as the following logical operations: not, and, or, eq (for equal), + * and ne (for not equal). No arithmetic operations are supported. The following is a valid + * filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is + * not a valid filter example: $filter=location eq 'westus'. */ filter?: string; /** - * The number of results to return. + * The number of results to return per page for the list operation. Valid range for top parameter + * is 1 to 100. If not specified, the default number of results to be returned is 20 items per + * page. */ top?: number; - /** - * The label used to filter the results for event subscriptions list. - */ - label?: string; } /** @@ -1083,17 +1016,20 @@ export interface EventSubscriptionsListByResourceOptionalParams extends msRest.R */ export interface EventSubscriptionsListByDomainTopicOptionalParams extends msRest.RequestOptionsBase { /** - * Filter the results using OData syntax. + * The query used to filter the search results using OData syntax. Filtering is permitted on the + * 'name' property only and with limited number of OData operations. These operations are: the + * 'contains' function as well as the following logical operations: not, and, or, eq (for equal), + * and ne (for not equal). No arithmetic operations are supported. The following is a valid + * filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is + * not a valid filter example: $filter=location eq 'westus'. */ filter?: string; /** - * The number of results to return. + * The number of results to return per page for the list operation. Valid range for top parameter + * is 1 to 100. If not specified, the default number of results to be returned is 20 items per + * page. */ top?: number; - /** - * The label used to filter the results for event subscriptions list. - */ - label?: string; } /** @@ -1101,11 +1037,18 @@ export interface EventSubscriptionsListByDomainTopicOptionalParams extends msRes */ export interface TopicsListBySubscriptionOptionalParams extends msRest.RequestOptionsBase { /** - * Filter the results using OData syntax. + * The query used to filter the search results using OData syntax. Filtering is permitted on the + * 'name' property only and with limited number of OData operations. These operations are: the + * 'contains' function as well as the following logical operations: not, and, or, eq (for equal), + * and ne (for not equal). No arithmetic operations are supported. The following is a valid + * filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is + * not a valid filter example: $filter=location eq 'westus'. */ filter?: string; /** - * The number of results to return. + * The number of results to return per page for the list operation. Valid range for top parameter + * is 1 to 100. If not specified, the default number of results to be returned is 20 items per + * page. */ top?: number; } @@ -1115,11 +1058,18 @@ export interface TopicsListBySubscriptionOptionalParams extends msRest.RequestOp */ export interface TopicsListByResourceGroupOptionalParams extends msRest.RequestOptionsBase { /** - * Filter the results using OData syntax. + * The query used to filter the search results using OData syntax. Filtering is permitted on the + * 'name' property only and with limited number of OData operations. These operations are: the + * 'contains' function as well as the following logical operations: not, and, or, eq (for equal), + * and ne (for not equal). No arithmetic operations are supported. The following is a valid + * filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is + * not a valid filter example: $filter=location eq 'westus'. */ filter?: string; /** - * The number of results to return. + * The number of results to return per page for the list operation. Valid range for top parameter + * is 1 to 100. If not specified, the default number of results to be returned is 20 items per + * page. */ top?: number; } @@ -1133,24 +1083,24 @@ export interface EventGridManagementClientOptions extends AzureServiceClientOpti /** * @interface - * Result of the List Domains operation + * Result of the List Domains operation. * @extends Array */ export interface DomainsListResult extends Array { /** - * A link for the next page of domains + * A link for the next page of domains. */ nextLink?: string; } /** * @interface - * Result of the List Domain Topics operation + * Result of the List Domain Topics operation. * @extends Array */ export interface DomainTopicsListResult extends Array { /** - * A link for the next page of domain topics + * A link for the next page of domain topics. */ nextLink?: string; } @@ -1211,14 +1161,6 @@ export interface TopicTypesListResult extends Array { */ export type DomainProvisioningState = 'Creating' | 'Updating' | 'Deleting' | 'Succeeded' | 'Canceled' | 'Failed'; -/** - * Defines values for InputSchema. - * Possible values include: 'EventGridSchema', 'CustomEventSchema', 'CloudEventV01Schema' - * @readonly - * @enum {string} - */ -export type InputSchema = 'EventGridSchema' | 'CustomEventSchema' | 'CloudEventV01Schema'; - /** * Defines values for DomainTopicProvisioningState. * Possible values include: 'Creating', 'Updating', 'Deleting', 'Succeeded', 'Canceled', 'Failed' @@ -1236,14 +1178,6 @@ export type DomainTopicProvisioningState = 'Creating' | 'Updating' | 'Deleting' */ export type EventSubscriptionProvisioningState = 'Creating' | 'Updating' | 'Deleting' | 'Succeeded' | 'Canceled' | 'Failed' | 'AwaitingManualAction'; -/** - * Defines values for EventDeliverySchema. - * Possible values include: 'EventGridSchema', 'CloudEventV01Schema', 'CustomInputSchema' - * @readonly - * @enum {string} - */ -export type EventDeliverySchema = 'EventGridSchema' | 'CloudEventV01Schema' | 'CustomInputSchema'; - /** * Defines values for TopicProvisioningState. * Possible values include: 'Creating', 'Updating', 'Deleting', 'Succeeded', 'Canceled', 'Failed' diff --git a/sdk/eventgrid/arm-eventgrid/src/models/mappers.ts b/sdk/eventgrid/arm-eventgrid/src/models/mappers.ts index 532e90a93b11..df4810cb7d77 100644 --- a/sdk/eventgrid/arm-eventgrid/src/models/mappers.ts +++ b/sdk/eventgrid/arm-eventgrid/src/models/mappers.ts @@ -12,28 +12,6 @@ import * as msRest from "@azure/ms-rest-js"; export const CloudError = CloudErrorMapper; export const BaseResource = BaseResourceMapper; -export const InputSchemaMapping: msRest.CompositeMapper = { - serializedName: "InputSchemaMapping", - type: { - name: "Composite", - polymorphicDiscriminator: { - serializedName: "inputSchemaMappingType", - clientName: "inputSchemaMappingType" - }, - uberParent: "InputSchemaMapping", - className: "InputSchemaMapping", - modelProperties: { - inputSchemaMappingType: { - required: true, - serializedName: "inputSchemaMappingType", - type: { - name: "String" - } - } - } - } -}; - export const Resource: msRest.CompositeMapper = { serializedName: "Resource", type: { @@ -65,99 +43,6 @@ export const Resource: msRest.CompositeMapper = { } }; -export const JsonField: msRest.CompositeMapper = { - serializedName: "JsonField", - type: { - name: "Composite", - className: "JsonField", - modelProperties: { - sourceField: { - serializedName: "sourceField", - type: { - name: "String" - } - } - } - } -}; - -export const JsonFieldWithDefault: msRest.CompositeMapper = { - serializedName: "JsonFieldWithDefault", - type: { - name: "Composite", - className: "JsonFieldWithDefault", - modelProperties: { - sourceField: { - serializedName: "sourceField", - type: { - name: "String" - } - }, - defaultValue: { - serializedName: "defaultValue", - type: { - name: "String" - } - } - } - } -}; - -export const JsonInputSchemaMapping: msRest.CompositeMapper = { - serializedName: "Json", - type: { - name: "Composite", - polymorphicDiscriminator: InputSchemaMapping.type.polymorphicDiscriminator, - uberParent: "InputSchemaMapping", - className: "JsonInputSchemaMapping", - modelProperties: { - ...InputSchemaMapping.type.modelProperties, - id: { - serializedName: "properties.id", - type: { - name: "Composite", - className: "JsonField" - } - }, - topic: { - serializedName: "properties.topic", - type: { - name: "Composite", - className: "JsonField" - } - }, - eventTime: { - serializedName: "properties.eventTime", - type: { - name: "Composite", - className: "JsonField" - } - }, - eventType: { - serializedName: "properties.eventType", - type: { - name: "Composite", - className: "JsonFieldWithDefault" - } - }, - subject: { - serializedName: "properties.subject", - type: { - name: "Composite", - className: "JsonFieldWithDefault" - } - }, - dataVersion: { - serializedName: "properties.dataVersion", - type: { - name: "Composite", - className: "JsonFieldWithDefault" - } - } - } - } -}; - export const TrackedResource: msRest.CompositeMapper = { serializedName: "TrackedResource", type: { @@ -207,20 +92,6 @@ export const Domain: msRest.CompositeMapper = { type: { name: "String" } - }, - inputSchema: { - serializedName: "properties.inputSchema", - defaultValue: 'EventGridSchema', - type: { - name: "String" - } - }, - inputSchemaMapping: { - serializedName: "properties.inputSchemaMapping", - type: { - name: "Composite", - className: "InputSchemaMapping" - } } } } @@ -897,12 +768,6 @@ export const EventSubscription: msRest.CompositeMapper = { name: "DateTime" } }, - eventDeliverySchema: { - serializedName: "properties.eventDeliverySchema", - type: { - name: "String" - } - }, retryPolicy: { serializedName: "properties.retryPolicy", type: { @@ -958,12 +823,6 @@ export const EventSubscriptionUpdateParameters: msRest.CompositeMapper = { name: "DateTime" } }, - eventDeliverySchema: { - serializedName: "eventDeliverySchema", - type: { - name: "String" - } - }, retryPolicy: { serializedName: "retryPolicy", type: { @@ -1087,20 +946,6 @@ export const Topic: msRest.CompositeMapper = { type: { name: "String" } - }, - inputSchema: { - serializedName: "properties.inputSchema", - defaultValue: 'EventGridSchema', - type: { - name: "String" - } - }, - inputSchemaMapping: { - serializedName: "properties.inputSchemaMapping", - type: { - name: "Composite", - className: "InputSchemaMapping" - } } } } @@ -1432,8 +1277,6 @@ export const TopicTypesListResult: msRest.CompositeMapper = { }; export const discriminators = { - 'InputSchemaMapping' : InputSchemaMapping, - 'InputSchemaMapping.Json' : JsonInputSchemaMapping, 'EventSubscriptionDestination' : EventSubscriptionDestination, 'AdvancedFilter' : AdvancedFilter, 'DeadLetterDestination' : DeadLetterDestination, diff --git a/sdk/eventgrid/arm-eventgrid/src/models/parameters.ts b/sdk/eventgrid/arm-eventgrid/src/models/parameters.ts index b34d4b8f31be..c374a712bac3 100644 --- a/sdk/eventgrid/arm-eventgrid/src/models/parameters.ts +++ b/sdk/eventgrid/arm-eventgrid/src/models/parameters.ts @@ -72,18 +72,6 @@ export const filter: msRest.OperationQueryParameter = { } } }; -export const label: msRest.OperationQueryParameter = { - parameterPath: [ - "options", - "label" - ], - mapper: { - serializedName: "label", - type: { - name: "String" - } - } -}; export const location: msRest.OperationURLParameter = { parameterPath: "location", mapper: { diff --git a/sdk/eventgrid/arm-eventgrid/src/models/topicTypesMappers.ts b/sdk/eventgrid/arm-eventgrid/src/models/topicTypesMappers.ts index 946e7fff150a..3232487469c5 100644 --- a/sdk/eventgrid/arm-eventgrid/src/models/topicTypesMappers.ts +++ b/sdk/eventgrid/arm-eventgrid/src/models/topicTypesMappers.ts @@ -22,10 +22,6 @@ export { EventType, EventTypesListResult, HybridConnectionEventSubscriptionDestination, - InputSchemaMapping, - JsonField, - JsonFieldWithDefault, - JsonInputSchemaMapping, NumberGreaterThanAdvancedFilter, NumberGreaterThanOrEqualsAdvancedFilter, NumberInAdvancedFilter, diff --git a/sdk/eventgrid/arm-eventgrid/src/models/topicsMappers.ts b/sdk/eventgrid/arm-eventgrid/src/models/topicsMappers.ts index c73b58cf1b7a..46f12c5418a8 100644 --- a/sdk/eventgrid/arm-eventgrid/src/models/topicsMappers.ts +++ b/sdk/eventgrid/arm-eventgrid/src/models/topicsMappers.ts @@ -22,10 +22,6 @@ export { EventType, EventTypesListResult, HybridConnectionEventSubscriptionDestination, - InputSchemaMapping, - JsonField, - JsonFieldWithDefault, - JsonInputSchemaMapping, NumberGreaterThanAdvancedFilter, NumberGreaterThanOrEqualsAdvancedFilter, NumberInAdvancedFilter, diff --git a/sdk/eventgrid/arm-eventgrid/src/operations/domainTopics.ts b/sdk/eventgrid/arm-eventgrid/src/operations/domainTopics.ts index 016a21192bd7..b1bcf79aca70 100644 --- a/sdk/eventgrid/arm-eventgrid/src/operations/domainTopics.ts +++ b/sdk/eventgrid/arm-eventgrid/src/operations/domainTopics.ts @@ -28,26 +28,26 @@ export class DomainTopics { } /** - * Get properties of a domain topic - * @summary Get a domain topic + * Get properties of a domain topic. + * @summary Get a domain topic. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the domain - * @param domainTopicName Name of the topic + * @param domainName Name of the domain. + * @param domainTopicName Name of the topic. * @param [options] The optional parameters * @returns Promise */ get(resourceGroupName: string, domainName: string, domainTopicName: string, options?: msRest.RequestOptionsBase): Promise; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the domain - * @param domainTopicName Name of the topic + * @param domainName Name of the domain. + * @param domainTopicName Name of the topic. * @param callback The callback */ get(resourceGroupName: string, domainName: string, domainTopicName: string, callback: msRest.ServiceCallback): void; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the domain - * @param domainTopicName Name of the topic + * @param domainName Name of the domain. + * @param domainTopicName Name of the topic. * @param options The optional parameters * @param callback The callback */ @@ -66,10 +66,10 @@ export class DomainTopics { /** * Asynchronously creates or updates a new domain topic with the specified parameters. - * @summary Create or update a domain topic + * @summary Create or update a domain topic. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the domain - * @param domainTopicName Name of the domain topic + * @param domainName Name of the domain. + * @param domainTopicName Name of the domain topic. * @param [options] The optional parameters * @returns Promise */ @@ -79,11 +79,11 @@ export class DomainTopics { } /** - * Delete existing domain topic - * @summary Delete a domain topic + * Delete existing domain topic. + * @summary Delete a domain topic. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the domain - * @param domainTopicName Name of the domain topic + * @param domainName Name of the domain. + * @param domainTopicName Name of the domain topic. * @param [options] The optional parameters * @returns Promise */ @@ -127,10 +127,10 @@ export class DomainTopics { /** * Asynchronously creates or updates a new domain topic with the specified parameters. - * @summary Create or update a domain topic + * @summary Create or update a domain topic. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the domain - * @param domainTopicName Name of the domain topic + * @param domainName Name of the domain. + * @param domainTopicName Name of the domain topic. * @param [options] The optional parameters * @returns Promise */ @@ -147,11 +147,11 @@ export class DomainTopics { } /** - * Delete existing domain topic - * @summary Delete a domain topic + * Delete existing domain topic. + * @summary Delete a domain topic. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the domain - * @param domainTopicName Name of the domain topic + * @param domainName Name of the domain. + * @param domainTopicName Name of the domain topic. * @param [options] The optional parameters * @returns Promise */ diff --git a/sdk/eventgrid/arm-eventgrid/src/operations/domains.ts b/sdk/eventgrid/arm-eventgrid/src/operations/domains.ts index e362ce419a48..808a2b29a8e0 100644 --- a/sdk/eventgrid/arm-eventgrid/src/operations/domains.ts +++ b/sdk/eventgrid/arm-eventgrid/src/operations/domains.ts @@ -28,23 +28,23 @@ export class Domains { } /** - * Get properties of a domain - * @summary Get a domain + * Get properties of a domain. + * @summary Get a domain. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the domain + * @param domainName Name of the domain. * @param [options] The optional parameters * @returns Promise */ get(resourceGroupName: string, domainName: string, options?: msRest.RequestOptionsBase): Promise; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the domain + * @param domainName Name of the domain. * @param callback The callback */ get(resourceGroupName: string, domainName: string, callback: msRest.ServiceCallback): void; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the domain + * @param domainName Name of the domain. * @param options The optional parameters * @param callback The callback */ @@ -62,10 +62,10 @@ export class Domains { /** * Asynchronously creates or updates a new domain with the specified parameters. - * @summary Create or update a domain + * @summary Create or update a domain. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the domain - * @param domainInfo Domain information + * @param domainName Name of the domain. + * @param domainInfo Domain information. * @param [options] The optional parameters * @returns Promise */ @@ -75,10 +75,10 @@ export class Domains { } /** - * Delete existing domain - * @summary Delete a domain + * Delete existing domain. + * @summary Delete a domain. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the domain + * @param domainName Name of the domain. * @param [options] The optional parameters * @returns Promise */ @@ -89,10 +89,10 @@ export class Domains { /** * Asynchronously updates a domain with the specified parameters. - * @summary Update a domain + * @summary Update a domain. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the domain - * @param domainUpdateParameters Domain update information + * @param domainName Name of the domain. + * @param domainUpdateParameters Domain update information. * @param [options] The optional parameters * @returns Promise */ @@ -102,8 +102,8 @@ export class Domains { } /** - * List all the domains under an Azure subscription - * @summary List domains under an Azure subscription + * List all the domains under an Azure subscription. + * @summary List domains under an Azure subscription. * @param [options] The optional parameters * @returns Promise */ @@ -127,8 +127,8 @@ export class Domains { } /** - * List all the domains under a resource group - * @summary List domains under a resource group + * List all the domains under a resource group. + * @summary List domains under a resource group. * @param resourceGroupName The name of the resource group within the user's subscription. * @param [options] The optional parameters * @returns Promise @@ -156,23 +156,23 @@ export class Domains { } /** - * List the two keys used to publish to a domain - * @summary List keys for a domain + * List the two keys used to publish to a domain. + * @summary List keys for a domain. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the domain + * @param domainName Name of the domain. * @param [options] The optional parameters * @returns Promise */ listSharedAccessKeys(resourceGroupName: string, domainName: string, options?: msRest.RequestOptionsBase): Promise; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the domain + * @param domainName Name of the domain. * @param callback The callback */ listSharedAccessKeys(resourceGroupName: string, domainName: string, callback: msRest.ServiceCallback): void; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the domain + * @param domainName Name of the domain. * @param options The optional parameters * @param callback The callback */ @@ -189,26 +189,26 @@ export class Domains { } /** - * Regenerate a shared access key for a domain - * @summary Regenerate key for a domain + * Regenerate a shared access key for a domain. + * @summary Regenerate key for a domain. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the domain - * @param regenerateKeyRequest Request body to regenerate key + * @param domainName Name of the domain. + * @param regenerateKeyRequest Request body to regenerate key. * @param [options] The optional parameters * @returns Promise */ regenerateKey(resourceGroupName: string, domainName: string, regenerateKeyRequest: Models.DomainRegenerateKeyRequest, options?: msRest.RequestOptionsBase): Promise; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the domain - * @param regenerateKeyRequest Request body to regenerate key + * @param domainName Name of the domain. + * @param regenerateKeyRequest Request body to regenerate key. * @param callback The callback */ regenerateKey(resourceGroupName: string, domainName: string, regenerateKeyRequest: Models.DomainRegenerateKeyRequest, callback: msRest.ServiceCallback): void; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the domain - * @param regenerateKeyRequest Request body to regenerate key + * @param domainName Name of the domain. + * @param regenerateKeyRequest Request body to regenerate key. * @param options The optional parameters * @param callback The callback */ @@ -227,10 +227,10 @@ export class Domains { /** * Asynchronously creates or updates a new domain with the specified parameters. - * @summary Create or update a domain + * @summary Create or update a domain. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the domain - * @param domainInfo Domain information + * @param domainName Name of the domain. + * @param domainInfo Domain information. * @param [options] The optional parameters * @returns Promise */ @@ -247,10 +247,10 @@ export class Domains { } /** - * Delete existing domain - * @summary Delete a domain + * Delete existing domain. + * @summary Delete a domain. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the domain + * @param domainName Name of the domain. * @param [options] The optional parameters * @returns Promise */ @@ -267,10 +267,10 @@ export class Domains { /** * Asynchronously updates a domain with the specified parameters. - * @summary Update a domain + * @summary Update a domain. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the domain - * @param domainUpdateParameters Domain update information + * @param domainName Name of the domain. + * @param domainUpdateParameters Domain update information. * @param [options] The optional parameters * @returns Promise */ @@ -287,8 +287,8 @@ export class Domains { } /** - * List all the domains under an Azure subscription - * @summary List domains under an Azure subscription + * List all the domains under an Azure subscription. + * @summary List domains under an Azure subscription. * @param nextPageLink The NextLink from the previous successful call to List operation. * @param [options] The optional parameters * @returns Promise @@ -316,8 +316,8 @@ export class Domains { } /** - * List all the domains under a resource group - * @summary List domains under a resource group + * List all the domains under a resource group. + * @summary List domains under a resource group. * @param nextPageLink The NextLink from the previous successful call to List operation. * @param [options] The optional parameters * @returns Promise diff --git a/sdk/eventgrid/arm-eventgrid/src/operations/eventSubscriptions.ts b/sdk/eventgrid/arm-eventgrid/src/operations/eventSubscriptions.ts index eb60c833c2e3..715e24921409 100644 --- a/sdk/eventgrid/arm-eventgrid/src/operations/eventSubscriptions.ts +++ b/sdk/eventgrid/arm-eventgrid/src/operations/eventSubscriptions.ts @@ -28,8 +28,8 @@ export class EventSubscriptions { } /** - * Get properties of an event subscription - * @summary Get an event subscription + * Get properties of an event subscription. + * @summary Get an event subscription. * @param scope The scope of the event subscription. The scope can be a subscription, or a resource * group, or a top level resource belonging to a resource provider namespace, or an EventGrid * topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, @@ -38,7 +38,7 @@ export class EventSubscriptions { * for a resource, and * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' * for an EventGrid topic. - * @param eventSubscriptionName Name of the event subscription + * @param eventSubscriptionName Name of the event subscription. * @param [options] The optional parameters * @returns Promise */ @@ -52,7 +52,7 @@ export class EventSubscriptions { * for a resource, and * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' * for an EventGrid topic. - * @param eventSubscriptionName Name of the event subscription + * @param eventSubscriptionName Name of the event subscription. * @param callback The callback */ get(scope: string, eventSubscriptionName: string, callback: msRest.ServiceCallback): void; @@ -65,7 +65,7 @@ export class EventSubscriptions { * for a resource, and * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' * for an EventGrid topic. - * @param eventSubscriptionName Name of the event subscription + * @param eventSubscriptionName Name of the event subscription. * @param options The optional parameters * @param callback The callback */ @@ -84,7 +84,7 @@ export class EventSubscriptions { /** * Asynchronously creates a new event subscription or updates an existing event subscription based * on the specified scope. - * @summary Create or update an event subscription + * @summary Create or update an event subscription. * @param scope The identifier of the resource to which the event subscription needs to be created * or updated. The scope can be a subscription, or a resource group, or a top level resource * belonging to a resource provider namespace, or an EventGrid topic. For example, use @@ -97,7 +97,7 @@ export class EventSubscriptions { * @param eventSubscriptionName Name of the event subscription. Event subscription names must be * between 3 and 64 characters in length and should use alphanumeric letters only. * @param eventSubscriptionInfo Event subscription properties containing the destination and filter - * information + * information. * @param [options] The optional parameters * @returns Promise */ @@ -107,8 +107,8 @@ export class EventSubscriptions { } /** - * Delete an existing event subscription - * @summary Delete an event subscription + * Delete an existing event subscription. + * @summary Delete an event subscription. * @param scope The scope of the event subscription. The scope can be a subscription, or a resource * group, or a top level resource belonging to a resource provider namespace, or an EventGrid * topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, @@ -117,7 +117,7 @@ export class EventSubscriptions { * for a resource, and * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' * for an EventGrid topic. - * @param eventSubscriptionName Name of the event subscription + * @param eventSubscriptionName Name of the event subscription. * @param [options] The optional parameters * @returns Promise */ @@ -128,7 +128,7 @@ export class EventSubscriptions { /** * Asynchronously updates an existing event subscription. - * @summary Update an event subscription + * @summary Update an event subscription. * @param scope The scope of existing event subscription. The scope can be a subscription, or a * resource group, or a top level resource belonging to a resource provider namespace, or an * EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, @@ -137,8 +137,8 @@ export class EventSubscriptions { * for a resource, and * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' * for an EventGrid topic. - * @param eventSubscriptionName Name of the event subscription to be updated - * @param eventSubscriptionUpdateParameters Updated event subscription information + * @param eventSubscriptionName Name of the event subscription to be updated. + * @param eventSubscriptionUpdateParameters Updated event subscription information. * @param [options] The optional parameters * @returns Promise */ @@ -148,8 +148,8 @@ export class EventSubscriptions { } /** - * Get the full endpoint URL for an event subscription - * @summary Get full URL of an event subscription + * Get the full endpoint URL for an event subscription. + * @summary Get full URL of an event subscription. * @param scope The scope of the event subscription. The scope can be a subscription, or a resource * group, or a top level resource belonging to a resource provider namespace, or an EventGrid * topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, @@ -158,7 +158,7 @@ export class EventSubscriptions { * for a resource, and * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' * for an EventGrid topic. - * @param eventSubscriptionName Name of the event subscription + * @param eventSubscriptionName Name of the event subscription. * @param [options] The optional parameters * @returns Promise */ @@ -172,7 +172,7 @@ export class EventSubscriptions { * for a resource, and * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' * for an EventGrid topic. - * @param eventSubscriptionName Name of the event subscription + * @param eventSubscriptionName Name of the event subscription. * @param callback The callback */ getFullUrl(scope: string, eventSubscriptionName: string, callback: msRest.ServiceCallback): void; @@ -185,7 +185,7 @@ export class EventSubscriptions { * for a resource, and * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' * for an EventGrid topic. - * @param eventSubscriptionName Name of the event subscription + * @param eventSubscriptionName Name of the event subscription. * @param options The optional parameters * @param callback The callback */ @@ -202,8 +202,8 @@ export class EventSubscriptions { } /** - * List all aggregated global event subscriptions under a specific Azure subscription - * @summary Get an aggregated list of all global event subscriptions under an Azure subscription + * List all aggregated global event subscriptions under a specific Azure subscription. + * @summary Get an aggregated list of all global event subscriptions under an Azure subscription. * @param [options] The optional parameters * @returns Promise */ @@ -228,19 +228,19 @@ export class EventSubscriptions { /** * List all global event subscriptions under an Azure subscription for a topic type. - * @summary List all global event subscriptions for a topic type - * @param topicTypeName Name of the topic type + * @summary List all global event subscriptions for a topic type. + * @param topicTypeName Name of the topic type. * @param [options] The optional parameters * @returns Promise */ listGlobalBySubscriptionForTopicType(topicTypeName: string, options?: Models.EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams): Promise; /** - * @param topicTypeName Name of the topic type + * @param topicTypeName Name of the topic type. * @param callback The callback */ listGlobalBySubscriptionForTopicType(topicTypeName: string, callback: msRest.ServiceCallback): void; /** - * @param topicTypeName Name of the topic type + * @param topicTypeName Name of the topic type. * @param options The optional parameters * @param callback The callback */ @@ -256,8 +256,8 @@ export class EventSubscriptions { } /** - * List all global event subscriptions under a specific Azure subscription and resource group - * @summary List all global event subscriptions under an Azure subscription and resource group + * List all global event subscriptions under a specific Azure subscription and resource group. + * @summary List all global event subscriptions under an Azure subscription and resource group. * @param resourceGroupName The name of the resource group within the user's subscription. * @param [options] The optional parameters * @returns Promise @@ -286,22 +286,22 @@ export class EventSubscriptions { /** * List all global event subscriptions under a resource group for a specific topic type. - * @summary List all global event subscriptions under a resource group for a topic type + * @summary List all global event subscriptions under a resource group for a topic type. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param topicTypeName Name of the topic type + * @param topicTypeName Name of the topic type. * @param [options] The optional parameters * @returns Promise */ listGlobalByResourceGroupForTopicType(resourceGroupName: string, topicTypeName: string, options?: Models.EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptionalParams): Promise; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param topicTypeName Name of the topic type + * @param topicTypeName Name of the topic type. * @param callback The callback */ listGlobalByResourceGroupForTopicType(resourceGroupName: string, topicTypeName: string, callback: msRest.ServiceCallback): void; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param topicTypeName Name of the topic type + * @param topicTypeName Name of the topic type. * @param options The optional parameters * @param callback The callback */ @@ -318,20 +318,20 @@ export class EventSubscriptions { } /** - * List all event subscriptions from the given location under a specific Azure subscription - * @summary List all regional event subscriptions under an Azure subscription - * @param location Name of the location + * List all event subscriptions from the given location under a specific Azure subscription. + * @summary List all regional event subscriptions under an Azure subscription. + * @param location Name of the location. * @param [options] The optional parameters * @returns Promise */ listRegionalBySubscription(location: string, options?: Models.EventSubscriptionsListRegionalBySubscriptionOptionalParams): Promise; /** - * @param location Name of the location + * @param location Name of the location. * @param callback The callback */ listRegionalBySubscription(location: string, callback: msRest.ServiceCallback): void; /** - * @param location Name of the location + * @param location Name of the location. * @param options The optional parameters * @param callback The callback */ @@ -348,23 +348,23 @@ export class EventSubscriptions { /** * List all event subscriptions from the given location under a specific Azure subscription and - * resource group - * @summary List all regional event subscriptions under an Azure subscription and resource group + * resource group. + * @summary List all regional event subscriptions under an Azure subscription and resource group. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param location Name of the location + * @param location Name of the location. * @param [options] The optional parameters * @returns Promise */ listRegionalByResourceGroup(resourceGroupName: string, location: string, options?: Models.EventSubscriptionsListRegionalByResourceGroupOptionalParams): Promise; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param location Name of the location + * @param location Name of the location. * @param callback The callback */ listRegionalByResourceGroup(resourceGroupName: string, location: string, callback: msRest.ServiceCallback): void; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param location Name of the location + * @param location Name of the location. * @param options The optional parameters * @param callback The callback */ @@ -383,22 +383,22 @@ export class EventSubscriptions { /** * List all event subscriptions from the given location under a specific Azure subscription and * topic type. - * @summary List all regional event subscriptions under an Azure subscription for a topic type - * @param location Name of the location - * @param topicTypeName Name of the topic type + * @summary List all regional event subscriptions under an Azure subscription for a topic type. + * @param location Name of the location. + * @param topicTypeName Name of the topic type. * @param [options] The optional parameters * @returns Promise */ listRegionalBySubscriptionForTopicType(location: string, topicTypeName: string, options?: Models.EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams): Promise; /** - * @param location Name of the location - * @param topicTypeName Name of the topic type + * @param location Name of the location. + * @param topicTypeName Name of the topic type. * @param callback The callback */ listRegionalBySubscriptionForTopicType(location: string, topicTypeName: string, callback: msRest.ServiceCallback): void; /** - * @param location Name of the location - * @param topicTypeName Name of the topic type + * @param location Name of the location. + * @param topicTypeName Name of the topic type. * @param options The optional parameters * @param callback The callback */ @@ -416,27 +416,27 @@ export class EventSubscriptions { /** * List all event subscriptions from the given location under a specific Azure subscription and - * resource group and topic type + * resource group and topic type. * @summary List all regional event subscriptions under an Azure subscription and resource group - * for a topic type + * for a topic type. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param location Name of the location - * @param topicTypeName Name of the topic type + * @param location Name of the location. + * @param topicTypeName Name of the topic type. * @param [options] The optional parameters * @returns Promise */ listRegionalByResourceGroupForTopicType(resourceGroupName: string, location: string, topicTypeName: string, options?: Models.EventSubscriptionsListRegionalByResourceGroupForTopicTypeOptionalParams): Promise; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param location Name of the location - * @param topicTypeName Name of the topic type + * @param location Name of the location. + * @param topicTypeName Name of the topic type. * @param callback The callback */ listRegionalByResourceGroupForTopicType(resourceGroupName: string, location: string, topicTypeName: string, callback: msRest.ServiceCallback): void; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param location Name of the location - * @param topicTypeName Name of the topic type + * @param location Name of the location. + * @param topicTypeName Name of the topic type. * @param options The optional parameters * @param callback The callback */ @@ -454,29 +454,29 @@ export class EventSubscriptions { } /** - * List all event subscriptions that have been created for a specific topic - * @summary List all event subscriptions for a specific topic + * List all event subscriptions that have been created for a specific topic. + * @summary List all event subscriptions for a specific topic. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param providerNamespace Namespace of the provider of the topic - * @param resourceTypeName Name of the resource type - * @param resourceName Name of the resource + * @param providerNamespace Namespace of the provider of the topic. + * @param resourceTypeName Name of the resource type. + * @param resourceName Name of the resource. * @param [options] The optional parameters * @returns Promise */ listByResource(resourceGroupName: string, providerNamespace: string, resourceTypeName: string, resourceName: string, options?: Models.EventSubscriptionsListByResourceOptionalParams): Promise; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param providerNamespace Namespace of the provider of the topic - * @param resourceTypeName Name of the resource type - * @param resourceName Name of the resource + * @param providerNamespace Namespace of the provider of the topic. + * @param resourceTypeName Name of the resource type. + * @param resourceName Name of the resource. * @param callback The callback */ listByResource(resourceGroupName: string, providerNamespace: string, resourceTypeName: string, resourceName: string, callback: msRest.ServiceCallback): void; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param providerNamespace Namespace of the provider of the topic - * @param resourceTypeName Name of the resource type - * @param resourceName Name of the resource + * @param providerNamespace Namespace of the provider of the topic. + * @param resourceTypeName Name of the resource type. + * @param resourceName Name of the resource. * @param options The optional parameters * @param callback The callback */ @@ -495,26 +495,26 @@ export class EventSubscriptions { } /** - * List all event subscriptions that have been created for a specific domain topic - * @summary List all event subscriptions for a specific domain topic + * List all event subscriptions that have been created for a specific domain topic. + * @summary List all event subscriptions for a specific domain topic. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the top level domain - * @param topicName Name of the domain topic + * @param domainName Name of the top level domain. + * @param topicName Name of the domain topic. * @param [options] The optional parameters * @returns Promise */ listByDomainTopic(resourceGroupName: string, domainName: string, topicName: string, options?: Models.EventSubscriptionsListByDomainTopicOptionalParams): Promise; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the top level domain - * @param topicName Name of the domain topic + * @param domainName Name of the top level domain. + * @param topicName Name of the domain topic. * @param callback The callback */ listByDomainTopic(resourceGroupName: string, domainName: string, topicName: string, callback: msRest.ServiceCallback): void; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param domainName Name of the top level domain - * @param topicName Name of the domain topic + * @param domainName Name of the top level domain. + * @param topicName Name of the domain topic. * @param options The optional parameters * @param callback The callback */ @@ -534,7 +534,7 @@ export class EventSubscriptions { /** * Asynchronously creates a new event subscription or updates an existing event subscription based * on the specified scope. - * @summary Create or update an event subscription + * @summary Create or update an event subscription. * @param scope The identifier of the resource to which the event subscription needs to be created * or updated. The scope can be a subscription, or a resource group, or a top level resource * belonging to a resource provider namespace, or an EventGrid topic. For example, use @@ -547,7 +547,7 @@ export class EventSubscriptions { * @param eventSubscriptionName Name of the event subscription. Event subscription names must be * between 3 and 64 characters in length and should use alphanumeric letters only. * @param eventSubscriptionInfo Event subscription properties containing the destination and filter - * information + * information. * @param [options] The optional parameters * @returns Promise */ @@ -564,8 +564,8 @@ export class EventSubscriptions { } /** - * Delete an existing event subscription - * @summary Delete an event subscription + * Delete an existing event subscription. + * @summary Delete an event subscription. * @param scope The scope of the event subscription. The scope can be a subscription, or a resource * group, or a top level resource belonging to a resource provider namespace, or an EventGrid * topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, @@ -574,7 +574,7 @@ export class EventSubscriptions { * for a resource, and * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' * for an EventGrid topic. - * @param eventSubscriptionName Name of the event subscription + * @param eventSubscriptionName Name of the event subscription. * @param [options] The optional parameters * @returns Promise */ @@ -591,7 +591,7 @@ export class EventSubscriptions { /** * Asynchronously updates an existing event subscription. - * @summary Update an event subscription + * @summary Update an event subscription. * @param scope The scope of existing event subscription. The scope can be a subscription, or a * resource group, or a top level resource belonging to a resource provider namespace, or an * EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, @@ -600,8 +600,8 @@ export class EventSubscriptions { * for a resource, and * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' * for an EventGrid topic. - * @param eventSubscriptionName Name of the event subscription to be updated - * @param eventSubscriptionUpdateParameters Updated event subscription information + * @param eventSubscriptionName Name of the event subscription to be updated. + * @param eventSubscriptionUpdateParameters Updated event subscription information. * @param [options] The optional parameters * @returns Promise */ @@ -618,8 +618,8 @@ export class EventSubscriptions { } /** - * List all aggregated global event subscriptions under a specific Azure subscription - * @summary Get an aggregated list of all global event subscriptions under an Azure subscription + * List all aggregated global event subscriptions under a specific Azure subscription. + * @summary Get an aggregated list of all global event subscriptions under an Azure subscription. * @param nextPageLink The NextLink from the previous successful call to List operation. * @param [options] The optional parameters * @returns Promise @@ -648,7 +648,7 @@ export class EventSubscriptions { /** * List all global event subscriptions under an Azure subscription for a topic type. - * @summary List all global event subscriptions for a topic type + * @summary List all global event subscriptions for a topic type. * @param nextPageLink The NextLink from the previous successful call to List operation. * @param [options] The optional parameters * @returns Promise @@ -676,8 +676,8 @@ export class EventSubscriptions { } /** - * List all global event subscriptions under a specific Azure subscription and resource group - * @summary List all global event subscriptions under an Azure subscription and resource group + * List all global event subscriptions under a specific Azure subscription and resource group. + * @summary List all global event subscriptions under an Azure subscription and resource group. * @param nextPageLink The NextLink from the previous successful call to List operation. * @param [options] The optional parameters * @returns Promise @@ -706,7 +706,7 @@ export class EventSubscriptions { /** * List all global event subscriptions under a resource group for a specific topic type. - * @summary List all global event subscriptions under a resource group for a topic type + * @summary List all global event subscriptions under a resource group for a topic type. * @param nextPageLink The NextLink from the previous successful call to List operation. * @param [options] The optional parameters * @returns Promise @@ -734,8 +734,8 @@ export class EventSubscriptions { } /** - * List all event subscriptions from the given location under a specific Azure subscription - * @summary List all regional event subscriptions under an Azure subscription + * List all event subscriptions from the given location under a specific Azure subscription. + * @summary List all regional event subscriptions under an Azure subscription. * @param nextPageLink The NextLink from the previous successful call to List operation. * @param [options] The optional parameters * @returns Promise @@ -764,8 +764,8 @@ export class EventSubscriptions { /** * List all event subscriptions from the given location under a specific Azure subscription and - * resource group - * @summary List all regional event subscriptions under an Azure subscription and resource group + * resource group. + * @summary List all regional event subscriptions under an Azure subscription and resource group. * @param nextPageLink The NextLink from the previous successful call to List operation. * @param [options] The optional parameters * @returns Promise @@ -795,7 +795,7 @@ export class EventSubscriptions { /** * List all event subscriptions from the given location under a specific Azure subscription and * topic type. - * @summary List all regional event subscriptions under an Azure subscription for a topic type + * @summary List all regional event subscriptions under an Azure subscription for a topic type. * @param nextPageLink The NextLink from the previous successful call to List operation. * @param [options] The optional parameters * @returns Promise @@ -824,9 +824,9 @@ export class EventSubscriptions { /** * List all event subscriptions from the given location under a specific Azure subscription and - * resource group and topic type + * resource group and topic type. * @summary List all regional event subscriptions under an Azure subscription and resource group - * for a topic type + * for a topic type. * @param nextPageLink The NextLink from the previous successful call to List operation. * @param [options] The optional parameters * @returns Promise @@ -854,8 +854,8 @@ export class EventSubscriptions { } /** - * List all event subscriptions that have been created for a specific topic - * @summary List all event subscriptions for a specific topic + * List all event subscriptions that have been created for a specific topic. + * @summary List all event subscriptions for a specific topic. * @param nextPageLink The NextLink from the previous successful call to List operation. * @param [options] The optional parameters * @returns Promise @@ -883,8 +883,8 @@ export class EventSubscriptions { } /** - * List all event subscriptions that have been created for a specific domain topic - * @summary List all event subscriptions for a specific domain topic + * List all event subscriptions that have been created for a specific domain topic. + * @summary List all event subscriptions for a specific domain topic. * @param nextPageLink The NextLink from the previous successful call to List operation. * @param [options] The optional parameters * @returns Promise @@ -971,8 +971,7 @@ const listGlobalBySubscriptionOperationSpec: msRest.OperationSpec = { queryParameters: [ Parameters.apiVersion, Parameters.filter, - Parameters.top, - Parameters.label + Parameters.top ], headerParameters: [ Parameters.acceptLanguage @@ -998,8 +997,7 @@ const listGlobalBySubscriptionForTopicTypeOperationSpec: msRest.OperationSpec = queryParameters: [ Parameters.apiVersion, Parameters.filter, - Parameters.top, - Parameters.label + Parameters.top ], headerParameters: [ Parameters.acceptLanguage @@ -1025,8 +1023,7 @@ const listGlobalByResourceGroupOperationSpec: msRest.OperationSpec = { queryParameters: [ Parameters.apiVersion, Parameters.filter, - Parameters.top, - Parameters.label + Parameters.top ], headerParameters: [ Parameters.acceptLanguage @@ -1053,8 +1050,7 @@ const listGlobalByResourceGroupForTopicTypeOperationSpec: msRest.OperationSpec = queryParameters: [ Parameters.apiVersion, Parameters.filter, - Parameters.top, - Parameters.label + Parameters.top ], headerParameters: [ Parameters.acceptLanguage @@ -1080,8 +1076,7 @@ const listRegionalBySubscriptionOperationSpec: msRest.OperationSpec = { queryParameters: [ Parameters.apiVersion, Parameters.filter, - Parameters.top, - Parameters.label + Parameters.top ], headerParameters: [ Parameters.acceptLanguage @@ -1108,8 +1103,7 @@ const listRegionalByResourceGroupOperationSpec: msRest.OperationSpec = { queryParameters: [ Parameters.apiVersion, Parameters.filter, - Parameters.top, - Parameters.label + Parameters.top ], headerParameters: [ Parameters.acceptLanguage @@ -1136,8 +1130,7 @@ const listRegionalBySubscriptionForTopicTypeOperationSpec: msRest.OperationSpec queryParameters: [ Parameters.apiVersion, Parameters.filter, - Parameters.top, - Parameters.label + Parameters.top ], headerParameters: [ Parameters.acceptLanguage @@ -1165,8 +1158,7 @@ const listRegionalByResourceGroupForTopicTypeOperationSpec: msRest.OperationSpec queryParameters: [ Parameters.apiVersion, Parameters.filter, - Parameters.top, - Parameters.label + Parameters.top ], headerParameters: [ Parameters.acceptLanguage @@ -1195,8 +1187,7 @@ const listByResourceOperationSpec: msRest.OperationSpec = { queryParameters: [ Parameters.apiVersion, Parameters.filter, - Parameters.top, - Parameters.label + Parameters.top ], headerParameters: [ Parameters.acceptLanguage @@ -1224,8 +1215,7 @@ const listByDomainTopicOperationSpec: msRest.OperationSpec = { queryParameters: [ Parameters.apiVersion, Parameters.filter, - Parameters.top, - Parameters.label + Parameters.top ], headerParameters: [ Parameters.acceptLanguage diff --git a/sdk/eventgrid/arm-eventgrid/src/operations/operations.ts b/sdk/eventgrid/arm-eventgrid/src/operations/operations.ts index e5eb867508ac..d231b2693a30 100644 --- a/sdk/eventgrid/arm-eventgrid/src/operations/operations.ts +++ b/sdk/eventgrid/arm-eventgrid/src/operations/operations.ts @@ -27,8 +27,8 @@ export class Operations { } /** - * List the available operations supported by the Microsoft.EventGrid resource provider - * @summary List available operations + * List the available operations supported by the Microsoft.EventGrid resource provider. + * @summary List available operations. * @param [options] The optional parameters * @returns Promise */ diff --git a/sdk/eventgrid/arm-eventgrid/src/operations/topicTypes.ts b/sdk/eventgrid/arm-eventgrid/src/operations/topicTypes.ts index 4d28e80098ce..f39e25895e38 100644 --- a/sdk/eventgrid/arm-eventgrid/src/operations/topicTypes.ts +++ b/sdk/eventgrid/arm-eventgrid/src/operations/topicTypes.ts @@ -27,8 +27,8 @@ export class TopicTypes { } /** - * List all registered topic types - * @summary List topic types + * List all registered topic types. + * @summary List topic types. * @param [options] The optional parameters * @returns Promise */ @@ -52,20 +52,20 @@ export class TopicTypes { } /** - * Get information about a topic type - * @summary Get a topic type - * @param topicTypeName Name of the topic type + * Get information about a topic type. + * @summary Get a topic type. + * @param topicTypeName Name of the topic type. * @param [options] The optional parameters * @returns Promise */ get(topicTypeName: string, options?: msRest.RequestOptionsBase): Promise; /** - * @param topicTypeName Name of the topic type + * @param topicTypeName Name of the topic type. * @param callback The callback */ get(topicTypeName: string, callback: msRest.ServiceCallback): void; /** - * @param topicTypeName Name of the topic type + * @param topicTypeName Name of the topic type. * @param options The optional parameters * @param callback The callback */ @@ -81,20 +81,20 @@ export class TopicTypes { } /** - * List event types for a topic type - * @summary List event types - * @param topicTypeName Name of the topic type + * List event types for a topic type. + * @summary List event types. + * @param topicTypeName Name of the topic type. * @param [options] The optional parameters * @returns Promise */ listEventTypes(topicTypeName: string, options?: msRest.RequestOptionsBase): Promise; /** - * @param topicTypeName Name of the topic type + * @param topicTypeName Name of the topic type. * @param callback The callback */ listEventTypes(topicTypeName: string, callback: msRest.ServiceCallback): void; /** - * @param topicTypeName Name of the topic type + * @param topicTypeName Name of the topic type. * @param options The optional parameters * @param callback The callback */ diff --git a/sdk/eventgrid/arm-eventgrid/src/operations/topics.ts b/sdk/eventgrid/arm-eventgrid/src/operations/topics.ts index 4a30839413cd..93abd7290980 100644 --- a/sdk/eventgrid/arm-eventgrid/src/operations/topics.ts +++ b/sdk/eventgrid/arm-eventgrid/src/operations/topics.ts @@ -28,23 +28,23 @@ export class Topics { } /** - * Get properties of a topic - * @summary Get a topic + * Get properties of a topic. + * @summary Get a topic. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param topicName Name of the topic + * @param topicName Name of the topic. * @param [options] The optional parameters * @returns Promise */ get(resourceGroupName: string, topicName: string, options?: msRest.RequestOptionsBase): Promise; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param topicName Name of the topic + * @param topicName Name of the topic. * @param callback The callback */ get(resourceGroupName: string, topicName: string, callback: msRest.ServiceCallback): void; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param topicName Name of the topic + * @param topicName Name of the topic. * @param options The optional parameters * @param callback The callback */ @@ -62,10 +62,10 @@ export class Topics { /** * Asynchronously creates a new topic with the specified parameters. - * @summary Create a topic + * @summary Create a topic. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param topicName Name of the topic - * @param topicInfo Topic information + * @param topicName Name of the topic. + * @param topicInfo Topic information. * @param [options] The optional parameters * @returns Promise */ @@ -75,10 +75,10 @@ export class Topics { } /** - * Delete existing topic - * @summary Delete a topic + * Delete existing topic. + * @summary Delete a topic. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param topicName Name of the topic + * @param topicName Name of the topic. * @param [options] The optional parameters * @returns Promise */ @@ -89,10 +89,10 @@ export class Topics { /** * Asynchronously updates a topic with the specified parameters. - * @summary Update a topic + * @summary Update a topic. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param topicName Name of the topic - * @param topicUpdateParameters Topic update information + * @param topicName Name of the topic. + * @param topicUpdateParameters Topic update information. * @param [options] The optional parameters * @returns Promise */ @@ -102,8 +102,8 @@ export class Topics { } /** - * List all the topics under an Azure subscription - * @summary List topics under an Azure subscription + * List all the topics under an Azure subscription. + * @summary List topics under an Azure subscription. * @param [options] The optional parameters * @returns Promise */ @@ -127,8 +127,8 @@ export class Topics { } /** - * List all the topics under a resource group - * @summary List topics under a resource group + * List all the topics under a resource group. + * @summary List topics under a resource group. * @param resourceGroupName The name of the resource group within the user's subscription. * @param [options] The optional parameters * @returns Promise @@ -156,23 +156,23 @@ export class Topics { } /** - * List the two keys used to publish to a topic - * @summary List keys for a topic + * List the two keys used to publish to a topic. + * @summary List keys for a topic. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param topicName Name of the topic + * @param topicName Name of the topic. * @param [options] The optional parameters * @returns Promise */ listSharedAccessKeys(resourceGroupName: string, topicName: string, options?: msRest.RequestOptionsBase): Promise; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param topicName Name of the topic + * @param topicName Name of the topic. * @param callback The callback */ listSharedAccessKeys(resourceGroupName: string, topicName: string, callback: msRest.ServiceCallback): void; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param topicName Name of the topic + * @param topicName Name of the topic. * @param options The optional parameters * @param callback The callback */ @@ -189,26 +189,26 @@ export class Topics { } /** - * Regenerate a shared access key for a topic - * @summary Regenerate key for a topic + * Regenerate a shared access key for a topic. + * @summary Regenerate key for a topic. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param topicName Name of the topic - * @param regenerateKeyRequest Request body to regenerate key + * @param topicName Name of the topic. + * @param regenerateKeyRequest Request body to regenerate key. * @param [options] The optional parameters * @returns Promise */ regenerateKey(resourceGroupName: string, topicName: string, regenerateKeyRequest: Models.TopicRegenerateKeyRequest, options?: msRest.RequestOptionsBase): Promise; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param topicName Name of the topic - * @param regenerateKeyRequest Request body to regenerate key + * @param topicName Name of the topic. + * @param regenerateKeyRequest Request body to regenerate key. * @param callback The callback */ regenerateKey(resourceGroupName: string, topicName: string, regenerateKeyRequest: Models.TopicRegenerateKeyRequest, callback: msRest.ServiceCallback): void; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param topicName Name of the topic - * @param regenerateKeyRequest Request body to regenerate key + * @param topicName Name of the topic. + * @param regenerateKeyRequest Request body to regenerate key. * @param options The optional parameters * @param callback The callback */ @@ -226,29 +226,29 @@ export class Topics { } /** - * List event types for a topic - * @summary List topic event types + * List event types for a topic. + * @summary List topic event types. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param providerNamespace Namespace of the provider of the topic - * @param resourceTypeName Name of the topic type - * @param resourceName Name of the topic + * @param providerNamespace Namespace of the provider of the topic. + * @param resourceTypeName Name of the topic type. + * @param resourceName Name of the topic. * @param [options] The optional parameters * @returns Promise */ listEventTypes(resourceGroupName: string, providerNamespace: string, resourceTypeName: string, resourceName: string, options?: msRest.RequestOptionsBase): Promise; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param providerNamespace Namespace of the provider of the topic - * @param resourceTypeName Name of the topic type - * @param resourceName Name of the topic + * @param providerNamespace Namespace of the provider of the topic. + * @param resourceTypeName Name of the topic type. + * @param resourceName Name of the topic. * @param callback The callback */ listEventTypes(resourceGroupName: string, providerNamespace: string, resourceTypeName: string, resourceName: string, callback: msRest.ServiceCallback): void; /** * @param resourceGroupName The name of the resource group within the user's subscription. - * @param providerNamespace Namespace of the provider of the topic - * @param resourceTypeName Name of the topic type - * @param resourceName Name of the topic + * @param providerNamespace Namespace of the provider of the topic. + * @param resourceTypeName Name of the topic type. + * @param resourceName Name of the topic. * @param options The optional parameters * @param callback The callback */ @@ -268,10 +268,10 @@ export class Topics { /** * Asynchronously creates a new topic with the specified parameters. - * @summary Create a topic + * @summary Create a topic. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param topicName Name of the topic - * @param topicInfo Topic information + * @param topicName Name of the topic. + * @param topicInfo Topic information. * @param [options] The optional parameters * @returns Promise */ @@ -288,10 +288,10 @@ export class Topics { } /** - * Delete existing topic - * @summary Delete a topic + * Delete existing topic. + * @summary Delete a topic. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param topicName Name of the topic + * @param topicName Name of the topic. * @param [options] The optional parameters * @returns Promise */ @@ -308,10 +308,10 @@ export class Topics { /** * Asynchronously updates a topic with the specified parameters. - * @summary Update a topic + * @summary Update a topic. * @param resourceGroupName The name of the resource group within the user's subscription. - * @param topicName Name of the topic - * @param topicUpdateParameters Topic update information + * @param topicName Name of the topic. + * @param topicUpdateParameters Topic update information. * @param [options] The optional parameters * @returns Promise */ @@ -328,8 +328,8 @@ export class Topics { } /** - * List all the topics under an Azure subscription - * @summary List topics under an Azure subscription + * List all the topics under an Azure subscription. + * @summary List topics under an Azure subscription. * @param nextPageLink The NextLink from the previous successful call to List operation. * @param [options] The optional parameters * @returns Promise @@ -357,8 +357,8 @@ export class Topics { } /** - * List all the topics under a resource group - * @summary List topics under a resource group + * List all the topics under a resource group. + * @summary List topics under a resource group. * @param nextPageLink The NextLink from the previous successful call to List operation. * @param [options] The optional parameters * @returns Promise