Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[AutoPR @azure/arm-maps] update readme #8106

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions sdk/maps/arm-maps/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,33 @@
# Release History

## 3.1.0-beta.1 (2022-03-15)

**Features**

- Added operation Accounts.listSas
- Added Interface AccountSasParameters
- Added Interface AccountsListSasOptionalParams
- Added Interface Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
- Added Interface CorsRule
- Added Interface CorsRules
- Added Interface LinkedResource
- Added Interface ManagedServiceIdentity
- Added Interface MapsAccountSasToken
- Added Type Alias AccountsListSasResponse
- Added Type Alias ResourceIdentityType
- Added Type Alias SigningKey
- Interface MapsAccountProperties has a new optional parameter cors
- Interface MapsAccountProperties has a new optional parameter linkedResources
- Interface MapsAccountUpdateParameters has a new optional parameter cors
- Interface MapsAccountUpdateParameters has a new optional parameter identity
- Interface MapsAccountUpdateParameters has a new optional parameter linkedResources
- Interface MetricSpecification has a new optional parameter internalMetricName
- Interface MetricSpecification has a new optional parameter sourceMdmAccount
- Type Alias Creator has a new parameter systemData
- Type Alias MapsAccount has a new parameter identity
- Added Enum KnownSigningKey


## 3.0.0 (2022-01-19)

The package of @azure/arm-maps is using our next generation design principles since version 3.0.0, which contains breaking changes.
Expand Down
2 changes: 1 addition & 1 deletion sdk/maps/arm-maps/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Azure Maps

[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/maps/arm-maps) |
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-maps) |
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-maps) |
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-maps?view=azure-node-preview) |
[Samples](https://github.com/Azure-Samples/azure-samples-js-management)

## Getting started
Expand Down
7 changes: 4 additions & 3 deletions sdk/maps/arm-maps/_meta.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{
"commit": "184b23b63ee3a79fb41ca3aa55a31a8d9e636772",
"commit": "85eb3e7dbe23e025b9c838bef309f11a05768f10",
"readme": "specification/maps/resource-manager/readme.md",
"autorest_command": "autorest --version=3.7.3 --typescript --modelerfour.lenient-model-deduplication --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\mydev\\azure-sdk-for-js ../azure-rest-api-specs/specification/maps/resource-manager/readme.md --use=@autorest/typescript@6.0.0-alpha.16.20220114.1",
"autorest_command": "autorest --version=3.7.3 --typescript --modelerfour.lenient-model-deduplication --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js ../azure-rest-api-specs/specification/maps/resource-manager/readme.md --use=@autorest/typescript@6.0.0-alpha.16.20220105.1",
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
"use": "@autorest/typescript@6.0.0-alpha.16.20220114.1"
"release_tool": "@azure-tools/js-sdk-release-tools@2.1.1",
"use": "@autorest/typescript@6.0.0-alpha.16.20220105.1"
}
25 changes: 19 additions & 6 deletions sdk/maps/arm-maps/api-extractor.json
Original file line number Diff line number Diff line change
@@ -1,18 +1,31 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"mainEntryPointFilePath": "./dist-esm/src/index.d.ts",
"docModel": { "enabled": true },
"apiReport": { "enabled": true, "reportFolder": "./review" },
"docModel": {
"enabled": true
},
"apiReport": {
"enabled": true,
"reportFolder": "./review"
},
"dtsRollup": {
"enabled": true,
"untrimmedFilePath": "",
"publicTrimmedFilePath": "./types/arm-maps.d.ts"
},
"messages": {
"tsdocMessageReporting": { "default": { "logLevel": "none" } },
"tsdocMessageReporting": {
"default": {
"logLevel": "none"
}
},
"extractorMessageReporting": {
"ae-missing-release-tag": { "logLevel": "none" },
"ae-unresolved-link": { "logLevel": "none" }
"ae-missing-release-tag": {
"logLevel": "none"
},
"ae-unresolved-link": {
"logLevel": "none"
}
}
}
}
}
25 changes: 15 additions & 10 deletions sdk/maps/arm-maps/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,24 @@
"sdk-type": "mgmt",
"author": "Microsoft Corporation",
"description": "A generated SDK for AzureMapsManagementClient.",
"version": "3.0.0",
"engines": { "node": ">=12.0.0" },
"version": "3.1.0-beta.1",
"engines": {
"node": ">=12.0.0"
},
"dependencies": {
"@azure/core-paging": "^1.2.0",
"@azure/core-client": "^1.0.0",
"@azure/core-auth": "^1.3.0",
"@azure/core-rest-pipeline": "^1.1.0",
"tslib": "^2.2.0"
},
"keywords": ["node", "azure", "typescript", "browser", "isomorphic"],
"keywords": [
"node",
"azure",
"typescript",
"browser",
"isomorphic"
],
"license": "MIT",
"main": "./dist/index.js",
"module": "./dist-esm/src/index.js",
Expand All @@ -39,7 +47,9 @@
"type": "git",
"url": "https://github.com/Azure/azure-sdk-for-js.git"
},
"bugs": { "url": "https://github.com/Azure/azure-sdk-for-js/issues" },
"bugs": {
"url": "https://github.com/Azure/azure-sdk-for-js/issues"
},
"files": [
"dist/**/*.js",
"dist/**/*.js.map",
Expand Down Expand Up @@ -86,10 +96,5 @@
"docs": "echo skipped"
},
"sideEffects": false,
"//metadata": {
"constantPaths": [
{ "path": "src/AzureMapsManagementClient.ts", "prefix": "packageDetails" }
]
},
"autoPublish": true
}
}
78 changes: 78 additions & 0 deletions sdk/maps/arm-maps/review/arm-maps.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,21 @@ export interface Accounts {
listByResourceGroup(resourceGroupName: string, options?: AccountsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<MapsAccount>;
listBySubscription(options?: AccountsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<MapsAccount>;
listKeys(resourceGroupName: string, accountName: string, options?: AccountsListKeysOptionalParams): Promise<AccountsListKeysResponse>;
listSas(resourceGroupName: string, accountName: string, mapsAccountSasParameters: AccountSasParameters, options?: AccountsListSasOptionalParams): Promise<AccountsListSasResponse>;
regenerateKeys(resourceGroupName: string, accountName: string, keySpecification: MapsKeySpecification, options?: AccountsRegenerateKeysOptionalParams): Promise<AccountsRegenerateKeysResponse>;
update(resourceGroupName: string, accountName: string, mapsAccountUpdateParameters: MapsAccountUpdateParameters, options?: AccountsUpdateOptionalParams): Promise<AccountsUpdateResponse>;
}

// @public
export interface AccountSasParameters {
expiry: string;
maxRatePerSecond: number;
principalId: string;
regions?: string[];
signingKey: SigningKey;
start: string;
}

// @public
export interface AccountsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
}
Expand Down Expand Up @@ -73,6 +84,13 @@ export interface AccountsListKeysOptionalParams extends coreClient.OperationOpti
// @public
export type AccountsListKeysResponse = MapsAccountKeys;

// @public
export interface AccountsListSasOptionalParams extends coreClient.OperationOptions {
}

// @public
export type AccountsListSasResponse = MapsAccountSasToken;

// @public
export interface AccountsRegenerateKeysOptionalParams extends coreClient.OperationOptions {
}
Expand Down Expand Up @@ -111,12 +129,29 @@ export interface AzureMapsManagementClientOptionalParams extends coreClient.Serv
endpoint?: string;
}

