Microsoft.Azure.Common.Authentication.xml
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 |
<?xml version="1.0"?>
<doc> <assembly> <name>Microsoft.Azure.Common.Authentication</name> </assembly> <members> <member name="T:Microsoft.Azure.Common.Authentication.AadAuthenticationException"> <summary> Base class representing an exception that occurs when authenticating against Azure Active Directory </summary> </member> <member name="T:Microsoft.Azure.Common.Authentication.AadAuthenticationCanceledException"> <summary> Exception that gets thrown when the user explicitly cancels an authentication operation. </summary> </member> <member name="T:Microsoft.Azure.Common.Authentication.AadAuthenticationFailedWithoutPopupException"> <summary> Exception that gets thrown when the ADAL library is unable to authenticate without a popup dialog. </summary> </member> <member name="T:Microsoft.Azure.Common.Authentication.AadAuthenticationFailedException"> <summary> Exception that gets thrown if an authentication operation fails on the server. </summary> </member> <member name="T:Microsoft.Azure.Common.Authentication.AadAuthenticationCantRenewException"> <summary> Exception thrown if a refresh token has expired. </summary> </member> <member name="T:Microsoft.Azure.Common.Authentication.AdalConfiguration"> <summary> Class storing the configuration information needed for ADAL to request token from the right AD tenant depending on environment. </summary> </member> <member name="T:Microsoft.Azure.Common.Authentication.AdalTokenProvider"> <summary> A token provider that uses ADAL to retrieve tokens from Azure Active Directory </summary> </member> <member name="T:Microsoft.Azure.Common.Authentication.ITokenProvider"> <summary> This interface represents objects that can be used to obtain and manage access tokens. </summary> </member> <member name="M:Microsoft.Azure.Common.Authentication.ITokenProvider.GetAccessToken(Microsoft.Azure.Common.Authentication.AdalConfiguration,Microsoft.Azure.Common.Authentication.ShowDialog,System.String,System.Security.SecureString,Microsoft.Azure.Common.Authentication.Models.AzureAccount.AccountType)"> <summary> Get a new login token for the given environment, user credential, and credential type. </summary> <param name="config">Configuration.</param> <param name="promptBehavior">Prompt behavior.</param> <param name="userId">User ID/Service principal to get the token for.</param> <param name="password">Secure strings with password/service principal key.</param> <param name="credentialType">Credential type.</param> <returns>An access token.</returns> </member> <member name="M:Microsoft.Azure.Common.Authentication.ITokenProvider.GetAccessTokenWithCertificate(Microsoft.Azure.Common.Authentication.AdalConfiguration,System.String,System.String,Microsoft.Azure.Common.Authentication.Models.AzureAccount.AccountType)"> <summary> Get a new authentication token for the given environment </summary> <param name="config">The ADAL Configuration</param> <param name="principalId">The id for the given principal</param> <param name="certificateThumbprint">The certificate thumbprint for this user</param> <param name="credentialType">The account type</param> <returns>An access token, which can be renewed</returns> </member> <member name="T:Microsoft.Azure.Common.Authentication.ConsoleParentWindow"> <summary> An implementation of <see cref="T:System.Windows.Forms.IWin32Window"/> that gives the windows handle for the current console window. </summary> </member> <member name="T:Microsoft.Azure.Common.Authentication.CredStore"> <summary> Class wrapping PInvoke signatures for Windows Credential store </summary> </member> <member name="T:Microsoft.Azure.Common.Authentication.CertificateApplicationCredentialProvider"> <summary> Interface to the certificate store for authentication </summary> </member> <member name="M:Microsoft.Azure.Common.Authentication.CertificateApplicationCredentialProvider.#ctor(System.String)"> <summary> Create a certificate provider </summary> <param name="certificateThumbprint"></param> </member> <member name="M:Microsoft.Azure.Common.Authentication.CertificateApplicationCredentialProvider.AuthenticateAsync(System.String,System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext)"> <summary> Authenticate using certificate thumbprint from the datastore </summary> <param name="clientId">The active directory client id for the application.</param> <param name="audience">The intended audience for authentication</param> <param name="context">The AD AuthenticationContext to use</param> <returns></returns> </member> <member name="T:Microsoft.Azure.Common.Authentication.KeyStoreApplicationCredentialProvider"> <summary> Interface to the keystore for authentication </summary> </member> <member name="M:Microsoft.Azure.Common.Authentication.KeyStoreApplicationCredentialProvider.#ctor(System.String)"> <summary> Create a credential provider </summary> <param name="tenant"></param> </member> <member name="M:Microsoft.Azure.Common.Authentication.KeyStoreApplicationCredentialProvider.AuthenticateAsync(System.String,System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext)"> <summary> Authenticate using the secret for the specified client from the key store </summary> <param name="clientId">The active directory client id for the application.</param> <param name="audience">The intended audience for authentication</param> <param name="context">The AD AuthenticationContext to use</param> <returns></returns> </member> <member name="F:Microsoft.Azure.Common.Authentication.LoginType.OrgId"> <summary> User is logging in with orgid credentials </summary> </member> <member name="F:Microsoft.Azure.Common.Authentication.LoginType.LiveId"> <summary> User is logging in with liveid credentials </summary> </member> <member name="T:Microsoft.Azure.Common.Authentication.ProtectedFileTokenCache"> <summary> An implementation of the Adal token cache that stores the cache items in the DPAPI-protected file. </summary> </member> <member name="T:Microsoft.Azure.Common.Authentication.ServicePrincipalKeyStore"> <summary> Helper class to store service principal keys and retrieve them from the Windows Credential Store. </summary> </member> <member name="T:Microsoft.Azure.Common.Authentication.UserTokenProvider"> <summary> A token provider that uses ADAL to retrieve tokens from Azure Active Directory for user credentials. </summary> </member> <member name="T:Microsoft.Azure.Common.Authentication.UserTokenProvider.AdalAccessToken"> <summary> Implementation of <see cref="T:Microsoft.Azure.Common.Authentication.IAccessToken"/> using data from ADAL </summary> </member> <member name="T:Microsoft.Azure.Common.Authentication.AzureSession"> <summary> Represents current Azure session. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.AzureSession.ClientFactory"> <summary> Gets or sets Azure client factory. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.AzureSession.AuthenticationFactory"> <summary> Gets or sets Azure authentication factory. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.AzureSession.DataStore"> <summary> Gets or sets data persistence store. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.AzureSession.TokenCache"> <summary> Gets or sets the token cache store. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.AzureSession.ProfileDirectory"> <summary> Gets or sets profile directory. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.AzureSession.TokenCacheFile"> <summary> Gets or sets token cache file path. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.AzureSession.ProfileFile"> <summary> Gets or sets profile file name. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.AzureSession.OldProfileFileBackup"> <summary> Gets or sets file name for the migration backup. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.AzureSession.OldProfileFile"> <summary> Gets or sets old profile file name. </summary> </member> <member name="T:Microsoft.Azure.Common.Authentication.ProfileData"> <summary> This class provides the representation of data loaded and saved into data files for AzureSMProfile. </summary> </member> <member name="T:Microsoft.Azure.Common.Authentication.AzureEnvironmentData"> <summary> This class provides the representation of data loaded and saved into data files for an individual Azure environment </summary> </member> <member name="T:Microsoft.Azure.Common.Authentication.AzureSubscriptionData"> <summary> This class provides the representation of data loaded and saved into data file for an individual Azure subscription. </summary> </member> <member name="M:Microsoft.Azure.Common.Authentication.AzureSubscriptionData.#ctor"> <summary> Constructor used by DataContractSerializer </summary> </member> <member name="M:Microsoft.Azure.Common.Authentication.Validate.ValidateStringIsNullOrEmpty(System.String,System.String,System.Boolean)"> <summary> Validates against given string if null or empty. </summary> <param name="data">string variable to validate</param> <param name="messageData">This parameter is used when the validation fails. It can contain actual message to display or parameter name to display with default message</param> <param name="useDefaultMessage">Indicates either to use messageData as actual message or parameter name</param> </member> <member name="M:Microsoft.Azure.Common.Authentication.Validate.ValidatePath(System.String,System.String)"> <summary> Make validation for given path. </summary> <param name="path">Path to validate</param> <param name="exceptionMessage">message to display if this validation failed</param> </member> <member name="M:Microsoft.Azure.Common.Authentication.Validate.ValidateDirectoryFull(System.String,System.String)"> <summary> Validates against given directory </summary> <param name="directoryNameOnDisk">Directory name</param> <param name="directoryName">Name which you use to identify that directory to user (i.e. AzureSdkDirectory)</param> </member> <member name="M:Microsoft.Azure.Common.Authentication.Validate.ValidateFileFull(System.String,System.String)"> <summary> Validates against given file </summary> <param name="fileNameOnDisk">File name</param> <param name="fileName">Name which you use to identify that directory to user (i.e. Service Settings)</param> </member> <member name="M:Microsoft.Azure.Common.Authentication.IAuthenticationFactory.Authenticate(Microsoft.Azure.Common.Authentication.Models.AzureAccount,Microsoft.Azure.Common.Authentication.Models.AzureEnvironment,System.String,System.Security.SecureString,Microsoft.Azure.Common.Authentication.ShowDialog,Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCache,Microsoft.Azure.Common.Authentication.Models.AzureEnvironment.Endpoint)"> <summary> Returns IAccessToken if authentication succeeds or throws an exception if authentication fails. </summary> <param name="account">The azure account object</param> <param name="environment">The azure environment object</param> <param name="tenant">The AD tenant in most cases should be 'common'</param> <param name="password">The AD account password</param> <param name="promptBehavior">The prompt behavior</param> <param name="tokenCache">Token Cache</param> <param name="resourceId">Optional, the AD resource id</param> <returns></returns> </member> <member name="M:Microsoft.Azure.Common.Authentication.IAuthenticationFactory.Authenticate(Microsoft.Azure.Common.Authentication.Models.AzureAccount,Microsoft.Azure.Common.Authentication.Models.AzureEnvironment,System.String,System.Security.SecureString,Microsoft.Azure.Common.Authentication.ShowDialog,Microsoft.Azure.Common.Authentication.Models.AzureEnvironment.Endpoint)"> <summary> Returns IAccessToken if authentication succeeds or throws an exception if authentication fails. </summary> <param name="account">The azure account object</param> <param name="environment">The azure environment object</param> <param name="tenant">The AD tenant in most cases should be 'common'</param> <param name="password">The AD account password</param> <param name="promptBehavior">The prompt behavior</param> <param name="resourceId">Optional, the AD resource id</param> <returns></returns> </member> <member name="M:Microsoft.Azure.Common.Authentication.IClientFactory.AddUserAgent(System.String)"> <summary> Adds user agent to UserAgents collection with empty version. </summary> <param name="productName">Product name.</param> </member> <member name="M:Microsoft.Azure.Common.Authentication.IClientFactory.AddUserAgent(System.String,System.String)"> <summary> Adds user agent to UserAgents collection. </summary> <param name="productName">Product name.</param> <param name="productVersion">Product version.</param> </member> <member name="M:Microsoft.Azure.Common.Authentication.Factories.ClientFactory.CreateClient``1(Microsoft.Azure.Common.Authentication.Models.AzureSMProfile,Microsoft.Azure.Common.Authentication.Models.AzureSubscription,Microsoft.Azure.Common.Authentication.Models.AzureEnvironment.Endpoint)"> <summary> </summary> <typeparam name="TClient"></typeparam> <param name="subscription"></param> <param name="endpoint"></param> <returns></returns> </member> <member name="M:Microsoft.Azure.Common.Authentication.Factories.ClientFactory.AddUserAgent(System.String,System.String)"> <summary> Adds user agent to UserAgents collection. </summary> <param name="productName">Product name.</param> <param name="productVersion">Product version.</param> </member> <member name="M:Microsoft.Azure.Common.Authentication.Factories.ClientFactory.AddUserAgent(System.String)"> <summary> Adds user agent to UserAgents collection with empty version. </summary> <param name="productName">Product name.</param> </member> <member name="F:Microsoft.Azure.Common.Authentication.Models.AzureAccount.Property.Subscriptions"> <summary> Comma separated list of subscription ids on this account. </summary> </member> <member name="F:Microsoft.Azure.Common.Authentication.Models.AzureAccount.Property.Tenants"> <summary> Comma separated list of tenants on this account. </summary> </member> <member name="F:Microsoft.Azure.Common.Authentication.Models.AzureAccount.Property.AccessToken"> <summary> Access token. </summary> </member> <member name="F:Microsoft.Azure.Common.Authentication.Models.AzureAccount.Property.CertificateThumbprint"> <summary> Thumbprint for associated certificate </summary> </member> <member name="T:Microsoft.Azure.Common.Authentication.Models.AzureContext"> <summary> Represents current Azure session context. </summary> </member> <member name="M:Microsoft.Azure.Common.Authentication.Models.AzureContext.#ctor(Microsoft.Azure.Common.Authentication.Models.AzureSubscription,Microsoft.Azure.Common.Authentication.Models.AzureAccount,Microsoft.Azure.Common.Authentication.Models.AzureEnvironment)"> <summary> Creates new instance of AzureContext. </summary> <param name="subscription">The azure subscription object</param> <param name="account">The azure account object</param> <param name="environment">The azure environment object</param> </member> <member name="M:Microsoft.Azure.Common.Authentication.Models.AzureContext.#ctor(Microsoft.Azure.Common.Authentication.Models.AzureAccount,Microsoft.Azure.Common.Authentication.Models.AzureEnvironment,Microsoft.Azure.Common.Authentication.Models.AzureTenant)"> <summary> Creates new instance of AzureContext. </summary> <param name="account">The azure account object</param> <param name="environment">The azure environment object</param> <param name="tenant">The azure tenant object</param> </member> <member name="M:Microsoft.Azure.Common.Authentication.Models.AzureContext.#ctor(Microsoft.Azure.Common.Authentication.Models.AzureSubscription,Microsoft.Azure.Common.Authentication.Models.AzureAccount,Microsoft.Azure.Common.Authentication.Models.AzureEnvironment,Microsoft.Azure.Common.Authentication.Models.AzureTenant)"> <summary> Creates new instance of AzureContext. </summary> <param name="subscription">The azure subscription object</param> <param name="account">The azure account object</param> <param name="environment">The azure environment object</param> <param name="tenant">The azure tenant object</param> </member> <member name="P:Microsoft.Azure.Common.Authentication.Models.AzureContext.Account"> <summary> Gets the azure account. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Models.AzureContext.Subscription"> <summary> Gets the azure subscription. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Models.AzureContext.Environment"> <summary> Gets the azure environment. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Models.AzureContext.Tenant"> <summary> Gets the azure tenant. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Models.AzureContext.TokenCache"> <summary> Gets or sets the token cache contents. </summary> </member> <member name="M:Microsoft.Azure.Common.Authentication.Models.AzureEnvironment.StorageBlobEndpointFormat"> <summary> The storage service blob endpoint format. </summary> </member> <member name="M:Microsoft.Azure.Common.Authentication.Models.AzureEnvironment.StorageQueueEndpointFormat"> <summary> The storage service queue endpoint format. </summary> </member> <member name="M:Microsoft.Azure.Common.Authentication.Models.AzureEnvironment.StorageTableEndpointFormat"> <summary> The storage service table endpoint format. </summary> </member> <member name="M:Microsoft.Azure.Common.Authentication.Models.AzureEnvironment.StorageFileEndpointFormat"> <summary> The storage service file endpoint format. </summary> </member> <member name="M:Microsoft.Azure.Common.Authentication.Models.AzureEnvironment.GetStorageBlobEndpoint(System.String,System.Boolean)"> <summary> Gets the endpoint for storage blob. </summary> <param name="accountName">The account name</param> <param name="useHttps">Use Https when creating the URI. Defaults to true.</param> <returns>The fully qualified uri to the blob service</returns> </member> <member name="M:Microsoft.Azure.Common.Authentication.Models.AzureEnvironment.GetStorageQueueEndpoint(System.String,System.Boolean)"> <summary> Gets the endpoint for storage queue. </summary> <param name="accountName">The account name</param> <param name="useHttps">Use Https when creating the URI. Defaults to true.</param> <returns>The fully qualified uri to the queue service</returns> </member> <member name="M:Microsoft.Azure.Common.Authentication.Models.AzureEnvironment.GetStorageTableEndpoint(System.String,System.Boolean)"> <summary> Gets the endpoint for storage table. </summary> <param name="accountName">The account name</param> <param name="useHttps">Use Https when creating the URI. Defaults to true.</param> <returns>The fully qualified uri to the table service</returns> </member> <member name="M:Microsoft.Azure.Common.Authentication.Models.AzureEnvironment.GetStorageFileEndpoint(System.String,System.Boolean)"> <summary> Gets the endpoint for storage file. </summary> <param name="accountName">The account name</param> <param name="useHttps">Use Https when creating the URI. Defaults to true.</param> <returns>The fully qualified uri to the file service</returns> </member> <member name="M:Microsoft.Azure.Common.Authentication.Models.AzureEnvironment.GetManagementPortalUrlWithRealm(System.String)"> <summary> Gets the management portal URI with a particular realm suffix if supplied </summary> <param name="realm">Realm for user's account</param> <returns>Url to management portal.</returns> </member> <member name="M:Microsoft.Azure.Common.Authentication.Models.AzureEnvironment.GetPublishSettingsFileUrlWithRealm(System.String)"> <summary> Get the publish settings file download url with a realm suffix if needed. </summary> <param name="realm">Realm for user's account</param> <returns>Url to publish settings file</returns> </member> <member name="P:Microsoft.Azure.Common.Authentication.Models.AzureEnvironment.PublicEnvironments"> <summary> Predefined Microsoft Azure environments </summary> </member> <member name="T:Microsoft.Azure.Common.Authentication.Models.AzureSMProfile"> <summary> Represents Azure profile structure with multiple environments, subscriptions, and accounts. </summary> </member> <member name="T:Microsoft.Azure.Common.Authentication.Models.IAzureProfile"> <summary> Interface for Azure supported profiles. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Models.IAzureProfile.Context"> <summary> Gets the default azure context object. </summary> </member> <member name="M:Microsoft.Azure.Common.Authentication.Models.AzureSMProfile.#ctor"> <summary> Initializes a new instance of AzureSMProfile </summary> </member> <member name="M:Microsoft.Azure.Common.Authentication.Models.AzureSMProfile.#ctor(System.String)"> <summary> Initializes a new instance of AzureSMProfile and loads its content from specified path. Any errors generated in the process are stored in ProfileLoadErrors collection. </summary> <param name="path">Location of profile file on disk.</param> </member> <member name="M:Microsoft.Azure.Common.Authentication.Models.AzureSMProfile.Save"> <summary> Writes profile to a ProfilePath </summary> </member> <member name="M:Microsoft.Azure.Common.Authentication.Models.AzureSMProfile.Save(System.String)"> <summary> Writes profile to a specified path. </summary> <param name="path">File path on disk to save profile to</param> </member> <member name="P:Microsoft.Azure.Common.Authentication.Models.AzureSMProfile.Accounts"> <summary> Gets Azure Accounts </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Models.AzureSMProfile.Subscriptions"> <summary> Gets Azure Subscriptions </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Models.AzureSMProfile.DefaultSubscription"> <summary> Gets or sets current Azure Subscription </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Models.AzureSMProfile.Environments"> <summary> Gets Azure Environments </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Models.AzureSMProfile.Context"> <summary> Gets the default azure context object. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Models.AzureSMProfile.ProfileLoadErrors"> <summary> Gets errors from loading the profile. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Models.AzureSMProfile.ProfilePath"> <summary> Location of the profile file. </summary> </member> <member name="T:Microsoft.Azure.Common.Authentication.Models.AzureRMProfile"> <summary> Represents Azure Resource Manager profile structure with default context, environments and token cache. </summary> </member> <member name="M:Microsoft.Azure.Common.Authentication.Models.AzureRMProfile.#ctor"> <summary> Creates new instance of AzureRMProfile. </summary> </member> <member name="M:Microsoft.Azure.Common.Authentication.Models.AzureRMProfile.#ctor(System.String)"> <summary> Initializes a new instance of AzureRMProfile and loads its content from specified path. </summary> <param name="path">The location of profile file on disk.</param> </member> <member name="M:Microsoft.Azure.Common.Authentication.Models.AzureRMProfile.Save"> <summary> Writes profile to the disk it was opened from disk. </summary> </member> <member name="M:Microsoft.Azure.Common.Authentication.Models.AzureRMProfile.Save(System.String)"> <summary> Writes profile to a specified path. </summary> <param name="path">File path on disk to save profile to</param> </member> <member name="M:Microsoft.Azure.Common.Authentication.Models.AzureRMProfile.ToString"> <summary> Serializes the current profile and return its contents. </summary> <returns>The current string.</returns> </member> <member name="P:Microsoft.Azure.Common.Authentication.Models.AzureRMProfile.Environments"> <summary> Gets or sets Azure environments. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Models.AzureRMProfile.Context"> <summary> Gets or sets the default azure context object. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Models.AzureRMProfile.ProfilePath"> <summary> Gets the path of the profile file. </summary> </member> <member name="F:Microsoft.Azure.Common.Authentication.Models.AzureSubscription.Property.RegisteredResourceProviders"> <summary> Comma separated registered resource providers, i.e.: websites,compute,hdinsight </summary> </member> <member name="F:Microsoft.Azure.Common.Authentication.Models.AzureSubscription.Property.Tenants"> <summary> Associated tenants </summary> </member> <member name="F:Microsoft.Azure.Common.Authentication.Models.AzureSubscription.Property.Default"> <summary> If this property existed on the subscription indicates that it's default one. </summary> </member> <member name="T:Microsoft.Azure.Common.Authentication.Models.AzureTenant"> <summary> Represents an AD tenant. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Models.AzureTenant.Id"> <summary> Gets or sets the tenant id. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Models.AzureTenant.Domain"> <summary> Gets or sets the tenant domain. </summary> </member> <member name="M:Microsoft.Azure.Common.Authentication.Models.MemoryDataStore.WildcardToRegex(System.String)"> <summary> Converts unix asterisk based file pattern to regex </summary> <param name="wildcard">Asterisk based pattern</param> <returns>Regeular expression of null is empty</returns> </member> <member name="T:Microsoft.Azure.Common.Authentication.Properties.Resources"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.AccountNeedsToBeSpecified"> <summary> Looks up a localized string similar to Account needs to be specified. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.AccountNotFound"> <summary> Looks up a localized string similar to No account was found for this subscription. Please execute Clear-AzureProfile and then execute Add-AzureAccount.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.AdalAuthConfigurationTrace"> <summary> Looks up a localized string similar to [Common.Authentication]: Authenticating using configuration values: Domain: '{0}', Endpoint: '{1}', ClientId: '{2}', ClientRedirect: '{3}', ResourceClientUri: '{4}', ValidateAuthrity: '{5}'. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.AdalAuthException"> <summary> Looks up a localized string similar to [Common.Authentication]: Received exception {0}, while authenticating.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.AdalMultipleTokens"> <summary> Looks up a localized string similar to Multiple tokens were found for this user. Please clear your token cache using, Clear-AzureProfile and try this command again.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.AdalUserInteractionRequired"> <summary> Looks up a localized string similar to User Interaction is required to authenticate this user. Please authenticate using the log in dialog. In PowerShell, execute Login-AzureRMAccount for Azure Resource Manager cmdlets or Add-AzureAccount for service management cmdlets.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.ArmAccountNotFound"> <summary> Looks up a localized string similar to No account found in the context. Please login using Login-AzureRMAccount.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.ArmUserInteractionRequired"> <summary> Looks up a localized string similar to User Interaction is required to authenticate this user. Please execute Login-AzureRMAccount without parameters and enter your credentials.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.AuthenticatingForSingleTenant"> <summary> Looks up a localized string similar to [Common.Authentication]: Authenticating for account {0} with single tenant {1}. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.AzureDirectoryName"> <summary> Looks up a localized string similar to Windows Azure Powershell. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.CertificateNotFoundInStore"> <summary> Looks up a localized string similar to No certificate was found in the certificate store with thumbprint {0}. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.ChangingDefaultEnvironmentNotSupported"> <summary> Looks up a localized string similar to Changing public environment is not supported.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.CredentialOrganizationIdMessage"> <summary> Looks up a localized string similar to -Credential parameter can only be used with Organization ID credentials. For more information, please refer to http://go.microsoft.com/fwlink/?linkid=331007&clcid=0x409 for more information about the difference between an organizational account and a Microsoft account.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.EnvironmentNameNeedsToBeSpecified"> <summary> Looks up a localized string similar to Environment name needs to be specified. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.EnvironmentNeedsToBeSpecified"> <summary> Looks up a localized string similar to Environment needs to be specified. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.EnvironmentNotFound"> <summary> Looks up a localized string similar to The environment name '{0}' is not found.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.ExpiredRefreshToken"> <summary> Looks up a localized string similar to Your Microsoft Azure credential in the Windows PowerShell session has expired. Please log in again. In PowerShell, execute Login-AzureRMAccount for Azure Resource Manager cmdlets or Add-AzureAccount for service management cmdlets.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.FilePathIsNotValid"> <summary> Looks up a localized string similar to File path is not valid. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.IllegalPath"> <summary> Looks up a localized string similar to Illegal characters in path.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.InvalidArmContext"> <summary> Looks up a localized string similar to Your Azure credentials have not been set up or have expired, please run Login-AzureRMAccount to set up your Azure credentials.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.InvalidCertificate"> <summary> Looks up a localized string similar to Invalid certificate format. Publish settings may be corrupted. Use Get-AzurePublishSettingsFile to download updated settings. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.InvalidCredentialType"> <summary> Looks up a localized string similar to Credential type invalid, only handles '{0}'. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.InvalidDefaultSubscription"> <summary> Looks up a localized string similar to No default subscription has been designated. Use Select-AzureSubscription -Default <subscriptionName> to set the default subscription.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.InvalidDnsName"> <summary> Looks up a localized string similar to "{0}" is an invalid DNS name for {1}. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.InvalidFileExtension"> <summary> Looks up a localized string similar to The provided file in {0} must be have {1} extension. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.InvalidManagementClientType"> <summary> Looks up a localized string similar to Cannot create instance of management client type {0}. It does not have the expected constructor.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.InvalidOrEmptyArgumentMessage"> <summary> Looks up a localized string similar to {0} is invalid or empty. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.InvalidSubscriptionName"> <summary> Looks up a localized string similar to Must specify a non-null subscription name.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.InvalidSubscriptionState"> <summary> Looks up a localized string similar to Your Azure credentials have not been set up or have expired, please run Add-AzureAccount to set up your Azure credentials.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.NoAccountInContext"> <summary> Looks up a localized string similar to [Common.Authentication]: No matching account record for account {0} in subscription {1}. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.NoEnvironmentInContext"> <summary> Looks up a localized string similar to [Common.Authentication]: No matching environment record for environment {0} in subscription {1}, using AzureCloud environment instead. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.NoInternetConnection"> <summary> Looks up a localized string similar to Please connect to internet before executing this cmdlet. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.NoSubscriptionInContext"> <summary> Looks up a localized string similar to No subscription found in the context. Please ensure that the credentials you provided are authorized to access an Azure subscription, then run Login-AzureRMAccount to login.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.NoTenantInContext"> <summary> Looks up a localized string similar to No tenant found in the context. Please ensure that the credentials you provided are authorized to access an Azure subscription, then run Login-AzureRMAccount to login.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.PathDoesNotExist"> <summary> Looks up a localized string similar to Path {0} doesn't exist.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.PathDoesNotExistForElement"> <summary> Looks up a localized string similar to Path for {0} doesn't exist in {1}.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.PublishSettingsFileRealmFormat"> <summary> Looks up a localized string similar to &whr={0}. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.RemovingDefaultEnvironmentsNotSupported"> <summary> Looks up a localized string similar to Removing public environment is not supported.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.ServiceKeyNotFound"> <summary> Looks up a localized string similar to Unable to retrieve service key for ServicePrincipal account {0}. Please log in again to supply the credentials for this service principal. In PowerShell, execute Login-AzureRMAccount for Azure Resource Manager cmdlets or Add-AzureAccount for service management cmdlets.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.ServiceNameExists"> <summary> Looks up a localized string similar to The provided service name {0} already exists, please pick another name. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.SPNRenewTokenTrace"> <summary> Looks up a localized string similar to [Common.Authentication]: Renewing token using AppId: '{0}', AdalConfiguration with ADDomain: '{1}', AdEndpoint: '{2}', ClientId: '{3}', RedirectUri: '{4}'. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.SPNTokenExpirationCheckTrace"> <summary> Looks up a localized string similar to [Common.Authentication]: Checking token expiration, token expires '{0}' Comparing to '{1}' With threshold '{2}', calculated time until token expiry: '{3}'. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.SubscriptionIdNotFoundMessage"> <summary> Looks up a localized string similar to The subscription id {0} doesn't exist.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.SubscriptionNameNeedsToBeSpecified"> <summary> Looks up a localized string similar to Subscription name needs to be specified. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.SubscriptionNameNotFoundMessage"> <summary> Looks up a localized string similar to The subscription name {0} doesn't exist.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.SubscriptionNeedsToBeSpecified"> <summary> Looks up a localized string similar to Subscription needs to be specified. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.TenantNotFound"> <summary> Looks up a localized string similar to No tenant was found for this subscription. Please execute Clear-AzureProfile and then execute Add-AzureAccount.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.UnableToPatchJson"> <summary> Looks up a localized string similar to Unable to update mismatching Json structured: {0} {1}.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.UnknownCredentialType"> <summary> Looks up a localized string similar to Illegal credential type. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.UnsupportedCredentialType"> <summary> Looks up a localized string similar to Certificate authentication is not supported for account type {0}.. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.UPNAcquireTokenConfigTrace"> <summary> Looks up a localized string similar to [Common.Authentication]: Acquiring token using AdalConfiguration with Domain: '{0}', AdEndpoint: '{1}', ClientId: '{2}', ClientRedirectUri: {3}. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.UPNAcquireTokenContextTrace"> <summary> Looks up a localized string similar to [Common.Authentication]: Acquiring token using context with Authority '{0}', CorrelationId: '{1}', ValidateAuthority: '{2}'. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.UPNAuthenticationTokenTrace"> <summary> Looks up a localized string similar to [Common.Authentication]: Received token with LoginType '{0}', Tenant: '{1}', UserId: '{2}'. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.UPNAuthenticationTrace"> <summary> Looks up a localized string similar to [Common.Authentication]: Authenticating using Account: '{0}', environment: '{1}', tenant: '{2}'. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.UPNExpiredTokenTrace"> <summary> Looks up a localized string similar to [Common.Authentication]: Token is expired. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.UPNRenewTokenTrace"> <summary> Looks up a localized string similar to [Common.Authentication]: Renewing Token with Type: '{0}', Expiry: '{1}', MultipleResource? '{2}', Tenant: '{3}', UserId: '{4}'. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.UPNRenewTokenUserInfoTrace"> <summary> Looks up a localized string similar to [Common.Authentication]: User info for token DisplayId: '{0}', Name: {2} {1}, IdProvider: '{3}', Uid: '{4}'. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.UPNTokenExpirationCheckTrace"> <summary> Looks up a localized string similar to [Common.Authentication]: Checking token expiration, token expires '{0}' Comparing to '{1}' With threshold '{2}', calculated time until token expiry: '{3}'. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.UserNameIsNotValid"> <summary> Looks up a localized string similar to User name is not valid. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.UserNameNeedsToBeSpecified"> <summary> Looks up a localized string similar to User name needs to be specified. </summary> </member> <member name="P:Microsoft.Azure.Common.Authentication.Properties.Resources.x86InProgramFiles"> <summary> Looks up a localized string similar to (x86). </summary> </member> <member name="M:Microsoft.Azure.Common.Authentication.FileUtilities.DirectoryCopy(System.String,System.String,System.Boolean)"> <summary> Copies a directory. </summary> <param name="sourceDirName">The source directory name</param> <param name="destDirName">The destination directory name</param> <param name="copySubDirs">Should the copy be recursive</param> </member> <member name="M:Microsoft.Azure.Common.Authentication.FileUtilities.EnsureDirectoryExists(System.String)"> <summary> Ensures that a directory exists beofre attempting to write a file </summary> <param name="pathName">The path to the file that will be created</param> </member> <member name="M:Microsoft.Azure.Common.Authentication.FileUtilities.CreateTempDirectory"> <summary> Create a unique temp directory. </summary> <returns>Path to the temp directory.</returns> </member> <member name="M:Microsoft.Azure.Common.Authentication.FileUtilities.CopyDirectory(System.String,System.String)"> <summary> Copy a directory from one path to another. </summary> <param name="sourceDirectory">Source directory.</param> <param name="destinationDirectory">Destination directory.</param> </member> <member name="M:Microsoft.Azure.Common.Authentication.FileUtilities.IsValidDirectoryPath(System.String)"> <summary> Returns true if path is a valid directory. </summary> <param name="path"></param> <returns></returns> </member> <member name="M:Microsoft.Azure.Common.Authentication.FileUtilities.GetPSModulePathForModule(Microsoft.Azure.Common.Authentication.AzureModule)"> <summary> Gets the root installation path for the given Azure module. </summary> <param name="module" >The module name</param> <returns>The module full path</returns> </member> <member name="M:Microsoft.Azure.Common.Authentication.FileUtilities.GetInstallPath"> <summary> Gets the root directory for all modules installation. </summary> <returns>The install path</returns> </member> <member name="M:Microsoft.Azure.Common.Authentication.XmlUtilities.TryFormatXml(System.String)"> <summary> Formats the given XML into indented way. </summary> <param name="content">The input xml string</param> <returns>The formatted xml string</returns> </member> <member name="M:Microsoft.Azure.Common.Authentication.XmlUtilities.Beautify(System.String)"> <summary> Formats given string into well formatted XML. </summary> <param name="unformattedXml">The unformatted xml string</param> <returns>The formatted XML string</returns> </member> <member name="T:Microsoft.Azure.Common.Authentication.XmlSchema.PublishData"> <remarks/> </member> <member name="P:Microsoft.Azure.Common.Authentication.XmlSchema.PublishData.Items"> <remarks/> </member> <member name="T:Microsoft.Azure.Common.Authentication.XmlSchema.PublishDataPublishProfile"> <remarks/> </member> <member name="P:Microsoft.Azure.Common.Authentication.XmlSchema.PublishDataPublishProfile.Subscription"> <remarks/> </member> <member name="P:Microsoft.Azure.Common.Authentication.XmlSchema.PublishDataPublishProfile.PublishMethod"> <remarks/> </member> <member name="P:Microsoft.Azure.Common.Authentication.XmlSchema.PublishDataPublishProfile.Url"> <remarks/> </member> <member name="P:Microsoft.Azure.Common.Authentication.XmlSchema.PublishDataPublishProfile.ManagementCertificate"> <remarks/> </member> <member name="P:Microsoft.Azure.Common.Authentication.XmlSchema.PublishDataPublishProfile.SchemaVersion"> <remarks/> </member> <member name="T:Microsoft.Azure.Common.Authentication.XmlSchema.PublishDataPublishProfileSubscription"> <remarks/> </member> <member name="P:Microsoft.Azure.Common.Authentication.XmlSchema.PublishDataPublishProfileSubscription.Id"> <remarks/> </member> <member name="P:Microsoft.Azure.Common.Authentication.XmlSchema.PublishDataPublishProfileSubscription.Name"> <remarks/> </member> <member name="P:Microsoft.Azure.Common.Authentication.XmlSchema.PublishDataPublishProfileSubscription.ServiceManagementUrl"> <remarks/> </member> <member name="P:Microsoft.Azure.Common.Authentication.XmlSchema.PublishDataPublishProfileSubscription.ManagementCertificate"> <remarks/> </member> </members> </doc> |