// @public (undocumented)
export interface Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties {
readonly clientId?: string;
readonly principalId?: string;
}

// @public
export interface CorsRule {
allowedOrigins: string[];
}

// @public
export interface CorsRules {
corsRules?: CorsRule[];
}

// @public
export type CreatedByType = string;

// @public
export type Creator = TrackedResource & {
properties: CreatorProperties;
readonly systemData?: SystemData;
};

// @public
Expand Down Expand Up @@ -263,6 +298,30 @@ export enum KnownName {
S1 = "S1"
}

// @public
export enum KnownSigningKey {
// (undocumented)
PrimaryKey = "primaryKey",
// (undocumented)
SecondaryKey = "secondaryKey"
}

// @public
export interface LinkedResource {
id: string;
uniqueName: string;
}

// @public
export interface ManagedServiceIdentity {
readonly principalId?: string;
readonly tenantId?: string;
type?: ResourceIdentityType;
userAssignedIdentities?: {
[propertyName: string]: Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties;
};
}

// @public
export interface Maps {
listOperations(options?: MapsListOperationsOptionalParams): PagedAsyncIterableIterator<OperationDetail>;
Expand All @@ -274,6 +333,7 @@ export type MapsAccount = TrackedResource & {
sku: Sku;
kind?: Kind;
readonly systemData?: SystemData;
identity?: ManagedServiceIdentity;
properties?: MapsAccountProperties;
};

Expand All @@ -287,7 +347,9 @@ export interface MapsAccountKeys {

// @public
export interface MapsAccountProperties {
cors?: CorsRules;
disableLocalAuth?: boolean;
linkedResources?: LinkedResource[];
readonly provisioningState?: string;
readonly uniqueId?: string;
}
Expand All @@ -298,10 +360,18 @@ export interface MapsAccounts {
readonly value?: MapsAccount[];
}

// @public
export interface MapsAccountSasToken {
readonly accountSasToken?: string;
}

// @public
export interface MapsAccountUpdateParameters {
cors?: CorsRules;
disableLocalAuth?: boolean;
identity?: ManagedServiceIdentity;
kind?: Kind;
linkedResources?: LinkedResource[];
readonly provisioningState?: string;
sku?: Sku;
tags?: {
Expand Down Expand Up @@ -357,8 +427,10 @@ export interface MetricSpecification {
displayDescription?: string;
displayName?: string;
fillGapWithZero?: boolean;
internalMetricName?: string;
name?: string;
resourceIdDimensionNameOverride?: string;
sourceMdmAccount?: string;
unit?: string;
}

Expand Down Expand Up @@ -389,11 +461,17 @@ export interface Resource {
readonly type?: string;
}

// @public
export type ResourceIdentityType = "SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None";

// @public
export interface ServiceSpecification {
metricSpecifications?: MetricSpecification[];
}

// @public
export type SigningKey = string;

// @public
export interface Sku {
name: Name;
Expand Down
4 changes: 2 additions & 2 deletions sdk/maps/arm-maps/src/azureMapsManagementClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ export class AzureMapsManagementClient extends coreClient.ServiceClient {
credential: credentials
};

const packageDetails = `azsdk-js-arm-maps/3.0.0`;
const packageDetails = `azsdk-js-arm-maps/3.1.0-beta.1`;
const userAgentPrefix =
options.userAgentOptions && options.userAgentOptions.userAgentPrefix
? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
Expand All @@ -67,7 +67,7 @@ export class AzureMapsManagementClient extends coreClient.ServiceClient {

// Assigning values to Constant parameters
this.$host = options.$host || "https://management.azure.com";
this.apiVersion = options.apiVersion || "2021-02-01";
this.apiVersion = options.apiVersion || "2021-12-01-preview";
this.accounts = new AccountsImpl(this);
this.maps = new MapsImpl(this);
this.creators = new CreatorsImpl(this);
Expand Down
Loading